Python script and Prometheus exporter for Sharp GP2Y1051AU0F Dust Sensor

The device will keep sending 1 bytes of serial data every 10ms.

AA 00 02 00 61 63 FF AA 00 02 00 61 63 FF AA 00 02 00 61 63 FF AA 00 02 00 61 63 FF AA 00 02 00 61 63 FF ... ...

The useful data chunk is formatted as AA 00 02 00 61 63 FF where AA represents the begining byte, FF represents the ending byte.

Second byte 00 is the Vout high Vout(H), third byte 02 is the Vout low Vout(L). Sixth byte 63 is the checksum of the sum of second to fifth byte. The rest of the bytes will not be used.

To caculate checksum, we can take AA 00 02 00 61 63 FF for an example: 63 = 00 + 02 + 00 + 61

Disclaimer: The the way of caculation is searched from the internet, it might be not correct

Vout = (Vout(H) * 256 + Vout(L)) / 1024 * 5

Vout(H) and Vout(L) need to be converted to decimal format first

Given the data chunk AA 00 02 00 61 63 FF, we get:

Vout(H) = 00 in Hex = 0 in decimal

Vout(L) = 02 in Hex = 2 in decimal

So Vout = (0 * 256 + 2) / 1024 * 5 = 0.0097

Ud = K * Vout Where Ud represents the dust density (ug/m3)

if K = 700, then Ud = 700 * 0.0097 = 6.79 (ug/m3)

K represents a specific coefficient for the GP2Y1051AU0F dust sensor. The value of K may vary, since Sharp doesn't indicate any specific value. This K value is from the internet search, so it might be not correct or accurate.

Please set K value in settings.txt as you like.

Before run the script, please copy settings.txt.example to settings.txt and edit this file as you like.

You can import this as the package or call it locally

$ python airq/airq.py

if you execute the run.py, it will start a web engine with prometheus exporter on https://0.0.0.0:5000/metrics