Git Product home page Git Product logo

airgradient-prometheus-sensor's Introduction

AirGradient Prometheus Arduino Server for ESP8266

Build your own low cost air quality sensor with optional display measuring PM2.5, CO2, Temperature and Humidity.

This sketch makes it easy for prometheus to read the sensor data from the Plantower PMS5003 PM2.5 sensor, the Senseair S8 and the SHT30/31 Temperature and Humidity sensor. Visit our DIY section for detailed build instructions and PCB layout.

https://www.airgradient.com/diy/

How To Use

By default, all 3 sensors are enabled. If you are planning to not use one of them, make sure you disable the correct sensor in the sketch by changing true to false.

Make sure you change your SSID and password, that way you can connect to it from your prometheus server. You may want to assign it a static ip from your router.

Verify that your ESP8266 is working by using curl to verify the response. It should look something like this:

$ curl http://your-ip:9926/metrics
# HELP pm02 PM2.5 Particulate Matter Concentration (ug/m^3)
# TYPE pm02 gauge
pm02{id="AirGradient",mac="00:11:22:33:44:55"} 6

# HELP rc02 CO2 Concentration (ppm)
# TYPE rc02 gauge
rco2{id="AirGradient",mac="00:11:22:33:44:55"} 862

# HELP atmp Ambient Temperature (*C)
# TYPE atmp gauge
atmp{id="AirGradient",mac="00:11:22:33:44:55"} 31.6

# HELP rhum Relative Humidity (%)
# TYPE rhum gauge
rhum{id="AirGradient",mac="00:11:22:33:44:55"} 38

# HELP wifi WiFi Signal Strength (dBm)
# TYPE wifi guage
wifi{id="AirGradient",mac="00:11:22:33:44:55"} -69

If a sensor is disabled or non-functional, it's respone will look like the following:

# ERROR pm02 encountered an error, or the result was out of range `0`
# ERROR rc02 encountered an error, or the result was out of range `(disabled)`

License

See LICENSE.md.

Authors

AirGradientHQ, Jordan Jones, Bradan J. Wolbeck

airgradient-prometheus-sensor's People

Contributors

airgradienthq avatar boomacoh avatar compaqdisc avatar kashalls avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.