Add AirVisual Pro docs (#24427)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Aaron Bach 2022-12-27 01:16:55 -07:00 committed by GitHub
parent 1797a0bee2
commit a1679835f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 21 deletions

View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: device
---
The `airvisual` sensor platform queries the [AirVisual](https://www.iqair.com) cloud API for air quality data. Data can be collected via latitude/longitude, by city/state/country, or from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro).
The `airvisual` sensor platform queries the [AirVisual](https://www.iqair.com) cloud API for air quality data. Data can be collected via latitude/longitude or city/state/country.
## Using the AirVisual Cloud API
@ -35,10 +35,6 @@ For example:
</div>
## Using an AirVisual Node/Pro Unit
The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; [instructions here](https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba)).
{% include integrations/config_flow.md %}
## Determining the City/State/Country
@ -53,8 +49,6 @@ 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
@ -93,17 +87,3 @@ 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)

View File

@ -0,0 +1,38 @@
---
title: AirVisual Pro
description: Instructions on how to use AirVisual Pro devices within Home Assistant
ha_category:
- Health
ha_release: 2023.1
ha_iot_class: Local Polling
ha_codeowners:
- '@bachya'
ha_domain: airvisual_pro
ha_config_flow: true
ha_platforms:
- diagnostics
- sensor
ha_integration_type: integration
---
The AirVisual Pro integration allows users to retrieve data from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro). Communication with the device occurs over the local network.
## Determining the Passowrd
You will need the device's Samba password, which [can be found on the unit](https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba).
{% include integrations/config_flow.md %}
## Sensor Types
AirVisual Pro devices 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)