Skip to content

Commit f0cab5f

Browse files
committed
finished up getting started
1 parent 15f1de8 commit f0cab5f

File tree

5 files changed

+48
-0
lines changed

5 files changed

+48
-0
lines changed
197 KB
Loading

docs/assets/img/digi-xon-a-device.png

98.6 KB
Loading

docs/assets/img/digi-xon-devices.png

129 KB
Loading
210 KB
Loading

docs/getting_started.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Getting Started
2+
3+
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.
4+
5+
## Setting up your Digi X-ON account and Gateway
6+
7+
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.
8+
9+
## Registering the IoT Node - LoRaWAN
10+
11+
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/).
12+
13+
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.
14+
15+
After you device is registered with your account, it will be listed in the device section of you XON account.
16+
17+
![XON Devices](assets/img/digi-xon-devices.png)
18+
19+
Device listing
20+
21+
![XON A Device](assets/img/digi-xon-a-device.png)
22+
23+
From the specific device page, the messages sent by the device are listed. The ***Data*** column contains the message data.
24+
25+
![XON Messages](assets/img/digi-device-messages.png)
26+
27+
With the highlighted corresponding sent messages reported on the output of the IoT Node board:
28+
29+
![Node Messages](assets/img/node-sent-messages.png)
30+
31+
## Troubleshooting and Notes
32+
33+
### If the Node Board Fails to Connect
34+
35+
* Make sure your Digi XON gateway is powered on, connected and connected to a network
36+
* Verify that the LoRa Antenna is property connected to the IOT Node - LoRaWAN board
37+
38+
### Application ID or Key Error message printed at startup
39+
40+
While not often, this has been seen with some new boards. Restarting the board a couple of times often resoles this issue.
41+
42+
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.
43+
44+
Note: The Application and Network Key values are ***secret***, and as such stored securely on the device and not visible once entered.
45+
46+
### Notes
47+
48+
* Sometimes the first data message fails to send on setup. This is only after initial setup, with following messages successfully sent.

0 commit comments

Comments
 (0)