Release v1.0.0

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+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).
+
+## [1.0.0] - 2022-04-07
+
+### Added
+
+- Initial version

LICENSE.txt

@@ -0,0 +1,30 @@
+License for the code produced by Semtech contained in this project
+------------------------------------------------------------------
+
+The Clear BSD License
+Copyright Semtech Corporation 2022. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Semtech corporation nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

LICENSES.txt

@@ -0,0 +1,67 @@
+This file is an inventory of the software licenses that are part of this project.
+
+
+Semtech Corporation
+-------------------
+
+The Clear BSD License
+Copyright Semtech Corporation 2022. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Semtech corporation nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+
+STMicroelectronics (STM32L4 HAL, LIS2DE12)
+------------------------------------------
+
+This software component is licensed by ST under BSD 3-Clause license,
+the "License"; You may not use this file except in compliance with the
+License. You may obtain a copy of the License at:
+                       opensource.org/licenses/BSD-3-Clause
+
+
+STMicroelectronics (CMSIS Device)
+------------------------------
+
+This software component is licensed by ST under Apache License, Version 2.0,
+the "License"; You may not use this file except in compliance with the
+License. You may obtain a copy of the License at:
+                       opensource.org/licenses/Apache-2.0
+
+
+Arm Limited (CMSIS)
+-------------------
+
+Licensed under the Apache License, Version 2.0 (the License); you may
+not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an AS IS BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -0,0 +1,149 @@
+# LR11xx SDK
+
+The LR11xx SDK contains several simple examples for LR11xx transceivers.
+
+## Examples
+
+### Radio
+
+| 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) |
+
+A demonstration of the LR-FHSS capability of the chip can be found [here](https://github.com/Lora-net/SWDM001).
+
+### Geolocation
+
+| Name                   | Description                   | Documentation                 |
+| ---------------------- | ----------------------------- | ----------------------------- |
+| GNSS - Assisted scan   | Perform GNSS assisted scans   | [README](apps/gnss/README.md) |
+| GNSS - Autonomous scan | Perform GNSS autonomous scans | [README](apps/gnss/README.md) |
+| Wi-Fi passive scan     | Perform Wi-Fi passive scans   | [README](apps/wifi/README.md) |
+
+## Configuration
+
+Each example has its own set of parameters - see `apps/<example>/main_<example>.h`.
+
+There is also [a common configuration file](apps/common/apps_configuration.h) where parameters can be set, among which:
+
+* Packet type
+* RF frequency
+* Output power
+* Packet and modulation parameters for different modulations
+
+## Requirements
+
+### Supported boards
+
+This SDK is developed on the ST Microeletronic [NUCLEO-L476RG development board](https://www.st.com/en/evaluation-tools/nucleo-l476rg.html)
+
+### Supported shields
+
+The list of compatible Semtech LR1110 shields is:
+
+| Shield       | PCB                                                   | Frequency matching |
+| ------------ | ----------------------------------------------------- | ------------------ |
+| LR1110MB1DIS | PCB_E655V01A - GNSS with LNA for Passive GNSS Antenna | 868/915MHz         |
+| LR1110MB1DJS | PCB_E656V01A - GNSS without LNA                       | 868/915MHz         |
+| LR1110MB1GIS | PCB_E655V01A - GNSS with LNA for Passive GNSS Antenna | 490MHz             |
+| LR1110MB1GJS | PCB_E656V01A - GNSS without LNA                       | 490MHz             |
+
+The list of compatible Semtech LR1120 shields is:
+
+| Shield       | PCB                                                   | Frequency matching |
+| ------------ | ----------------------------------------------------- | ------------------ |
+| LR1120MB1DIS | PCB_E655V01A - GNSS with LNA for Passive GNSS Antenna | 868/915MHz         |
+| LR1120MB1DJS | PCB_E656V01A - GNSS without LNA                       | 868/915MHz         |
+| LR1120MB1GIS | PCB_E655V01A - GNSS with LNA for Passive GNSS Antenna | 490MHz             |
+| LR1120MB1GJS | PCB_E656V01A - GNSS without LNA                       | 490MHz             |
+
+### Firmware
+
+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))
+
+To update the transceiver with the desired firmware version, please use [the updater tool application](https://github.com/Lora-net/lr1110_updater_tool/).
+
+### Toolchain
+
+Each example can be compiled with the following toolchains:
+
+* [Keil MDK ARM](https://www2.keil.com/mdk5) - Keil project file available in `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 `apps/<example>/makefile/`
+
+## Getting started
+
+### Configure
+
+Before starting to build an example, check the parameters in both the common and the example-specific configuration files.
+
+### Build
+
+#### Keil MDK ARM
+
+Each example is delivered with a Keil project file - see `apps/<example>/MDK-ARM/lr11xx-sdk_<example>.uvprojx`.
+
+To build a project:
+
+1. Launch Keil IDE
+2. Open the project file
+3. Select the target
+4. Compile
+
+Each project has different targets ([Keil manual](https://www.keil.com/support/man/docs/uv4/uv4_ca_projtargfilegr.htm)), each one allowing to choose the shield the example is compiled for.
+
+The name of the targets is taken from the column `shield` of the table available [here](#supported-shields).
+
+#### GNU Arm embedded toolchain
+
+Examples are built from their respective subfolder in the `apps` directory. For instance, the makefile for the `per` example is available in `apps/per/makefile/Makefile`.
+
+Build settings, compile time and configuration options are specified in the project's Makefile.
+
+The output files of the build process are stored in the `build` folder with firmware binary file having the same name as the project with a .bin extension.
+
+Here are the parameters available at compile time:
+
+| Parameter    | Description                              | Default value |
+| ------------ | ---------------------------------------- | ------------- |
+| TARGET_BOARD | Board for which the example is compiled  | NUCLEO_L476RG |
+| RADIO_SHIELD | Shield for which the example is compiled | LR1120MB1DIS  |
+
+For instance, to build the project `per` with LR1110MB1GJS shield:
+
+To build a project, simply run make
+
+```shell
+$ cd $SDK_FOLDER/apps/per/makefile
+$ make RADIO_SHIELD=LR1110MB1GJS
+```
+
+### Load
+
+After a project is built, it can be loaded onto a device.
+
+There are multiple ways to do it, among which:
+
+* Drag and drop the binary file to the USB drive listed by our OS - usually shows up as `NODE_L476RG`.
+* Load it through the Keil IDE
+
+### View debug output
+
+On the NUCLEO-L476RG development board, the firmware prints debug information to the UART that is connected via the ST-LINK to the host computer. The configuration is 921600/8-N-1:
+
+* On Linux, this device usually shows up as `/dev/ttyACM0`
+* On Windows, the port can be obtained from the device manager
+
+For instance, using stty on Linux with a device available in `/dev/ttyACM0`:
+
+```shell
+$ stty -echo raw speed 921600 < /dev/ttyACM0 && cat /dev/ttyACM0
+```