Skip to main content

Devices import file

This topic describes the content of the CSV file you must create to massively add or deletes devices as explained in Import devices. Each line in the CSV file allows to either add an OTAA device, add an ABP device or delete a device.

OTAA device provisioning​

The following columns should be filled to add an OTAA device.

ColumnDefinition
A

Directive (mandatory)

  • CREATE_OTAA for OTAA device provisioning
B

DevEUI or Onboarding tag (mandatory)

  • DevEUI:
    • Globally unique device identifier
    • Is composed of 32 hexadecimal digits (0 to 9, and A to F), the first 6, 7 or 9 digits identify the device manufacturer.
    • Example: F0-3D-29-00-0B-B1-7A-AA
  • Onboarding tag:
    • The tag includes:
      • DevEUI: unique device identifier (8 bytes),
      • JoinEUI: unique identifier of the LoRaWAN®Join Server where the device has been pre-commissioned (8 bytes),
      • ProfileID: identifier of the device model to be associated with the device.
    • The tag may also include the owner token as an optional element.
    • If an Onboarding tag is provided in column B, elements from columns D, E and F become Optional. But, if elements from columns D, E and F are still provided, these elements will be processed over the Onboarding tag provided in the column B.
    • To learn more about Onboarding tags, see TR005 LoRaWAN® Device Identification QR Codes.
Cn/a
D

Identifier of device model

  • Device models IDs can be retrieved in a CSV file via the MODELS LIST button on the device import.
  • This column is optional if an Onboarding tag is provided in the B column, mandatory otherwise.
E

JoinEUI (AppEUI)

  • Global application ID that uniquely identifies the Join-Server that is able to assist in the processing of the Join procedure and the derivation of session keys.
  • Composed of 16 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.
  • This column is mandatory when an external Join Server is used, optional otherwise.
  • Example: 8899AABBCCDDEEFF
F

AppKey

  • Encrypts the device's communication with the network.
  • Composed of 32 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.
  • This column is mandatory when the local Join Server is used, forbidden otherwise.
  • Example: 1B3E11A6A8CE91C6A1F12581D9CC4A2C
Gn/a
H

Features / Connectivity plan ID (optional)

  • Features (if Connectivity Plans not displayed in the main menu):
    • A comma-separated list of features to enable for the device.
    • The supported features are NetworkGeolocation and PassiveRoaming.
    • If an invalid feature is set, the device is not provisioned; an error is returned.
  • Identifier of the connectivity plan associated with the device (if Connectivity Plans displayed in the main menu):
    • The selected connectivity plan determines the activation of network geolocation and passive roaming features.
    • If the column is empty, the device is created without connectivity plan (suspended device).
In/a
Jn/a
K

Device name (optional)

  • A name you want for the device that allows you to identify it on your IoT network
  • The device name is automatically set to the DevEUI when not provided at creation.
L

Device latitude (optional)

  • Administrative latitude of the device in decimal coordinates.
  • This column must not be filled if the network geolocation is enabled for this device (see column H).
M

Device longitude (optional)

  • Administrative longitude of the device in decimal coordinates.
  • This column must not be filled if the network geolocation is enabled for this device (see column H).
N

Additional information (optional)

  • Any useful information related to the device.
  • Examples: building A, indoor, basement, etc…
O

No uplink activity alarm configuration (optional)

  • No uplink activity alarm configuration XML document:
    • The root XML element is alarm004
    • The enclosed threshold1 self-closing XML element configures the first threshold of the alarm
    • The enclosed threshold2 self-closing XML element configures the second threshold of the alarm
    • For each threshold XML element the following attributes are available:
      • status: ENABLE or DISABLE this threshold
      • level: severity (2-6) of the alarm for this threshold
      • duration: inactivity period (ISO 8601 duration among PT1H, PT2H, PT5H, PT10H, P1D, P2D, P4D, P7D and P15D) after which the alarm is triggered for this threshold
    • The following constraints must be satisfied:
      • threshold2@status can be set to ENABLE only if threshold1@status is ENABLE
      • threshold1@level must be lower than threshold2@level
      • threshold1@duration must be lower than threshold2@duration

  • Example:

    <alarm004>
