|Project LoRaWAN dust Sensor|
|LoRaWAN airborne particulate matter sensor|
What is it?
The concept consists of:
- a sensor that measures airborne particulate matter and sends the measurement data using LoRaWAN to TheThingsNetwork (TTN)
- a forwarder application that collects the data from TTN and forwards it to sensor.community (formerly luftdaten), opensensemap, mycayenne dashboard, etc.
This has been done before by other people, but it appears there is no universal solution. I am publishing all source code on github and will put up documentation on this wiki. My concept uses Cayenne because it is the closest practical thing towards a universal format but still reasonably compact format.
A similar thing has been done by:
- TTN Ulm, see https://github.com/verschwoerhaus/ttn-ulm-feinstaub (the sensor code) and https://github.com/verschwoerhaus/ttn-ulm-muecke (the forwarder, in python)
One thing in particular that my concept does better than existing solutions is to use proper OTAA for the LoRa connection to TTN. OTAA means over-the-air-activation and is a mechanism to dynamically negotiate encryption keys and communication settings.
The OTAA key can be programmed and stored in the node (initially it has a working default key), the session keys exist only as long as the device is powered. Each node identifies itself by a DeviceEUI based on the built-in unique ESP32 serial number.
This makes it possible to have a *single* firmware image for all sensor nodes and it simplifies the setup:
- each node can be flashed with the same firmware
- the node shows its unique Device EUI on the OLED
- at the TTN console, you register the node with the unique Device EUI
- the sensor node receives encryption keys over the air automatically by OTAA
- migration from the v2 stack to the v3 stack of the TTN infrastructure is almost effortless on the node side (just a reboot)
- Implement a simple command set through LoRaWAN downlink commands, for example:
- a command to trigger an immediate reboot of the node
- Implement the ESP-Now lamp/display protocol, for easy visualisation, see https://revspace.nl/StofAnanas#Next_generation. This sends both the measured values (to show on a display) plus a color to indicate how 'bad' the situation is (to show on an RGB LED)
- Start the LoRaWAN OTAA procedure at a slower rate than SF7, so it doesn't take a long time before the node finally connects to the network if it's not close to a gateway -> tried this, didn't work, ADR algorithm of TTN is a black box ...
- Firmware update over WiFi:
- basic OTA-over-WiFi has been implemented, allows remote flashing from the development environment, not so user-friendly, not secure
- basic OTA-over-WiFi with a timeout, not so user-friendly, not very secure
- next step is to use the ESP32 as access point + web server, user-friendly (only a browser needed to upload firmware images), not very secure
- final step is to use the ESP32 as access point + web server, using signed images, this is user-friendly and secure
Useful links for the TTGO LoRa board:
- Example code that joins TTN by OTAA and saves the OTAA parameters
The node is based on the Arduino framework:
- for the processor board, either the TTGO ESP32 board ("ttgo-lora32-v1") or the Heltec LoRa32 V2 can be used.
- the particulate matter sensor is the SDS011, just like in the sensor.community project.
- the humidity/temperature sensor is the BME280 (superior to the DHT11/22).
|TTGO LoRa v1||Heltec LoRa v2||Sensor||Remark|
|5V||5V||SDS011 5V (pin 3)||triple-check this, swapping 5V/GND destroys the SDS011|
|GND||GND||SDS011 GND (pin 5)||triple-check this, swapping 5V/GND destroys the SDS011|
|GPIO23||GPIO23||SDS011 RXD (pin 6)|
|GPIO22||GPIO22||SDS011 TXD (pin 7)|
|3.3V||3.3V/Vext||BME280 3V||Both Vext and 3.3V can be used|
- NOTE: https://www.thethingsnetwork.org/community/berlin/post/warning-attention-users-of-ttgo21-v16-boards-labeled-t3_v16-on-pcb-battery-exploded-and-got-on-fire
Compile and upload the firmware
Source code is hosted on github:
- Arduino node, written in C/Arduino, built using platformio. This firmware joins TTN by OTAA and sends the measurement data using Cayenne.
- TTN-to-luftdaten forwarder, written in Java, built using gradle. This picks up the Cayenne encoded data and forwards it to the Luftdaten API.
On Linux, with platformio (the command line tool), instructions for Debian Linux are:
- install platformio:
sudo apt install python3-pip sudo pip3 install platformio pio update
- get the source from github:
- enter the correct directory:
cd LoraWanPmSensor cd Esp32PmSensor
- compile and upload (for TTGO LoRa32 v1 board):
pio run -e ttgov1 -t upload
or (for Heltec LoRa32 v2 board):
pio run -e heltecv2 -t upload
On Windows, with the Arduino IDE
- Install the Arduino IDE ...
- Get the ESP32 support package ...
- Install the following libraries
- mcci-catena/MCCI LoRaWAN LMIC library, version 3.3.0
- sparkfun/SparkFun BME280
- Set the target to either the TTGO LoRa32 v1 or Heltec LoRa32 v2
- Ctrl-U to compile and upload
My firmware uses the Cayenne LPP (low power payload) encoding.
It's reasonably compact, it's a standard format, you can get a preview of the data in the TTN console. Interacts nicely with other platforms.
Over-the-air payload encoding:
- 4 bytes: PM10: analog input (type 2), channel id 1, with value in units of 0.01 ug/m3, saturated to 327.67 ug/m3
- 4 bytes: PM2.5: analog input (type 2), channel id 2, with value in units of 0.01 ug/m3, saturated to 327.67 ug/m3
- 4 bytes: Temperature: temperature (type 103), with value in units of 0.1 degrees celcius
- 3 bytes: Humidity: humidity (type 104), with value in units of 0.5 %
Particulate matter concentrations higher than 327.67 ug/m3 are saturated to 327.67, this is the maximum that can be represented as analog value in Cayenne.
- 4 bytes: PM1.0: analog input (type 2), channel id 0, with value in units of 0.01 ug/m3, saturated to 327.67 ug/m3
- 4 bytes: Pressure: barometer (type 115), with value in units of 0.1 mbar, or 10 Pa (optional)
A nice thing about Cayenne is that you can simply leave items out if you don't support them, which results in a shorter yet still valid message.
0x01 0x01 0xXX 0xXX 0x02 0x01 0xYY 0xYY 0x03 0x67 0xTT 0xTT 0x04 0x68 0xHH <== PM10 value ===> <== PM2.5 value ==> <== temperature ==> <= humidity =>
Total payload size is 15 bytes. The LoRaWAN header adds 13 bytes (at least).
Particulate matter values encoded are averaged over the measurement interval.
Update: discovered that the Cayenne standard *does* actually support a "particle concentration" id, this is 125, derived from IPSO id 3325 http://www.openmobilealliance.org/tech/profiles/lwm2m/3325.xml . No idea yet though how to specify the type of particle measurement, if there's any convention for PM10, PM2.5, etc. The resolution is only 1 ppm, with typical sensors delivering 0.1 ppm resolution.
How other projects encode the data:
- TTN Apeldoorn (?): https://github.com/tijnonlijn/RFM-node/blob/master/dustduino_PPD42NS_example.ino#L327 sends 5 bytes
- 1 byte : 0x04
- 2 bytes: PM25(?) big endian
- 2 bytes: PM10(?) big endian
- TTN Ulm: https://github.com/verschwoerhaus/ttn-ulm-feinstaub/blob/master/ttnulmdust/ttnulmdust.ino#L225 sends 8 bytes:
- 2 bytes: PM10, big endian (unit 0.01 ug/m3)
- 2 bytes: PM2.5, big endian (unit 0.01 ug/m3)
- 2 bytes: humidity (unit of 0.01%)
- 2 bytes: temperature (unit of 0.01 degree Celcius)
- RIVM node, sends 20 bytes
- 1 byte temperature (unit deg Celcius ?)
- 1 byte relative humidity (unit % ?)
- 2 bytes pressure (unit?)
- 2 bytes pm10 (unit?)
- 2 bytes pm25 (unit?)
- 2 bytes op1 (unit?)
- 2 bytes op2 (unit?)
- 4 bytes latitude (unit?)
- 4 bytes longitude (unit?)
- Apeldoorn in data: https://github.com/nijmeijer/TTN_Apeldoorn_in_Data_2018/blob/master/AiD_Dust_2018/AiD_Dust_2018.ino#L184 sends 16 bytes:
- 4 bytes: pm2_5 float big endian (unit?)
- 4 bytes: pm10 float big endian (unit?)
- 4 bytes: humidity float big endian (unit?)
- 4 bytes: temperature float big endian (unit?)
A smaller payload means less time in the air, smaller chance of collision with other LoRaWAN packets and more packets per hour. However, there is always an overhead from the LoRaWAN package (minimum 13 bytes), so using the smallest encoding (5 bytes) compared to the largest (16 bytes), reduces the on-air-time by only 23%.
LoraWan time budget
The number of bytes per telemetry packet and the number of packets sent per day determine how much of the available "airtime" we use. TheThingsNetwork states a fair-use-policy of 30 seconds per day total uplink time.
Consider the following:
- radio regulations generally have a 1% duty cycle requirement for the two bands used by the 8 LoRaWAN (EU) frequencies, so according to the legal limits, there is about (86400s x 1% x 2bands) = 1728 seconds per day send time at the best case.
- TheThingsNetwork has a FUP of 30s of data upload per day. This is actually a *lot* more strict than allowed purely by radio regulations.
- The sensor.community backend runs on a 5 minute interval, or 288 measurements per day.
- The default sensor.community WiFi firmware sends new data every 145s by default
With the TTN FUP of 30s upload per day and 5 minute upload interval, we can spend 30s / 288 = 104 ms on each transmission.
Using the LoRaWAN airtime calculator we can determine which modes can be used. At 15 bytes payload, this is only possible at SF7, the highest LoRa speed. Stretching the TTN guideline a bit, say by a factor 2, we can achieve those transfers still only at SF7 and SF8. So you need to be relatively close to a gateway.
In terms of interval:
- SF7: payload 17 bytes -> 71.9 ms/transmission -> every 3m27s
- SF8: payload 17 bytes -> 123,4 ms/transmission -> every 5m55s
- SF9: payload 17 bytes -> 226,3 ms/transmission -> every 10m32s
- SF10: payload 17 bytes -> 452.6 ms/transmission -> every 21m43s
With a smaller payload, can we use higher spreading factors? :
- smallest possible binary payload is 4 bytes (PM10 and PM2.5, no temperature, no humidity): SF7 takes 51.5 ms, SF8 takes 92.7 ms, SF9 takes 164.9 ms
- smallest Cayenne payload is 8 bytes (PM10 and PM2.5, no temperature, no humidity): SF7 takes 56.6 ms, SF8 takes 102.9 ms, SF9 takes 185.3 ms
So, in conclusion: With the FUP of TTN and use of Cayenne encoding, you can just barely send enough data to transport PM data! Also note that the payload size does not actually differ *that* much, this is because of the LoRaWAN overhead of 13 bytes minimum and pre-amble symbols which are sent anyway.
Source code for the particulate matter measurement node can be found on the github page.
The luftdaten backend has a 5 minute "heartbeat", so at least one measurement per 5 minutes should be sent to avoid disappearing from the map. The node firmware (attempts to) send a message every 4m30s seconds, just like the luftdaten WiFi sensor. A little bit of randomness (30 s) is added to avoid nodes transmitting at exactly the same time over long periods of time and interfering with each other.
Measurements run in a cycle running through the following states:
- INIT: determine presence of the SDS011, print the SDS011 serial number
- IDLE: wait until the start of the cycle, then turn on the fan
- WARMUP: wait 20 seconds while the sensor "warms up"
- MEASURE: measure 10 seconds, then turn off fan, calculate median/average and send LoRaWAN message
Building with platformio
Platformio is used to compile and upload the code to the node.
To install platformio (example for Debian):
sudo apt install python3-pip sudo pip3 install platformio pio update
To compile and upload:
pio run -t upload
TTN key provisioning
The node needs to be registered at TheThingsNetwork, in order for its messages to be accepted by the TTN.
To keep things simple, there is no key provisioning for the nodes themselves. All nodes use the same firmware with the same APP EUI and the same APP KEY. The thing that makes each node unique is its DEVEUI, this is derived from the built-in unique ESP32 id.
On the TTN side, each node will have to be registered by its DEV EUI. The following scheme is used to make TTN provisioning as simple as possible:
- Each node can be programmed with the *same* software, no source code modification is required
- The node administrator needs to enter the following properties at the TTN console, for each node:
- The Device EUI is derived from the node-specific ESP32 MAC address, the node shows this on its OLED
- The App EUI has a fixed value and is the same for all nodes
- The App Key has a fixed value and is the same for all nodes
- Use 32-bit frame counter, leave frame counter checks enabled
The node uses a fixed App EUI and App key by default, but each node can also be configured to use a custom set of OTAA keys.
This is implemented by my LoraLuftdatenForwarder (source code).
It currently supports the following:
- Subscribes to a TTN MQTT stream and receives incoming messages, both TTN "v2" and "v3" stacks are supported.
- Decodes Cayenne and custom payloads.
- Forwards to luftdaten.info/sensor.community
- Forward to opensensemap.org, the opensensebox is automatically picked up from an attribute specified in the TTN v3 console.
Forward to feinstaub app (experimental), https://pm.mrgames-server.de/
To receive data using mosquitto, separately from the backend:
mosquitto_sub -h eu.thethings.network -p 1883 -t +/devices/+/up -u particulatematter -P ttn-account-v2.cNaB2zO-nRiXaCUYmSAugzm-BaG_ZSHbEc5KgHNQFsk
Example upstream data:
Example downstream data:
- packet decoder: https://lorawan-packet-decoder-0ta6puiniaut.runkit.sh/
- airtime calculator: ...