Adding Devices

Adding Devices using the Console

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.

Using the LoRaWAN Device Repository

The LoRaWAN device repository contains device profiles, LoRaWAN information, codecs, and more, for many LoRaWAN devices. Using the device repository to add devices in The Things Stack automatically uses the correct LoRaWAN version and regional parameters version, which means less information for you to find!

In addition to the written instructions below, a video with instructions for adding a device using the device repository is available on The Things Network youtube channel.

To use the device repository, make sure the From the LoRaWAN Device Repository tab is selected. Then, select the Brand, Model, Hardware Version, Software Version, and Region for your device.

Choose a Frequency plan appropriate for your region. Your device and gateway must use the same frequency plan to communicate.

Enter a JoinEUI/AppEUI if provided by your manufacturer. If your device is programmable, you may use the Fill with zeros button, and then program the same JoinEUI/AppEUI (0000000000000000) in the device.

Enter your DevEUI. This should be provided by your manufacturer for commercial devices. If your device is programmable, you may generate an EUI using the Generate button, and program it in your device.

For LoRaWAN version 1.0.x devices, you will see an AppKey field. If your manufacturer provides an AppKey, enter it. Otherwise, use the Generate button to create one, and program it in to your device.

For LoRaWAN version 1.1.x devices, you will also see a NwkKey field. If it is provided by your manufacturer, enter it. Otherwise, use the Generate button to create one, and program it in to your device.

Finally, give your device a unique End device ID, and click the Register end device button to create the end device.

The device is now activated, and will appear as connected in The Things Stack once it sends an uplink.

Manually Registering an End Device

If your device is not in the device repository, you may manually register it.

Make sure the Manually tab is selected.

Select the device LoRaWAN version. This should be provided with your device as the LoRaWAN version, LoRaWAN specification, or MAC version.

Choose a Frequency plan appropriate for your region. Your device and gateway must use the same frequency plan to communicate.

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.

If you need to use a method of activation other than OTAA, create a multicast group, specify a Class B or Class C device, or change Rx Delay and Frequency plan settings, see the Advanced settings section below. Otherwise, proceed to OTAA devices.

Advanced Settings

To modify advanced settings, expand the Show advanced activation, LoRaWAN class and cluster settings dropdown.

Here, you may choose your Activation Mode.

If your device supports Class B or Class C features, you may enable them using the dropdown.

To modify Rx2 data rate or Rx2 frequency, uncheck Use network’s Rx and frequency defaults. If using ABP, this will also allow you to configure Rx1 settings.

To use an external join server or an external network server, check Use external LoRaWAN backend servers.

The Network Server and Join Server addresses should correctly point to the address of The Things Stack deployment you are using.

If using an External Join Server, enter its address in the Join Server field.

OTAA Devices

Over-the-Air-Activation (OTAA) is the secure, scalable way to activate LoRaWAN devices. All commercially available LoRaWAN devices support OTAA, and it is selected by default. If you are using a custom or DIY device, and cannot use OTAA, see the Activation by Personalisation section.

Enter your DevEUI. This should be provided by your manufacturer for commercial devices. If your device is programmable, you may generate an EUI using the Generate button, and program it in your device.

Enter a JoinEUI/AppEUI if provided by your manufacturer. If your device is programmable, you may use the Fill with zeros button, and then program the same JoinEUI/AppEUI (0000000000000000) in the device.

If your manufacturer provides an AppKey, enter it. Otherwise, use the Generate button to create one, and program it in to your device.

Give your device a unique End device ID.

Click Register end device to create the end device.

ABP Devices

If your device can not be activated using the more secure OTAA, you may manually activate it by programming security keys in.

In the Advanced settings dropdown, select Activation by Personalization (ABP).

When using ABP, it is important to make sure that the Rx1 settings in your device match those in The Things Stack. Uncheck Use network’s Rx and frequency defaults to specify settings that match those in your device. The Things Stack recommends an Rx1 delay of 5 seconds.

Enter your DevEUI. This should be provided by your manufacturer for commercial devices. If your device is programmable, you may generate an EUI using the Generate button, and program it in your device.

Use the Generate button to create a Device address, and program it in your device.

For LoRaWAN versions 1.0.x, generate an AppSKey and NwkSKey and program them in your device.

For LoRaWAN versions 1.1.x, generate an AppSKey, FNwkSIntKey, SNwkSIntKey, and NwkSEncKey, and program them in your device.

Finally, give your device a unique End device ID.

Click Register end device to create the end device.

