Releases: MallocArray/airgradient_esphome
2.0.0
Breaking Changes
In the 2.x release of these configurations, some breaking changes are introduced
- See previous 1.x release breaking changes if coming from earlier versions
- Changed
name_add_mac_suffixto false by default. This will no longer add the MAC address to the end of the device name. Assists ESPHome in properly detecting new device as Online without a static IP. Can be changed totrueif desired. Ensure all devices have uniquename:fields iffalse. - Changed the variable names in the
substitutions:section to have them match the ESPHome parameters they are used with. - Changed to
config_version:substitution name for a shorter name - Disabled Upload to AirGradient Dashboard by default, but able to flip the switch in HomeAssistant to enable if desired
Changes
- Added Display Contrast slider to dim the display
- Added device_class to the PMSx005 sensors to have them properly reflect in the HomeKit integration if supported (Forum Link)
- Added optional Factory Reset switch that is disabled by default. Can be enabled in HomeAssistant and used if desired
- Added optional
diagnostic.yamlpackage with extra sensors about the ESP device itself, including temperature and free - Added optional
sensor_bme680.yamlpackage to support the BME680 module if desired - Added
dashboard_importto assist discovery of new devices installed with the pre-compiled .bin files
1.0.0
Splits up configuration into individual files in the 'packages' directory and are referenced through their GitHub address by default. See the README.md file for more information in the Configuration section.
Features
Many added features can be found in HomeAssistant by going to Settings>Devices and selecting the AirGradient device. Alternatively, add web_server: to the config file to enable a built-in web server on the AirGradient device (No recommended for devices based on the D1 Mini ESP8266)
-
Compact single page display by default with all relevant sensor readings
-
Enable different pages of information to be shown on the OLED display, or leave the default of a single page with all relevant information
-
Button to initiate a SenseAir S8 CO2 Calibration on demand
-
Switch to enable or disable SenseAir S8 CO2 sensor Automatic Baseline Calibration (ABC)
-
Button to view the current S8 ABC interval (confirm if ABC is disabled or enable, which defaults to every 7 days) View ESPHome logs to see the output of this button
-
Switch to disable LED output on AirGradient ONE model
-
Brightness slider to adjust intensity of AirGradient ONE LED
-
Switch to toggle display between Fahrenheit and Celsius and persist between reboots
-
Switch to enable or disable uploading to AirGradient Dashboard via API (Choose to keep data local or also send to AirGradient)
-
Utilize hardware configuration buttons on AirGradient Pro v3.7 and higher
- Short press (Less than 1 second) - Toggle between F and C on display
- Long press (More than 1 second, less than 5) - Trigger manual CO2 calibration
-
Leverage automations in HomeAssistant to turn on the "Blank" page and turn off all other pages to effectively disable the display output. Could also turn off the LED strip or set Brightness to 0 to eliminate output while still collecting sensor data
Breaking Changes
- The devicename has been shortened from "airgradient-*" to "ag-". This matches the Friendly Name convention and results in a shorter overall devicename. You may keep yours at the longer full name if desired, but for the Open Air, the name became longer than allowed
- Substitution entry for "friendly_devicename" has been renamed to "friendly_devicename" to better match it's use case instead of the legacy use
- The name of the CO2 sensor has been changed to just "CO2" from the previous "Senseair S8 CO2" to shorten overall sensor name length and match other sensors that are named for what they are measuring and not the name of the sensor itself. This will result in a new sensor registered to your device in HomeAssistant and the previous one will be "Unavailable". You may need to update any graphs or other dashboard entries with the new CO2 entry
- New switch added to enable/disable Automatic Background Calibration of the Senseair S8 CO2 sensor. If previously disabled, on the first install of the 1.x config, it will be enabled again. Disable after installation if desired.
0.x
Add packages files for upcoming modification