Are you looking for the generic LoRaWAN® documentation?
Here you can find the generic LoRaWAN® documentation.
Basics
📢 This document describes the properties and adjustable parameters specific to the LoRaWAN® wireless protocol across all sensors.
Join behavior of the LoRaWAN® sensors
Before telemetry data can be sent via LoRaWAN, the device must establish a connection with the network. To do this, the device sends join requests until a join accept has been successfully received. As a compromise between energy consumption and a fast join, the transmission intervals of the join requests become longer and longer. In addition, the data rate is also varied (initially large data rate or small spreading factor, then smaller data rate or larger spreading factor). The join behavior strictly adheres to the specifications and recommendations of the LoRa Alliance specification. Sentinum sensors implement the specifications through so-called join bursts, the distance between which increasesA join burst consists of a maximum of 6 join requests with decreasing data rate (DR5-DR0) or increasing spreading factor (SF7-SF12). The intervals between the requests increase quadratically in order not to violate the Lora-Alliance specific duty cycle guidelines. The LoRa Alliance prescribes a decreasing duty cycle for join requests according to the following tablez Time duty cycle <1h 1% <11h 0.1%
11h 0.01%
This means that in the first phase (<1h) exactly the same amount of send budget is available as in the second (<11h), although only a tenth of the time is available. In order to make maximum use of the budget, the intervals between join bursts (consisting of max. 6 join requests) are initially small and then become larger. Specifically, 2 bursts are carried out in phase 1. In phase 2, 2 further bursts are carried out, and from phase 3 onwards, 1 burst is carried out per day. The length of the bursts increases from approx. 10 minutes in phase 1, to approx. 100 in phase 2, to up to 16 hours in phase 3.
EUIs and keys
All Sentinum sensors supplied have
-
DEVEUI
-
APPEUI
-
APPKEY
-
Product number
The 8-byte DEVEUI is a unique number selected from the Sentinum OUI block FC84A, which has been assigned to the sensors. The 8-byte APPEUI is also selected from Sentinum's own number range. Each sensor series always has the same APPEUI. This allows the product series to be identified within the Sentinum products. The 16-byte APPKEY is a key randomly generated by a program.
In addition, each product has an individual product number. Each product number (APOQXXXX, FEBRXXXX, ...) is linked to a DEVEUI and an APPKEY.
The scope of delivery includes the three keys listed for each LoRaWAN® sensor and are part of the package. In addition, the keys are provided via a secure cloud.
The APPEUI is displayed when read out by the Sentinum LinQs app.
Default parameters
The default parameters and default settings apply if no other values are specified in the product-specific documentation.
Parameters | Default | Optional (adjustable) |
---|---|---|
Activation | OTAA | ABP |
LoRa MAC version | 1.0.2 | Update takes place if properties of the sensors are positively influenced. |
Join Loop Datarate Start | SF7 (datarate 5) | |
Join Loop Datarate End | Internal temperature | |
Regional Parameters | RP001 Regional Parameters 1.0.2 revision B |
|
REV | REV B | |
Frequency Plan (for EU) | Europe 863-870 MHz (SF12 for RX2 recommended) |
APPEUI Configuration options
NFC and downlink commands
Name: APPEUI
Description: Specifies the Application EUI (APPEUI), which identifies the product series within Sentinum devices.
JSON Key: app_eui
Module key: 0x1112
Group for downlink: 0x00
Property ID: 0x00
Default value:
Minimum adjustable value:
Maximum adjustable value:
Unit:
Read/Write: w (write-only)
Name: APPKEY
Description: Specifies the Application Key (APPKEY), which is used for secure authentication and encryption in LoRaWAN communication.
json Key: app_key
Module key: 0x1112
Group for downlink: 0x00
Property ID: 0x01
Default value:
Minimum adjustable value:
Maximum adjustable value:
Unit:
Read/Write: w (write-only)
Name: DEVEUI
Description: Specifies the Device EUI (DEVEUI), a unique identifier assigned to each Sentinum sensor.
json Key: dev_eui
Module key: 0x1112
Group for downlink: 0x00
Property ID: 0x02
Default value:
Minimum adjustable value:
Maximum adjustable value:
Unit:
Read/Write: r (read-only)
Name: Confirmed Strategy
Description: Indicates whether the sensor operates in confirmed mode. The available options are:
- 0: Unconfirmed (confirmed off).
- 1: Confirmed INFO messages (status uplinks) – currently not available.
- 2: Confirmed alarm uplinks.
- 3: All uplinks confirmed.
json Key: conf
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x00
Default value: 0
Minimum adjustable value: 0
Maximum adjustable value: 3
Unit:
Read/Write: rw (read/write)
Name: Confirmed Retries
Description: Defines the maximum number of retries (transmission attempts) when the sensor operates in confirmed mode.
json Key: retry
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x01
Default value: 3
Minimum adjustable value: 1
Maximum adjustable value: 5
Unit: (Not applicable)
Read/Write: rw (read/write)
Name: ADR
Description: Controls the Adaptive Data Rate (ADR) feature, which optimizes transmission settings based on network conditions.
- 0: ADR off
- 1: ADR on
json Key: adr
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x02
Default value: 3
Minimum adjustable value: 0
Maximum adjustable value: 1
Unit:
Read/Write: rw
Description: Defines the minimum spreading factor (SF) that the Adaptive Data Rate (ADR) can fall back to. This controls the lowest data rate the sensor can use.
json Key: dr
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x03
Default value: 5
Minimum adjustable value: 0
Maximum adjustable value: 5
Unit: datarate
Read/Write: rw
Description: Sets a fixed spreading factor (SF) when Adaptive Data Rate (ADR) is disabled. This ensures a constant transmission rate.
json Key: drmax
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x04
Default value: 0
Minimum adjustable value: 0
Maximum adjustable value: 5
Unit: datarate
Read/Write: rw
Name: Enable Downlink Response
Description: Determines whether a downlink message triggers an uplink response, independent of standard downlink confirmation.
- 0: Off (no response uplink)
- 1: On (downlink triggers an uplink response)
json Key: dresp
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x05
Default value: 0
Minimum adjustable value: 0
Maximum adjustable value: 1
Unit:
Read/Write: rw (read/write)
Name: ACTMTH
Description: Defines the activation method for the LoRaWAN connection.
- 0: OTAA (Over-The-Air Activation)
- 1: ABP (Activation by Personalization)
json Key: act_mth
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x06
Default value: 0
Minimum adjustable value: 0
Maximum adjustable value: 1
Unit:
Read/Write: rw (read/write)
Name: CHKEV
Description: Defines the number of transmissions (X) after which a network check is performed. The type of check depends on the Rejoin Strategy (rejstr):
- Link Check (if rejstr = 1)
- Confirmed Uplink with ACK (if rejstr = 2)
json Key: chkev
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x07
Default value: 4
Minimum adjustable value: 1
Maximum adjustable value: 48
Unit:
Read/Write: rw (read/write)
Name: REJAFT
Description: Specifies the number of failed network checks after which the sensor should attempt to rejoin the network.
JSON Key: rejaft
Module key: 0x1112
Group for downlink: 0x01
Property ID: 0x08
Default value: 4
Minimum adjustable value: 0
Maximum adjustable value: 5
Unit:
Read/Write: rw (read/write)
📢 The values of the group for downlink APPEUI, APPKEY, DEVEUI can only be set via NFC!
To change the keys such as app_eui and app_key and perform a REBOOT at the same time
at the same time, please always perform the following:
{
"power": "REBOOT",
"senticom":{
"app_eui": "8XXXXXXXXXXXXXXXXX",
"app_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
}
As app_eui and app_key are write-only parameters, they cannot be read by the app unless they have been previously written by the app. We therefore generally recommend leaving the keys permanently in the JSON configuration. If it is required that user-specific keys are set, but these should not be readable under any circumstances, another JSON can be written without these keys after the keys have been set for the first time. In this case, the keys remain in the internal memory. Only when power=RESET are they reset to the factory setting.
💡 rejstr, chkev and rejaft are features to activate a link check.
SF vs. DR
DR
|
SF
|
0
|
SF12
|
1
|
SF11
|
2
|
SF10
|
3
|
SF9
|
4
|
SF8
|
5
|
SF7
|