JSON File Reference

The Things Stack has support for importing end devices from JSON files.

This method is useful when batches of end devices are managed as JSON files or to add end devices in bulk from V2, ChirpStack and other LoRaWAN® networks using a JSON file describing those devices.

Using JSON file with device descriptions, you can migrate end devices with or without their existing sessions.

Here is an example of an OTAA device description in the devices.json file:

{
  "ids": {
    "device_id": "my-device",
    "dev_eui": "0102030405060708",
    "join_eui": "0102030405060708"
  },
  "name": "My Device",
  "description": "Living room temperature sensor",
  "lorawan_version": "MAC_V1_0_2",
  "lorawan_phy_version": "PHY_V1_0_2_REV_B",
  "frequency_plan_id": "EU_863_870_TTN",
  "supports_join": true,
  "root_keys": {
    "app_key": {
      "key": "01020304050607080102030405060708"
    }
  }
}

Multiple end devices can also be contained in a single devices.json file like so:

{
  /* device 1 */
}
{
  /* device 2 */
}

The format above is considered by the Console and CLI as a JSON stream, processing one object at a time. For more details in how to use the file, please refer to Adding End Devices in Bulk.

JSON End Device Format

The full specification of the JSON format is defined in the API protos. See the EndDevice message definition for details.

The linked specification is quite extensive, and contains a lot of fields that are not required, or are only set and used internally by the Network Server. Below, the required and most commonly used fields are discussed.

Note that the dots in the Field column imply an embedded object. For example, root_keys.nwk_key.key must be set as:

"root_keys": {
  "nwk_key:": {
  "key": "<NWK_KEY_HERE>"
  }
}