Skip to main content

About import file

This topic describes the content of the CSV file you must create to massively add, update or delete devices as explained in Executing bulk operations. Each line in the CSV file allows to either:

  • Add or update a LoRaWAN® OTAA device
  • Add or update a LoRaWAN® ABP device
  • Add or update a cellular device
  • Delete a device

To learn more about the parameters to fill in the CSV file, see Device attributes.

Generic syntax rules
  1. Field separator

    • The comma (,) is used as the column separator.
    • Each line represents one operation.
    • Each column within an operation must be separated by a comma.
  2. Values containing commas

    • If a column value contains a comma (such as list of tags or domains), the entire value must be enclosed in double quotes (").
    • This prevents the comma inside the value from being interpreted as a field separator.
  3. Double quotes inside values

    • If a value contains double quotes:
      • The column must be enclosed in double quotes.
      • Internal double quotes must be escaped by doubling them ("").

Adding or updating a LoRaWAN® OTAA device

The following columns must be filled to add or update a LoRaWAN® OTAA device.

ColumnDefinitionAddUpdate
A

Type of operation

  • CREATE_OTAA to add a LoRaWAN® OTAA device
  • UPDATE_OTAA to update a LoRaWAN® OTAA device
MandatoryMandatory
B

LoRaWAN® DevEUI or onboarding tag

If an onboarding tag is provided in column B when adding a device, 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.

MandatoryMandatory: only DevEUI is supported
C

LoRaWAN® DevAddr

Only applicable to a LoRaWAN 1.0 device migrated from another network server.

Optionaln/a
D

Device model ID

Available device model IDs can be retrieved in a CSV file via the MODEL LIST button.

Optional if an onboarding tag is provided in column B, mandatory otherwise.Optional
ELoRaWAN JoinEUI/AppEUIOptional if an onboarding tag is provided in column B or if the local Join Server is used, mandatory otherwise.Optional
F

LoRaWAN AppKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)

When adding a device: if AppKey is provided, the OTAA device uses the local Join Server; otherwise an external Join Server (identified by its JoinEUI) is used.

OptionalOptional if the local Join Server is used, forbidden otherwise.
Gn/an/an/a
H

Features / Connectivity plan ID

Features (if Connectivity Plans not displayed in the main menu):

  • Provide a comma-separated list of features.
  • Available features are Default, NetworkGeolocation and PassiveRoaming.

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

  • Provide the ID of the selected connectivity plan.
  • If empty (when adding a device) or _unset (when updating a device), the device is not associated with a connectivity plan and is automatically suspended: all its packets are ignored by the network server.
OptionalOptional
In/an/an/a
Jn/an/an/a
KDevice nameOptional: The device name is automatically set to the DevEUI when not provided.Optional
L

Device latitude (decimal degrees)

If provided the manual location mode is automatically activated. If empty (when adding a device) or _unset (when updating a device), the network location mode is activated if enabled by the column H.

OptionalOptional
M

Device longitude (decimal degrees)

If provided the manual location mode is automatically activated. If empty (when adding a device) or _unset (when updating a device), the network location mode is activated if enabled by the column H.

OptionalOptional
NAdditional informationOptionalOptional
O

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

Default value when adding a device:

<alarm004> <threshold1 status="ENABLE" level="3" duration="P7D"/> <threshold2 status="ENABLE" level="5" duration="P15D"/> </alarm004>

OptionalOptional
Pn/an/an/a
Q

Motion indicator

Value is one of the following:

  • NEAR_STATIC
  • WALKING_SPEED
  • BIKE_SPEED
  • VEHICLE_SPEED
  • RANDOM
Optional: the motion indicator of the device profile will be used when no motion indicator is specified.Optional
RHSM group IDOptional if Local Join Server is used, forbidden otherwise.Optional if Local Join Server is used, forbidden otherwise.
Sn/an/an/a
T

Connection IDs

Multiple connection IDs may be provided, separated by a comma.

OptionalOptional
U

LoRaWAN NwkKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
Mandatory for LoRaWAN 1.1 device if the local Join Server is used, forbidden otherwise.Optional for LoRaWAN 1.1 device if the local Join Server is used, forbidden otherwise.
Vn/an/an/a
WAS transport key IDOptional if the local Join Server is used with HSM, forbidden otherwise.Optional if the local Join Server is used with HSM, forbidden otherwise.
X

Public key version used to encrypt the keys

Version of the RSA public key used to encrypt the device keys.

Mandatory if the local Join Server is used with HSM, Optional if the local Join Server is used without HSM, Forbidden with an external Join Server.Mandatory if the local Join Server is used with HSM, Optional if the local Join Server is used without HSM, Forbidden with an external Join Server.
YOwner TokenOptional if an external Join Server is used, forbidden otherwise.n/a
ZProtocol identifier (system driver or custom driver)Optional: the default protocol identifier defined in the device model will be used when no protocol identifier is specified.Optional
AALoRaWAN® device session context (internal usage only)OptionalOptional
ABComma-separated list of tag namesOptionalOptional
AC

