mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
b5cd4dc921
* Fixes to configuration description and example. Alignment with new documentation guidelines (https://developers.home-assistant.io/docs/en/documentation_standards.html) * Fixed of sample config and documentation Alignment with new documentation guidelines. * Update sensor.waqi.markdown * Update sensor.bom.markdown * Update sensor.bom.markdown
56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
---
|
|
layout: page
|
|
title: "World Air Quality Index"
|
|
description: "Instructions on how to setup World Air Quality Index sensor in Home Assistant."
|
|
date: 2016-11-17 06:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: waqi.png
|
|
ha_category: Health
|
|
ha_release: 0.34
|
|
ha_iot_class: "Cloud Polling"
|
|
---
|
|
|
|
The `waqi` sensor platform will query [World Air Quality Index](http://aqicn.org) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.
|
|
|
|
This sensor requires an API token. Please obtain one at [AQICN API token](http://aqicn.org/data-platform/token/#/).
|
|
|
|
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:
|
|
|
|
AQI | Status | Description
|
|
------- | :----------------: | ----------
|
|
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
|
|
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
|
|
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
|