Please :star: this repo if you find it useful
This component allows you to evaluate the air quality in any room, using data from various sensors installed there. Such as temperature, humidity, carbon dioxide sensors, etc.
The index is calculating in accordance with the IAQ UK organization methodology.
I also suggest you visit the support topic on the community forum.
... then if you want to use configuration.yaml
to configure sensor...
iaquk
sensor to your configuration.yaml
file. See configuration examples below.configuration.yaml
).custom_components
directory (folder) there, you need to create it.custom_components
directory (folder) create a new folder called iaquk
.iaquk.zip
from the latest release section in this repository.... then if you want to use configuration.yaml
to configure sensor...
iaquk
sensor to your configuration.yaml
file. See configuration examples below.To use this component in your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
iaquk:
kitchen:
sources:
temperature: sensor.kitchen_temperature
humidity: sensor.kitchen_humidity
co2: sensor.kitchen_eco2
tvoc: sensor.kitchen_tvoc
sensors:
- iaq_level
livingroom:
name: "Living Room"
sources:
hcho: sensor.livingroom_formaldehyde
pm:
- sensor.livingroom_pm25
- sensor.livingroom_pm10
* * *
I put a lot of work into making this repo and component available and updated to inspire and help others! I will be glad to receive thanks from you — it will give me new strength and add enthusiasm:
or support via Bitcoin or Etherium:
16yfCfz9dZ8y8yuSwBFVfiAa3CNYdMh7Ts
Each room in the settings is defined by its own named group of parameters. You can specify the friendly name of this group (room), the sensors involved in the calculations, and which sensors you need to create for the output.
You can create as many groups as you need. But each group must have an unique name.
name:\ (string) (Optional) (Default value: deslugified group name)\ Friendly name to use in the frontend.
sources:\ (dictionary) (Required)\ Dictionary of sensors involved in the calculations. At least one sensor must be specified.
temperature:\ (string) (Optional)\ Room temperature sensor entity ID.\ Required sensor's unit of measurement: °C or °F
humidity:\ (string) (Optional)\ Room humidity sensor entity ID.\ Required sensor's unit of measurement: %
co2:\ (string) (Optional)\ Room Carbon Dioxide (CO2) sensor entity ID.\ Required sensor's unit of measurement: ppm, ppb, mg/m3 or µg/m3
co:\ (string) (Optional)\ Room Carbon Monoxide (CO) sensor entity ID.\ Required sensor's unit of measurement: ppm, ppb, mg/m3 or µg/m3
no2:\ (string) (Optional)\ Room Nitrogen Dioxide (NO2) sensor entity ID.\ Required sensor's unit of measurement: ppm, ppb, mg/m3 or µg/m3
tvoc:\ (string) (Optional)\ Room tVOC sensor entity ID.\ Required sensor's unit of measurement: ppm, ppb, mg/m3 or µg/m3\ Note: Only one VOC source are allowed at once: tvoc or voc_index.
voc_index:\ (string) (Optional)\ Room VOC sensor entity ID.\ Required sensor's unit of measurement: None\ Especially for SGP40 and SGP41 gas sensors that return a VOC value as an index from 0 to 500.\ Note: Only one VOC source are allowed at once: tvoc or voc_index.
hcho:\ (string) (Optional)\ Room Formaldehyde (HCHO; CH2O) sensor entity ID.\ Required sensor's unit of measurement: ppm, ppb, mg/m3 or µg/m3
radon:\ (string) (Optional)\ Room Radon (Rn) sensor entity ID.\ Required sensor's unit of measurement: Bq/m3
pm:\ (string | list) (Optional)\ Room particulate matter sensors entity IDs.\ Required sensor's unit of measurement: mg/m3 or µg/m3
sensors:\ (list) (Optional) (Default value: all sensors below)\ List of sensors you need to create for the output. The following sensors can be added:
iaq_index:\ The sensor displays the air quality in numerical form from 1 to 65. The higher the value, the better the air quality.
iaq_level:\ The sensor shows the air quality in a human-readable form. Possible values: Excellent, Good, Fair, Poor, Inadequate.
Note:\
The icon of iaq_level
sensor changes its image depending on the value of the sensor.
You can automatically track new versions of this component and update it by HACS.
To enable debug logs use this configuration:
# Example configuration.yaml entry
logger:
default: info
logs:
custom_components.iaquk: debug
... then restart HA.
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved! :heart_eyes:
The original setup of this component is by Andrey "Limych" Khrolenok.
For a full list of all authors and contributors, check the contributor's page.
This Home Assistant custom component was created and is updated using the HA-Blueprint template. You can use this template to maintain your own Home Assistant custom components.
MIT License
Copyright (c) 2019–2021 Andrey "Limych" Khrolenok
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.