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-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add information about Awair Local API (#23588)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Zach Berger 2022-08-18 01:20:03 -07:00 committed by GitHub
parent ec613b86a3
commit df86bd4483
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_integrations/awair.markdown
View File

@ -5,7 +5,7 @@ ha_category:
- Health
ha_config_flow: true
ha_release: 0.84
ha_iot_class: Cloud Polling
ha_iot_class: Local Polling
ha_codeowners:
- '@ahayworth'
- '@danielsjf'
@ -17,13 +17,23 @@ ha_integration_type: integration
The Awair integration will fetch data from your [Awair devices](https://getawair.com).
You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). It is free, but getting a token can take up to 24 hours.
## Prerequisites
### Connect locally (preferred)
When connecting locally, the integration will poll the device every 30 seconds. Awair provides a [list of devices](https://support.getawair.com/hc/en-us/articles/360049221014-Awair-Element-Local-API-Feature#h_01F40FB3ETMR4TZKPVXJNE86HQ) that support the Local API. This API must be enabled via the Awair app via [these steps](https://support.getawair.com/hc/en-us/articles/360049221014-Awair-Element-Local-API-Feature#h_01F40FBBW5323GBPV7D6XMG4J8). If you add new Awair devices to your home, you must follow these steps again.
### Connect via the cloud
When connecting via the cloud, data is summarized over 5-minute intervals. All devices are supported. You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). It is free, but getting a token can take up to 24 hours.
This integration refreshes once every 5 minutes, based on the [default per-device quota](https://docs.developer.getawair.com/?version=latest#tiers--quotas) of 300 API calls per day.
{% include integrations/config_flow.md %}
## Available Sensors
The integration will fetch data from each device linked to your Awair developer account. The following sensors are supported:
The integration will fetch data from each device. The following sensors are supported:
* Temperature
* Humidity
@ -35,5 +45,3 @@ The integration will fetch data from each device linked to your Awair developer
* Luminescence
Not all devices support all sensors; consult Awair's documentation to find out what sensors are present on your device. For first-generation Awair devices with a "dust" sensor, the integration will create identical PM2.5 and PM10 sensors (which reflects the capabilities of the sensor - it can detect dust between PM2.5 and PM10 but cannot differentiate between them).
This integration refreshes once every 5 minutes, based on the [default per-device quota](https://docs.developer.getawair.com/?version=latest#tiers--quotas) of 300 API calls per day.