<threshold1 status="ENABLE" level="3" duration="P2D"/>
<threshold2 status="ENABLE" level="5" duration="P7D"/>
</alarm004>
Pn/a
Q

Motion indicator (optional)

  • Value is one of the following:
    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM
  • Default motion indicator from device model is used when not provided.
R

HSM Group ID (optional)

  • Identifier of the Hardware Security Module (HSM) where the device keys are stored
  • Optional if Local Join Server is used, Forbidden otherwise
Sn/a
T

Connection IDs (optional)

  • Identifiers of the connections that receive uplinks and, if supporting the feature, can send downlinks too.
  • To retrieve the Connection ID: go to Connections, click the connection, and copy the value of the ID box in INFORMATION.
  • If you want to associate the device with several connections, separate the IDs by a comma inside double quotes: "value1,value2".
U

NwkKey

  • Encrypts the device's communication with the network. Composed of 32 hexadecimal digits (0 to 9, and A to F).
  • Composed of 32 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer only when the LoRaWAN® version implemented by the device is 1.1.
  • This column is mandatory when the LoRaWAN® version implemented by the device is 1.1 and the local Join Server is used, forbidden otherwise.
  • Example: 1B3E11A6A8CE91C6A1F12581D9CC4A2C.
Vn/a
Wn/a
X

Exchange Key version used to encrypt device keys

  • Version of the RSA public key used to encrypt the device keys
  • Mandatory if Local Join Server is used with HSM, Optional if Local Join Server is used without HSM, Forbidden with External Join Server

Y

Owner Token

  • Owner token proving the ownership of a Device. This element is provided when devices are pre-commissioned on an external Join Server by the device manufacturer.
  • This column is optional when an external Join Server is used, forbidden otherwise.
Z

Protocol Identifier (optional)

  • Protocol Identifier of the system driver or custom driver.

ABP device provisioning​

The following columns should be filled to add an ABP device.

ColumnDefinition
A

Directive (mandatory)

  • CREATE_ABP for ABP device provisioning
B

DevEUI (mandatory)

  • Globally unique device identifier
  • Is composed of 32 hexadecimal digits (0 to 9, and A to F), the first 6, 7 or 9 digits identify the device manufacturer.
  • Example: F0-3D-29-00-0B-B1-7A-AA
C

DevAddr (mandatory)

  • An end-device address composed of 8 hexadecimal digits (0 to 9 and A to F).
  • It is used to identify the device within the network and is transmitted in each frame exchanged between the device and the LoRaWAN® network.
  • Example: 00ABC489
D

Identifier of device model (mandatory)

  • Device models IDs can be retrieved in a CSV file via the MODELS LIST button on the device import.
E

NwkSKey or FNwkSIntKey (mandatory)

  • Network session key providing integrity protection and encryption to the MAC commands in LoRaWAN® 1.0 or forwarding network session integrity key providing integrity protection to roaming devices in LoRaWAN® 1.1.
  • Composed of 32 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.
  • Example: 1B3E11A6A8CE91C6A1F12581D9CC4A2C
F

AppSKey (optional)

  • XML document containing the application session key used by the application and device to encrypt and decrypt the applicative payload:
    • The root XML element is AppSKeys
    • The enclosed AppSKey XML element contains the AppSKey value (see below for the supported encoding modes)
    • The AppSKey@Port attribute must be set to *
  • The AppSKey value is composed of 32 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.

  • Example:

    <AppSKeys>
<AppSKey Port="*">1B3E11A6A8CE91C6A1F12581D9CC4A2C</AppSKey>
</AppSKeys>
Gn/a
H

