Technical_Reference_Manual_-MODBUS-_LoRa__Sigfox_11.2022.pdf

<aside> 💡 Applicable for APP versions >= 2.1.0

</aside>

DOCUMENTATION GUIDE

TABLE OF CONTENTS

1. REGISTERS

1.1 Generic registers

Register Size (bytes) Base Description Default Value Range (Min-Max) Comments
304 2 10 PIN code
0
(deactivated)

0 - 9999 | PIN code used with ATPIN command. Value 0 disables the PIN code. | | 306 | 1 | 10 | Product mode |   0 | 0: PARK 1: PRODUCTION | In PARK mode, product is not using Radio. In PRODUCTION mode, product will send/receive RF uplinks/downlinks. | | 308 | 4 | 16 | LED activity |   0x0018007F |   0 … 0xFFFFFFFF | Default: 18007F Eco : 180070 Other values : reserved |

1.2 Applicative registers

Register Size (bytes) Base Description Default value Min- Max Value Comments
300 2 10 Keep alive period
8640 (24h) 2 ...
65535
X 10 seconds
301 2 10 Transmit period for periodic data 1
8640 (24h) 0 ...
65535 x 10 seconds
0: deactivated
320 2 10 Sampling period for alarms 180
(30 min) 1 ...
65535
X 10 seconds
321 1 16 Modbus link configuration

0x44 (19200/E/1 RS485) |                 0 … 0xFF | Bit 0: Bus type •   0: RS485 •   1: RS232 Bit 1: Stop bits •   0: 1 bit •   1: 2 bits Bits 2 and 3: Parity •   0: None •   1: Even •   2: Odd Bits 4 to 7: Baud rate •   0: 1200 •   1: 2400 •   2: 4800 •   3: 9600 •   4: 19200 •   5: 38400 •   6: 57600 •   7: 115200 |

| 322 | 2 | 10 | Supply time of the external load (slave) before theModbus request | 0 (OFF) | 0 …65535 | x 100ms

•   0: no power supply (toward the slave)> •   From 1 to 65535: supply time of the external load (slave) before the Modbus request x100ms •   65535: permanent external power supply to the slave

E.g.: if S322 is set to 250, the power supply will be delivered to the slave 250x100ms ie 25s before the transmission of the Modbus request to the slave | | --- | --- | --- | --- | --- | --- | --- | | 323 | 2 | 10 | Transmit period for periodic data 2 | 8640(24 h) | 0 ...65535 | x 10 seconds0: deactivated | | 324 | 2 | 10 | Transmit period for periodic data 3 | 8640(24 h) | 0 ...65535 | x 10 seconds0: deactivated | | 325 | 2 | 10 | Transmit period for periodic data 4 | 8640(24 h) | 0 ...65535 | x 10 seconds0: deactivated | | 326 | 2 | 10 | Transmit period for periodic data 5 | 8640(24 h) | 0 ...65535 | x 10 seconds0: deactivated | | 327 | 2 | 10 | Transmit period for periodic data 6 | 8640(24 h) | 0 ...65535 | x 10 seconds0: deactivated | | 329 | 2 | 10 | Alarm repetition period | 0 | 0 ...65535 | x sampling period (S320) 0: no repetition |

1.3 Periodic data registers

