<aside> đź’ˇ Applicable to APP versions: >= 1.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: RUN In PARK mode, product is not using Radio.
In RUN mode, product will send/receive RF uplinks/downlinks.

1.2 Applicative registers

Register Size (bytes) Base Description Default value Min-Max Value Comments
300 2 10 Daily Frame
1 0: Disable
1: Daily transmission 1: Daily frame sent every 24H
301 2 10 Transmit period of data
2 → Sigfox 6 → LoRa

0 … 65535 | Number of backups (history logs) to be done before sending a frame (thus defining the sending period). The value 0 is equivalent to disabling the periodic mode. | | 315 | 1 | 10 | Time zone offset | 0 | -12 … 14 | Defines the Time Zone offset from UTC (in hours). Must be defined for Daylight Saving Time management. | | 316 | 1 | 10 | Daylight Saving Timemanagement | 0 | 0 … 1 | Only applicable for European countries. 0: disabled 1: enabled | | 318 | 1 | 10 | Time stamping |   0 |   0 … 1 | LoRaWAN only If enabled, adds a time stamp in data frames. 0: disabled 1: enabled | | 319 | 1 | 10 | RTCcalibration value | 0 | -100 … 100 | Allows correcting a possible drift of the clock. In tenths of a second per day. | | 320 | 2 | 10 | History period | 1 | 1 … 65535 | Number of readings to be performed before saving in the history logs. The value 1 is equivalent to 1 backup per reading | | 321 | 2 | 10 | Sampling period | 300 (10 min) | 15 … 65535 | 0: no sampling x2 seconds With S320 = 1 and S301 = 2 è 72 TX / Day With S320 = 1 and S301 = 6 è 24 TX / Day | | 322 | 2 | 10 | Alarm repetition period |   0 |   0 … 65535 | If an alarm is active, this register allows the product to send periodically a reminder.   0: no repetition X sampling period (S321) | | 323 | 1 | 10 | Number of additional (redundant) samplesper frame | 0 |   0 … 15 | Number of samples to be repeated in the next frame | | 324 | 1 | 10 | Black out duration | 0 | 0 – 12 (h) | 0 : blackout feature disable ≠ 0 : blackout active, duration of daily black out. Unit Hour | | 325 | 1 | 10 | Black out start time | 22 | 0 – 23 (h) | Black out start time. Unit Hour | | 326 | 1 | 10 | VOC enable | 1 | 0-1 | If 1 : enable VOC measurement

VOC measurement can be disabled to save power. If VOC is disable (S326=0) the VOC measurement and alarm are disabled. “Periodic data frame (0x6F)”,”Alarms frame(0x70)”, “Daly frame(0x38)” change to “Periodic data frame (0x6A)”,”Alarms frame(0x6B)”, “Daily frame(0x30)” |

1.2.1 Black-out period

The device can daily suspend the sensor acquisition and associated processes, using the blackout parameters. When the blackout interval is entered:

When the blackout period is in progress:

1.2.2 CO2 Calibration registers

Register Size (bytes) Base Description Default Value Range (Min-Max) Comments
355 2 10 Calibration Reference Level 400

200-2000 | 0 ➔ Factory calibration [200-2000] ➔ use as target value when a calibration is performed | | 356 | 2 | 10 | Automatic calibration period | 1 |   0-65534 | 0: Automatic calibration deactivated 1: Automatic calibration activated with default period of 180 hours 2-65534: Automatic calibration period in hours | | 357 | 1 | 10 | Start of the calibration by pressing the button | 1 |   0-1 | 0: Deactivated 1: Activated |

1.3 Alarm registers

1.3.1 Temperature

Register Size (bytes) Base Description Default value Min-Max value Comments
330 1 10 Alarm type 0 (inactive) 0: Inactive
1: Low threshold
2: High threshold
3: Both thresholds
331 2 10 High threshold value 0 -200 … 600
(-20°C to +60°C) tenth of °C
332 1 10 High threshold hysteresis 0 0…255 tenth of °C
333 2 10 Low threshold value 0 -200 … 600
(-20°C to +60°C) tenth of °C
334 1 10 Low threshold hysteresis 0 0… 255 tenth of °C

1.3.2 Humidity

