Breath_Technical_Reference_Manual_APP_2.4.0.pdf
<aside> đź’ˇ Applicable to APP versions: >= 2.4.x
</aside>
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 send/receive UL/DL. |
Register | Size (bytes) | Base | Description | Default value | Min-Max Value | Comments |
---|---|---|---|---|---|---|
300 | 1 | 10 | Daily Frame | |||
1 | 0: Disable | |||||
1: Daily transmission | ||||||
1: Daily frame sent every 24H | ||||||
301 | 2 | 10 | Transmit period of data |
1 → 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. NOTE: for Sigfox only 0 or 1 is tolerated. | | 308 | 4 | 16 | LED activity | 0x0394007F | 0 … 0xFFFFFFFF | Default: 0x0394007F Other values: reserved | | 320 | 2 | 10 | History period | 600 (10 minutes) | 60 ... 3600 | History logging period in seconds | | 321 | 1 | 10 | Alarm repetition activation | 0 | 0 ... 1 | If an alarm is active, this register allows the product to send periodically a reminder. 0: disabled 1: enabled | | 322 | 2 | 10 | Alarm repetition period | 600 (10 min) | 60 ... 3600 | Alarm repetition period in seconds | | 323 | 1 | 10 | Number of additional (redundant) samplesper frame |  0 |  0 ... 5 | Number of samples to be repeated in the next frame  Sigfox: do not use, not enough space |
Register | Size (bytes) | Base | Description | Default value | Min-Max value | Comments |
---|---|---|---|---|---|---|
330 | 1 | 10 | Alarm type | 0 | 0: Alarm disabled | |
1: Alarm enabled | ||||||
331 | 2 | 10 | Threshold value | 0 | 0 … 65535 | Unit µg/m3 |
332 | 2 | 10 | Threshold hysteresis | 0 | 0 … 65535 | Unit µg/m3 |
Register | Size (bytes) | Base | Description | Default value | Min-Max value | Comments |
---|---|---|---|---|---|---|
340 | 1 | 10 | Alarm type | 0 | ||
(inactive) | 0: Inactive | |||||
1: Active | ||||||
341 | 2 | 10 | Threshold value | 0 | 0 … 65535 | Unit µg/m3 |
342 | 2 | 10 | Threshold hysteresis | 0 | 0 … 65535 | Unit µg/m3 |
Register | Size (bytes) | Base | Description | Default value | Min-Max value | Comments |
---|---|---|---|---|---|---|
350 | 1 | 10 | Alarm type | 2 | 0: all disabled | |
1: Alarm enabled | ||||||
2: Led indicator enabled | ||||||
3: Alarm and Led indicator enabled | ||||||
351 | 2 | 10 | Threshold value | 0 | 0 … 65535 | Unit µg/m3 |
352 | 2 | 10 | Threshold hysteresis | 0 | 0 … 65535 | Unit µg/m3 |
353 | 2 | 10 | PM2.5 indicator, orange, medium threshold | 10 | 0 … 65535 | Unit µg/m3 |
354 | 2 | 10 | PM2.5 indicator, Red LED, highthreshold | 25 | 0 … 65535 | Unit µg/m3 |
Register | Size (bytes) | Base | Description | Default value | Min-Max value | Comments |
---|---|---|---|---|---|---|
360 | 1 | 10 | Alarm type | 0 | 0: Alarm disabled | |
1: Alarm enabled | ||||||
361 | 2 | 10 | Threshold value | 0 | 0 … 65535 | Unit µg/m3 |
362 | 2 | 10 | Threshold hysteresis | 0 | 0 … 65535 | Unit µg/m3 |
Register | Size (bytes) | Base | Description | Default value | Min-Max value | Comments |
---|---|---|---|---|---|---|
370 | 2 | 10 | TVOC threshold for the alarm duration measured in the daily frame | 600 | 0 … 65535 | Unit µg/m3 |
371 | 2 | 10 | PM10 threshold for the alarm duration measured in the daily frame | 50 | 0 … 65535 | Unit µg/m3 |
372 | 2 | 10 | PM2.5 threshold for thealarm duration measured in the daily frame | 25 | 0 … 65535 | Unit µg/m3 |
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 2 = 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
|
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:
| --- | --- | --- | --- | --- | --- | --- | --- |
A configuration coherency check is made at the time of the backup. Cases where backups are refused because considered as inconsistent:
| --- | --- |
Data with size greater than 1 byte will be transmitted MSB first. In LoRaWAN, frames are sent on port 1.
All frames sent by the product contain a status byte. Its format is identical for all IoT Adeunis products.
| --- | --- | --- | --- | --- | --- | --- |
The status byte provides two bits reserved for a specific use of each product (AppFlag1 and AppFlag2). For this product:
This frame is sent following the reception of a frame with code 0x01, or at the start of the product.
| --- | --- | --- |
Decoding example:
| --- | --- | --- |