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 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add config flow to WAQI (#28643)

Browse Source
This commit is contained in:
Joost Lekkerkerker 2023-09-12 19:29:44 +02:00 committed by GitHub
parent 1131ff6688
commit f311c110ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
source/_integrations/waqi.markdown
View File

@ -19,45 +19,15 @@ The `waqi` sensor platform will query [World Air Quality Index](https://aqicn.or
This sensor requires an API token. Please obtain one at [AQICN API token](https://aqicn.org/data-platform/token/#/). This sensor requires an API token. Please obtain one at [AQICN API token](https://aqicn.org/data-platform/token/#/).
The locations field is a search for a location. E.g., "brisbane" or "Brisban" would find Brisbane, Australia and all associated stations in the area. {% include integrations/config_flow.md %}
The format for station fields is exactly from the website, e.g., you would provide the location string "[South Brisbane, Australia](http://aqicn.org/city/australia/queensland/south-brisbane/)" for the linked location.
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: waqi
token: AQICN_API_TOKEN
locations:
- beijing
```
{% configuration %}
token:
description: The token for the AQICN public API.
required: true
type: string
locations:
description: A list of location names to look for air quality data. In case a specific location has multiple registered stations all of them will be added to Home Assistant.
required: true
type: list
stations:
description: A list of station names to look for air quality data. Station should be within locations specified above.
required: false
type: list
{% endconfiguration %}
The value reported is an overall AQ index for the location. The values of the index can be interpreted as following: The value reported is an overall AQ index for the location. The values of the index can be interpreted as following:
AQI | Status | Description | AQI | Status | Description |
------- | :----------------: | ---------- |-----------|:----------------------------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
0 - 50 | **Good** | Air quality is considered satisfactory, and air pollution poses little or no risk | 0 - 50 | **Good** | Air quality is considered satisfactory, and air pollution poses little or no risk |
51 - 100 | **Moderate** | Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution | 51 - 100 | **Moderate** | Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution |
101 - 150 | **Unhealthy for Sensitive Groups** | Members of sensitive groups may experience health effects. The general public is not likely to be affected | 101 - 150 | **Unhealthy for Sensitive Groups** | Members of sensitive groups may experience health effects. The general public is not likely to be affected |
151 - 200 | **Unhealthy** | Everyone may begin to experience health effects; members of sensitive groups may experience more serious health effects | 151 - 200 | **Unhealthy** | Everyone may begin to experience health effects; members of sensitive groups may experience more serious health effects |
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected | 201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected |
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects | 301+ | **Hazardous** | Health alert: everyone may experience more serious health effects |