Add sensor docs for AirVisual (#18388)

This commit is contained in:
Aaron Bach 2021-07-05 02:42:52 -05:00 committed by GitHub
parent 06843db3a6
commit f3f1cab042
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,7 +10,6 @@ ha_codeowners:
ha_domain: airvisual
ha_config_flow: true
ha_platforms:
- air_quality
- sensor
---
@ -52,9 +51,11 @@ For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo >
## Sensor Types
### Cloud API
When configured, the platform will create three sensors for each air quality standard:
### Air Quality Index
#### Air Quality Index
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
@ -70,13 +71,13 @@ AQI | Status | Description
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
### Air Pollution Level
#### Air Pollution Level
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
- **Example Sensor Value:** `Moderate`
### Main Pollutant
#### Main Pollutant
- **Description:** This sensor displays the pollutant whose value is currently highest.
- **Sample Sensor Name:** `sensor.us_main_pollutant`
@ -90,3 +91,17 @@ Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution](https:
Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution)
Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution)
Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution)
### Node/Pro
Node/Pro units will create a variety of sensors:
* Air Quality Index (AQI)
* Battery Level
* Carbon Dioxide (CO2)
* Humidity
* Particulate (<= 0.1 μm) (PM0.1)
* Particulate (<= 2.5 μm) (PM2.5)
* Particulate (<= 10 μm) (PM10)
* Temperature
* Volatile Organic Compounds (VOC)