Release v2.1.0

Lora-net · Oct 18, 2023 · 36a03cd · 36a03cd
1 parent b0d0913
commit 36a03cd
Show file tree

Hide file tree

Showing 19 changed files with 11,292 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ 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).
 
+## [v2.1.0] - 2023-10-06
+
+### Added
+
+- LR11xx ranging example
+
 ## [v2.0.2] - 2023-09-05
 
 ### Removed

diff --git a/README.md b/README.md
@@ -113,10 +113,10 @@ Each example can be compiled with the following toolchains:
 * [Keil MDK ARM](https://www2.keil.com/mdk5) - Keil project file available in `<chip_family>/apps/<example>/MDK-ARM/`
 * [GNU Arm Embedded toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm) - makefile available in `<chip_family>/apps/<example>/makefile/`
 
-## Known limitations
+## Remarks
 
 ### Channel Activity Detection accuracy
 
 The Channel Activity Detection (CAD) may expose false negative or false positive detection.
 The parameters for CAD configuration needs adaptation relative to context usage.
-Refer to the application notes available on [LoRa Developer Portal](https://lora-developers.semtech.com/documentation/product-documents/) and [Semtech website](https://www.semtech.com/) relative to CAD performances.
+Refer to the application notes available on [Semtech website](https://www.semtech.com/) relative to CAD performances.
diff --git a/common/inc/common_version.h b/common/inc/common_version.h
@@ -50,7 +50,7 @@ extern "C" {
  * --- PUBLIC MACROS -----------------------------------------------------------
  */
 
-#define COMMON_SDK_VERSION "v2.0.2"
+#define COMMON_SDK_VERSION "v2.1.0"
 
 /*
  * -----------------------------------------------------------------------------

diff --git a/lr11xx/README.md b/lr11xx/README.md
@@ -4,15 +4,16 @@ The LR11xx SDK contains several simple examples for LR11xx transceivers.
 
 ## Examples
 
-| Name                 | Description                                                     | Documentation                                 |
-| -------------------- | --------------------------------------------------------------- | --------------------------------------------- |
-| CAD                  | Perform a Channel Activity Detection (CAD) - LoRa only          | [README](apps/cad/README.md)                  |
-| PER                  | Perform a Packet Error Rate (PER) test - both Tx and Rx roles   | [README](apps/per/README.md)                  |
-| Ping pong            | Launch an exchange between two devices                          | [README](apps/ping_pong/README.md)            |
-| Sprectral scan       | Get inst-RSSI values in RX mode to form a heat map              | [README](apps/spectral_scan/README.md)        |
-| Spectrum display     | Get inst-RSSI values in RX mode to form a dyamic spectrum curve | [README](apps/spectrum_display/README.md)     |
-| Tx continuous wave   | Configure the chip to transmit a single tone                    | [README](apps/tx_cw/README.md)                |
-| Tx infinite preamble | Configure the chip to transmit an infinite preamble             | [README](apps/tx_infinite_preamble/README.md) |
+| Name                 | Description                                                                             | Documentation                                 |
+| -------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------- |
+| CAD                  | Perform a Channel Activity Detection (CAD) - LoRa only                                  | [README](apps/cad/README.md)                  |
+| PER                  | Perform a Packet Error Rate (PER) test - both Tx and Rx roles                           | [README](apps/per/README.md)                  |
+| Ping pong            | Launch an exchange between two devices                                                  | [README](apps/ping_pong/README.md)            |
+| RTToF (Ranging)      | Perform Round-Trip Time of Flight (ranging) exchanges. Only valid for LR1110 and LR1120 | [README](apps/ranging/README.md)              |
+| Sprectral scan       | Get inst-RSSI values in RX mode to form a heat map                                      | [README](apps/spectral_scan/README.md)        |
+| Spectrum display     | Get inst-RSSI values in RX mode to form a dyamic spectrum curve                         | [README](apps/spectrum_display/README.md)     |
+| Tx continuous wave   | Configure the chip to transmit a single tone                                            | [README](apps/tx_cw/README.md)                |
+| Tx infinite preamble | Configure the chip to transmit an infinite preamble                                     | [README](apps/tx_infinite_preamble/README.md) |
 
 A demonstration of the LR-FHSS capability of the chip can be found [here](https://github.com/Lora-net/SWDM001).
 
@@ -64,9 +65,9 @@ The list of compatible Semtech LR1121 shields is:
 
 This SDK requires the transceiver to run the following version
 
-* LR1110: firmware version ([0x0307](https://github.com/Lora-net/radio_firmware_images/tree/master/lr1110/transceiver))
-* LR1120: firmware version ([0x0101](https://github.com/Lora-net/radio_firmware_images/tree/master/lr1120/transceiver))
-* LR1121: firmware version ([0x0101](https://github.com/Lora-net/radio_firmware_images/tree/master/lr1121/transceiver))
+* LR1110: firmware version ([0x0308](https://github.com/Lora-net/radio_firmware_images/tree/master/lr1110/transceiver))
+* LR1120: firmware version ([0x0102](https://github.com/Lora-net/radio_firmware_images/tree/master/lr1120/transceiver))
+* LR1121: firmware version ([0x0102](https://github.com/Lora-net/radio_firmware_images/tree/master/lr1121/transceiver))
 
 To update the transceiver with the desired firmware version, please use [the updater tool application](https://github.com/Lora-net/SWTL001).
 

diff --git a/lr11xx/apps/cad/MDK-ARM/lr11xx-sdk_cad.uvprojx b/lr11xx/apps/cad/MDK-ARM/lr11xx-sdk_cad.uvprojx
@@ -523,6 +523,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -1499,6 +1504,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -2475,6 +2485,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -3520,6 +3535,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -4496,6 +4516,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -5541,6 +5566,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -6586,6 +6616,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -7631,6 +7666,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -8676,6 +8716,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -9739,6 +9784,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>

diff --git a/lr11xx/apps/per/MDK-ARM/lr11xx-sdk_per.uvprojx b/lr11xx/apps/per/MDK-ARM/lr11xx-sdk_per.uvprojx
@@ -523,6 +523,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -1499,6 +1504,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -2475,6 +2485,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -3520,6 +3535,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -4496,6 +4516,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -5541,6 +5566,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -6586,6 +6616,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -7631,6 +7666,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -8676,6 +8716,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>
@@ -9739,6 +9784,11 @@
               <FileType>1</FileType>
               <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_radio.c</FilePath>
             </File>
+            <File>
+              <FileName>lr11xx_ranging.c</FileName>
+              <FileType>1</FileType>
+              <FilePath>..\..\..\..\lr11xx\lr11xx_driver\src\lr11xx_ranging.c</FilePath>
+            </File>
             <File>
               <FileName>lr11xx_radio_timings.c</FileName>
               <FileType>1</FileType>