Adding Devices in Bulk

It is also possible to import end devices in bulk, using a file format defined in the JSON file reference. See the following video from The Things Network youtube channel for instructions.

Set Device Location in the Console

Once you have added your end device to The Things Stack, you can also set its location to be displayed on a map widget by clicking Change location settings.

The end device location can be manually set by pinning on the map widget, or entering the Latitude, Longitude and Altitude values.

Adding Devices using the CLI

First, list the available frequency plans and LoRaWAN versions:

$ ttn-lw-cli end-devices list-frequency-plans
$ ttn-lw-cli end-devices create --help

Over-The-Air-Activation (OTAA) Device

LoRaWAN 1.0.x:

To create an end device using over-the-air-activation (OTAA):

$ ttn-lw-cli end-devices create app1 dev1 \
  --dev-eui 0004A30B001C0530 \
  --app-eui 800000000000000C \
  --frequency-plan-id EU_863_870 \
  --root-keys.app-key.key 752BAEC23EAE7964AF27C325F4C23C9A \
  --lorawan-version 1.0.3 \
  --lorawan-phy-version 1.0.3-a

This will create a LoRaWAN 1.0.3 end device dev1 in application app1 with the EU_863_870 frequency plan.

The end device should now be able to join the private network.

LoRaWAN 1.1.x:

To create an end device using over-the-air-activation (OTAA):

$ ttn-lw-cli end-devices create app1 dev1 \
  --dev-eui 0004A30B001C0530 \
  --app-eui 800000000000000C \
  --frequency-plan-id EU_863_870 \
  --root-keys.app-key.key 752BAEC23EAE7964AF27C325F4C23C9A \
  --root-keys.nwk-key.key 01020304050607080102030405060708 \
  --lorawan-version 1.1.0 \
  --lorawan-phy-version 1.1.0-b

This will create a LoRaWAN 1.1.0 end device dev1 in application app1 with the EU_863_870 frequency plan.

The end device should now be able to join the private network.

Activation By Personalization (ABP) Device

LoRaWAN 1.0.x:

It is also possible to register an ABP activated device using the --abp flag as follows:

$ ttn-lw-cli end-devices create app1 dev2 \
  --frequency-plan-id EU_863_870 \
  --lorawan-version 1.0.3 \
  --lorawan-phy-version 1.0.3-a \
  --abp \
  --session.dev-addr 00E4304D \
  --session.keys.app-s-key.key A0CAD5A30036DBE03096EB67CA975BAA \
  --session.keys.nwk-s-key.key B7F3E161BC9D4388E6C788A0C547F255

LoRaWAN 1.1.x:

To register a LoRaWAN 1.1.x end device using ABP:

$ ttn-lw-cli end-devices create app1 dev2 \
  --frequency-plan-id EU_863_870 \
  --lorawan-version 1.1.0 \
  --lorawan-phy-version 1.1.0-b \
  --abp \
  --session.dev-addr 00E4304D \
  --session.keys.app-s-key.key A0CAD5A30036DBE03096EB67CA975BAA \
  --session.keys.nwk-s-key.key B7F3E161BC9D4388E6C788A0C547F255
  --session.keys.f-nwk-s-int-key.key 01020304050607080102030405060708 \
  --session.keys.s-nwk-s-int-key.key 01020304050607080102030405060708 \
  --session.keys.nwk-s-enc-key.key 01020304050607080102030405060708

Set Device Location with the CLI

Once you have added your end device to The Things Stack, you can also set its location.

Set your end device’s location with:

$ APP_ID="your-application-id" 
$ DEVICE_ID="your-device-id"
$ ttn-lw-cli end-devices set $APP_ID $DEVICE_ID \
  --location.latitude 43.84 \
  --location.longitude 18.32 \
  --location.altitude 500 \

You can also set the end device location to be updated from various sources with the --location.source flag. The source of the location data can be the registry, GPS data, results of the LoRa RSSI geolocation, etc.

The CLI will return something like:

{
  "ids": {
    "device_id": "dev1",
    "application_ids": {
      "application_id": "app1"
    },
    "dev_eui": "0004A30B001C0530",
    "join_eui": "800000000000000C"
  },
  "created_at": "2020-05-27T15:50:38.567Z",
  "updated_at": "2020-12-25T11:16:20.592Z",
  "locations": {
    "user": {
      "latitude": 43.84,
      "longitude": 18.32,
      "altitude": 500,
      "source": "SOURCE_REGISTRY"
    }
  }
}