Skip to content

doc: Update JSON device file reference #1480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vlasebian merged 1 commit into from
Apr 14, 2026
Merged

doc: Update JSON device file reference #1480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/content/hardware/devices/adding-devices/adding-devices-in-bulk/device-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The full specification of the JSON format is defined in the API protos. See the

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.

<div class="fixed-table table-device-json">
<div class="table-device-json">

| Field | Required | Type | Example | Description |
| ---------------------------------------- | ------------------------ | ------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -73,7 +73,7 @@ The linked specification is quite extensive, and contains a lot of fields that a
| **`lorawan_version`** | **Always** | string | `"MAC_V1_0_2"` | See [MACVersion]({{< ref "/api/reference/grpc/end_device#enum:MACVersion" >}}) for supported versions. See [LoRaWAN Version]({{< ref "/getting-started/glossary#lorawan-version" >}}) for more information. |
| **`lorawan_phy_version`** | **Always** | string | `"PHY_V1_0_2_REV_B"` | See [PHYVersion]({{< ref "/api/reference/grpc/end_device#enum:PHYVersion" >}}) for supported versions. See [LoRaWAN Version]({{< ref "/getting-started/glossary#regional-parameters" >}}) for more information. |
| **`frequency_plan_id`** | **Always** | string | `"EU_863_870_TTN"` | See [Frequency Plans]({{< ref "/concepts/features/lorawan/frequency-plans" >}}) for a list of supported frequency plans (The frequency plan `ID` is needed). See [Frequency Plan]({{< ref "/getting-started/glossary#frequency-plan" >}}) for more information. |
| **`supports_join`** | **Always** | boolean | `true` | `true` for OTAA devices, `false` for ABP. |
| **`supports_join`** | No | boolean | `true` | `true` for OTAA devices, `false` for ABP. Defaults to `false` (ABP) if not set. |
| **`supports_class_c`** | No | boolean | `true` | `true` for Class C devices, `false` otherwise. |
| **`root_keys.app_key.key`** | **For OTAA devices** | string | `"01020304050607080102030405060708"` | See [Application Key]({{< ref "/getting-started/glossary#application-key" >}}) for more information. |
| **`root_keys.nwk_key.key`** | **For OTAA devices** | string | `"01020304050607080102030405060708"` | For LoRaWAN version 1.1 and later only. See [Network Key]({{< ref "/getting-started/glossary#network-key" >}}) for more information. |
Expand All @@ -82,6 +82,7 @@ The linked specification is quite extensive, and contains a lot of fields that a
| **`session.dev_addr`** | **For existing session** | string | `"01020304"` | **Needed for ABP devices or when migrating OTAA devices with an existing session**. See [Device Address]({{< ref "/getting-started/glossary#device-address" >}}) for more information. |
| **`session.keys.app_s_key.key`** | **For existing session** | string | `"01020304050607080102030405060708"` | **Needed for ABP devices or when migrating OTAA devices with an existing session**. See [Application Session Key]({{< ref "/getting-started/glossary#application-session-key" >}}) for more information. |
| **`session.keys.f_nwk_s_int_key.key`** | **For existing session** | string | `"01020304050607080102030405060708"` | Forwarding Network Session Integrity Key, also referred to as **Network Session Key** in LoRaWAN v1.0.x compatibility mode. See [SessionKeys]({{< ref "/api/reference/grpc/end_device#message:SessionKeys" >}}) and [Forwarding Network Session Integrity Key]({{< ref "/getting-started/glossary#forwarding-network-session-integrity-key" >}}) for more information. |
| **`session.keys.session_key_id`** | **For existing session** | string | `"AXA50tHhzVMGEE…"` | A unique identifier for the session keys. If not provided, generate a random 16-byte value and encode it using base64. Required when importing devices via the Console. |
| **`session.last_f_cnt_up`** | **For existing session** | uint | `12` | Last uplink frame counter used. |
| **`session.last_n_f_cnt_down`** | **For existing session** | uint | `12` | Last network downlink frame counter used. |
| **`session.last_a_f_cnt_down`** | **For existing session** | uint | `12` | Last application downlink frame counter used. |
Expand Down
Loading