Merge pull request #132 from mcci-catena/issue119

Prepare for release v2.6.0
mcci-catena · Oct 29, 2019 · 6d58747 · 6d58747
2 parents c653872 + 22ff83c
commit 6d58747
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 65 deletions.
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -3,14 +3,14 @@ Before reporting any issue:
 - Make sure you are using the latest Arduino_Core_STM32 version. See
   https://github.com/mcci-catena/Arduino_Core_STM32/releases/latest
 
-- Make sure the issue is not already reported on the GitHub [issues page](https://github.com/mcci-catena/Arduino_Core_STM32/issues).
+- Make sure the issue is not already reported on GitHub [issues page](https://github.com/mcci-catena/Arduino_Core_STM32/issues).
 
 - Check whether the issue has been discussed on the [MCCI Support forum](https://portal.mcci.com)
 
-- Submit a GitHub issue only for reporting a problem related to the Arduino_Core_STM32.
+- Submit a GitHub issue only for reporting a problem related to Arduino_Core_STM32.
 
 - **Please do not** submit a GitHub issue for project troubleshooting.
- 
+
 Any questions/feedback/suggestions should be discussed on the [MCCI support forum](https://portal.mcci.com).
 
 When reporting any issue, please try to provide all relevant information:

diff --git a/MCCI-ADDING-BOARDS.md b/MCCI-ADDING-BOARDS.md
@@ -20,7 +20,7 @@ In both objects, a special array variable is used to parameterize the lines in t
      "using": "{{replacementname}}" }
    ```
 
-After section substitution, the board specification is scancced for strings within doubled-curly-braces (`{{...}}`). These are taken as macro names; the name is looked up, first in boards.json `boards` then in `defaults`. If found, the value is substituted. Substitutions are further macro-expanded.
+After section substitution, the board specification is scanned for strings within doubled-curly-braces (`{{...}}`). These are taken as macro names; the name is looked up, first in `boards.json` object `boards`, then in object `defaults`. If found, the value is substituted. Substitutions are further macro-expanded.
 
 The template file is divided into sections.
 
@@ -60,28 +60,28 @@ $section usb
 And `boards.json` is
 
 ```json
-	{
-	"boards":
-		[
-			{
-			"modelnumber": 	"one",
-			"extra_sections": []
-			},
-			{
-			"modelnumber": "two",
-			"extra_sections": [
-				{"name": "usb"}
-				]
-			},
-			{
-			"modelnumber": "three",
-			"extra_sections": [
-				{"name": "usb"},
-				{"using": "usb_disable" }
-				]
-			}
-		]
-	}
+    {
+    "boards":
+        [
+            {
+            "modelnumber": "one",
+            "extra_sections": []
+            },
+            {
+            "modelnumber": "two",
+            "extra_sections": [
+                {"name": "usb"}
+                ]
+            },
+            {
+            "modelnumber": "three",
+            "extra_sections": [
+                {"name": "usb"},
+                {"using": "usb_disable" }
+                ]
+            }
+        ]
+    }
 ```
 
 Then the output will be:
@@ -97,13 +97,13 @@ Then the output will be:
 
 The following template macros are used in `boards.template`.
 
-- `{{board}}` identifies the board tuple to the Arduino IDE. It is conventionally `mcci_catena_{{modelnumber}}`. Characters should be chosen from C++ indentifier characters (`[a-zA-Z0-9_]`).
-- `{{modelnumber}}` is assigned by marketing; it's typically a number but might have a regional suffix. Characters should be chosen from C++ indentifier characters (`[a-zA-Z0-9_]`).
+- `{{board}}` identifies the board tuple to the Arduino IDE. It is conventionally `mcci_catena_{{modelnumber}}`. Characters should be chosen from C++ identifier characters (`[a-zA-Z0-9_]`).
+- `{{modelnumber}}` is assigned by marketing; it's typically a number but might have a regional suffix. Characters should be chosen from C++ identifier characters (`[a-zA-Z0-9_]`).
 - `{{name}}` is the UI name of the board, assigned by marketing; it's typically `MCCI Catena {{modelnumber}}`.
-- `{{build_board}}` is used to form the C pre-processor symbol for the board. It's normally `MCCI_CATENA_{{modelnumber}}`. Characters should be chosen from C++ indentifier characters (`[a-zA-Z0-9_]`).  `platform.txt` normally arranges for `ARDUINO_{{build_board}}` to be defined at compile time.
+- `{{build_board}}` is used to form the C pre-processor symbol for the board. It's normally `MCCI_CATENA_{{modelnumber}}`. Characters should be chosen from C++ identifier characters (`[a-zA-Z0-9_]`).  `platform.txt` normally arranges for `ARDUINO_{{build_board}}` to be defined at compile time.
 - `{{vid}}` is the USB vendor ID: for MCCI products, it's 040E.  This should be four hexadecimal digits.
 - `{{pid}}` is the USB product ID -- a 4-digit hex number. This is controlled by MCCI sysadmin. This should be four hexadecimal digits.
-- `{{build_variant}}` is the directory name (in `variants/`) for the variant-specfic source files for this board. Note that this might be shared with other boards.{}
+- `{{build_variant}}` is the directory name (in `variants/`) for the variant-specific source files for this board. Note that this might be shared with other boards.{}
 - `{{build_variant_extra_flags}}` specifies additional compile flags for this variant.
 
 The following command is used to generate `boards.txt`.

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This repository is MCCI's version of [Arduino_Core_STM32](https://github.com/stm
 
 For general information, please check the stm32duino [README.md](https://github.com/stm32duino/Arduino_Core_STM32#arduino-core-support-for-stm32-based-boards), especially the [Getting Started](https://github.com/stm32duino/Arduino_Core_STM32#getting-started) section.
 
-[![GitHub release](https://img.shields.io/github/release/mcci-catena/Arduino_Core_STM32.svg)](https://github.com/mcci-catena/Arduino_Core_STM32/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/Arduino_Core_STM32/latest.svg)](https://github.com/mcci-catena/Arduino_Core_STM32/compare/v2.5.0...master)
+[![GitHub release](https://img.shields.io/github/release/mcci-catena/Arduino_Core_STM32.svg)](https://github.com/mcci-catena/Arduino_Core_STM32/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/Arduino_Core_STM32/latest.svg)](https://github.com/mcci-catena/Arduino_Core_STM32/compare/v2.6.0...master)
 
 **Contents:**
 <!-- markdownlint-disable MD033 -->
@@ -15,10 +15,10 @@ For general information, please check the stm32duino [README.md](https://github.
 - [Getting Started](#getting-started)
 - [Features](#features)
 - [Supported Boards and CPUs](#supported-boards-and-cpus)
-	- [Catena 461x Series](#catena-461x-series)
-		- [Sensors on Catena 4612, 4617, and 4618](#sensors-on-catena-4612-4617-and-4618)
-	- [Catena 4630 Features](#catena-4630-features)
-	- [Catena 4801 Features](#catena-4801-features)
+    - [Catena 461x Series](#catena-461x-series)
+        - [Sensors on Catena 4612, 4617, and 4618](#sensors-on-catena-4612-4617-and-4618)
+    - [Catena 4630 Features](#catena-4630-features)
+    - [Catena 4801 Features](#catena-4801-features)
 - [Troubleshooting](#troubleshooting)
 - [Installing a Development Copy of this BSP](#installing-a-development-copy-of-this-bsp)
 - [Release History](#release-history)
@@ -41,7 +41,7 @@ For full instructions on using the "**Boards Manager**", see  [Installing the MC
 
 The Arduino IDE allows you to select the following items.
 
-- **LoRaWAN Region**: when using the Arduino LMIC, you can select North America, Europ, Australia, Asia, Japan, or India as your target region.
+- **LoRaWAN Region**: when using the Arduino LMIC, you can select North America, Europe, Australia, Asia-923, Japan, Korea, or India as your target region.
 - **Optimization**: choose smallest, fast, faster, fastest, or debug.
 - **Serial interface**: Select "USB Serial", "Generic Serial" or "No Serial".
 - **System clock**: Select "32 MHz (most power)", "24 MHz", "16 MHz", "4.194 MHz (no USB)" or "2.097 MHz (no USB, least power)". If "2.097 MHz (no USB, least power)" or "4.194 MHz (no USB)" is selected, then you cannot use "USB Serial" for serial interface.
@@ -155,7 +155,7 @@ Remember to restart the IDE whenever you change `platform.txt`, `boards.txt` or
 
 ## Release History
 
-- HEAD adds support for KR-920 (Korea 920 MHz) in the region selection menu.
+- [v2.6.0](https://github.com/mcci-catena/Arduino_Core_STM32/releases/tag/v2.6.0) adds support for KR-920 (Korea 920 MHz) in the region selection menu ([#117](https://github.com/mcci-catena/Arduino_Core_STM32/issues/117)). Adds official library.properties fields for linking pre-compiled object and adds additional pins definitions for SX1276 radios ([#128](https://github.com/mcci-catena/Arduino_Core_STM32/issues/128)) (thanks to Kent Williams). Add source-level debugging support ([#122](https://github.com/mcci-catena/Arduino_Core_STM32/issues/122)). Adjust USB `Vbus` check values for Catena 461x platform. Define AU915 as well as AU921 for LMIC migration ([#131](https://github.com/mcci-catena/Arduino_Core_STM32/issues/131)). Fix link "`warning: changing start of section .bss by 4 bytes`" ([#129](https://github.com/mcci-catena/Arduino_Core_STM32/issues/129)). Update issue template.
 
 - [v2.5.0](https://github.com/mcci-catena/Arduino_Core_STM32/releases/tag/v2.5.0) enables the crystal controlled LSE clock, and uses it to run the RTC. Code was substantially refactored to move common code to common directories. Bug fixes.
 

diff --git a/boards.template b/boards.template
@@ -154,15 +154,15 @@ $section xserial
 # menu.lorawan_region
 {{board}}.menu.lorawan_region.us915=North America 915 MHz
 {{board}}.menu.lorawan_region.eu868=Europe 868 MHz
-{{board}}.menu.lorawan_region.au921=Australia 921 MHz
+{{board}}.menu.lorawan_region.au915=Australia 915 MHz
 {{board}}.menu.lorawan_region.as923=Asia 923 MHz
 {{board}}.menu.lorawan_region.as923jp=Japan 923 MHz
 {{board}}.menu.lorawan_region.kr920=Korea 920 MHz
 {{board}}.menu.lorawan_region.in866=India 866 MHz
 {{board}}.menu.lorawan_region.projcfg=Use arduino-lmic/project_confic/lmic_project_lmic_config_preconditions.h
 {{board}}.menu.lorawan_region.us915.build.lorawan_flags=-DCFG_us915=1 -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h
 {{board}}.menu.lorawan_region.eu868.build.lorawan_flags=-DCFG_eu868=1 -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h
-{{board}}.menu.lorawan_region.au921.build.lorawan_flags=-DCFG_au921=1 -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h
+{{board}}.menu.lorawan_region.au915.build.lorawan_flags=-DCFG_au921=1 -DCFG_au915=1 -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h
 {{board}}.menu.lorawan_region.as923.build.lorawan_flags=-DCFG_as923=1 -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h
 {{board}}.menu.lorawan_region.as923jp.build.lorawan_flags=-DCFG_as923=1 -DLMIC_COUNTRY_CODE=LMIC_COUNTRY_CODE_JP -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h
 {{board}}.menu.lorawan_region.kr920.build.lorawan_flags=-DCFG_kr920=1 -DCFG_sx1276_radio=1 -DARDUINO_LMIC_PROJECT_CONFIG_H=lmic_config_preconditions.h