Skip to main content

Sample import files

This topic lists the following information:

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.

EAppEUI

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

Optional
  • A comma separated list of features to enable for the device.

  • The supported feature is the Network Geolocation

  • If an invalid feature is set, the device is not provisioned; an error is returned.

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.

OTAA sample import file

A sample import file of an Over The-Air-Activation is given as follows:

# DEVICE IMPORTATION (CSV)
#
# SYNTAX for Over-the-Air Activation (OTAA) with local Join Server
#Directive (CREATE_OTAA),DevEUI,n/a,Device model ID,JoinEUI (AppEUI),AppKey,n/a,Features,n/a,n/a,Device name,Latitude,Longitude,Additional information,n/a,n/a,Motion indicator,n/a,n/a,Application IDs,NwkKey,n/a,n/a,n/a,n/a,Protocol identifier
#MANDATORY,MANDATORY,,MANDATORY,OPTIONAL,MANDATORY,,OPTIONAL,,,MANDATORY,
OPTIONAL,OPTIONAL,OPTIONAL,,,OPTIONAL,,,MANDATORY,OPTIONAL,,,,,OPTIONAL
CREATE_OTAA,F03D291000F00001,,LORA/GenericA.1.0.2b_ETSI_Rx2-SF12,8899AABBCCDDEEFF,8899AABBCCDDEEFF8899AABBCCDDEEFF,,,,,My first OTAA device,50.859988,4.35826,"Mme Michu, Appt 434 3ième gauche, 8 rue de fleurs, Toulouse",,,,,,TWA_1100000114.658.AS,,,,,,
CREATE_OTAA,F03D291000F00002,,LORA/GenericA.1.1a_ETSI_Rx2-SF12,,1234AABBCCDDEEFF8899AABBCCDDEEFF,,NetworkGeolocation,,,Another OTAA device,,,"John Doe 123 Main St Anytown, USA",,,BIKE_SPEED,,,"TWA_1100000114.658.AS,TWA_1100000114.751.AS",5678AABBCCDDEEFF8899AABBCCDDEEFF,,,,,custom:driver:1
#
# SYNTAX for Over-the-Air Activation (OTAA) with external Join Server
#Directive (CREATE_OTAA),DevEUI|onboarding tag,n/a,Device model ID,JoinEUI (AppEUI),n/a,n/a,Features,n/a,n/a,Device name,Latitude,Longitude,Additional information,n/a,n/a,Motion indicator,n/a,n/a,Application IDs,n/a,n/a,n/a,n/a,Owner Token,Protocol identifier
#MANDATORY,MANDATORY,,MANDATORY,MANDATORY,,,OPTIONAL,,,MANDATORY,OPTIONAL,
OPTIONAL,OPTIONAL,,,OPTIONAL,,,MANDATORY,,,,,OPTIONAL,OPTIONAL
CREATE_OTAA,F03D291000F00021,,LORA/GenericA.1.0.2b_ETSI_Rx2-SF12,8899AABBCCDDEEFF,,,,,,My first OTAA device,50.859988,4.35826,"Mme Michu, Appt 434 3ième gauche, 8 rue de fleurs, Toulouse",,,,,,TWA_1100000114.658.AS,,,,,BEC499C69E9C939E413B663961636C61,
CREATE_OTAA,F03D291000F00022,,LORA/GenericA.1.1a_ETSI_Rx2-SF12,1234AABBCCDDEEFF,,,NetworkGeolocation,,,Another OTAA device,,,"John Doe 123 Main St Anytown, USA",,,BIKE_SPEED,,,"TWA_1100000114.658.AS,TWA_1100000114.751.AS",,,,,,custom:driver:1

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  
HFeaturesOptional
  • A comma separated list of features to enable for the device.

  • The supported feature is the Network Geolocation

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.

ABP sample import file

A sample import file of an Activation By Personalization is given as follows:

# SYNTAX for Activation-by-Personalization (ABP)
#Directive (CREATE_ABP),DevEUI,DevAddr,Device model ID,NwkSKey/FNwkSIntKey,AppSKeys,n/a,Features,n/a,n/a,Device name,Latitude,Longitude,Additional information,n/a,n/a,Motion indicator,n/a,n/a,Application IDs,SNwkSIntKey,NwkSEncKey,n/a,n/a,n/a,Protocol identifier
#MANDATORY,MANDATORY,MANDATORY,MANDATORY,MANDATORY,MANDATORY,,OPTIONAL,,,
MANDATORY,OPTIONAL,OPTIONAL,OPTIONAL,,,OPTIONAL,,,MANDATORY,OPTIONAL,
OPTIONAL,,,,OPTIONAL
CREATE_ABP,F03D291000F00011,00ABC489,LORA/GenericA.1.0.2b_ETSI_Rx2-SF12,0011AABBCCDDEEFF8899AABBCCDDEEFF,"<AppSKeys><AppSKey Port=\*"">1122AABBCCDDEEFF8899AABBCCDDEEFF</AppSKey></AppSKeys>""",,
PassiveRoaming,,,My first ABP device,50.859988,4.35826,"Mme Michu, Appt 434 3ième gauche, 8 rue de fleurs, Toulouse",,,,,,TWA_1100000114.658.AS,,,,,,
CREATE_ABP,F03D291000F00012,00ABC490,LORA/GenericA.1.1a_ETSI_Rx2-SF12,2233AABBCCDDEEFF8899AABBCCDDEEFF,"<AppSKeys><AppSKey Port=\*"">3344AABBCCDDEEFF8899AABBCCDDEEFF</AppSKey></AppSKeys>""",,"
NetworkGeolocation,PassiveRoaming",,,Another ABP device,,,"John Doe 123 Main St Anytown, USA",,,BIKE_SPEED,,,"TWA_1100000114.658.AS,TWA_1100000114.751.AS",4455AABBCCDDEEFF8899AABBCCDDEEFF,
5566AABBCCDDEEFF8899AABBCCDDEEFF,,,,custom:driver:1