Merge branch 'current' into next

source/_components/counter.markdown

@@ -15,6 +15,8 @@ ha_qa_scale: internal
 
 The `counter` component allows one to count occurrences fired by automations.
 
+## {% linkable_title Configuration %}
+
 To add a counter to your installation, add the following to your `configuration.yaml` file:
 
 ```yaml

source/_components/iperf3.markdown

@@ -17,11 +17,13 @@ redirect_from:
   - /components/sensor.iperf3/
 ---
 
-The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public Iperf3 server.
+The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public [Iperf3](http://software.es.net/iperf/index.html) server.
 
-Enabling this component will automatically create the Iperf3 Sensors for the monitored conditions (below).
+Enabling this component will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run.
 
-By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a iperf3 test to run.
+## {% linkable_title Setup %}
+
+This component requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions.
 
 ## {% linkable_title Configuration %}
 
@@ -43,9 +45,9 @@ iperf3:
     type: list
     keys:
       download:
-        description: Download speed (Mbit/s)
+        description: The download speed (Mbit/s).
       upload:
-        description: Upload speed (Mbit/s)
+        description: The upload speed (Mbit/s).
   hosts:
     description: A list of Iperf3 servers to perform the test against.
     required: true
@@ -56,17 +58,17 @@ iperf3:
     default: 60 minutes
     type: time
   manual:
-    description: >
-      `true` or `false` to turn manual mode on or off. Manual mode will disable scheduled tests.
+    description: "`true` or `false` to turn manual mode on or off. Manual mode will disable scheduled tests."
     required: false
     type: boolean
     default: false
 {% endconfiguration %}
 
 Configuration variables (host):
+
 {% configuration %}
   host:
-    description: Server name/ip address running Iperf3 to test against.
+    description: Server name/IP address running Iperf3 to test against.
     required: true
     type: string
   port:
@@ -117,8 +119,12 @@ Once loaded, the `iperf3` component will expose a service (`iperf3.speedtest`) t
 | Service data attribute | Description |
 | `host` | String that point at a configured `host` from configuration.yaml. Otherwise, tests will be run against all configured hosts.
 
+Example Service data:
+
+```json
+{"host": "192.168.0.121"}
+```
 
 ## {% linkable_title Notes %}
 
 - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
-- This component requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions.

source/_components/logi_circle.markdown

@@ -33,7 +33,10 @@ The `logi_circle` implementation allows you to integrate your [Logi Circle](http
     * `circle:notifications`
     * `circle:summaries`
 4. Request the `authorization_code` grant type.
-5. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://homeassistant.local`, then request `https://homeassistant.local/api/logi_circle`. The redirect URI _must_ be HTTPS.
+5. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://abc123.ui.nabu.casa`, then request `https://abc123.ui.nabu.casa/api/logi_circle`. The redirect URI must meet the following criteria:
+ * The URL must be HTTPS with a SSL certificate issued by a trusted CA (i.e., trusted by normal browsers).
+ * At the time you submit your request to Logitech, you need to demonstrate that you have exclusive control of the fully qualified domain name in your redirect URI. An active Home Assistant instance at the redirect URI will suffice. If you don't want to expose your Home Assistant instance publicly, you may also place a static page at the redirect URI with a short message that you will manage redirection of the authorization token to your local Home Assistant instance. Free static hosts that issue subdomains for hosting (e.g., Netlify) are permitted.
+ * As the redirect URI must be public facing, no local/reserved TLDs are permitted (eg. .local, .localhost, .example, etc. are not allowed).
 
 Please note that the turn-around time for API access takes a few business days after which you will be contacted by Logitech using the email address you provided in the form.
 

source/_components/mastodon.markdown

@@ -16,8 +16,12 @@ redirect_from:
 
 The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to delivery notifications from Home Assistant.
 
+### {% linkable_title Setup %}
+
 Go to **Preferences** in the Mastodon web interface, then to **Development** and create a new application.
 
