|Project LoRaWAN dust Sensor|
|LoRaWAN airborne particulate matter sensor|
The idea is to create a system consisting of:
- a sensor that measures airborne particulate matter and sends the measurement data using LoRa to TheThingsNetwork.
- a forwarder application that collects the data from TTN and forwards it to luftdaten.info
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. Everyone invents their own payload format, something more universal like Cayenne LPP would be nice. However I could not find a way to encode particulate matter data using Cayenne, so I'll just invent my own payload format too.
This 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 I'd like to do 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 communication/encryption keys instead of programmed specifically in each sensor node. Once the OTAA is done successfully, the node remembers device address, session keys, etc for future communication.
This makes it possible to have a single firmware image for all sensor nodes and it simplifies the setup:
- you flash the node with a unified firmware
- the node shows its unique id on the OLED
- at the TTN console, you register a new device with the unique id
- the sensor node receives encryption keys over the air automatically
- Investigate failing re-joins that seem to happen sometimes after the node has been online for a while
- Implement a kind of schedule: turn the sds011 on, wait some time, take a measurement, turn it off, wait for some time
- make this match the TTN send schedule? it's useless to do a measurement if we don't have TTN airtime to transmit it
- Finish the Java software (MQTT listener, payload decoder, luftdaten forwarder)
- I don't know what kind of id I can use towards Luftdaten, the regular convention is "esp8266-XXXX", where XXXX is the unique ESP id, but obviously my node is not an ESP8266.
Useful links for the TTGO LoRa board:
- Example code that joins TTN by OTAA and saves the OTAA parameters
The node is based on Arduino, in particular a TTGO ESP32 board with onboard SX1276 LoRa chip. The sensor is an SDS-011, just like in the luftdaten project. For humidity/temperature, I'd like to use a BME280.
Luftdaten uses a cycle time of 145 seconds for the SDS011.
Proposed hardware connections:
- SDS011 5V to ESP32 5V
- SDS011 GND to ESP32 GND
- SDS011 TXD to ESP32 GPIO35 (maybe I can find two suitable pins close together)
- SDS011 RXD to ESP32 GPIO25 (maybe I can find two suitable pins close together)
- BME280 3V todo
- BME280 SDA todo
- BME280 SCL todo
- BME280 GND todo
Source code is hosted on github:
- Arduino node, written in C/Arduino, built using platformio
- TTN-to-luftdaten forwarder, written in Java, built using gradle
Proposed structure of packets transferred over LoRa:
- PM10 value, encoded in units of 0.1 ug/m3: 2 bytes, big endian
- PM2.5 value, encoded in units of 0.1 ug/m3: 2 bytes, big endian
- temperature, encoded in units of 0.1 deg C: 2 bytes, signed big endian
- relative humidity, encoded in units of 0.1%, 2 bytes, big endian
Total: 8 bytes
Not present value is 0xFFFF. Encoding is big endian.
Would be nice to use Cayenne for this, but I don't know if Cayenne has an id for particulate matter.
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: P10 (?) big endian (unit 0.01 ug/m3)
- 2 bytes: P25 (?) 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
- 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?)
Source code for the particulate matter measurement node can be found on the github page.
To compile and upload the code to the node, platformio is used.
To install platformio (example for Debian):
sudo apt-get install python-pip sudo pip install platformio pio update
To compile and upload:
pio run -t upload
The function of the node software is to collect data from the SDS011 (particulate matter) and BME280 (temperature/humidity) at regular intervals, encode this as a data packet and send it over LoRaWAN towards TheThingsNetwork.
For the LoRaWAN data connection, over-the-air activation (OTAA) is used. I use the following scheme, to keep administration to a minimum:
- The Device EUI is derived from the ESP32 MAC address, the node shows this on its OLED
- The App EUI is generated in the TTN console, it is the same for all nodes
- The App Key is generated in the TTN console, it is the same for all nodes
- The device is registered in the TTN console by the Device EUI (this doesn't happen automatically). Frame counter checks are disabled.
- OTAA is done only once for each node. After that, the OTAA parameters are stored in (simulated) EEPROM.
- A long press on the PRG button restarts the OTAA procedure
- OTAA progress is shown on the OLED
- If OTAA has been done successfully, the node restores the session parameters negotiated during OTAA on next bootup, so it can quickly resume sending data.
- I'm NOT saving the upload frame counter (this would be preferable), just disable the feature in the TTN console.
TODO to figure out:
- What about the channel setup? The node connects using 3 frequencies, but receives a bigger list of frequencies during OTAA JOIN.
I've seen the following from the node, receiving an ADR:
40829907: engineUpdate, opmode=0x8 40829935: EV_TXSTART 40829939: engineUpdate, opmode=0x888 40830013: TXMODE, freq=868300000, len=25, SF=11, BW=125, CR=4/5, IH=0 40944876: setupRx1 txrxFlags 0x22 --> 01 start single rx: now-rxtime: 5 40945013: RXMODE_SINGLE, freq=868300000, SF=11, BW=125, CR=4/5, IH=0 rxtimeout: entry: 40951170 rxtime: 40945001 entry-rxtime: 6169 now-entry: 5 rxtime-txend: 63524 41005584: setupRx2 txrxFlags 0x1 --> 02 start single rx: now-rxtime: 4 41005720: RXMODE_SINGLE, freq=869525000, SF=9, BW=125, CR=4/5, IH=0 41017003: process options (olen=0x5) 41017012: LinkAdrReq: p1:11 chmap:00ff chpage:00 uprt:01 ans:86 41017019: ??ack error ack=1 txCnt=0 41017073: decodeFrame txrxFlags 0x2 --> 22 41017312: Received downlink, window=RX2, port=-1, ack=1, txrxFlags=0x22 41017708: EV_TXCOMPLETE (includes waiting for RX windows) 41018027: engineUpdate, opmode=0x800
A Java program subscribes to the MQTT stream, decodes the telemetry packets and forwards them to the luftdaten API. There is no storage of measurement data in the Java application.
To receive data using mosquitto:
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: