Skip to content

Commit c62b228

Browse files
committed
doc: Update adding device doc for device repo
1 parent be2bf9d commit c62b228

14 files changed

Lines changed: 76 additions & 18 deletions

doc/content/devices/adding-devices/_index.md

Lines changed: 76 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,41 +14,99 @@ This section contains instructions for adding devices in {{% tts %}}.
1414

1515
## Adding Devices using the Console
1616

17-
Go to **Devices** in the left menu and click on **+ Add Device** to reach the end device registration page. Fill the device ID, the LoRaWAN MAC and PHY versions and the frequency plan used by the device.
17+
Devices are managed under applications. An application can contain an unlimited number of devices, but it can be helpful to sort devices in to applications by function or geographical area, to make the integrations and live data views more useful.
1818

19-
{{< note "The PHY version represents the revision of the LoRAWAN Regional Parameters that the device expects, and must be correlated with the MAC version." />}}
19+
To create a device, first open the application you wish to add the device in. Go to **End devices** in the left menu and click on **+ Add end device** to reach the end device registration page.
2020

21-
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Cspan+class%3D"x x-first x-last">device-creation-1.png" alt="Creating a new device" >}}
21+
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Cspan+class%3D"x x-first x-last">application-overview.png" alt="Application overview" >}}
2222

23-
### Over-The-Air-Activation (OTAA) Device
23+
### Using the LoRaWAN Device Repository
2424

