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 docs for auto-leveling AirVisual API calls (#13335)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Aaron Bach 2020-05-25 15:15:06 -06:00 committed by GitHub
parent c19a4e3709
commit 6c5d85940a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_integrations/airvisual.markdown
View File

@ -21,7 +21,13 @@ The Community API key is valid for 12 months after which it will expire. You mus
<div class='note warning'>
The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Note that each item in the `geographies` list will consume an API call with each update.
The "Community" API key is limited to 10,000 calls per month. In order to accommodate using the same API key for multiple geographies, the `airvisual` integration will automatically "re-level" the time between API calls so as to not overrun the call limit.
For example:
- One instance of the integration: API calls every 5 minutes
- Two instances of the integration: API calls every 10 minutes
- etc.
</div>
@ -38,14 +44,6 @@ airvisual:
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).