You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/content/devices/adding-devices/_index.md
+76-18Lines changed: 76 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,41 +14,99 @@ This section contains instructions for adding devices in {{% tts %}}.
14
14
15
15
## Adding Devices using the Console
16
16
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.
18
18
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.
20
20
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" >}}
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!
26
26
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.
28
28
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." />}}
30
30
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" >}}
32
32
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.
34
34
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.
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.
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.
40
98
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.
42
100
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.
0 commit comments