25-
After filling the fields in the **General Settings** section, scroll to the lower part of the device registration page and make sure that **Over The Air Activation** is selected.
25+
The [LoRaWAN device repository](https://github.com/TheThingsNetwork/lorawan-devices) contains device profiles, LoRaWAN information, codecs, and more, for many LoRaWAN devices. Using the device repository to add devices in {{% tts %}} automatically uses the correct LoRaWAN version and regional parameters version, which means less information for you to find!
2626

27-
Fill the **JoinEUI** (AppEUI in LoRaWAN versions before 1.1), **DevEUI** and **AppKey**. The **NwkKey** is only needed for LoRaWAN version 1.1 or later. All other fields on the page are optional.
27+
To use the device repository, make sure the **From the LoRaWAN Device Repository** button is selected. Then, select the **Brand**, **Model**, **Hardware Version**, **Software Version**, and **Region** for your device.
2828

29-
Press **Create Device** to create the device.
29+
{{< note "If your device is not in the device repository, see [Manually Create End Device](#manually-create-end-device) below." />}}
3030

31-
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fdevice-%3Cspan+class%3D"x x-first x-last">creation-otaa.png" alt="Creating an OTAA device" >}}
31+
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fdevice-%3Cspan+class%3D"x x-first x-last">repo.png" alt="Creating a new device with the Device Repository" >}}
3232

33-
You will now reach the device overview page for your device. The end device should now be able to join the private network.
33+
Choose a **Frequency plan** appropriate for your region. Your device and gateway must use the same frequency plan to communicate.
3434

35-
{{< note >}} If you do not have a `JoinEUI` or `AppEUI`, it is okay to use `0000000000000000`. Be sure to use the same `JoinEUI` in your device as you enter in {{% tts %}}. {{</ note >}}
35+
Enter a **JoinEUI/AppEUI** if provided by your manufacturer. If your device is programmable, you may use all 0's, and then program the same JoinEUI/AppEUI in the device.
3636

37-
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fdevice-otaa-created.png" alt="OTAA device overview" >}}
37+
Enter your **DevEUI**.
3838

39-
### Activation By Personalization (ABP) Device
39+
If your manufacturer provides an **AppKey**, enter it. Otherwise, use the generate button to create one, and program it in to your device.
40+
41+
Finally, give your device a unique **End device ID**, and click the **Register end device** button to create the end device.
42+
43+
{{< note >}}
44+
See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
45+
{{</ note >}}
46+
47+
{{< figure src="device-repo-settings.png" alt="Device information" >}}
48+
49+
The device is now activated, and will appear as connected in {{% tts %}} once it sends an uplink.
50+
51+
### Manually Create End Device
52+
53+
If your device is not in the device repository, you may manually register it.
54+
55+
Make sure the **Manually** button is selected.
56+
57+
{{< figure src="register-manually.png" alt="Register manually" >}}
58+
59+
Choose the **Activation Mode**.
60+
61+
Select the device **LoRaWAN version**.
62+
63+
If using Over-the-Air-Activation (OTAA) and an External Join Server, tick the **External Join Server** button.
64+
65+
The **Network Server**, **Application Server**, and **Join Server** addresses should correctly point to the address of your {{% tts %}} deployment.
66+
67+
Click the **Start** button to proceed to the Basic Settings page.
68+
69+
{{< figure src="manual-settings.png" alt="Register manually" >}}
70+
71+
{{< note >}}
72+
This guide covers adding a device using [OTAA]({{< ref "reference/glossary#over-the-air-activation" >}}) (the most secure and preferred activation method) and [LoRaWAN version]({{< ref "reference/glossary#over-the-air-activation" >}}) MAC V1.0.2 (the most common LoRaWAN version, although newer version are better and more secure). Names and keys may vary slightly for other versions.
73+
{{</ note >}}
74+
75+
Give your device a unique **End device ID**.
76+
77+
{{< note >}}
78+
See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
79+
{{</ note >}}
80+
81+
Enter a **JoinEUI/AppEUI** if provided by your manufacturer. If your device is programmable, you may use all 0's, and then program the same JoinEUI/AppEUI in the device.
82+
83+
Enter your **DevEUI**.
84+
85+
**Name** and **Description** are optional fields to help you identify your device.
86+
87+
Click **Network Layer Settings** to proceed to the next page.
88+
89+
{{< figure src="basic-settings.png" alt="Basic settings" >}}
90+
91+
Choose a **Frequency plan** appropriate for your region. Your device and gateway must use the same frequency plan to communicate.
92+
93+
Choose the **Regional Parameters version** provided by the manufacturer of your device. This should be specified in the data sheet as Regional Parameters or PHY version.
94+
95+
If your device supports **Class B** or **Class C** features, you may enable them using the checkboxes.
96+
97+
There are also advanced settings to configure **Frame counter width** and **RX2 settings**, but these should not be necessary for most devices.
4098

41-
After filling the fields in the **General Settings** section, scroll to the lower part of the device registration page and make sure that **Activation By Personalization** is selected.
99+
Click the **Join settings** button to proceed to the next page.
42100

43-
Fill the **Device Address**, the **FNwkSIntKey** (NwkSKey in LoRaWAN versions before 1.1) and the **AppSKey**. The other key fields are only needed for LoRaWAN version 1.1 or later. All other fields on the page are optional.
101+
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fnetwork-settings.png" alt="Network settings" >}}
44102

45-
Press **Create Device** to create the device.
103+
If your manufacturer provides an **AppKey**, enter it. Otherwise, use the generate button to create one, and program it in to your device.
46104

47-
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fdevice-creation-abp.png" alt="Creating an ABP device" >}}
105+
There are also advanced settings to configure **Net ID**, **Application Server ID**, and **KEK Labels**, but these are not necessary for most devices.
48106

49-
You will now reach the device overview page for your device. The end device should now be able to communicate with the private network.
107+
Finally, click **Add end device** to register the end device.
50108

51-
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Cspan+class%3D"x x-first x-last">device-abp-created.png" alt="ABP device overview" >}}
109+
{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Cspan+class%3D"x x-first x-last">join-settings.png" alt="Join settings" >}}
52110

53111
## Set Device Location
54112

1.15 MB
Loading
1.08 MB
Loading
-459 KB
Binary file not shown.
-309 KB
Binary file not shown.
-294 KB
Binary file not shown.
-305 KB
Binary file not shown.
-448 KB
Binary file not shown.
1.11 MB
Loading
1.06 MB
Loading

0 commit comments

Comments
 (0)