Version 2.1 (2022-23-02)

This document describes the downlink possibilities of the IoT SoundSensor, and also contains the encryption and decryption-logic in Javascript.
Tip: Press [F12] and watch console for detailed info.

Examples in the source of this page: This document contains several functions that are copied from our working codebase. Because your local telecom provider probably differs from KPN Telecom (Dutch), you can use it as pseudo-code.

• Pseudo code for transmitting KPN downlink message (Dutch telecom provider)
• Pseudo code for composing settings downlink message
• Pseudo code for validating ACK uplink message
• Parsing example of the settings uplink message

There are two downlink possibilities: transmit settings to the IoT SoundSensor and request settings from the IoT SoundSensor. After transmitting an uplink, the sensor opens a window to receive a downlink. Be aware that it can take 1 LoRa transmission interval length before the sensor can receive a downlink.

Transmit settings
After the sensor receives the settings, the sensor transmits an ACK uplink message (acknowledgement). This ACK message contains a CRC value. This value is calculated by the sensor and based on its current settings. You should use this CRC value to validate if your downlink configuration attempt succeeded.
The CRC value calculation: Polynomial is 0x8005 (Koopman calls this ANSI-16 0xC002), see Javascript for example.

The settings payload format (14 bytes):

byte index	value
0	message type (0x03)
1	ADR on/off (0x00/0x01)
2	Spreading factor
3	correction (-6.0 - 6.0, transmitted as byte)
4	GPS Mode: OFF (0x00), ONCE (0x01), INTERVAL (0x02)
5 - 8	GPS interval in ms (3600000 - 43200000) Little Endian
9	sample count
10 - 13	transmit interval in ms (60000 - 3600000) Little Endian
14	LED bit, Headphone bit, Transmission time sync bit, Message Info bit, Bat bit, First Timestamp bit, Last Timestamp bit, LAF bit
15	LAS bit, LCF bit, LCS bit, LAeq bit, LCeq bit, LAmax bit, LAmin bit, LCmax bit
16	LCmin bit

The ack payload format (3 bytes):

byte index	value
0	message type (0xC0)
1 - 2	CRC value

Request settings
After the sensor receives the settings request, the sensor transmits its settings.

The request payload format (1 byte):

byte index	value
0	message type (0x02)

The settings payload format (14 bytes, same as transmit message):

byte index	value
0	message type (0x80)
1	ADR on/off (0x00/0x01)
2	Spreading factor
3	correction (-6.0 - 6.0, transmitted as byte)
4	GPS Mode: OFF (0x00), ONCE (0x01), INTERVAL (0x02)
5 - 8	GPS interval in ms (3600000 - 43200000) Little Endian
9	sample count
10 - 13	transmit interval in ms (60000 - 3600000) Little Endian
14	LED bit, Headphone bit, Transmission time sync bit, Message Info bit, Bat bit, First Timestamp bit, Last Timestamp bit, LAF bit
15	LAS bit, LCF bit, LCS bit, LAeq bit, LCeq bit, LAmax bit, LAmin bit, LCmax bit
16	LCmin bit