You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_integrations/airvisual.markdown
+25-8Lines changed: 25 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,11 @@ ha_domain: airvisual
11
11
ha_config_flow: true
12
12
---
13
13
14
-
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.
14
+
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).
15
15
16
-
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).
16
+
## Using the AirVisual Cloud API
17
+
18
+
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).
17
19
18
20
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.
19
21
@@ -23,19 +25,34 @@ The "Community" API key is limited to 10,000 calls per month. In order to leave
23
25
24
26
</div>
25
27
28
+
## Using an AirVisual Node/Pro Unit
29
+
30
+
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).
31
+
26
32
## Configuration
27
33
28
-
To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file:
34
+
To enable the integration and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file:
29
35
30
36
```yaml
31
37
airvisual:
32
38
api_key: YOUR_AIRVISUAL_API_KEY
33
39
```
34
40
41
+
To enable the integration and gather from a Node/Pro unit, add the following lines to your `configuration.yaml` file:
42
+
43
+
```yaml
44
+
airvisual:
45
+
ip_address: YOUR_NODE_PRO_IP_ADDRESS
46
+
password: YOUR_NODE_PRO_SAMBA_PASSWORD
47
+
```
48
+
49
+
Note that an API key-based entry can be mixed with one or more Node/Pro-based entries
50
+
(examples below).
51
+
35
52
{% configuration %}
36
53
api_key:
37
54
description: Your AirVisual API key.
38
-
required: true
55
+
required: false
39
56
type: string
40
57
geographies:
41
58
description: A list of geographical locations to monitor
@@ -66,14 +83,14 @@ geographies:
66
83
67
84
## Example Configurations
68
85
69
-
No explicit configuration (uses the `latitude` and `longitude` defined within `configuration.yaml`):
86
+
No explicit configuration (using the cloud API and the `latitude` and `longitude` defined within `configuration.yaml`):
70
87
71
88
```yaml
72
89
airvisual:
73
90
api_key: YOUR_AIRVISUAL_API_KEY
74
91
```
75
92
76
-
Configuration using a single custom latitude and longitude:
93
+
Configuration using the cloud API and a single custom latitude and longitude:
77
94
78
95
```yaml
79
96
airvisual:
@@ -83,7 +100,7 @@ airvisual:
83
100
longitude: 108.12422
84
101
```
85
102
86
-
Configuration using multiple custom latitude and longitude pairs:
103
+
Configuration using the cloud API and multiple custom latitude and longitude pairs:
87
104
88
105
```yaml
89
106
airvisual:
@@ -95,7 +112,7 @@ airvisual:
95
112
longitude: -117.22743
96
113
```
97
114
98
-
Configuration using a single city, state, and country:
115
+
Configuration using the cloud API and a single city, state, and country:
0 commit comments