Giter Site home page Giter Site logo

airgradienthomeassistant's Introduction

AirGradientHomeAssistant

CI

Publish AirGradient to Home Assistant through MQTT

Based on the work done by https://www.airgradient.com/diy/ and https://github.com/ChaseCares/AirGradient-InfluxDB

Getting Started, the terminal way

  • Install arduino-cli
  • make init

Now, copy DeviceConfig.hpp.template into DeviceConfig.hpp and configure the stuff: cp ./DeviceConfig.hpp.template ./DeviceConfig.hpp

Then, compile it: make compile

Finally, upload it: make upload (you can only use make upload, as it automatically compile)

Getting Started, the visual way

Step 0 | Prerequisites

  • Assemble the AirGradient device - Instructions here
  • Install Arduino - Download here
  • Download this repository - Click the green “Code” button and then “Download ZIP”
  • Unzip the folder, navigate to the AirQualityMonitor and copy the example config file. Paste it into the same directory and rename it DeviceConfig

Step 1 | Settting up Arduino

Add ESP8266 platform information.

  • Open the Arduino sketch file. Then open the Preferences menu, and add http://arduino.esp8266.com/stable/package_esp8266com_index.json to Additional Board Manager URLs Image
  • Open the Board Manager and search for and install: esp8266 by ESP8266 comunity Image
  • Load the board preferences by navigating to Tool -> Board: -> ESP8266 Boards, then select LOLIN(WEMOS) D1 R2 & mini Image

Add the required libraries.

  • Open library manager, search for and install: AirGradient Air Quality Sensor Image

If only using sensors, with no connectivity skip to step two

  • Search for and install: AirGradient Air Quality Sensor by AirGradient Image
  • Search for and install: ESP8266 and ESP32 OLED driver for SSD1306 displays by ThingPulse Image

Only needed if you enable MQTT

  • Search for and install: home-assistant-integration by Dawid Chyrzynski Image You will be asked if you would like to install dependencies, select Install all Image

Step 2 | Configuration

Navigate to DeviceConfig.hpp tab and enable any features you would like to use. Then fill out their corresponding credentials.

Once customization is complete, plug the device (esp8266) into your computer then click upload.

airgradienthomeassistant's People

Contributors

michaelbitard 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.