|
2 | 2 |
|
3 | 3 | ESPHome yaml files for an AirGradient DIY devices to send data to HomeAssistant and AirGradient servers while maintaining a similar functionality and look to the official AirGradient Arduino IDE sketch |
4 | 4 |
|
| 5 | +## Features |
| 6 | + |
| 7 | +- Button to initate a SenseAir S8 CO2 Calibration on demand |
| 8 | +- Buttons to enable or disable SenseAir S8 CO2 sensor Automatic Baseline Calibration (ABC) |
| 9 | +- Button to view the current S8 ABC interval (confirm if ABC is disabled or enable, which defaults to every 7 days) |
| 10 | +- Switch to disable LED output on AirGradient ONE model |
| 11 | +- Brightness slider to adjust intensity of AirGradient ONE LED |
| 12 | +- Switch to toggle display between Fahrenheit and Celsius and persist between reboots |
| 13 | +- Switch to enable or disable uploading to AirGradient Dashboard via API (Choose to keep data local or also send to AirGradient) |
| 14 | +- Utilize hardware configuration buttons on AirGradient Pro v3.7 and higher |
| 15 | + - Short press (Less than 1 second) - Toggle between F and C on display |
| 16 | + - Long press (More than 1 second, less than 5) - Trigger manual CO2 calibration |
| 17 | + |
5 | 18 | ## Configuration |
6 | 19 |
|
7 | | -If all original sensors (PMS5003, Senseair S8, SHT3x) are connected, airgradient-basic.yml should be fully ready |
| 20 | +If all original sensors (PMS5003, Senseair S8, SHT4x) are connected, configuration files should be ready |
8 | 21 | If some sensors are not installed, comment or remove the associated sections in sensor: and display: and http_request.post: |
9 | | -Code supports TVOC readings from SGP30 sensor, but in testing, when used with the Basic board, it required being connected to 3.3v instead of 5v as wired on the AirGradient board. Also does not appear to work if the OLED display is connected, but works if display is physically removed. |
10 | 22 |
|
11 | | -To add your wifi SSID and password, either remove the "!secret" section and type in your information, or edit the secrets.yaml file with |
12 | | -your information so it is not hard coded into the device's file. |
| 23 | +To add your wifi SSID and password, add your SSID and password information, per ESPHome specifications |
| 24 | + |
| 25 | +```yaml |
| 26 | +wifi: |
| 27 | + ssid: NachoWiFi |
| 28 | + password: 123456123456 |
| 29 | +``` |
13 | 30 |
|
14 | 31 | ## Installation |
15 | 32 |
|
16 | 33 | Copy the .yaml files and any associated fonts or secrets.yaml files to the config folder in your ESPHome installation. |
17 | 34 |
|
18 | | -Alternatively, save the .bin file and go to [https://web.esphome.io/](https://web.esphome.io/) in your browser to connect your ESP device and sent the .bin file to it, without having ESPHome installed |
| 35 | +Alternatively, save the .bin file and go to [https://web.esphome.io/](https://web.esphome.io/) in your browser to connect your ESP device and send the .bin file to it, without having ESPHome installed |
19 | 36 |
|
20 | | -## Fonts |
| 37 | +## Todo list |
21 | 38 |
|
22 | | -You may substitute any font as desired. Included font "Liberation Sans" is open source and very similar to Arial that is |
23 | | -used by the official AirGradient Arduino sketch |
| 39 | +Several more features are planned to be added to this repo |
24 | 40 |
|
25 | | -Future configurations will begin using fonts downloaded directly from Google's servers so they will not need to be present in the same folder as the .yaml files |
| 41 | +- Support for Open Air without CO2 sensor |
| 42 | +- Explore options for disabling display/LED during certain times (May be deffered to HomeAssistant Automations) |
| 43 | +- Switches to enable/disable desired display pages |
| 44 | +- Add Display page to show all relevant information in a single page |
| 45 | + - https://forum.airgradient.com/t/airgradient-one-customized-mallocarray-esphome-display/1328 |
| 46 | +- Standardize font on AirGradient Basic display to match Pro |
| 47 | +- Add GitHub actions to automatically build updated .bin files as needed |
0 commit comments