Register Size (bytes) Base Description Default value Min-Max value
340 1 10 Alarm type 0 (inactive) 0: Inactive
1: Low threshold
2: High threshold
3: Both thresholds
341 1 10 High threshold value 0 0 … 100
342 1 10 High threshold hysteresis 0 0 … 255
343 1 10 Low threshold value 0 0 … 100
344 1 10 Low threshold hysteresis 0 0 … 255

1.3.3 CO2 alarm and QAI indicator

Register Size (bytes) Base Description Default value Min-Max value Comments
350 1 10 Alarm / indicator type
2 (LED
indicator) 0: all inactive
1: Alarm activation 2: QAI Led indicator activation
3: Alarm + QAI Led activations
351 2 10 CO2 indicator, Orange LED, Medium threshold
1000
0 … 10 000 Unit ppm
Below this threshold it is a level
of CO2 considered as correct (Green LED)
352 2 10 CO2 indicator, Red LED, high threshold
1700
0 … 10 000 Unit ppm
Above this threshold it is a level of CO2 considered as bad (Red LED)
353 2 10 CO2 alarm threshold value 1300 400 … 10 000 Unit ppm
354 1 10 CO2 Highthreshold hysteresis
10
0 … 255
Unit ppm

Co2 alarm frame and CO2 “led” indicator are updated/evaluated each time a CO2 sensor measurement (sampling) is performed (according to S321 value, sampling period).

Note: CO2 LED indicator is not associated to an alarm frame.

These registers allow to update QAI led repetition period (i.e.: speeding up the led indication or decrease rate to optimize power consumption).

Register Size (bytes) Base Description Default value Min-Max value Comments Since V02.03.01
377 1 10 QAI green led repetition 10 1.. 60 Unit Minutes
378 1 10 QAI orange led repetition 1 1.. 60 Unit Minutes
379 1 10 QAI red led repetition 1 1.. 60 Unit Minutes

1.3.4 VOC alarm and parameters

| Register | Size (bytes) | Base | Description | Default value | Min-Max value | Comments | | --- | --- | --- | --- | --- | --- | --- | | 360 | 1 | 10 | VOC Alarm | 0 (inactive) | 0: Inactive 1: Active | Enable alarm for VOC | | 361 | 2 | 10 | VOC alarm High threshold value | 200 | 100 … 500 | Unit: Index value | | 362 | 1 | 10 | VOC High threshold hysteresis | 5 | 0 … 50 | Unit: Index value |

1.3.5 Digital inputs

Register Size (bytes) Base Description Default value Min-Max Value Comments
380 1 10 Button configuration
1 0 = Alarm OFF
1 = Alarm ON Only short press (<500ms) on the button is considered as an event Alarm.
381 2 10 Button threshold 1 1 … 65535 Number of detections before the alarm is triggered
382 1 16 Configuration of the digital input

0x00 (deactivated) | <7:4> Debounce duration 0: no debounce 1: 10 ms 2: 20 ms 3: 50 ms 4: 100 ms 5: 200 ms 6: 500 ms 7: 1 s 8: 2 s 9: 5 s A: 10 s B: 20 s C: 40 s D: 60 s E: 5 minutes F: 10 minutes

<3:0> Type 0 = Deactivated 1 = Event ON 0    = Event OFF 3 = Event ON/OFF | | | 383 | 2 | 10 | Digital input threshold | 1 | 1 … 65535 | Number of detections before the alarm is triggered | | 390 | 4 | 10 | Global counter for button |   0 |   0 – 4294967295 | Read Only In-RAM counter that counts the number of events detected on the channel

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 391 | 4 | 10 | Global counter for digital input |   0 |   0 – 4294967295 | Read Only In-RAM counter that counts the number of events detected on the channel

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore |

1.4 Radio registers

1.4.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
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 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
259 Channels Plan (US/AU 915 only) Decimal Default: 0
Min/max: 0 to 8
Select the Sub Band to use by the device during the Join phase (the same Sub Band supported by the GW).
0: the device uses all the supported channels: [0-63] in 125 kHz and [64-71] in 500 kHz
1: the device will use only Sub Band n°1. Use the channels [0-7] in 125 kHz and a channel [65] in 500 kHz.
…
8: the device will use only Sub Band n°8. Use the channels [56-63] in 125 kHz and 71 in 500 kHz.
CAUTION:
Using one Sub Band 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 using a value different to “0”, liability is trans-ferred to the user.
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: