Devices' parameters
Devices are provisioned either by Over-The-Air Activation (OTAA) or by Activation By Personalization (ABP).
To provision your devices, you need to set the generic parameters and the parameters that are specific to the activation mode that you choose.
The following device parameters are read-only parameters, unless otherwise notified.
Generic device parameters
| Parameter | Definition |
|---|---|
| Device Name | Name of the device (Editable). |
| Manufacturer | Name of the device manufacturer. |
| Class | LoRaWAN® class of the device, class A, B or C. (Editable). |
| Device Model | Device model, corresponding to a configured LoRaWAN® parameter template (Editable). The model label is composed of the model name followed by compatible ISM bands. |
| Driver Metadata | Designates all information that is required to identify the device (firmware) and the protocol to be used by the device to encode its payload. The Protocol Identifier is a block of information composed of Protocol Manufacturer, Protocol Name and Protocol Version. There are two types of Protocol Identifiers: - Built-in: inherited from the device model and used to select system drivers included in the drivers catalog - Custom: used to select custom drivers created by the user. |
| Driver Identifier | Identifier of the driver used to decode the payload. |
| Decoded Payload | Output of the driver (JSON document). |
| Content | The packet content includes either payload data (DATA), LoRaWAN® MAC commands (MAC), or both. It includes: - DATA: The packet includes payload data from the device or the application. - MAC: The packet includes LoRaWAN® MAC radio configuration commands. The packet can may also be a Join-request (UL) or a Join-accept (DL). In this case, the JOIN is included in the Content column of the "Last 10 packets" widget... |
| DevEUI | Globally unique address of the device. The DevEUI is usually written on the device casing. The DevEUI is based on IEEE Organizationally Unique Identifier (OUI). The 24, 28, or 36 leading bits identify the vendor which the OUI was assigned by the IEEE. All LoRaWAN® device vendors must buy an IEEE OUI block from IEEE. A DevEUI 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. |
| DevAddr | 8-digit hexadecimal device address in the LoRaWAN® network, unique within the network and allocated by the Network Server. The most significant bits of the DevAddr identify a LoRaWAN® network operator ID. Network identifiers are available to LoRa Alliance® members and are needed if your devices need to roam out of your ThingPark Enterprise network (requires roaming agreement with an operator, ask your System Integrator for Actility for ThingPark Exchange roaming hub). If you do not own a network identifier, the first 7 bits will be set to ‘0000000’, or ‘0000001’ which are reserved values for local networks. Example: 00-AB-C4-89 |
| Activation Mode | Specifies the device by the way it is activated on the network. If the device you want to provision already has a DevAddr, select Activation-by-Personalization (ABP). If you know the AppKey of the device, select Over-the-Air Activation (OTAA) with local Join Server. Otherwise, select Over-the-Air Activation (OTAA) with external Join Server. To learn more about activation mode, see Activation modes. |
| Additional Information | Any useful information related to the device. (Editable) |
| Location Mode | Technique used to locate the device. The position of the device is expressed by its latitude and its longitude. You can choose among the following: - No location: if the location of the device does not matter. - Manual: if the device is stationary and never in movement. This mode implies that the user already knows the precise device location. - Network geolocation: device is geolocated by the network via triangulation techniques. While this mode is particularly interesting if the device is in movement; this mode may also be used for stationary devices. |
| Position | Exact position of the device using WGS84. The World Geodetic System is the standard used by the Global Positioning System (GPS). Only applies to Manual mode. This is the static position of the device. |
| ISM band | Defines the regional profile of the device. |
| Motion Indicator | Speed of the device’s movement. Example: If the device tracks a parcel, select "vehicle speed". By default, the motion indicator keeps the value configured in the device model associated with this device. It enhances the network geolocation accuracy and impacts the choice of the base station used to send a downlink to the device. |
| Last Uplink (UL) | Last packet that was sent from the device. |
| Last Downlink (DL) | Last Downlink packet that was sent by the Network Server to the device. |
| Applications | Applications associated with the device. |
| SNR | Signal to Noise Ratio in Decibels (dB). Determines the quality of LoRaWAN® reception. LoRaWAN® physical layer can receive signals with negative SNR, up to about -20 dB for SF12. |
| FCNT | Frame Counter. There are separate uplink and downlink frame counters. Whenever an uplink or downlink packet is sent, the corresponding counter is incremented. |
| FCNT | Packet Error Rate in percentage (%). Measures the ratio of missing uplink packets to total uplinks. |
| RSSI | Received Signal Strength Indicator. Measures in dBm the total RF power received on a given RF channel, summing up the desired LoRaWAN® signal and the background noise. When the SNR is negative, it is a good approximation of the background noise power. |
| RSSI | Estimated Signal Power measured in dBm. It is an estimate of the LoRaWAN® useful signal power, computed from SNR and RSSI estimates. |
| SF | LoRaWAN® Spreading Factor. Determines the data rate used during transmission. LoRaWAN® SF range is [7...12]: SF7 corresponds to the fastest data rate (~5.5 kbits/sec) while SF12 corresponds to the slowest data rate (~300 bits/sec). |
| Best LRR ID | Is only available if the location mode is the network geolocation. Designates all location details for the seven days before the last reported location. It is expressed by the following data: - Date of the geolocation, - Computed latitude, - Computed longitude, - Geolocation precision (meters), - Computed altitude (meters), - Altitude precision, - Computed moving speed (meters per second), - Moving direction relative to the North (degrees). |
| Location history | Is only available if the location mode is the network geolocation. Designates all location details for the seven days before the last reported location. It is expressed by the following data: -Date of the geolocation, - Computed latitude, - Computed longitude, - Geolocation precision (meters), - Computed altitude (meters), - Altitude precision, - Computed moving speed (meters per second), - Moving direction relative to the North (degrees). |
| Domains | List of domains associated with the device. If your user account has domain restrictions, the associated domains must match your domain restrictions without any domain prefix. Only available if the segregation based on domains has been enabled by an administrator user. See About domains for more details. |
Specific device parameters for Over-the-Air activation (OTAA)
| Parameter | Definition |
|---|---|
| JoinEUI (AppEUI) | Global application ID that identifies uniquely the application provider of the device. The JoinEUI is a global application ID in IEEE EUI64 address space that uniquely identifies the Join Server that can assist in the processing of the Join procedure and the session keys derivation for OTAA devices. Composed of 16 hexadecimal digits (0 to 9, and A to F). Is provided by the device manufacturer. This parameter is displayed as "JoinEUI (AppEUI)" for LoRaWAN® 1.0 devices and "JoinEUI" for LoRaWAN® 1.1 devices. |
| NwkKey | Network Key. Encrypts the device communication with the network. It is composed of 32 hexadecimal digits (0 to 9, and A to F). It is provided by the device manufacturer. This is a LoRaWAN® 1.1 parameter. |
| AppKey | The Application Key is an AES-128 key specific for each end-device, programmed in factory by the device manufacturer. It is used to derive the session keys that allow LoRaWAN® to secure communication with the Network Server and the Application Server. The AppKey is provided by the device manufacturer when you purchase the device. In the future, the manufacturer may also provide you with an ownership claim key and a JoinEUI, which together will allow ThingPark Wireless to reach the manufacturer’s Join Server and negotiate session keys without ever communicating the AppKey in clear. Ask your System Integrator about Actility's ThingParkApplication Server for more information. This is a LoRaWAN® 1.0 and LoRaWAN® 1.1 parameter. |
| Owner-token | The owner-token proves the ownership of a Device. This element is provided when devices are pre-commissioned on an external Join Server by the device manufacturer. |
Specific device parameters for Activation By Personalization (ABP)
| Parameter | Definition |
|---|---|
| DevAddr | Device Address on the network. Composed of 8 hexadecimal digits (0 to 9, and A to F). It identifies the device within the current network in each uplink and downlink. Example: 00-AB-C4-89 No check is done on DevAddr prefix when provisioning an ABP device: DevAddr prefix may not match the NetID allocated to the self-hosted ThingPark Enterprise instance or the NetID of the ThingPark EnterpriseSaaS Operator. |
| NwkSKey | Network session key that is specific to the ABP device. Composed of 32 hexadecimal digits (0 to 9, and A to F). It provides integrity protection and encryption to the MAC commands. Example: 1B-3E-11-A6-A8-CE-91-C6-A1-F1-25-81-D9-CC-4A-2C This is a LoRaWAN® 1.0 parameter. |
| FNwkSIntKey | Forwarding Network Session Integrity Key. Composed of 32 hexadecimal digits (0 to 9, and A to F). It provides integrity protection to roaming devices. Example: 1B-3E-11-A6-A8-CE-91-C6-A1-F1-25-81-D9-CC-4A-2C This is a LoRaWAN® 1.1 parameter. |
| SNwkSIntKey | Serving Network Session Integrity Key. Composed of 32 hexadecimal digits (0 to 9, and A to F). It provides integrity protection. Example: 1B-3E-11-A6-A8-CE-91-C6-A1-F1-25-81-D9-CC-4A-2C This is a LoRaWAN® 1.1 parameter. |
| NwkSEncKey | Network Session encryption Key. Composed of 32 hexadecimal digits (0 to 9, and A to F). It is used for the 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 This is a LoRaWAN® 1.1 parameter. |
| AppSKey | Application Session Key that is specific to the ABP device. Composed of 32 hexadecimal digits (0 to 9 and A to F). It is used by the application and the device to encrypt and decrypt the payload. Example: 2B-7E-15-16-28-AE-D2-A6-AB-F7-15-88-09-CF-4F-3C Only one AppSKey can be provisioned when provisioning an ABP device via the Adding a device panel. This limitation is not applicable to ABP device provisioning using the Importing device from CSV file panel: the device import can be used as a workaround to provision an ABP device with several AppSKeys. This is a LoRaWAN® 1.0 and LoRaWAN® parameter. |