Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add headings #11179

Merged
merged 1 commit into from
Nov 14, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions source/_integrations/waqi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,16 @@ ha_iot_class: Cloud Polling

The `waqi` sensor platform will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.

## Setup

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.

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
Expand All @@ -38,10 +46,6 @@ stations:
type: list
{% endconfiguration %}

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.

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.

The value reported is an overall AQ index for the location. The values of the index can be interpreted as following:

AQI | Status | Description
Expand Down