DustSensor

Project Dust Sensor
Experiments with a dust sensor
Status	Completed
Contact	bertrik
Last Update	2017-12-28

Introduction

I ordered a dust sensor module to perform measurements of airborne dust. In particular, I ordered this one, the Plantower PMS 7003, AliExpress link. It's being advertised as an advanced generation of dust sensor (7th generation), while still reasonably priced (E15,-). It uses lasers to perform the measurement and I think it contains a small fan to move the air around.

I recommend to also get the cable converter board. The pitch of the connector on the sensor module is slightly non-standard: 2 x 5 pins with a spacing of 0.05 inch (instead of the common 0.1 inch spacing).

Graph

Hardware

Data sheets can be found:

• here (english) and
• here (chinese)

The module takes 5V to run and communicates using 3.3V levels. This is a perfect match with an ESP8266 board like the Wemos D1 mini.

The module makes an estimate of the number of particles per size category, total 6 categories: 0.3-0.5-1.0-2.5-5.0-10 micrometer. It also gives an estimate of the total mass of the particles (microgram/m3) in 3 categories: PM1.0, PM2.5 and PM10, both for "standard particle" (CF-1) and "standard atmosphere". I don't know how it actually works on the inside and is able to make a distinction between particles of different size.

Connections

PMS7003	Wemos D1 mini	Remark
D1	TX	Wemos receive, PMS7003 transmit
D2	RX	Wemos transmit, PMS7003 receive
D3	RST	Pulled-up on Wemos side, not sure if actually needed
D4	SET	Pulled-up on Wemos side, not sure if actually needed
GND	GND
5V	Vcc

Special thanks to Crashjuh for helping with the cable, putting dupont connectors on them, making it a lot easier to connect the module to an ESP8266.

Software

The software archive can be found at github. Reading measurements works, sending commands to the module does not. I don't know yet whether this is a hardware or software problem.

Typing 'make' builds and runs unit tests that verify parsing of measurement data and construction of command data. The sub-directory 'pms7003_esp' contains the .ino file to be opened in the Arduino IDE.

Libraries used:

• SoftwareSerial for serial communication with the sensor
• WiFiClient for WiFi connectivity
• WiFiManager to present a captive portal and allow selection of an AP to connect to the internet
• PubSubClient to handle publishing of data over MQTT

This dust sensor outputs its data as a 32-byte serial data stream at 9600 bps.

Protocol outgoing data

The protocol for measurement data from the module is that data is sent in frames. Each frame starts with specific begin marker bytes, then a length byte, then the actual data, and finally a checksum. I think it is a good match to use a simple finite state machine to parse the stream and get synchronized to the frames.

Protocol

Value	Meaning	Remark
0x42 0x4D	Begin marker	ASCII for characters 'B' and 'M'
0x00 0x1C	Length	Length of following data
XX YY	PM1.0 concentration (ug/m3)	CF=1, standard particles
XX YY	PM2.5 concentration (ug/m3)	CF=1, standard particles
XX YY	PM10 concentration (ug/m3)	CF=1, standard particles
XX YY	PM1.0 concentration (ug/m3)	in atmospheric environment
XX YY	PM2.5 concentration (ug/m3)	in atmospheric environment
XX YY	PM10 concentration (ug/m3)	in atmospheric environment
XX YY	Number of particles >0.3 um	in 0.1 liter air
XX YY	Number of particles >0.5 um	in 0.1 liter air
XX YY	Number of particles >1.0 um	in 0.1 liter air
XX YY	Number of particles >2.5 um	in 0.1 liter air
XX YY	Number of particles >5.0 um	in 0.1 liter air
XX YY	Number of particles >10 um	in 0.1 liter air
VV	Version number	?
EE	Error code	?
C1 C2	Check code	basically the sum of all bytes up to the check code

Data is encoded in big-endian format.

Protocol incoming data

This protocol allows commands to be sent to the module, also in frames. Each command frame consists of 7 bytes. It starts with two marker bytes, then a command byte, two data bytes and finally two checksum bytes.

Command Protocol

Value	Meaning	Remark
0x42 0x4D	Begin marker	ASCII for characters 'B' and 'M'
CC	Command	0xE1, 0xE2 or 0xE4
HH LL	Data	Depends on command
C1 C2	Check code	basically the sum of all bytes up to the check code

References

Page on aqicn about the PMS5003/7003

List of dust sensors:

• list of sensors from "samen meten aan luchtkwaliteit".
• another overview of dust sensors.

Citizen science projects for measuring ultra fine dust:

• Dutch RIVM air quality measurement project
• Belgian project "ik adem" - fijnstofmetingen
• German project luftdaten - measure air data by yourself

Dust measurement blog:

• scapeler

Making graphs of dust data

To create nice graphs, I used the following stack of tools/applications:

• a dust sensor, as described here, that publishes measurement data towards an MQTT server
• an MQTT server to accept the data and forward it to subscribers
• the 'Telegraf' importer that listens on the MQTT stream and converts the data to influx database
• an influx database, to store the measurement data
• grafana, to grab the data from the database and display it

Sensor

An important thing to consider, is to omit the any unit from the measurement values in MQTT, so the published value can be parsed as an integer/float. So, use '10' instead of '10 ug/m3', for example.

Telegraf

Things I did:

• downloaded and installed the Telegraf .deb from here.
• generated a default configuration using:

  telegraf --input-filter mqtt_consumer --output-filter influxdb config >telegraf.conf

• edited the configuration to set mqtt and influxdb settings
  • influxdb output plugin
    • urls = ["http://172.29.0.1:8086"]
  • mqtt_consumer plugin
    • topics=[ "bertrik/pms7003/#" ]
    • data_format="value"
    • data_type="integer"
• test-run using 'telegraf <TODO>'
• copied the final telegraf.conf to /etc/telegraf and restarted the telegraf service

  systemctl restart telegraf

Grafana

Add a data source, pointing to the influx DB. Provide credentials and verify by pressing the 'test connection' button.

Add a dashboard, add a row to the dashboard, add a graph panel to the row. Under 'metrics', add a query with the following properties:

• FROM mqtt_consumer WHERE topic = bertrik/pms7003/PM10
• SELECT field(value)
• GROUP BY
• ALIAS BY PM10
• repeat for other particle sizes (PM1.0 and PM2.5)