Release v2.0.1

Lora-net · Nov 2, 2022 · 43de4d3 · 43de4d3
1 parent e08cdcf
commit 43de4d3
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,13 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.1] - 2022-11-02
+
+### Changed
+
+- Documentation update:
+  - Only LoRaWAN class A supported for WW2G4 region
+  - Region CN470 not validated
+
 ## [2.0.0] - 2022-09-09
 
 ### Added
 
 - Regional Parameters version can now be chosen in `apps/common/apps_modem_common.mk` - default value set to `RP2_103`
 - Region switching demonstration
-- Class B, multicast class B and multicast class C examples
+- Class B, multicast class B and multicast class C examples (region `SMTC_MODEM_REGION_WW2G4` is not supported)
 - Support of all SX1261/SX1262/SX1268 and LR1110/LR1120 shields:
   - SX1261MB1BAS
   - SX1261MB1CAS

diff --git a/README.md b/README.md
@@ -201,3 +201,38 @@ Region: EU868
 
 INFO: ###### ===== JOINED EVENT ==== ######
 ```
+
+## Validation
+
+The examples provided in the SDK have been tested under the following configurations:
+
+- shields (not all shields have been used on every regions):
+  - LR1110MB1DJS
+  - LR1110MB1GJS
+  - LR1120MB1DJS
+  - LR1120MB1GJS
+  - SX1261MB1BAS
+  - SX1261MB1CAS
+  - SX1262MB1CAS
+  - SX1262MB1DAS
+  - SX1268MB1GAS
+- LoRaWAN Network Server: The Things Network (v3.22.0)
+- Application Server: the Node-Red based one provided in [`apps/examples/application_server`](apps/examples/application_server/README.md)
+
+
+| Regions | Validation executed |  Comment |
+| -- | :--: | -- |
+| SMTC_MODEM_REGION_AS_923_GRP1 | :white_check_mark: | |
+| SMTC_MODEM_REGION_AS_923_GRP2 | :white_check_mark: | |
+| SMTC_MODEM_REGION_AS_923_GRP3 | :white_check_mark: | |
+| SMTC_MODEM_REGION_AU_915 | :white_check_mark: | |
+| SMTC_MODEM_REGION_CN_470 | :x: | Validation has not been executed on this region |
+| SMTC_MODEM_REGION_CN_470_RP_1_0 | :white_check_mark: | |
+| SMTC_MODEM_REGION_EU_868 | :white_check_mark: | |
+| SMTC_MODEM_REGION_IN_865 | :white_check_mark: | |
+| SMTC_MODEM_REGION_KR_920 | :white_check_mark: | |
+| SMTC_MODEM_REGION_RU_864 | :white_check_mark: | |
+| SMTC_MODEM_REGION_US_915 | :white_check_mark: | |
+| SMTC_MODEM_REGION_WW2G4 | :white_check_mark: | Validation has been executed on examples as only LoRaWAN class A is supported for this region: <br> - time_sync <br> - stream <br> - lorawan_asynchronous <br> - almanac_update <br> - dm_info <br> - lorawan (`SMTC_MODEM_CLASS_A`) <br> - large_file_upload |
+
+
diff --git a/apps/common/apps_modem_common_version.h b/apps/common/apps_modem_common_version.h
@@ -1,5 +1,5 @@
 /*!
- * @file      .h
+ * @file      apps_modem_common_version.h
  *
  * @brief     Version header file of the LoRa Basics Modem SDK
  *
@@ -54,7 +54,7 @@ extern "C" {
  * --- PUBLIC MACROS -----------------------------------------------------------
  */
 
-#define APPS_MODEM_COMMON_SDK_VERSION "v2.0.0"
+#define APPS_MODEM_COMMON_SDK_VERSION "v2.0.1"
 
 /*
  * -----------------------------------------------------------------------------

diff --git a/apps/examples/lorawan/README.md b/apps/examples/lorawan/README.md
@@ -54,4 +54,8 @@ INFO: Request uplink
 
 ```
 INFO: ###### ===== TX DONE EVENT ==== ######
-```
+```
+
+## Limitation
+
+Even though the lorawan example can run with the LoRaWAN class set to `SMTC_MODEM_CLASS_C` AND the region set to `SMTC_MODEM_REGION_WW2G4`, this configuration is not supported.
diff --git a/apps/examples/lorawan_class_b/README.md b/apps/examples/lorawan_class_b/README.md
@@ -91,3 +91,8 @@ The info displayed in this print may vary.
 
 However, one stays always the same to confirm the downlink is indeed a class B one, which is the Rx Windows.
 This last must be equal to SMTC_MODEM_EVENT_DOWNDATA_WINDOW_RXB
+
+## Limitation
+
+Even though the class B example can run with the region configured to `SMTC_MODEM_REGION_WW2G4`, it is not supported and has not been tested.
+
diff --git a/apps/examples/lorawan_multicast_class_b/README.md b/apps/examples/lorawan_multicast_class_b/README.md
@@ -148,3 +148,7 @@ Therefore if when using multicast class B with high datarate ping slots are not
 
 Note that increasing this value will lead to an overconsumption as the ping slot windows will open earlier and last longer.
 The value of crystal error estimation must then be evaluated by balancing PER on multicast class B downlinks and consumption.
+
+## Limitation
+
+Even though the multicast class B example can run with the region configured to `SMTC_MODEM_REGION_WW2G4`, it is not supported and has not been tested.
diff --git a/apps/examples/lorawan_multicast_class_c/README.md b/apps/examples/lorawan_multicast_class_c/README.md
@@ -102,3 +102,7 @@ Assuming that [mosquitto](https://mosquitto.org/) has been installed on a local
 ```
 mosquitto_pub -h eu1.cloud.thethings.network   -t "v3/sample-app-1@ttn/devices/sample-app-1-multicast-dev/down/push"   -u "sample-app-1@ttn" -P "NNSXS.MN..." -d  -m '{"downlinks":[{"class_b_c":{"gateways":[{"gateway_ids":{"gateway_id":"sample-gateway-1"}}]},"f_port":42,"frm_payload":"bXVsdGljYXN0Cg==","priority":"NORMAL"}]}'
 ```
+
+## Limitation
+
+Even though the multicast class C example can run with the region configured to `SMTC_MODEM_REGION_WW2G4`, it is not supported.