Merge branch 'rc' into current

Kagee · Feb 6, 2019 · c931155 · c931155
2 parents dede4a1 + 8106ef0
commit c931155
Show file tree

Hide file tree

Showing 68 changed files with 2,530 additions and 153 deletions.
diff --git a/_config.yml b/_config.yml
@@ -143,9 +143,9 @@ social:
 
 # Home Assistant release details
 current_major_version: 0
-current_minor_version: 86
-current_patch_version: 4
-date_released: 2019-01-29
+current_minor_version: 87
+current_patch_version: 0
+date_released: 2019-02-06
 
 # Either # or the anchor link to latest release notes in the blog post.
 # Must be prefixed with a # and have double quotes around it.

diff --git a/source/_addons/git_pull.markdown b/source/_addons/git_pull.markdown
@@ -13,12 +13,17 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
 
 ```json
 {
-  "repository": "https://example.com/my_configs.git",
-  "auto_restart": false,
   "git_branch": "master",
   "git_command": "pull",
   "git_remote": "origin",
   "git_prune": "false",
+  "repository": "https://example.com/my_configs.git",
+  "auto_restart": false,
+  "restart_ignore": [
+    "ui-lovelace.yaml",
+    ".gitignore",
+    "exampledirectory/"
+  ],
   "repeat": {
     "active": false,
     "interval": 300
@@ -38,22 +43,22 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
 }
 ```
 
-- **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your GitHub repository URL (see example configuration). The contents of the repository is assumed to be the root of Home Assistant `config/` folder. The configuration cannot be in a subdirectory, i.e., `configuration.yaml`, `groups.yaml`, etc. must be in the root of the repository.
 - **git_branch** (*Required*): Branch name of the Git repo. If left empty, the currently checked out branch will be updated. Leave this as 'master' if you are unsure.
-- **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure.
-- **git_prune** (*Required*): If set to true, the add-on will cleanup branches that are deleted on the remote repository, but still have cached entries on the local machine. Leave this as `false` if you are unsure.
-- **git_command** (*Required*): Must be either `pull` or `reset`. Leave this as `pull` if you are unsure.
-
-  * **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files.
-  * **reset**: Will execute `git reset --hard` and overwrite any local changes to tracked files and update from the remote repository.
-
+- **git_command** (*Required*): `pull`/`reset`: Command to run. Leave this as `pull` if you are unsure.
+* **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files.
+* **reset**: Will execute `git reset --hard` and overwrite any local changes to tracked files and update from the remote repository. Use with caution.
 <p class='note warning'>
-  Using the `reset` option will overwrite changes to tracked files. Tracked files are those visible in the Github repository or those given by the output on this command: `git ls-tree -r master --name-only`.
+  Using the `reset` option will overwrite changes to tracked files. Tracked files are those visible in the git repository or those given by the output on this command: `git ls-tree -r master --name-only`.
 </p>
-
-- **auto_restart** (*Optional*): Restart Home Assistant when the configuration has changed (and is valid).
-- **repeat/active** (*Optional*): Pull periodic for Git updates.
-- **repeat/interval** (*Optional*): Pull all x seconds and look for changes.
+- **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure.
+- **git_prune** (*Required*): `true`/`false`: If set to true, the add-on will clean-up branches that are deleted on the remote repository, but still have cached entries on the local machine. Leave this as `false` if you are unsure.
+
+- **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your repository URL (see example configuration).
+- **auto_restart** (*Required*): `true`/`false`: Restart Home Assistant when the configuration has changed (and is valid).
+- **restart_ignore** (*Optional*): When `auto_restart` is enabled, changes to these files will not make HA restart. Full directories to ignore can be specified.
+- **repeat**: Poll the repository for updates periodically automatically.
+* **active** (*Required*): `true`/`false`: Enable/disable automatic polling.
+* **interval** (*Required*): The interval in seconds to poll the repo for if automatic polling is enabled.
 - **deployment_user** (*Optional*): Username to use when authenticating to a repository with a username and password.
 - **deployment_password** (*Optional*): Password to use when authenticating to a repository.  Ignored if `deployment_user` is not set.
 - **deployment_key** (*Optional*): A private SSH key that will be used for communication during Git operations. This key is mandatory for ssh-accessed repositories, which are the ones with the following pattern: `<user>@<host>:<repository path>`.
@@ -63,7 +68,7 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
   * **ecdsa**
   * **ed25519**
   * **rsa**
-  
+
 The protocol is typically known by the suffix of the private key --e.g., a key file named `id_rsa` will be a private key using `rsa` protocol.
 
 <p class='note warning'>

diff --git a/source/_components/air_quality.nilu.markdown b/source/_components/air_quality.nilu.markdown
@@ -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
+```
diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown
@@ -93,6 +93,10 @@ payload_not_available:
   required: false
   type: string
   default: offline
+json_attributes_topic:
+  description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/components/sensor.mqtt/#json-attributes-topic-configuration) documentation.
+  required: false
+  type: string
 device:
   description: 'Information about the device this alarm panel is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.'
   required: false

diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown
@@ -58,6 +58,12 @@ entity_id:
   description: The ID of the entity to watch.
   required: true
   type: string
+title:
+  description: >
+    A title to be used for the notification if the notifier supports it
+    with [template][template] support.
+  required: false
+  type: template
 state:
   description: The problem condition for the entity.
   required: false
@@ -98,6 +104,10 @@ notifiers:
   description: "List of `notification` components to use for alerts."
   required: true
   type: list
+data:
+  description: "Dictionary of extra parameters to send to the notifier."
+  required: false
+  type: list  
 {% endconfiguration %}
 
 In this example, the garage door status (`input_boolean.garage_door`) is watched
@@ -254,4 +264,31 @@ alert:
 
 The resulting title of the alert could be `Garage has been open for 30 min`.
 
+### {% linkable_title Additional parameters for notifiers  %}
+
+Some notifiers support more parameters (e.g., to set text color or action
+  buttons). These can be supplied via the `data` parameter:
+
+```yaml
+# Example configuration.yaml entry
+alert:
+  garage_door:
+    name: Garage is open
+    entity_id: input_boolean.garage_door
+    state: 'on'   # Optional, 'on' is the default value
+    repeat:
+      - 15
+      - 30
+      - 60
+    can_acknowledge: True  # Optional, default is True
+    skip_first: True  # Optional, false is the default
+    data:
+      inline_keyboard:
+        - 'Close garage:/close_garage, Acknowledge:/garage_acknowledge'
+    notifiers:
+      - frank_telegram
+```
+This particular example relies on the `inline_keyboard` functionality of
+Telegram, where the user is presented with buttons to execute certain actions.
+
 [template]: /docs/configuration/templating/