+### {% linkable_title Configuration %}
+
 To add Mastodon to your installation, add the following to your `configuration.yaml` file:
 
 ```yaml

source/_components/opencv.markdown

@@ -52,5 +52,3 @@ image_processing:
 - **file** (*Required*): The path to the classifier xml file.
 - **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
 - **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
-
-If you would like to see the regions that OpenCV has detected, add this OpenCV camera to your config's `custom_components/camera` directory: [https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f](https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f)

source/_components/owntracks.markdown

@@ -15,7 +15,7 @@ redirect_from:
  - /components/device_tracker.owntracks_http/
 ---
 
-OwnTracks is a free and open source application for iOS and Android that allow you to track your location and send it directly to Home Assistant. It can be set up via the integrations panel in the configuration screen.
+[OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allow you to track your location and send it directly to Home Assistant. It can be set up via the integrations panel in the configuration screen.
 
 By default the integration will listen for incoming messages from OwnTracks via HTTP. It will also listen for MQTT messages if Home Assistant is configured to use MQTT.
 
@@ -42,14 +42,14 @@ By default the integration will listen for incoming messages from OwnTracks via
 In the OwnTracks app, open sidebar and click on preferences, then on connection. Change the following settings:
 
  - Mode: Private HTTP
- - Host: `<url given to you when setting up the integration above>`
+ - Host: `<URL given to you when setting up the integration above>`
  - Identification:
-   - Username:<Username>
+   - Username: `<Username>`
    - Password: Can be left blank.
-   - Device ID: `<Device name>
-   - Tracker ID: <xx> Two character tracker ID. (can be left blank)
+   - Device ID: `<Device name>`
+   - Tracker ID: `<xx>` Two character tracker ID. (can be left blank)
 
-Your tracker device will be known in home assistant as <Username>_<Device name>. If you entered a Tracker ID the tid attribute will  be set to that ID.
+Your tracker device will be known in home assistant as `<Username>_<Device name>`. If you entered a Tracker ID the tid attribute will  be set to that ID.
 
 ### {% linkable_title Configuring the app - iOS %}
 
@@ -58,7 +58,7 @@ Your tracker device will be known in home assistant as <Username>_<Device name>.
 In the OwnTracks app, tap the (i) in the top left and click on settings. Change the following settings:
 
  - Mode: HTTP
- - URL: `<url given to you when setting up the integration>`
+ - URL: `<URL given to you when setting up the integration>`
  - Turn on authentication
  - User ID: `<Your name>`
 
@@ -124,7 +124,7 @@ owntracks:
 
 ## {% linkable_title Using Owntracks regions %}
 
-Owntracks can track regions, and send region entry and exit information to Home Assistant (HA). You set up a region in the Owntracks app which you should name the same as your HA Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/).
+Owntracks can track regions, and send region entry and exit information to Home Assistant. You set up a region in the Owntracks app which you should name the same as your Home Assistant Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/).
 
 Home Assistant will use the enter and leave messages to set your zone location. Your location will be set to the center of zone when you enter. Location updates from OwnTracks will be ignored while you are inside a zone.
 

source/_components/random.markdown

@@ -20,9 +20,13 @@ redirect_from:
   - /components/binary_sensor.random/
 ---
 
+The `random` integration simply creates random values or state. This can be useful if you want to test automation rules or run an interactive demo. It generates a new state every time it is polled.
+
 ## {% linkable_title Binary Sensor %}
 
-The `random` binary sensor platform is creating random states (`true`, 1, `on` or `false`, 0, `off`). This can be useful if you want to test automation rules. It generates a new state every time it is polled.
+The `random` binary sensor platform is creating random states (`true`, 1, `on` or `false`, 0, `off`).
+
+### {% linkable_title Configuration %}
 
 To enable the random binary sensor, add the following lines to your `configuration.yaml` file:
 
@@ -42,7 +46,9 @@ name:
 
 ## {% linkable_title Sensor %}
 
-The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled.
+The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn.
+
+### {% linkable_title Configuration %}
 
 To enable the random sensor, add the following lines to your `configuration.yaml` file:
 
@@ -72,4 +78,4 @@ unit_of_measurement:
   description: Defines the units of measurement of the sensor, if any.
   required: false
   type: string
-{% endconfiguration %}
+{% endconfiguration %}

source/_components/reddit.markdown

@@ -1,6 +1,6 @@
 ---
 layout: page
-title: "Reddit Sensor"
+title: "Reddit"
 description: "How to integrate the Reddit sensor into Home Assistant."
 date: 2018-02-21 20:00
 sidebar: true
@@ -19,7 +19,7 @@ The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor
 
 ## {% linkable_title Setup %}
 
-To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this wiki](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example).
+To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example).
 
 ## {% linkable_title Configuration %}
 
@@ -27,14 +27,15 @@ To enable this platform, add the following to your `configuration.yaml` file:
 
 ```yaml
 # Example configuration.yaml entry
-- platform: reddit
-  username: !secret reddit_username
-  password: !secret reddit_password
-  client_id: !secret reddit_client_id
-  client_secret: !secret reddit_client_secret
-  subreddits:
-    - news
-    - worldnews
+sensor:
+  - platform: reddit
+    username: !secret reddit_username
+    password: !secret reddit_password
+    client_id: !secret reddit_client_id
+    client_secret: !secret reddit_client_secret
+    subreddits:
+      - news
+      - worldnews
 ```
 
 {% configuration %}
@@ -47,11 +48,11 @@ password:
   required: true
   type: string
 client_id:
-  description: Your Reddit account client_id generated from the wiki above.
+  description: Your Reddit account client ID.
   required: true
   type: string
 client_secret:
-  description: Your Reddit account client_secret generated from the wiki above.
+  description: Your Reddit account client secret
   required: true
   type: string
 subreddits:
@@ -59,7 +60,7 @@ subreddits:
   required: true
   type: list
 sort_by:
-  description: Sort reddit posts by new, top, controversial, and hot.
+  description: "Sort reddit posts by `new`, `top`, `controversial` and `hot`."
   required: false
   type: string
   default: hot

source/_components/rmvtransport.markdown

@@ -15,7 +15,11 @@ redirect_from:
  - /components/sensor.rmvtransport/
 ---
 
-The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes.
+The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes.
+
+## {% linkable_title Setup %}
+
+Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of valid station IDs.
 
 ## {% linkable_title Configuration %}
 
@@ -46,7 +50,7 @@ next_departure:
       default: The default is the station name.
       type: string
     station:
-      description: "ID of the stop or station, e.g. `3000010`. Visit [the RMV OpenData web site](https://opendata.rmv.de) to find a list of valid IDs."
+      description: "ID of the stop or station, e.g. `3000010`."
       required: true
       type: string
     destinations:

source/_components/vacuum.mqtt.markdown

@@ -103,7 +103,7 @@ battery_level_topic:
   required: false
   type: string
 battery_level_template:
-  description: Defines a [template](/topics/templating/) to define the battery level of the vacuum.
+  description: Defines a [template](/topics/templating/) to define the battery level of the vacuum. This is required if `battery_level_topic` is set.
   required: false
   type: string
 charging_topic:
@@ -111,7 +111,7 @@ charging_topic:
   required: false
   type: string
 charging_template:
-  description: Defines a [template](/topics/templating/) to define the charging state of the vacuum.
+  description: Defines a [template](/topics/templating/) to define the charging state of the vacuum. This is required if `charging_topic` is set.
   required: false
   type: string
 cleaning_topic:
@@ -119,7 +119,7 @@ cleaning_topic:
   required: false
   type: string
 cleaning_template:
-  description: Defines a [template](/topics/templating/) to define the cleaning state of the vacuum.
+  description: Defines a [template](/topics/templating/) to define the cleaning state of the vacuum. This is required if `cleaning_topic` is set.
   required: false
   type: string
 docked_topic:
@@ -127,7 +127,7 @@ docked_topic:
   required: false
   type: string
 docked_template:
-  description: Defines a [template](/topics/templating/) to define the docked state of the vacuum.
+  description: Defines a [template](/topics/templating/) to define the docked state of the vacuum. This is required if `docked_topic` is set.
   required: false
   type: string
 error_topic:
@@ -135,7 +135,7 @@ error_topic:
   required: false
   type: string
 error_template:
-  description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum.
+  description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum. This is required if `error_topic` is set.
   required: false
   type: string
 fan_speed_topic:
@@ -143,7 +143,7 @@ fan_speed_topic:
   required: false
   type: string
 fan_speed_template:
-  description: Defines a [template](/topics/templating/) to define the fan speed of the vacuum.
+  description: Defines a [template](/topics/templating/) to define the fan speed of the vacuum. This is required if `fan_speed_topic` is set.
   required: false
   type: string
 set_fan_speed_topic:

source/_components/volvooncall.markdown

@@ -75,7 +75,7 @@ mutable:
   default: true
   type: boolean
 name:
-  description: Make it possible to provide a name for the vehicles.
+  description: "Make it possible to provide a name for the vehicles. Note: Use all lower case letters when inputing your VIN number."
   required: false
   type: string
 resources:
@@ -140,7 +140,7 @@ volvooncall:
   username: YOUR_USERNAME
   password: YOUR_PASSWORD
   name:
-    abc123: 'Batmobile'
+    YOUR_VIN_NUMBER: 'NEW_NAME'
   resources:
     - odometer
     - lock

source/_components/xiaomi_aqara.markdown

@@ -287,6 +287,6 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
   - Open a serial terminal application (e.g. PuTTY) and connect to the serial port assigned to the USB-UART module (baudrate: 115200).
   - Wait until the gateway is booted up, connect the RX, TX and GND wires to the UART module (don't connect the Vcc (power) wire!).
   - You will see all the messages from the gateway.
-  - Send the command `psm-set network.open_pf 3` (the command has to end with a `CR` newline character).
-  - Check your settings executing the command `psm-get network.open_pf` to be sure it's OK.
+  - Send the command `psm-set network open_pf 3` (the command has to end with a `CR` newline character).
+  - Check your settings executing the command `psm-get network open_pf` to be sure it's OK.
   - Restart the gateway.

source/_cookbook/configuration_yaml_by_jonathan_adams.markdown

@@ -0,0 +1,12 @@
+---
+layout: page
+title: "Configuration.yaml by Jonathan Adams"
+description: ""
+date: 2019-05-07 15:30
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Example configuration.yaml
+ha_external_link: https://github.com/jonathanadams/Home-Assistant-Configuration
+---

source/_posts/2019-05-08-nest-data-bye-bye.markdown

@@ -0,0 +1,37 @@
+---
+layout: post
+title: "Nest to turn off their API"
+description: "Nest has announced that they will shut down their API in August, no longer allowing you to access your data."
+date: 2019-05-08 00:01:00
+date_formatted: "May 8, 2019"
+author: Paulus Schoutsen
+author_twitter: balloob
+comments: true
+categories: Public-Service-Announcement
+og_image: /images/blog/2019-05-nest-data-bye-bye/notice.png
+---
+
+Sigh. Another one. This time it's not a small one either: Nest is disabling their APIs.
+
+We already saw [the writing on the wall in January](/blog/2019/01/24/nest-cannot-access-data/), but now [it's official](https://developers.nest.com/): Google announced that the Nest API will be turned off at the end of August, 2019. This means that in a little over three months, you will no longer be able to get your own data, that Google has collected in your home, and use it like you see fit.
+
+<p class='img'>
+<img src='/images/blog/2019-05-nest-data-bye-bye/notice.png' alt='Screenshot of the Nest developer website.'>
+Notice posted on the Nest developer website.
+</p>
+
+The reason for shutting down the API is that the Nest team is focusing on making "Works with Google Assistant" the most helpful and intelligent ecosystem for the home. However, and this is crucial: the Google Assistant ecosystem is a one way street. You can put data in, but you can never get data out. They acknowledge this in [their FAQ](https://nest.com/whats-happening/):
+
+<p class='img'>
+<img src='/images/blog/2019-05-nest-data-bye-bye/faq.png' alt='Screenshot of the FAQ on the Nest developer website.'>
+FAQ Nest developer website.
+</p>
+
+## {% linkable_title Cherry on the Cake %}
+
+Google also [announced](https://nest.com/blog/2019/05/07/introducing-google-nest/) that they are transitioning the Nest ecosystem into the Google world, making you link all your Nest devices to your Google account. How that will work? We're just going to leave this snippet from [this article from the Financial Times](https://www.ft.com/content/d8cbd5e6-70de-11e9-bf5c-6eeb837566c5) here:
+
+<blockquote class="twitter-tweet" data-lang="en"><p lang="en" dir="ltr">Well that&#39;s reassuring <a href="https://t.co/SKFkE8cAyR">https://t.co/SKFkE8cAyR</a> <a href="https://t.co/zmjMjm23h0">pic.twitter.com/zmjMjm23h0</a></p>&mdash; David Meyer (@superglaze) <a href="https://twitter.com/superglaze/status/1126043166031994880?ref_src=twsrc%5Etfw">May 8, 2019</a>
+</blockquote>
+
+Our advice (as always): buy devices that communicate locally.

source/lovelace/yaml-mode.markdown

@@ -101,4 +101,11 @@ views:
           Welcome to your **Lovelace UI**.
 ```
 
+Your previously customized Lovelace UI won't be modifiable anymore and won't follow after you start writing code in the `<config>/ui-lovelace.yaml` file, but you can easily import it if you wish.
+
+  - Go in the `Overview` tab.
+  - Go in the three dots menu (top-right) and click on `Configure UI`.
+  - Go in the three dots menu again and click on `Raw config editor`.
+  - There you see the config for your actual Lovelace UI, you can copy that into the `<config>/ui-lovelace.yaml` file.
+
 Navigate to `<YOUR HASS URL>/lovelace`. When you make changes to `ui-lovelace.yaml`, you don't have to restart Home Assistant or refresh the page. Just hit the refresh button in the menu at the top of the UI.