Features / Connectivity plan ID (optional)

  • Features (if Connectivity Plans not displayed in the main menu):
    • A comma-separated list of features to enable for the device.
    • The supported features are NetworkGeolocation and PassiveRoaming.
    • If an invalid feature is set, the device is not provisioned; an error is returned.
  • Identifier of the connectivity plan associated with the device (if Connectivity Plans displayed in the main menu):
    • The selected connectivity plan determines the activation of network geolocation and passive roaming features.
    • If the column is empty, the device is created without connectivity plan (suspended device).
In/a
Jn/a
K

Device name (optional)

  • A name you want for the device that allows you to identify it on your IoT network
  • The device name is automatically set to the DevEUI when not provided at creation.
L

Device latitude (optional)

  • Administrative latitude of the device in decimal coordinates.
  • This column must not be filled if the network geolocation is enabled for this device (see column H).
M

Device longitude (optional)

  • Administrative longitude of the device in decimal coordinates.
  • This column must not be filled if the network geolocation is enabled for this device (see column H).
N

Additional information (optional)

  • Any useful information related to the device.
  • Examples: building A, indoor, basement, etc…
O

No uplink activity alarm configuration (optional)

  • No uplink activity alarm configuration XML document:
    • The root XML element is alarm004
    • The enclosed threshold1 self-closing XML element configures the first threshold of the alarm
    • The enclosed threshold2 self-closing XML element configures the second threshold of the alarm
    • For each threshold XML element the following attributes are available:
      • status: ENABLE or DISABLE this threshold
      • level: severity (2-6) of the alarm for this threshold
      • duration: inactivity period (ISO 8601 duration among PT1H, PT2H, PT5H, PT10H, P1D, P2D, P4D, P7D and P15D) after which the alarm is triggered for this threshold
    • The following constraints must be satisfied:
      • threshold2@status can be set to ENABLE only if threshold1@status is ENABLE
      • threshold1@level must be lower than threshold2@level
      • threshold1@duration must be lower than threshold2@duration

  • Example:

    <alarm004>
<threshold1 status="ENABLE" level="3" duration="P2D"/>
<threshold2 status="ENABLE" level="5" duration="P7D"/>
</alarm004>
Pn/a
Q

Motion indicator (optional)

  • Value is one of the following:
    • NEAR_STATIC
    • WALKING_SPEED
    • BIKE_SPEED
    • VEHICLE_SPEED
    • RANDOM
  • Default motion indicator from device model is used when not provided.
Rn/a
Sn/a
T

Connection IDs (optional)

  • Identifiers of the connections that receive uplinks and, if supporting the feature, can send downlinks too.
  • To retrieve the Connection ID: go to Connections, click the connection, and copy the value of the ID box in INFORMATION.
  • If you want to associate the device with several connections, separate the IDs by a comma inside double quotes: "value1,value2".
U

SNwkSIntKey

  • Serving network session integrity key providing integrity protection. Only available when the LoRaWAN® version implemented by the device is 1.1.
  • Composed of 32 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.
  • This column is mandatory when the LoRaWAN® version implemented by the device is 1.1, forbidden otherwise.
  • Example: 1B3E11A6A8CE91C6A1F12581D9CC4A2C.
V

NwkSEncKey

  • Network session encryption key used for encryption of MAC commands between the device and the LoRaWAN® network. Only available when the LoRaWAN® version implemented by the device is 1.1.
  • Composed of 32 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.
  • This column is mandatory when the LoRaWAN® version implemented by the device is 1.1, forbidden otherwise.
  • Example: 1B3E11A6A8CE91C6A1F12581D9CC4A2C.
Wn/a
X

Public Key version used to encrypt device keys (optional)

  • Version of the RSA public key used to encrypt the device keys
Yn/a
Z

Protocol Identifier (optional)

  • Protocol Identifier of the system driver or custom driver.

Device deletion​

The following columns must be filled to delete a device (LoRaWAN ABP, LoRaWAN OTAA or cellular).

ColumnDefinition
A

Directive (mandatory)

  • DELETE to delete an LoRaWAN ABP, LoRaWAN OTAA or cellular device.
B

DevEUI (mandatory)

  • DevEUI of the device to delete.
Last updated on
Copyright © 2025 Actility
On this page