Comma-separated list of associated domains

The domain group name and the domain name must be provided as follow: domain.group.name:domain.name.

OptionalOptional
AD32 bits integer representation of the last downlink frame counter (FCntDn) received by the deviceOptional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AE32 bits integer representation of the last uplink frame counter (FCntUp) sent by the deviceOptional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AFRX1 data rate offset (0..7)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AGRX2 frequency in MHz (433..928 up to 6 decimal places)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AHRX2 data rate (0..15)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AIRX1 delay in seconds (1..15)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AJDownlink dwell time: 0 (no limit) or 1 (400 ms)Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and that need to be resynchronized with the network server, forbidden otherwise.
AKUplink dwell time: 0 (no limit) or 1 (400 ms)Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and that need to be resynchronized with the network server, forbidden otherwise.
AL24 bits hexadecimal representation of the last JoinNonce used by the join serverMandatory for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Mandatory for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AM16 bits hexadecimal representation of the last DevNonce used by the deviceOptional for a LoRaWAN 1.0 device using Local Join Server and migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device using Local Join Server and that need to be resynchronized with the network server, forbidden otherwise.
AN

LoRaWAN NwkSKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AO

LoRaWAN AppSKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
Notes
  • When the added OTAA device is migrated from another network server (limited to LoRaWAN 1.0.x devices):

    • You may import the LoRaWAN session context of the migrated device, to inform the network about the DevAddr, session keys, frame counters and downlink RX1/RX2 configuration parameters currently used by the device.
      This process allows a seamless device migration without forcing the device to revert to the JOIN state.

    • If the LoRaWAN session context of the migrated device is not imported, the device must redo the JOIN procedure to get a new LoRaWAN session in ThingPark. Nevertheless, you must fill the column AL to inform the network about the last JoinNonce/AppNonce used by this device. In case you do not know it, enter a reasonably high value that you think the device has not yet reached.

  • When updating an OTAA device:

    • If an optional column is empty, the currently-used value is kept.
    • The _unset keyword can be used to unset the following columns: G, H, K, L, M, N, O, T, Z, AB and AC.
    • In case the LoRaWAN state has been desynchronized between your device and the network server, you may use columns AD to AO to instruct the network about the current keys/parameters used by your device.

Adding or updating a LoRaWAN® ABP device

The following columns must be filled to add or update a LoRaWAN® ABP device.

ColumnDefinitionAddUpdate
A

Type of operation

  • CREATE_ABP to add a LoRaWAN® ABP device
  • UPDATE_ABP to update a LoRaWAN® ABP device
MandatoryMandatory
BLoRaWAN® DevEUIMandatoryMandatory
CLoRaWAN® DevAddrMandatoryn/a
D

Device model ID

Device model IDs can be retrieved in a CSV file via the MODEL LIST button.

MandatoryOptional
E

LoRaWAN® FNwkSIntKey/NwkSKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
MandatoryOptional
F

LoRaWAN® AppSKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
OptionalOptional
Gn/an/an/a
H

Features / Connectivity plan ID

Features (if Connectivity Plans not displayed in the main menu):

  • Provide a comma-separated list of features.
  • Available features are Default, NetworkGeolocation and PassiveRoaming.

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

  • Provide the ID of the selected connectivity plan.
  • If empty (when adding a device) or _unset (when updating a device), the device is not associated with a connectivity plan and is automatically suspended: all its packets are ignored by the network server.
OptionalOptional
In/an/an/a
Jn/an/an/a
KDevice nameOptional: The device name is automatically set to the DevEUI when not provided.Optional
L

Device latitude (decimal degrees)

If provided the manual location mode is automatically activated. If empty (when adding a device) or _unset (when updating a device), the network location mode is activated if enabled by the column H.

OptionalOptional
M

Device longitude (decimal degrees)

If provided the manual location mode is automatically activated. If empty (when adding a device) or _unset (when updating a device), the network location mode is activated if enabled by the column H.

OptionalOptional
NAdditional informationOptionalOptional
O

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

Default value when adding a device:

<alarm004> <threshold1 status="ENABLE" level="3" duration="P7D"/> <threshold2 status="ENABLE" level="5" duration="P15D"/> </alarm004>

OptionalOptional
Pn/an/an/a
Q

Motion indicator

Value is one of the following:

  • NEAR_STATIC
  • WALKING_SPEED
  • BIKE_SPEED
  • VEHICLE_SPEED
  • RANDOM
Optional: the motion indicator of the device profile will be used when no motion indicator is specified.Optional
Rn/an/an/a
Sn/an/an/a
T

Connection IDs

Multiple connection IDs may be provided, separated by a comma.