Register Size (bytes) Base Description Default value Min-Max value Comments
330 4 16 Periodic data 1 0(deactivated) 0 …0xFFFFFFFF Bits 3 to 0: number of registers
Bit 4: Modbus registers type
• 0: holding registers (read/write)
• 1: input registers (read only)
Bits 7 to 5: Associated periodic frame
• 0: periodic frame 1
• 1: periodic frame 2
• 2: periodic frame 3
• 3: periodic frame 4
• 4: periodic frame 5
• 5: periodic frame 6
Bits 23 to 8: First register address
Bits 31 to 24: Slave address:
• 0: data deactivated
• 1 à 247: slave address
331 4 16 Periodic data 2 0(deactivated) 0 …0xFFFFFFFF See register 330
332 4 16 Periodic data 3 0(deactivated) 0 …0xFFFFFFFF See register 330
333 4 16 Periodic data 4 0(deactivated) 0 …0xFFFFFFFF See register 330
334 4 16 Periodic data 5 0(deactivated) 0 …0xFFFFFFFF See register 330
335 4 16 Periodic data 6 0(deactivated) 0 …0xFFFFFFFF See register 330
336 4 16 Periodic data 7 0(deactivated) 0 …0xFFFFFFFF See register 330
337 4 16 Periodic data 8 0(deactivated) 0 …0xFFFFFFFF See register 330
338 4 16 Periodic data 9 0(deactivated) 0 …0xFFFFFFFF See register 330
339 4 16 Periodic data 10 0(deactivated) 0 …0xFFFFFFFF See register 330
340 4 16 Periodic data 11 0(deactivated) 0 …0xFFFFFFFF See register 330
341 4 16 Periodic data 12 0(deactivated) 0 …0xFFFFFFFF See register 330
342 4 16 Periodic data 13 0(deactivated) 0 …0xFFFFFFFF See register 330
343 4 16 Periodic data 14 0(deactivated) 0 …0xFFFFFFFF See register 330
344 4 16 Periodic data 15 0(deactivated) 0 …0xFFFFFFFF See register 330
345 4 16 Periodic data 16 0(deactivated) 0 …0xFFFFFFFF See register 330
346 4 16 Periodic data 17 0(deactivated) 0 …0xFFFFFFFF See register 330
347 4 16 Periodic data 18 0(deactivated) 0 …0xFFFFFFFF See register 330
348 4 16 Periodic data 19 0(deactivated) 0 …0xFFFFFFFF See register 330
349 4 16 Periodic data 20 0(deactivated) 0 …0xFFFFFFFF See register 330

1.4 Alarm registers

Register Size (bytes) Base Description Default value Min-Max value Comments

350 | 4 | 16 | Alarm 1 configuration | 0(deactivated) | 0 …0xFFFFFFFF | Bits 1 to 0: Active thresholds • 1: Low threshold • 2: High threshold • 3: High and low thresholds Bit 2: Modbus register type • 0: holding registers (read/write) • 1: input registers (read only) Bit 3: Reserved Bits 4 and 6: Data type • 0: 16-bit unsigned integer • 1: 16-bit signed integer • 2: 32-bit unsigned integer • 3: 32-bit signed integer • 4: 32-bit unsigned integer (word swap) • 5: 32-bit signed integer (word swap) Bit 7: Reserved Bits 23 to 8: First register address Bits 31 to 24: Slave address: • 0: alarm deactivated • 1 à 247: slave address | | 351 | 2 | 16 | Alarm 1 - high threshold | 0 | 0 …0xFFFFFFFF | | | 352 | 4 | 16 | Alarm 1 - hysteresis of high threshold | 0 | 0 …0xFFFF | | | 353 | 2 | 16 | Alarm 1 - low threshold | 0 | 0 …0xFFFFFFFF | | | 354 | 4 | 16 | Alarm 1 - hysteresis of low threshold | 0 | 0 …0xFFFF | | | 355 - 359 | - | - | Alarm 2 configuration | - | - | See registers 350 to 354 | | 360 - 364 | - | - | Alarm 3 configuration | - | - | See registers 350 to 354 | | 365 - 369 | - | - | Alarm 4 configuration | - | - | See registers 350 to 354 | | 370 - 374 | - | - | Alarm 5 configuration | - | - | See registers 350 to 354 | | 375 - 379 | - | - | Alarm 6 configuration | - | - | See registers 350 to 354 | | 380 - 384 | - | - | Alarm 7 configuration | - | - | See registers 350 to 354 | | 385 - 389 | - | - | Alarm 8 configuration | - | - | See registers 350 to 354 | | 390 - 394 | - | - | Alarm 9 configuration | - | - | See registers 350 to 354 | | 395 - 399 | - | - | Alarm 10 configuration | - | - | See registers 350 to 354 |

1.5 Radio registers

