Reference information
Building your CSV file to import devices
This section helps you construct your CSV file when you want to add or delete devices in bulk. For more information, see Importing LoRaWAN® or cellular devices.
Import CSV file for cellular devices
The following table describes the contents of the formatted CSV file you must create to import or delete cellular devices.
Use TP-Wireless-7.2-device-import-MTC-rev1.xlsx as a sample to guide you through the process.
| Column | Field name | Cardinality - Description |
|---|---|---|
| A | Processing directive: - If #: commented row - If CREATE_CELLULAR: device creation- If DELETE: device deletion | |
| B | IMEI | Mandatory. IMEI terminal identifier (15 or 14 digits). In case of DELETE type, only IMEI is required |
| C | IMSI | Mandatory. IMSI of the SIM card |
| D | Device profile ID | Mandatory. Manufacturer ID. Ask your operator to get the manufacturer ID mapping |
| E | Secret key of the SIM card (Ki) | Optional if HSS provisioning is activated in operator settings, Forbidden otherwise. Supported encoding modes: - Clear text (hexadecimal encoding) - Encrypted with TWA Exchange Key (RSA) version specified in column X (base64 encoding) |
| F | n/a | n/a |
| G | TPK X config | XML encoded ThingPark X configuration:<modelCfgs><modelCfg>0</modelCfg></modelCfgs> |
| H | Connectivity Plan ID | Name of the connectivity plan |
| I | AS Routing Profile ID | See Routing Profile details to get the profile ID |
| J | Maker ID | Marker IDs in the icon bank are respectively from 100 to 106, and from 200 to 207. When not set, the default marker is used. |
| K | Device Name | When not provided at creation, the name is generated. |
| L | Admin LAT | Latitude (decimal degrees) When provided at the creation, the manual location is automatically activated, otherwise the network location is activated by default. |
| M | Admin LON | Longitude (decimal degrees) When provided at the creation, the manual location is automatically activated, otherwise the network location is activated by default. |
| N | Admin Info | Administrative information |
| O | Alarm 004 settings | Settings of alarm 004; For instance,<alarm004><threshold1 status="ENABLE" level="3" duration="P2D"/><threshold2 status="ENABLE" level="5" duration="P7D"/></alarm004> |
| P | n/a | n/a |
| Q | Motion indicator | Motion indicator of the device: - NEAR_STATIC - WALKING_SPEED - BIKE_SPEED - VEHICLE_SPEED - RANDOM When not specified at creation, the motion indicator of the device profile/model is used. |
| R | n/a | n/a |
| S | n/a | n/a |
| T | n/a | n/a |
| U | n/a | n/a |
| V | n/a | n/a |
| W | n/a | n/a |
| X | TWA Exchange Key (RSA) version | Optional if HSS provisioning is activated in operator settings; Forbidden otherwise. Used to encrypt the Ki key. |
Import CSV file for LoRaWAN® OTAA devices
The following table describes the contents of the formatted CSV file you must create to import or delete LoRaWAN® devices in OTAA mode.
Use TP-Wireless-7.2-device-import-OTAA-rev1.xlsx as a sample to guide you through the process.
| Column | Field name | Cardinality - Description |
|---|---|---|
| A | Type | Processing directive: - If #: commented row - If CREATE_OTAA: device creation- If DELETE: device deletion |
| B | DevEUI | Mandatory Globally unique IEEE EUI-64 address (hexadecimal) In case of DELETE type, only DevEUI is required. |
| C | DevAddr | Device address (hexadecimal) |
| D | Device Profile ID | Mandatory Device profile identifier Ask your operator to get the profile ID mapping. |
| E | LoRaWAN® JoinEUI/AppEUI | Mandatory JoinEUI applies to LoRaWAN® 1.1. AppEUI applies to LoRaWAN® 1.0. Global application ID in IEEE EUI64 address space that uniquely identifies the application provider of the device. |
| F | LoRaWAN® AppKey | Mandatory if External Join Server option is DEACTIVATED, Forbidden otherwise. Assigned by the application owner specifically to the device. Supported encoding modes: - Clear text (hexadecimal encoding) - Encrypted with HSM Application Key (AES) version specified in column S (hexadecimal encoding) - Encrypted with Exchange Key (RSA) version specified in column X (base64 encoding). |
| G | TPK X Config | XML encoded ThingPark X configuration:<modelCfgs><modelCfg>0</modelCfg></modelCfgs> |
| H | Connectivity Plan ID | Name of the connectivity plan |
| I | AS Routing Profile ID | See Routing Profile details to get the profile ID |
| J | Marker ID | Marker IDs in the icon bank are respectively from 100 to 106, and from 200 to 207. When not set, the default marker is used. |
| K | Device Name | Name of the device |
| L | Admin LAT | Latitude (decimal degrees) |
| M | Admin LON | Longitude (decimal degrees) |
| N | Admin info | Administrative information |
| O | Alarm 004 settings | Settings of alarm 004. For instance:<alarm004><threshold1 status="ENABLE" level="3" duration="P2D"/><threshold2 status="ENABLE" level="5" duration="P7D"/></alarm004> |
| P | ADM verification code | Address Manager Verification Code Verification code associated with the DevEUI when the ADM validation option has been activated on Device Manager subscription. |
| Q | Motion indicator | Motion indicator of the device: - NEAR_STATIC - WALKING_SPEED - BIKE_SPEED - VEHICLE_SPEED - RANDOM When not set, the motion indicator of the device profile/model is used. |
| R | HSM Group ID | Forbidden if LRC in mode NS, with an external JS. Value of Hardware Security Module (HSM) protection in your connectivity plan. |
| S | HSM Application Key version | Optional if External Join Server option is DEACTIVATED, Forbidden otherwise. It is provided by your operator. |
| T | Application server IDs | Forbidden if AS routing profile ID (in column I) is provided. Multiple application server IDs may be provided, separated by a comma. |
| U | LoRaWAN® NwkKey | Mandatory for LoRaWAN® 1.1 device if External Join Server option is DEACTIVATED, Forbidden otherwise. Supported encoding modes: - Clear text (hexadecimal encoding) - Encrypted with HSM Network Key (AES) version specified in column V (hexadecimal encoding) - Encrypted with HSM Exchange Key (RSA) version specified in column X (base64 encoding) |
| V | HSM Network Key version | Optional for LoRaWAN® 1.1 device if External Join Server option is DEACTIVATED, Forbidden otherwise. |
| W | n/a | n/a |
| X | HSM Exchange Key (RSA) version | or TWA Exchange Key (RSA) version Optional if External Join Server option is DEACTIVATED, Forbidden otherwise. Used to encrypt AppKey/NwkKey. |
Import CSV file for LoRaWAN® ABP devices
The following table describes the contents of the formatted CSV file you must create to import or delete LoRaWAN® devices in ABP mode.
Use TP-Wireless-7.2-device-import-ABP-rev1.xlsx as a sample to guide you through the process.
| Column | Field name | Cardinality - Description |
|---|---|---|
| A | Type | Processing directive: - If #: commented row - If CREATE_ABP or CREATE or empty: device creation- If DELETE: device deletion |
| B | DevEUI | Mandatory Globally unique IEEE EUI-64 address (hexadecimal) In case of DELETE type, only DevEUI is required. |
| C | DevAddr | Mandatory Device address (hexadecimal). |
| D | Device Profile ID | Mandatory Device profile ID. Ask your operator to get the profile ID mapping. |
| E | LoRaWAN® FNwkSIntKey/NwkSKey | Mandatory for LoRA™ MAC or Watteco 3.2 MAC devices, Forbidden otherwise. Forwarding Network Session Integrity Key (FNwkSIntKey) applies to LoRaWAN® 1.1. Network Session Key (NwkSKey) applies to LoRaWAN® 1.0: 128-bit key (hexadecimal). |
| F | AppSKeys | Optional for LoRA™ MAC or Watteco 3.2 MAC devices, Forbidden otherwise. XML encoded application session keys, 128-bit key per port: <AppSKeys><AppSKey Port="1-2">2B7E151628AED2A6ABF7158809CF4F3C</AppSKey><AppSKey Port="2">2B7E151628AED2A6ABF7158809CF4F3C</AppSKey></AppSKeys> |
| G | TPK X Config | XML encoded ThingPark X configuration:<modelCfgs><modelCfg>0</modelCfg></modelCfgs> |
| H | Connectivity Plan ID | Name of the connectivity plan |
| I | AS Routing Profile ID | See Routing Profile details to get the profile ID |
| J | Marker ID | Marker IDs in the icon bank are respectively from 100 to 106, and from 200 to 207. When not set, the default marker is used. |
| K | Device Name | Name of the device |
| L | Admin LAT | Latitude (decimal degrees) |
| M | Admin LON | Longitude (decimal degrees) |
| N | Admin info | Administrative information |
| O | Alarm 004 settings | Settings of alarm 004. For instance:<alarm004><threshold1 status="ENABLE" level="3" duration="P2D"/><threshold2 status="ENABLE" level="5" duration="P7D"/></alarm004> |
| P | ADM verification code | Address Manager Verification Code Verification code associated with the DevAddr/DevEUI pair when the ADM validation option has been activated on Device Manager subscription. |
| Q | Motion indicator | Motion indicator of the device: - NEAR_STATIC - WALKING_SPEED - BIKE_SPEED - VEHICLE_SPEED - RANDOM When not set, the motion indicator of the device profile/model is used. |
| R | HSM group ID | Forbidden |
| S | n/a | n/a |
| T | Application server IDs | Forbidden if AS routing profile ID (in column I) is provided. Multiple application server IDs may be provided, separated by a comma. |
| U | LoRaWAN® SNwkSIntKey | Mandatory for LoRaWAN® 1.1 device, Forbidden otherwise. |
| V | LoRaWAN® NwkSEncKey | Mandatory for LoRaWAN® 1.1 device, Forbidden otherwise. |
| W | n/a | n/a |
| X | n/a | n/a |
Connectivity plans
This section provides quick access to the details of all connectivity plans. For more information about connectivity plans, see Viewing connectivity plans and Managing the connectivity plan of a device.
Cellular IoT connectivity plan details
The Connectivity plan details frame, which gives information about the connectivity plan, is displayed in the Connectivity plans panel. This frame is for information only.
It displays the name, ID and description of the connectivity plan, and provides a view on its main characteristics. The default values, that are not displayed in Device Manager, are given here as an indication for troubleshooting purpose.
| Parameter | Cardinality - Description | Default setting |
|---|---|---|
| Message mode parameters | ||
| Uplink Rate regulator | Number of uplink packets allowed per hour with number of uplink packets allowed in burst. | 10/hour 10/burst |
| Uplink Regulator policy | Describes how the network behaves in case of uplink traffic overload. Mark: The system will keep track of the device packets exceeding the limits’ set. Exceeding packets are sent and marked. Drop: The system will drop the device packets exceeding the limits set. Exceeding packets are deleted. | Mark |
| Downlink transmission | Enables/Disables the activation state of the downlink transmission. | Enabled |
| Downlink Rate regulator | Number of downlink packets allowed per hour, number of downlink packets allowed in burst. By default, the Downlink rate is set to one packet/hour with a Downlink bucket size of two packets. | 1/hour |
| Downlink regulator policy | Describes how the network behaves in case of downlink traffic overload: - Mark: The system will keep track of devices exceeding the limits’ set. Exceeding packets are sent and marked. - Drop: The system will drop the device packets exceeding the limits’ set. Exceeding packets are deleted. | Mark |
| ThingPark X routing | Allows routing messages to and from the ThingPark X service (Actility proprietary application server, and more). | Enabled |
| Third Party Application Servers routing | Allows routing messages to and from a third-party application servers using an HTTP application server. | Enabled |
| Maximum allowed Application Servers | Number of allowed third party application servers in an AS routing profile, summing up local application servers and ThingPark X destinations. It is checked at the device’s creation or edition, when a connectivity plan and an AS routing profile have been allocated. This parameter can be set up to five by your operator. | 1 |
| ThingPark Kafka routing | Allows message routing to third party application servers using a Kafka topic. | Disabled |
| Direct IP mode parameters | ||
| Direct IP mode | Enable/Disable direct IP mode | Enabled |
| Maximum bandwidth up | Maximum allowed uplink bandwidth in kbps | - |
| Maximum bandwidth down | Maximum allowed downlink bandwidth in kbps | - |
| Microflow minimal duration | Minimum duration of microflow in seconds. Acceptable range is from 10 seconds to 1 minute. | 20 |
| Microflow maximal duration | Maximum duration of microflow in seconds. Acceptable range is from 1 minute to 1 hour. | 60 |
| Microflow maximal volume | Maximum reporting volume of microflow in Kilo Bytes. Acceptable range is from 50 KB to 10 MB. | 100 |
LoRaWAN® unicast connectivity plan details
The Connectivity plan details frame, which gives information about the connectivity plan, is displayed in the Connectivity plans panel. This frame is for information only.
It gives the name, ID and description of the connectivity plan, and provides a view on its main characteristics. The default values, that are not displayed in Device Manager, are given here as a guide for troubleshooting purpose.
| Parameter | Cardinality - Description | Default setting |
|---|---|---|
| Communication type | Mandatory Communication type of the connectivity plan | Unicast |
| Uplink frame parameters | ||
| Acknowledged uplink frame | Indicates that the device is authorized to use the uplink confirmed mode, i.e., requests an acknowledgment by the network to its uplink packets. If disabled, the network does not send acknowledgements to the uplink packets sent by the device even if the device uses the Confirmed mode. | Enabled |
| Rate regulator | Number of uplink packets allowed per unit of time (hour, day or week) with the number of uplink packets allowed in burst. | 10/hour 10/burst |
| Uplink Regulator policy | Describes how the network behaves in case of uplink traffic overload. Mark: The system will keep track of the device packets exceeding the limits set. Exceeding packets are sent and marked as overflow packets. Additional fees may be applied by the operator. Drop: The system will drop the device packets exceeding the limits set. Exceeding packets are deleted. | Mark |
| Base station buffering policy | Unavailable | Not set |
| Force Adaptive Data Rate | The Adaptive Data Rate (ADR) is always used even if not requested by the device. | Disabled |
| Asynchronous UL processing | Enabled if higher than zero milliseconds, it makes the LRC wait for an application server downlink payload before sending the LoRaWan® downlink to the device on RX1/RX2 response windows. The value defines the maximum delay the LRC can wait forward the AS payload in the downlink answer to the device, and thus the maximum delay the application server can send the AS downlink payload. If the delay is expired, the AS downlink payload will wait the next device uplink to be forwarded in the next downlink answer to the device. By default, this parameter is set to zero milliseconds which means that the synchronous uplink processing is enabled, and the LRC does not wait for the application server downlink payload. | 0 |
| Downlink frame parameters | ||
| Downlink transmission | Enables/Disables downlink packets transmission to the device. | Enabled |
| Acknowledged downlink frame | Indicates that the application server is authorized to use the Downlink Confirmed mode, to request an acknowledgment to its downlink packets. If disabled, the network rejects the downlink packets received from the application server in confirmed mode. | Enabled |
| Rate regulator | Number of downlink packets (also known as packets) allowed per unit of time (hour, day or week), number of downlink packets allowed in burst. | 1/hour 2/burst |
| Downlink regulator policy | Describes how the network behaves in case of downlink traffic overload. Mark: The system will keep track of the device packets exceeding the limits set. Exceeding packets are sent and marked as overflow packets. Additional fees may be applied by the operator. Drop: The system will drop the device packets exceeding the limits set. Exceeding packets are deleted. | Mark |
| Device status request rate (request/day) | Rate to initiate a device status request from the network. | 0/day |
| Report device battery level | For devices supporting the feature, activates the reporting of device battery level to application servers. | Disabled |
| Report device signal margin | Activates the reporting of device signal margin to application servers. | Disabled |
| Minimal RX1 delay (ms) | Specifies at the device level the delay in milliseconds between the uplink and the first downlink receive window (RX1). If provided, this value takes precedence over the RX1 value defined in the RF region. | Not set |
| Network parameters | ||
| Mobility | Unavailable | Disabled |
| Network geolocation | Enables the device network geolocation services (GPS-free). The Adaptive Data Rate policy seeks to keep the device within reach of three base stations. | Disabled |
| Add Base station metadata information | Provides LRR meta information (RSSI, SNR, ESP, LRR coordinates, ...) into routing messages to third party applications servers. | Enabled |
| Class B support | If supporting the feature, allows an OTAA or ABP device to switch to LoRaWAN® class B mode after a bootstrapping procedure. | Disabled |
| Managed Customer Network | Enables the use of one group of base stations dedicated to the application of a flat usage rate billing policy to the traffic of devices passing through it. Those base stations are typically owned by the subscriber and installed on their premises. Device traffic served outside the managed customer network is being applied the regular conditions of the connectivity plan. Available on subscription and if activated in the subscriber’s account configuration. | Disabled |
| Network Partner access control | Allows the network server to route or drop packets passing through base stations according to the network partners they belong to: - No access control: Routes all the uplink and downlink packets through all base stations. By default, this parameter is set. - Whitelist access control: Routes the uplink and downlink packets through base stations belonging to whitelisted network partners. If enabled, displays the network partners identifiers. - Blacklist access control: Drops the uplink and downlink packets coming from or to base stations belonging to blacklisted network partners. If enabled, displays the network partners identifiers. | Set |
| Routing parameters | ||
| ThingPark X routing | Allows routing messages to and from the ThingPark X service (Actility proprietary application server, and more). Important The connectivity plan associated with the device must enable the routing parameter corresponding to the application server used by the device. | Enabled |
| Third Party Application Servers routing | Allows routing messages to and from a third-party application servers using an HTTP application server. Important The connectivity plan associated with the device must enable the routing parameter corresponding to the application server used by the device. | Enabled |
| Maximum allowed Application Servers | Number of allowed third party application servers in an AS routing profile, summing up local application servers, supplier application servers and ThingPark X destinations. It is checked at the device’s creation or edition, when a connectivity plan and an AS routing profile have been allocated. This parameter can be set up from 0 to 5 by your operator. Important The connectivity plan associated with the device must enable the routing parameter corresponding to the application server used by the device. | 1 |
| Third-party Application Server PER information | Routes the Packet Error Rate information to application servers. Important The connectivity plan associated with the device must enable the routing parameter corresponding to the application server used by the device. | Disabled |
| Third-party Application Server downlink sent indication | Reports downlink delivery status to Third Party application servers. Important The connectivity plan associated with the device must enable the routing parameter corresponding to the application server used by the device. | Disabled |
| ThingPark Kafka routing | Allows message routing to third party application servers using a Kafka topic. Important The connectivity plan associated with the device must enable the routing parameter corresponding to the application server used by the device. | Disabled |
| Roaming parameters | ||
| Roaming activation allowed | Allows OTAA activation (LoRaWAN® JoinReq) of devices away from the home network server. | Disabled |
| Passive roaming allowed | Allows passive roaming. | Disabled |
| Handover Roaming allowed | Unavailable | Disabled |
| Security | ||
| Hardware Security Module (HSM) protection | If an HSM is installed on your operator’s platform, the HSM group set enables the protection of the root keys, AppKey and NwkKey, for OTAA devices. NwkKey only applies to LoRaWAN® 1.1. By default, no HSM group is set. | Disabled |
| Grade-of-Service based ADR parameters | ||
| Minimum Spreading Factor | Lowest spreading factor allowed for the device. The minimum spreading factor is defined by the network configuration of the RF region. By default, this parameter is not set, so the minimum spreading factor is defined by the network configuration of the RF region. | Not set |
| Maximum Spreading Factor | Highest spreading factor allowed for the device. By default, this parameter is not set, so the maximum spreading factor is defined by the network configuration of the RF region. | Not set |
| Force channel mask | Conceals certain radio channels, thus leaving others for the subsequent usage for uplink access. It changes the default channel mask settings defined in the RF region using a hexadecimal string (16/64/72/96-bit hexadecimal string according to the channels number) encoding the channels usable for uplink access. | Not set |
| Minimum antenna (macro) diversity | Minimum required number of base stations simultaneously receiving the device packets, typically used for network geolocation. | 1 |
| Force RX2 data rate | Specifies a data rate for the RX2 receive window to override the default data rate defined in the network configuration of the RF region. | Not set |
| Adaptive Data Rate algorithm | ADR algorithm version: ADR v3: Packet Error Rate-based optimization (New connectivity plans only support ADR v3) and ADR v2: Signal to Noise Ratio-based ADR optimization (Will be deprecated soon). The ADR algorithm is used to manage the data rate, number of transmissions and RF output power for each device individually, in order to maximize both battery life of devices and overall network capacity. If ADR v3: Packet Error Rate-based optimization is set, the following parameters are available: - Device PER target: Defines the Packet Error Rate value targeted by the ADR v3 algorithm. - Macro diversity reliability target: Defined the minimum probability target of having N base stations receiving device uplink packets. - Minimum number of device uplink transmissions: Defines the minimum number of device uplink transmissions to ensure quality of service will not be degraded. - Maximum number of device uplink transmissions: Defines the maximum number of device uplink transmissions to ensure quality of service will not be degraded. If ADR v2: Signal to Noise Ratio-based ADR optimization is set, the following parameters are available: - Margin offset: Defines the margin offset considered when computing the minimum Signal to Noise Ratio in the ADR v2 algorithm. By default, this parameter is set to zero. - Number of transmissions offset: Defines the offset added to the number of transmissions configured in the RF region. By default, this parameter is set to zero. | ADR v3 - 10% - 80% - 80% - 3 |
LoRaWAN® multicast connectivity plan details
The Connectivity plan details frame, which gives information about the connectivity plan, is displayed in the Connectivity plans panel. This frame is for information only.
It displays the name, ID and description of the connectivity plan, and provides a view on its main characteristics. The default values, that are not displayed in Device Manager, are given here as an indication for troubleshooting purpose.
| Parameter | Cardinality - Description | Default setting |
|---|---|---|
| Communication type | Mandatory Communication type of the connectivity plan | Multicast |
| Downlink frame parameters | ||
| Rate regulator | Number of packets allowed per hour with the number of packets allowed in burst. | 1/hour 2/burst |
| Downlink regulator policy | Describes how the network behaves in case of downlink traffic overload. Mark: The system will keep track of the device downlink exceeding the limits set. Exceeding packets are sent and marked. Drop: The system will drop the device downlink exceeding the limits set. Exceeding packets are deleted. | Mark |
| Force RX2 Data Rate | If not specified in Downlink data rate of the multicast group, defines a specific RX2 data rate that will override the RF region settings for class C multicast downlink transmission. Important When defined, this value must be the same as the Force RX2 Data Rate value set in the unicast connectivity plans of all target devices using the multicast group. | - |
| Multicast parameters | ||
| Maximum base station cells | Maximum number of base stations which can be added in the scope of the multicast group. Acceptable range is from 1 to 1,000 base stations. | 200 |
| Downlink transmission inter base station delay | Transmission delay in seconds between adjacent base stations which are not GPS-synchronized. | 5 |
| Downlink maximum transmissions | Maximum number of times the network server will attempt to transmit a downlink packet through a base station in case it fails to broadcast. Acceptable range is from 1 to 5 times. | 3 |
| Class C collision avoidance distance | Minimum distance in meters between two base stations to avoid transmission collision. Acceptable range is from 100 to 50,000 meters. | 7,000 |
| Routing parameters | ||
| ThingPark X routing | Allows routing messages to and from the ThingPark X service (Actility proprietary application server, and more) | Enabled |
| Third Party Application Servers routing | Allows routing messages to and from a third-party application servers using an HTTP application server | Enabled |
| ThingPark Kafka routing | Allows message routing to third party application servers using a Kafka topic | Disabled |