From 6c5d85940a71173eeae8a0ad52b2b5d01da4aa44 Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Mon, 25 May 2020 15:15:06 -0600 Subject: [PATCH] Add docs for auto-leveling AirVisual API calls (#13335) Co-authored-by: Franck Nijhof --- source/_integrations/airvisual.markdown | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown index c9bbc8be9c8..6864dd071d9 100644 --- a/source/_integrations/airvisual.markdown +++ b/source/_integrations/airvisual.markdown @@ -21,7 +21,13 @@ The Community API key is valid for 12 months after which it will expire. You mus
-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.
@@ -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).