1.5.1 LoRaWAN Network Registers

Register Description Encoding Details
201 Spreading Factor (SF) by default (Read Only) Decimal Default: 12
Min/max: 7 to 12
Unit: None
204 Reserved Hexadecimal Do not use
214 LORA APP-EUI (first part – MSB) Hexadecimal Default: 0
Key encoded on 16 characters. Each register contains a part of
the key.
Used during the JOIN phase in OTAA mode
E.g.:
APP-EUI = 0018B244 41524632
• S214 = 0018B244
• S215 = 41524632
215 LORA APP-EUI (second part – MSB) Hexadecimal Default: 0
Key encoded on 16 characters. Each register contains a part of
the key.
Used during the JOIN phase in OTAA mode
E.g.:
APP-EUI = 0018B244 41524632
• S214 = 0018B244
• S215 = 41524632
216 LORA APP-KEY (firstpart – MSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
217 LORA APP-KEY (second part – MID MSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
218 LORA APP-KEY (thirdpart – MID LSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
219 LORA APP-KEY (fourth part – LSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
220 LoRaWAN Options Hexadecimal Default: 5
Bit 0: Activation of the ADR ON(1)/OFF(0)
Bit 1: Reserved
Bit 2: DUTY CYCLE ON(1)/DUTY CYCLE OFF(0)
Bits 3 & 4: Reserved
Bits 5: CLASS C (1)/ CLASS A (0)
Bits 6 to 7: Reserved
CAUTION:
Deactivation of the Duty cycle may result in a violation of the
conditions of use of the frequency band, depending on the use of the device, thus violating the regulations in force.
In the case of disabling the Duty cycle, liability is transferred to
the user.
221 Mode of activation Decimal Default: 1
Choice: (see NOTE 1 after the table)
• 0: ABP
• 1: OTAA
222 LORA NWK_SKEY (first part – MSB) Hexadecimal Default: 0
Parameter encoded on 16 bytes. 4 registers contains 4 bytes.
223 LORA NWK_SKEY(second part - MID MSB) Hexadecimal
224 LORA NWK_SKEY (third part - MID LSB) Hexadecimal
225 LORA NWK_SKEY(fourth part – LSB) Hexadecimal
226 LORA APP_SKEY (first part – MSB) Hexadecimal Default: 0
Parameter encoded on 16 bytes, each register with 4 bytes.
227 LORA APP_SKEY(second part - MID MSB) Hexadecimal
228 LORA APP_SKEY (third part - MID LSB) Hexadecimal
229 LORA APP_SKEY(fourth part – LSB) Hexadecimal
280 NETWORK ID Hexadecimal Default: 0 Read only
281 DEVICE ADDRESS Hexadecimal Default: 0

NOTE 1: The “Over The Air Activation” (OTAA) mode uses a JOIN phase before being able to transmit on the network. This mode uses the APP_ EUI (S214 and S215) and APP_KEY (S216 to S219) codes during this phase to create the keys for network communication.

Once this phase is completed, the codes APP_sKEY, NWK_sKEY and DEVICE ADDRESS will be present in the corresponding registers. A new JOIN phase is started every time the device exits Command mode, a reset is performed, or the device is turned on.

Codes:

The “Activation by personalization” (ABP) mode has no JOIN phase; it transmits directly on the network using the codes NWK_sKEY (S222 to S225), APP_sKEY (S226 to S229) and DEVICE ADDRESS (S281) to communicate.

Codes:

Register Size (bytes) Base Description Default Value Range (Min- Max) Minimum required Application version Comments
303 1 10 LoRaWAN Confirmed mode
0
0-1
V1.2.0 0: deactivation
1: activation
312 4 10 Maximum delay between 2 authentication attempts
43200 (12h)
60-
2592000

V2.1.2 | X 1 second Period: 1 minute to 30 days | | 313 | 2 | 10 | Weighting factor for initial authentication attempts | 1 | 1-65535 | V2.1.2 | | | 314 | 1 | 10 | Number of tries for each authentication attempt | 10 | 1-255 | V2.1.2 | |