Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Latest commit

 

History

History
77 lines (54 loc) · 2.85 KB

README.md

File metadata and controls

77 lines (54 loc) · 2.85 KB
Raw

My Fork: Display Tweaks

  • Display SSID and IP after connection established
  • Reduced font size and nicer display:
                   TMP -> Temp.
                   HUM -> Humidity
                     C -> °C
  Waiting to connect.. -> Waiting for WiFi

The original repository README continues below

AirGradient - Prometheus WiFi Sketch

AirGradient has a DIY air sensor. I built one (actually, more than one). I want to integrate sensor data into my in-home Prometheus instance and graph the data in Grafana.

So I built this.

How it Works

If you're using the official AirGradient Arduino sketch (C02_PM_SHT_OLED_WIFI), you can configure it to enable WiFi and send data to a remote server every 9 seconds (as it cycles through the display of PM2.5, CO2, temperature, and humidity values).

By default, it sends a small JSON payload to AirGradient's servers, and you can monitor the data via their service.

This sketch provides stats upon request to the prometheus server during scrapes. By changing the deviceId in this sketch, you can easily probe multiple AirGradient DIY sensors from Prometheus.

How to Use

First, edit the configuration options in the Config section of AirGradient-DIY.ino to match your desired settings.

Make sure you enter the SSID and password for your WiFi network in the relevant variables, otherwise the sensor won't connect to your network.

Make sure you have the "AirGradient" library installed (in Arduino IDE, go to Tools > Manage Libraries...).

Upload the sketch to the AirGradient sensor (instructions here) using Arduino IDE, make sure it connects to your network, then test connecting to it by running this curl command:

$ curl http://airgradient-ip-address:9926/metrics
# HELP pm02 Particulate Matter PM2.5 value
# TYPE pm02 gauge
pm02{id="Airgradient"}6
# HELP rco2 CO2 value, in ppm
# TYPE rco2 gauge
rco2{id="Airgradient"}862
# HELP atmp Temperature, in degrees Celsius
# TYPE atmp gauge
atmp{id="Airgradient"}31.6
# HELP rhum Relative humidity, in percent
# TYPE rhum gauge
rhum{id="Airgradient"}38

Once you've verified it's working, configure Prometheus to scrape the sensor's endpoint: http://sensor-ip:9926/metrics.

Example job configuration in prometheus.yml:

scrape_configs:
  - job_name: 'airgradient-bedroom'
    metrics_path: /metrics
    scrape_interval: 30s
    static_configs:
      - targets: ['airgradient-ip-address:9926']

Static IP address

You can configure a static IP address for the sensor by uncommenting the #define staticip line and entering your own IP information in the following lines.

License

MIT.

Authors