OptionalOptional
U

LoRaWAN® SNwkSIntKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
Mandatory in LoRaWAN® 1.1, forbidden otherwise.Optional in LoRaWAN® 1.1, forbidden otherwise.
V

LoRaWAN® NwkSEncKey

Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with the public key version specified in column X (base64 encoding)
Mandatory in LoRaWAN® 1.1, forbidden otherwise.Optional in LoRaWAN® 1.1, forbidden otherwise.
Wn/an/an/a
X

Public key version used to encrypt the keys

Version of the RSA public key used to encrypt the device keys.

OptionalOptional
Yn/an/an/a
ZProtocol identifier (system driver or custom driver)Optional: the default protocol identifier defined in the device model will be used when no protocol identifier is specified.Optional
AALoRaWAN® device session context (internal usage only)OptionalOptional
ABComma-separated list of tag namesOptionalOptional
AC

Comma-separated list of associated domains

The domain group name and the domain name must be provided as follow: domain.group.name:domain.name.

OptionalOptional
AD32 bits integer representation of the last downlink frame counter (FCntDn) received by the deviceOptional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AE32 bits integer representation of the last uplink frame counter (FCntUp) sent by the deviceOptional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AFRX1 data rate offset (0..7)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AGRX2 frequency in MHz (433..928 up to 6 decimal places)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AHRX2 data rate (0..15)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AIRX1 delay in seconds (1..15)Optional for a LoRaWAN 1.0 device migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device that need to be resynchronized with the network server, forbidden otherwise.
AJDownlink dwell time: 0 (no limit) or 1 (400 ms)Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and that need to be resynchronized with the network server, forbidden otherwise.
AKUplink dwell time: 0 (no limit) or 1 (400 ms)Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and migrated from another network server, forbidden otherwise.Optional for a LoRaWAN 1.0 device in AS923 or AU915 ISM band using the local Join Server and that need to be resynchronized with the network server, forbidden otherwise.
Notes
  • When the added ABP device is migrated from another network server (limited to LoRaWAN 1.0.x devices), you must import the LoRaWAN session context of the migrated device, to inform the network about the frame counters and downlink RX1/RX2 configuration parameters currently used by the device.

  • When updating an ABP device:

    • If an optional column is empty, the currently-used value is kept.
    • The _unset keyword can be used to unset the following columns: F, G, H, K, L, M, N, O, T, Z, AB and AC.
    • In case the LoRaWAN state has been desynchronized between your device and the network server, you may use columns AD to AK to instruct the network about the current parameters used by your device.

Adding or updating a cellular device

The following columns must be filled to add or update a cellular device.

ColumnDefinitionAddUpdate
A

Type of operation

  • CREATE_CELLULAR to add a cellular device
  • UPDATE_CELLULAR to update a cellular device
MandatoryMandatory
BEnforced IMEI (15 digits) or DevEUIOptional: only enforced IMEI is supportedMandatory: only DevEUI is supported
CID of the SIM cardMandatoryn/a
D

Device model ID

Device model IDs can be retrieved in a CSV file via the MODEL LIST button.

MandatoryOptional
En/an/an/a
Fn/an/an/a
Gn/an/an/a
H

Connectivity plan ID

If empty (when adding a device) or _unset (when updating a device), the device is not associated with a connectivity plan and is automatically suspended: all its packets are ignored.

OptionalOptional
In/an/an/a
Jn/an/an/a
KDevice nameOptional: The device name is automatically set to the DevEUI when not provided.Optional
LDevice latitude (decimal degrees)OptionalOptional
MDevice longitude (decimal degrees)OptionalOptional
NAdditional informationOptionalOptional
O

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

Default value when adding a device:

<alarm004> <threshold1 status="ENABLE" level="3" duration="P7D"/> <threshold2 status="ENABLE" level="5" duration="P15D"/> </alarm004>

OptionalOptional
Pn/an/an/a
Q

Motion indicator

Value is one of the following:

  • NEAR_STATIC
  • WALKING_SPEED
  • BIKE_SPEED
  • VEHICLE_SPEED
  • RANDOM
Optional: the motion indicator of the device profile will be used when no motion indicator is specified.Optional
Rn/an/an/a
Sn/an/an/a
T

Connection IDs

Multiple connection IDs may be provided, separated by a comma.

OptionalOptional
Un/an/an/a
Vn/an/an/a
WNetwork context IDOptionalOptional
Xn/an/an/a
Yn/an/an/a
Zn/an/an/a
AAn/an/an/a
ABComma-separated list of tag namesOptionalOptional
AC

Comma-separated list of associated domains

The domain group name and the domain name must be provided as follow: domain.group.name:domain.name.

OptionalOptional

Deleting a device

The following columns must be filled to delete a device.

ColumnDefinitionDelete
AType of operation: DELETEMandatory
BDevEUIMandatory
Ask AI