Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs for auto-leveling AirVisual API calls #13335

Merged
merged 2 commits into from
May 25, 2020
Merged

Add docs for auto-leveling AirVisual API calls #13335

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ec5ad9
Add docs for auto-leveling AirVisual API calls
bachya May 7, 2020
d8b9438
Markdown tweak
frenck May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 7 additions & 9 deletions source/_integrations/airvisual.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand All @@ -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).

Expand Down