From ff6b8fc336d42d4f0daa83d311b8d199cf4f8f69 Mon Sep 17 00:00:00 2001 From: Mikhail Chatillon Date: Mon, 23 Oct 2023 08:27:15 +0200 Subject: [PATCH] Add documentation for Arduino (#2104) * Add documentation for Arduino * Correct linting errors * Update docs/quickstart.md Co-authored-by: Francisco Beltrao --------- Co-authored-by: Francisco Beltrao --- docs/quickstart.md | 2 +- docs/samples/arduino.md | 2 ++ docs/user-guide/lns-configuration.md | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index fe623dc439..3ef0425115 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -78,7 +78,7 @@ By using the `docker ps` command, you should see the Edge containers being deplo ### What does the template do? -The template provision an IoT Hub with a [LoRa Basics™ Station](https://github.com/lorabasics/basicstation) and a network server module already pre-configured to work out of the box. As soon as you connect your IoT Edge device in point 4 above, those will be pushed on your device. You can find template definition and Edge deployment specification [here](https://github.com/Azure/iotedge-lorawan-starterkit/tree/dev/Template). +The template provision an IoT Hub with a [LoRa Basics™ Station](https://github.com/lorabasics/basicstation) and a network server module already pre-configured to work out of the box. As soon as you connect your IoT Edge device in point 4 above, those will be pushed on your device. You can find template definition and Edge deployment specification [here](https://github.com/Azure/iotedge-lorawan-starterkit/tree/dev/Template). When setting the "deployDevice" argument to true, some LoRaWan devices will be ready to be used immediately, please consult the [Arduino Samples Documentation](samples/arduino.md) to discover how to quickly use them for tests. If you are using the the RAK833-USB, you'll need to build a different LoRa Basics™ Station image. You can find a fork of the official Basic Station repository with support for RAK833-USB [here](https://github.com/danigian/basicstation). diff --git a/docs/samples/arduino.md b/docs/samples/arduino.md index b725574250..e1863a6e9f 100644 --- a/docs/samples/arduino.md +++ b/docs/samples/arduino.md @@ -8,6 +8,8 @@ This samples were tested with the [Seeeduino LoRaWan boards](http://wiki.seeedst If you are using another LoRaWan library, you will have to adjust this code as so far, all LoRaWan libraries are different from one manufacturer to another on Arduino platform. That said, adaptation shouldn't be too difficult and equivalent functions has to exist in all libraries. +> **When using the initial template to provision the devices, make sure to get the devices key in the devices' twins or in the ARM deployment logs (go to the deployment resource group and then to deployments/devices/createIothubDevices)** + This samples were tested with the Seeeduino LoRaWan boards. Samples are organized by regions as LoRaWan uses different frequences based on your geography. Please make sure you're using the sample from the correct geography. 1. **TransmissionTestOTAALoRa** - This is the most basic example. The sample perform an OTAA authentication and send a message to the gateway every 5 seconds. The sample also display on the serial interface any cloud to device message. diff --git a/docs/user-guide/lns-configuration.md b/docs/user-guide/lns-configuration.md index 62f7239120..2056dd20c7 100644 --- a/docs/user-guide/lns-configuration.md +++ b/docs/user-guide/lns-configuration.md @@ -17,7 +17,7 @@ as environment variables for manual configuration of the | HTTPS_PROXY | HTTPS proxy url | No | | RX2_DATR | RX2 data rate; useful to override the default regional RX2 Data Rate at a global level | No (defaults to null, regional default value is used) | | RX2_FREQ | RX2 frequency; useful to override the default regional RX2 Frequency at a global level | No (defaults to null, regional default value is used) | -| FACADE_SERVER_URL | Azure Facade function url, e.g. "https://deployedfunction.azurewebsites.net/api" | Yes | +| FACADE_SERVER_URL | Azure Facade function url, e.g. | Yes | | FACADE_AUTH_CODE | Azure Facade function auth code | Yes | | LOG_LEVEL | Logging level | No (defaults to level 4 (Error) | | LOG_TO_CONSOLE | Indicates whether logging to console is enabled or not | No (default to `true`) | @@ -58,5 +58,5 @@ environment variables: | IOTHUBHOSTNAME | Host name of the IoT Hub to which the LNS should connect to. | Yes | | HOSTNAME | Identifier of the LNS. | Yes | | REDIS_CONNECTION_STRING | Connection string used to connect to the deployed Redis instance. | Yes | -| FACADE_SERVER_URL | Azure Facade function url, e.g. "https://deployedfunction.azurewebsites.net/api" | Yes | +| FACADE_SERVER_URL | Azure Facade function url, e.g. | Yes | | FACADE_AUTH_CODE | Azure Facade function auth code | Yes |