Breath_Technical_Reference_Manual_APP_2.4.0.pdf

<aside> 💡 Applicable to APP versions: >= 2.4.x

</aside>

DOCUMENTATION GUIDE

TABLE OF CONTENTS

• TABLE OF CONTENTS

REGISTERS

1.1 Generic registers

1.2 Applicative registers

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 |

1.3 Alarm registers

1.3.1 TVOC

1.3.2 PM10

1.3.3 PM2.5

1.3.4 PM1

1.4 Daily Frame

1.5 Digital inputs

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

|

1.6 Radio registers

1.6.1 LoRaWAN Network Registers

1.3.1 LoRaWAN Network Registers

| --- | --- | --- | --- |

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:

• APP_EUI identifier for global use (provided by default by Adeunis)
• APP_KEY device application key (provided by default by Adeunis)

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:

• NWK_sKEY network session key (provided by LNS)
• APP_KEY applicative session key (provided by LNS)
• DEVICE ADDRESS Address of the device in the network (provided by LNS)

| --- | --- | --- | --- | --- | --- | --- | --- |

1.6.2 Sigfox Network Registers

1.7 Coherency check

A configuration coherency check is made at the time of the backup. Cases where backups are refused because considered as inconsistent:

| --- | --- |

RADIO PROTOCOL

Data with size greater than 1 byte will be transmitted MSB first. In LoRaWAN, frames are sent on port 1.

2.1 Status byte

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:

• AppFlag1: configuration inconsistency o Samples lost in periodic data frame because the payload is not sufficient.
• AppFlag2: sensor error o Error reading a sensor. o Poor sensor health status. o This bit is reset after each sending of a periodic frame.

2.2 Uplink Frame format

2.2.1 Product configuration (0x10)

This frame is sent following the reception of a frame with code 0x01, or at the start of the product.

| --- | --- | --- |

Decoding example:

| --- | --- | --- |