Skip to content

Commit

Permalink
finished up getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
gigapod committed Jan 5, 2025
1 parent 15f1de8 commit f0cab5f
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 0 deletions.
Binary file added docs/assets/img/digi-device-messages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/digi-xon-a-device.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/digi-xon-devices.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/node-sent-messages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Getting Started

The SparkFun IoT Node - LoRaWAN firmware is designed to enable rapid setup and connection to the Digi LoRaWAN network or the Digi X-ON system. The SparkFun IoT Node - LoRaWAN board is pre-provisioned with the necessary keys to connect to Digi X-ON, and the default XON Application ID for the demo application is set as default within the IOT Node - LoRaWAN firmware. From the board standpoint, once the Digi module is registered with a XON account, all that is required is to connect the antenna, a supported qwiic sensor and apply power to the board.

## Setting up your Digi X-ON account and Gateway

To get started, you'll need to have access to an HX15 Gateway (NA or EU version) and a Digi Account. If you've purchased the kit, a Gateway will be included. Digi has a great ["Getting Started" video here](https://youtu.be/nrmTp8ZYa6c?si=9FnklldcUvFMTXLr). The kit also has a welcome card included that contains a QR Code. Scanning this code will take you to a URL where you can register for an account.

## Registering the IoT Node - LoRaWAN

To provision a IoT Node - LoRaWAN device, go to the following link, log in if necessary, and scan the Data Matrix on the XBee Module using the [Digi Scan page](https://scan-us1.haxiot.com/).

Note - if the DataMatrix scan is out-of-focus and unable to resolve, wait a few seconds and a manual entry prompt will appear on Digi Scan. From here you manually enter the modules serial number.

After you device is registered with your account, it will be listed in the device section of you XON account.

![XON Devices](assets/img/digi-xon-devices.png)

Device listing

![XON A Device](assets/img/digi-xon-a-device.png)

From the specific device page, the messages sent by the device are listed. The ***Data*** column contains the message data.

![XON Messages](assets/img/digi-device-messages.png)

With the highlighted corresponding sent messages reported on the output of the IoT Node board:

![Node Messages](assets/img/node-sent-messages.png)

## Troubleshooting and Notes

### If the Node Board Fails to Connect

* Make sure your Digi XON gateway is powered on, connected and connected to a network
* Verify that the LoRa Antenna is property connected to the IOT Node - LoRaWAN board

### Application ID or Key Error message printed at startup

While not often, this has been seen with some new boards. Restarting the board a couple of times often resoles this issue.

If it persists, verify the values being used via the settings menu. If need be, reset the board via the menu system to clear out any invalid value.

Note: The Application and Network Key values are ***secret***, and as such stored securely on the device and not visible once entered.

### Notes

* Sometimes the first data message fails to send on setup. This is only after initial setup, with following messages successfully sent.

0 comments on commit f0cab5f

Please sign in to comment.