jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add AirVisual Node/Pro docs (#12382)

Browse Source 
* Add docs for AirVisual Node/Pro

* Updates

* Add local info

* Code review

* Remove config options
This commit is contained in:
Aaron Bach 2020-04-23 16:36:36 -06:00 committed by GitHub
parent a7975ead67
commit 3242a437cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/_integrations/airvisual.markdown
View File

@ -11,9 +11,11 @@ ha_domain: airvisual
ha_config_flow: true ha_config_flow: true
--- ---
The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](https://www.clm.com/publication.cfm?ID=366) are created. The `airvisual` sensor platform queries the [AirVisual](https://airvisual.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.airvisual.com/air-quality-monitor).
This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all). ## Using the AirVisual Cloud API
AirVisual API keys can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).
The Community API key is valid for 12 months after which it will expire. You must then go back to the AirVisual website, delete your old key, create a new one following the same steps and update your configuration with the new key. The Community API key is valid for 12 months after which it will expire. You must then go back to the AirVisual website, delete your old key, create a new one following the same steps and update your configuration with the new key.
@ -23,19 +25,34 @@ The "Community" API key is limited to 10,000 calls per month. In order to leave
</div> </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.airvisual.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba).
## Configuration ## Configuration
To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: To enable the integration and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file:
```yaml ```yaml
airvisual: airvisual:
api_key: YOUR_AIRVISUAL_API_KEY api_key: YOUR_AIRVISUAL_API_KEY
``` ```
To enable the integration and gather from a Node/Pro unit, add the following lines to your `configuration.yaml` file:
```yaml
airvisual:
ip_address: YOUR_NODE_PRO_IP_ADDRESS
password: YOUR_NODE_PRO_SAMBA_PASSWORD
```
Note that an API key-based entry can be mixed with one or more Node/Pro-based entries
(examples below).
{% configuration %} {% configuration %}
api_key: api_key:
description: Your AirVisual API key. description: Your AirVisual API key.
required: true required: false
type: string type: string
geographies: geographies:
description: A list of geographical locations to monitor description: A list of geographical locations to monitor
@ -66,14 +83,14 @@ geographies:
## Example Configurations ## Example Configurations
No explicit configuration (uses the `latitude` and `longitude` defined within `configuration.yaml`): No explicit configuration (using the cloud API and the `latitude` and `longitude` defined within `configuration.yaml`):
```yaml ```yaml
airvisual: airvisual:
api_key: YOUR_AIRVISUAL_API_KEY api_key: YOUR_AIRVISUAL_API_KEY
``` ```
Configuration using a single custom latitude and longitude: Configuration using the cloud API and a single custom latitude and longitude:
```yaml ```yaml
airvisual: airvisual:
@ -83,7 +100,7 @@ airvisual:
longitude: 108.12422 longitude: 108.12422
``` ```
Configuration using multiple custom latitude and longitude pairs: Configuration using the cloud API and multiple custom latitude and longitude pairs:
```yaml ```yaml
airvisual: airvisual:
@ -95,7 +112,7 @@ airvisual:
longitude: -117.22743 longitude: -117.22743
``` ```
Configuration using a single city, state, and country: Configuration using the cloud API and a single city, state, and country:
```yaml ```yaml
airvisual: airvisual: