From f311c110eff8ae84fed2a2c06b88b1d3f5e63614 Mon Sep 17 00:00:00 2001 From: Joost Lekkerkerker Date: Tue, 12 Sep 2023 19:29:44 +0200 Subject: [PATCH] Add config flow to WAQI (#28643) --- source/_integrations/waqi.markdown | 48 ++++++------------------------ 1 file changed, 9 insertions(+), 39 deletions(-) diff --git a/source/_integrations/waqi.markdown b/source/_integrations/waqi.markdown index d25fb5c263e..421cfbba469 100644 --- a/source/_integrations/waqi.markdown +++ b/source/_integrations/waqi.markdown @@ -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/#/). -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 -# 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 %} +{% include integrations/config_flow.md %} 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 +| 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 |