diff --git a/source/_integrations/waqi.markdown b/source/_integrations/waqi.markdown index 30f301bb9c5..07d890f0492 100644 --- a/source/_integrations/waqi.markdown +++ b/source/_integrations/waqi.markdown @@ -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 @@ -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