Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.95 KB

README.md

File metadata and controls

76 lines (57 loc) · 2.95 KB
Raw

Readme

Screenshot of the device in HomeAssistant

Code for running DIY AirGradient sensor. Modified from this original arduino code

Differences compared to original code:

  • A lot of overall code changes not individually listed
  • Pushes data to mqtt server instead of arigradient
  • Properly rotates the display (at least my unit had display rotated 180 degrees, this is easily adjustible)
  • Add human readable AQI value
  • PlatformIO/cpp support instead of Arduino IDE/ino format.
  • Implemented Home Assistant auto discovery
    • Sensor values are pushed to Home Assistant via MQTT and automatically discovered
    • Display can be turned on/off via Home Assistant
    • Sensor updates can be manually triggered via Home Assistant
  • Average values before sending to mqtt
  • Improved error handling/wifi reconnecting
  • Handle errorous sensor readings such as negative values or values that are not within the expected range for normal environment

How to use

Clone repo, modify src/config.h.example with your values and rename it to config.h, install dependencies, and build/deploy main.cpp

macOS

brew install platformio
git clone https://github.com/nikolak/mqtt-airgradient
cd mqtt-airgradient
cp src/config.h.example src/config.h
# edit src/config.h
pio run --environment d1_mini_lite
# if it compiles ok, deploy to device
pio run --target upload --environment d1_mini_lite
# you can monitor the device with this command:
pio device monitor --environment d1_mini_lite

Hardware used

I only have access to the following hardware, that I've used to test this code:

  • AirGradient DIY Pro PCB v3.3
  • Wemos D1 Mini v4
  • 1.3" OLED display (OLED #2 spot on the PCB, pre-soledered by AirGradient)
  • Plantower PMS5003
  • Senseair S8 CO2
  • SHT31

License

Copyright (c) 2022 AirGradient Copyright (c) 2023 Nikola Kovacevic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.