Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for Arduino #2104

Merged
merged 3 commits into from
Oct 23, 2023
Merged

Add documentation for Arduino #2104

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e95cb5c
Add documentation for Arduino
Mandur Oct 22, 2023
6c3e568
Correct linting errors
Mandur Oct 22, 2023
17739e1
Update docs/quickstart.md
Mandur Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 immediagely, please consult the [Arduino Samples Documentation](samples/arduino.md) to discover how to quickly use them for tests.
Mandur marked this conversation as resolved.
Show resolved Hide resolved

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).

Expand Down
2 changes: 2 additions & 0 deletions docs/samples/arduino.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/lns-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <https://deployedfunction.azurewebsites.net/api> | 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`) |
Expand Down Expand Up @@ -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. <https://deployedfunction.azurewebsites.net/api> | Yes |
| FACADE_AUTH_CODE | Azure Facade function auth code | Yes |
Loading