Skip to main content

Import files

This topic describes the contents of the formatted CSV file you must create to import OTAA or ABP devices as explained in Import devices.

OTAA device import .CSV file​

A definition is given for each column of the table available in the .CSV file.

ColumnDefinitionCardinalityDescription
ADirectiveMandatory

  • Device import directive: 'CREATE_OTAA' for OTAA device import.

BDevEUI or Onboarding tagMandatory

  • 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.

    • Mandatory if an onboarding tag is not provided.

  • Onboarding tag consists of:

    • 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. To learn more, see Simplified provisioning of OTAA devices using a QR code .

    • 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.

Cn/a  
DDevice model ID

Mandatory

(Optional)

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

  • Optional if an Onboarding tag is provided in the B column, Mandatory otherwise.

EJoinEUI (AppEUI)

Mandatory

(Optional)

  • Global application ID that identifies uniquely the application provider of the device.

  • Composed of 16 hexadecimal digits (0 to 9, and A to F), it is provided by the device manufacturer.

  • Mandatory when an external Join Server is used, Optional if an Onboarding tag is provided in the B column.

FAppKeyMandatory

  • 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.

  • Mandatory when an external Join Server is not used, Optional if an onboarding tag is provided in the B column.

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.

Connectivity plan ID (if Connectivity Plans displayed in the main menu).

  • If the column is empty, the device is created without connectivity plan (suspended device).

In/a  
Jn/a  
KDevice nameMandatory

  • A name you want for the device that allows you to identify it on your IoT network

  • Example: Basement humidity device, kitchen smoke detector, etc…

LAdmin LATOptional

  • Device location

  • Ignored when the Network Geolocation feature is enabled (see column H).

  • If the Network Geolocation is set, but not available on the TPE Instance, an error is returned.

MAdmin LON
N

Additional information

Optional

  • Any useful information related to the device.

  • Examples: building A, indoor, basement, etc…

On/a  
Pn/a  
Q

Motion indicator

Optional

  • Indicator of the device profile.

  • Default motion indicator from device model is user when not provided.

  • Values are one of the following:

    • NEAR_STATIC

    • WALKING_SPEED

    • BIKE_SPEED

    • VEHICLE_SPEED

    • RANDOM

Rn/a  
Sn/a  
TConnection IDsMandatory

  • Identifier of the connection that receives uplinks and, if supporting the feature, can send downlinks too.

  • Available in ThingPark Enterprise: go to Connections, click the connection, and copy the value of the Connection ID box.

  • If you want to associate the device with several connections, separate the IDs by a comma inside double quotes: "value1,value2".

UNwkKeyOptional

  • 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 only when the LoRaWAN® version implemented by the device is 1.1.

Vn/a  
Wn/a  
Xn/a  

Y

Owner Token

Optional

  • 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.

  • Optional when an external Join Server is used, Forbidden otherwise.

ZProtocol IdentifierOptional

  • Protocol Identifier of the system driver or custom driver.

Columns C, G to J, O to S and V to X are ignored. They are placeholders used only in ThingPark Advanced Edition.

ABP device import .CSV file​

A definition is given for each column of the table in the .CSV file.

ColumnDefinitionCardinalityDescription
ADirectiveMandatory

  • Device import directive: 'CREATE_ABP' for ABP device import.

BDevEUIMandatory

  • 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.

CDevAddrMandatory

  • 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: 00-ABC4-89.

DDevice model IDMandatory

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

ENwkSKey or FNwkSIntKeyMandatory

  • 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.

  • Is composed of 32 hexadecimal digits (0 to 9, and A to F).

  • Example: 1B-3E-11-A6-A8-CE-91-C6-A1-F1-25-81-D9-CC-4A-2C

FAppSKeysMandatory

  • XML document containing application session key(s) specific to the ABP device.

  • Is composed of 32 hexadecimal digits (0 to 9 and A to F).

  • Used by the application and device to encrypt and decrypt the applicative payload.

  • Example: 2B-7E-15-16-28-AE-D2-A6-AB-F7-15-88-09-CF-4F-3C.

  • You can use a unique AppSKey for all LoRaWAN® ports used by your device ("*" means all ports) and allocate one (e.g. "1") or several ports (e.g. "1,2,3", "10-20").

  • Example:

<AppSKeys>
<AppSKey Port="1-2">00112233445566778899AABBCCDDEEFF</AppSKey>
<AppSKey Port="3">11112233445566778899AABBCCDDEEFF</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.

Connectivity plan ID (if Connectivity Plans displayed in the main menu).

  • If the column is empty, the device is created without connectivity plan (suspended device).

In/a  
Jn/a  
KDevice nameMandatory

  • A name you want for the device that allows you to identify it on your IoT network.

  • Example: Basement humidity device, kitchen smoke detector, etc...

LAdmin LATOptional

  • Device location

  • Ignored when the NetworkGeolocation feature is enabled (see column H).

MAdmin LON
NAdditional informationOptional

  • Any useful information related to the device.

  • Examples: building A, indoor, basement, etc...

On/a  
Pn/a  
Q

Motion indicator

Optional

  • Indicator of the device profile.

  • Default motion indicator from device model is user when not provided.

  • Values are one of the following:

    • NEAR_STATIC

    • WALKING_SPEED

    • BIKE_SPEED

    • VEHICLE_SPEED

    • RANDOM

Rn/a  
Sn/a  
TConnection IDsMandatory

  • Identifier of the connection that receives uplinks and, if supporting the feature, can send downlinks too.

  • Available in ThingPark Enterprise: go to Connections, click the connection, and copy the value of the Connection ID box.

  • If you want to associate the device with several connections, separate the IDs by a comma inside double quotes: "value1,value2".

USNwkSIntKeyOptional

  • Serving network session integrity key. Only available when the LoRaWAN® version implemented by the device is 1.1.

  • Is composed of 32 hexadecimal digits (0 to 9, and A to F) and provides integrity protection.

  • Example: 1B-3E-11-A6-A8-CE-91-C6-A1-F1-25-81-D9-CC-4A-2C.

VNwkSEncKeyOptional

  • Network session encryption key. Only available when the LoRaWAN® version implemented by the device is 1.1. Is composed of 32 hexadecimal digits (0 to 9, and A to F) and used for encryption of MAC commands between the device and the LoRaWAN® network.

  • Example: 1B-3E-11-A6-A8-CE-91-C6-A1-F1-25-81-D9-CC-4A-2C.

Wn/a  
Xn/a  
Yn/a  
ZProtocol IdentifierOptional

  • Protocol Identifier of the system driver or custom driver.

Columns C, G to J, O to S and V to X are ignored. They are placeholders used only in ThingPark Advanced Edition.

Last updated on
Copyright © 2024 Actility
On this page