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-26 18:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explicit scan_interval unit (#8369)

Browse Source 
It's not clear what is the unit at which scan_interval is defined. 
Text mentions default of 10 min, while examples show 30 (misleading reader to believe this also minutes).
This commit is contained in:
Lazar Obradovic 2019-02-01 16:16:15 +01:00 committed by Fabian Affolter
parent 777eb6388e
commit 0e0cad281e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_components/sensor.airvisual.markdown
View File

@ -18,7 +18,7 @@ The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/)
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). 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).
<p class='note warning'> <p 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 by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated. 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. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.
</p> </p>
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -47,7 +47,7 @@ show_on_map:
type: boolean type: boolean
default: true default: true
scan_interval: scan_interval:
description: "The rate at which AirVisual should be polled for new data." description: "The rate in seconds at which AirVisual should be polled for new data."
required: optional required: optional
type: integer type: integer
default: 600 default: 600
@ -86,7 +86,7 @@ sensor:
monitored_conditions: monitored_conditions:
- cn - cn
show_on_map: false show_on_map: false
scan_interval: 30 scan_interval: 300
latitude: 42.81212 latitude: 42.81212
longitude: 108.12422 longitude: 108.12422
``` ```
@ -100,7 +100,7 @@ sensor:
monitored_conditions: monitored_conditions:
- us - us
show_on_map: false show_on_map: false
scan_interval: 30 scan_interval: 300
city: Los Angeles city: Los Angeles
state: California state: California
country: USA country: USA