Docs for nilu air_quality platform (#7993)

* Docs for nilu air_pollution platform

* Updated with new location of pollution index

* Fixed stations to be plural

* platform rename from air_pollutants to air_quality
Managed to remove a commit from maintainer.
Edits should be within this renaming commit.

* Update 'ha_release'
This commit is contained in:
Heine Furubotten 2019-01-27 19:29:47 +01:00 committed by Fabian Affolter
parent db41c831f7
commit b267b7848b
2 changed files with 164 additions and 0 deletions

View File

@ -0,0 +1,164 @@
---
layout: page
title: "Norwegian Institute for Air Research"
description: "Instructions on how to integrate air pollution data from NILU within Home Assistant."
date: 2018-12-30 18:45
sidebar: true
comments: false
sharing: true
footer: true
logo: nilu_logo.png
ha_category: Health
ha_iot_class: "Cloud Polling"
ha_release: 0.87
---
The `nilu` air quality platform shows measurements of current air quality from NILU (Norsk Institutt for luftforskning/Norwegian Institute for Air Research) sensor stations within Norway. Makes data from the open API at [luftkvalitet.info](http://luftkvalitet.info/) and [nilu.no](https://nilu.no/) available in Home Assistant.
## {% linkable_title Configuration %}
To enable this platform, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
air_quality:
- platform: nilu
```
{% configuration %}
latitude:
description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: number
default: Provided by Home Assistant configuration.
longitude:
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: number
default: Provided by Home Assistant configuration.
name:
description: Name of the sensor to use in the frontend.
required: false
default: NILU
type: string
area:
description: Name of an area to get sensor stations from. See available areas below.
required: exclusive
type: string
stations:
description: Name of a specific station to get measurements from.
required: exclusive
type: string
show_on_map:
description: Option to show the position of the sensor station on the map.
required: false
default: false
type: boolean
{% endconfiguration %}
## {% linkable_title Health risk index explainations %}
Under the attributes from a NILU station, there will be a `nilu pollution index`. This indicates how polluted the air is in the area around the sensor station. Following is a longer explanation of what the indexes mean.
### {% linkable_title Low %}
Low or no health risk linked to measured air pollution. Outdoor activites are recommended.
### {% linkable_title Moderate %}
Health effects may occur in some asthmatics and people with other respiratory diseases, as well as serious cardiovascular diseases. Outdoor activity can be recommended for the vast majority, but some should consider their activity in areas with high traffic or high emissions.
### {% linkable_title High %}
Health effects may occur in asthmatics and people with other respiratory diseases, as well as serious cardiovascular disease. Children with respiratory distress (asthma, bronchitis) and adults with severe cardiac or respiratory distress should reduce outdoor activity and not stay in the most polluted areas.
### {% linkable_title Extremely high %}
Sensitive groups in the population can have health effects. Respiratory irritation and discomfort may occur in healthy subjects. People with heart or respiratory distress should reduce outdoor activity and not stay in the most polluted areas.
Source: [Explainations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx)
## {% linkable_title Available areas %}
The `area` configuration is restricted to the areas NILU has defined. Here is the list of available areas:
- `Bergen`
- `Birkenes`
- `Bodø`
- `Brumunddal`
- `Bærum`
- `Drammen`
- `Elverum`
- `Fredrikstad`
- `Gjøvik`
- `Grenland`
- `Halden`
- `Hamar`
- `Harstad`
- `Hurdal`
- `Karasjok`
- `Kristiansand`
- `Kårvatn`
- `Lillehammer`
- `Lillesand`
- `Lillestrøm`
- `Lørenskog`
- `Mo i Rana`
- `Moss`
- `Narvik`
- `Oslo`
- `Prestebakke`
- `Sandve`
- `Sarpsborg`
- `Stavanger`
- `Sør-Varanger`
- `Tromsø`
- `Trondheim`
- `Tustervatn`
- `Zeppelinfjellet`
- `Ålesund`
## {% linkable_title Configuration examples %}
Example of adding health risk monitoring from sensor stations around the Home Assistant location.
```yaml
# Example configuration.yaml entry
# Adds all sensor stations within 20km.
air_quality:
- platform: nilu
```
Example where the sensors are also added to the map.
```yaml
# Example configuration.yaml entry
# Adds all sensor stations within 20km.
# Additionally adds the sensors to the map.
air_quality:
- platform: nilu
show_on_map: True
```
Example of a specific station.
```yaml
# Example configuration.yaml entry
# Monitors stations 'Alnabru'
air_quality:
- platform: nilu
stations:
- Alnabru
```
Example of getting stations from a specified area, giving the sensors a custom name.
```yaml
# Example configuration.yaml entry
# Stations from specific area, 'Bergen'
# Custom name for the sensors.
air_quality:
- platform: nilu
area: Bergen
name: Forurensing Bergen
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB