Merge remote-tracking branch 'origin/current' into next

Author: balloob

_config.yml

@@ -139,14 +139,14 @@ social:
 
 # Home Assistant release details
 current_major_version: 0
-current_minor_version: 67
+current_minor_version: 68
 current_patch_version: 1
-date_released: 2018-04-17
+date_released: 2018-04-30
 
 # Either # or the anchor link to latest release notes in the blog post.
 # Must be prefixed with a # and have double quotes around it.
 # Major release:
-patch_version_notes: "#release-0671---april-17"
+patch_version_notes: "#release-0681---april-30"
 # Minor release (Example #release-0431---april-25):
 
 # Date we moved to Discourse for comments

source/_addons/lets_encrypt.markdown

@@ -2,7 +2,7 @@
 layout: page
 title: "Let's Encrypt"
 description: "Automatically manage your SSL certificate using Let's Encrypt."
-date: 2017-04-30 13:28
+date: 2018-04-18 10:55
 sidebar: true
 comments: false
 sharing: true
@@ -41,4 +41,24 @@ http:
 
 If you use another port such as `8123` or an SSL proxy, change the port number.
 
+## {% linkable_title Enabling auto-renewals %}
+
+Out of the box, the add-on will not automatically renew your certificate. In fact, it only starts, tries to get/renew your certificte, and then stops. It's up to you to manually start it again whenever your certificate comes close to expiry.
+
+However, you can automate this process using Home Assistant.
+
+Use this in your `automations.yaml` to attempt certificate renewal each day at midnight:
+
+```yaml
+- id: letsencrypt-renewal
+  alias: "Let's Encrypt Renewal"
+  trigger:
+  - platform: time
+    at: '00:00:00'
+  action:
+  - service: hassio.addon_restart
+    data:
+      addon: core_letsencrypt
+```
+
 [DuckDNS add-on]: /addons/duckdns/

source/_addons/snips.markdown

@@ -2,89 +2,116 @@
 layout: page
 title: "Snips.ai"
 description: "Enhance your Hass.io installation with a local voice assistant."
-date: 2018-03-22 13:28
+date: 2018-05-02 13:28
 sidebar: true
 comments: false
 sharing: true
 footer: true
 ---
 
-[Snips.ai] is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
+[Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
 
 The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed.
 
 HomeAssistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki).
 
 The Snips addon by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that component is enabled.
 
-If using a USB microphone and speakers plugged into the raspberry pi output, Snips will work without any change to the configuration. Trying saying things like:
+If using a USB microphone and speakers plugged into the Raspberry Pi output, Snips will work without any change to the configuration. Trying saying things like:
 
 ```
 Turn on kitchen light
 Open garage door
 What is on my shopping list
 ```
 
-To get started creating your own configuration, follow [their tutorial](https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle) to create an assistant and download the training data. You can add the HomeAssistant bundle to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks.
-
-Now install and activate the [Samba] add-on so you can upload your training data. Connect to the "share" Samba share and copy your training data over. Name the file `assistant.zip`.
-
-Now it's time to start Snips for the first time. When the Snips add-on starts, it will output your audio devices. If you are using a USB mic and the raspberry pi output, you won't need to change anything:
-
-```text
-**** List of PLAYBACK Hardware Devices ****
-card 0: ALSA [bcm2835 ALSA], device 0: bcm2835 ALSA [bcm2835 ALSA]
-  Subdevices: 8/8
-  Subdevice #0: subdevice #0
-  Subdevice #1: subdevice #1
-  Subdevice #2: subdevice #2
-  Subdevice #3: subdevice #3
-  Subdevice #4: subdevice #4
-  Subdevice #5: subdevice #5
-  Subdevice #6: subdevice #6
-  Subdevice #7: subdevice #7
-card 0: ALSA [bcm2835 ALSA], device 1: bcm2835 ALSA [bcm2835 IEC958/HDMI]
-  Subdevices: 1/1
-  Subdevice #0: subdevice #0
-```
-
-You need to use this information to point the add-on at the right speakers and microphone. The information describes different cards and devices. On a Raspberry Pi 3, card 0 - device 0 is the built-in headset port, card 0 - device 1 is the HDMI port. In the example above, the USB microphone showed up as card 1 - device 0.
+To get started creating your own configuration, follow [their tutorial](https://snips.gitbook.io/documentation/console) to create an assistant and download the training data. You can also add the HomeAssistant Skill to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks.
 
-Find the microphone and speakers that you want to use and note down their device and card number. We will need that to configure the add-on options `mic` (microphone to use) and `speaker` (speaker to use). The format for these options is `<card #>,<device #>`. Change the configuration options and click save.
+Now install and activate the [Samba](/addons/samba/) add-on so you can upload your training data. Connect to the "share" Samba share and copy your assistant over. Name the file `assistant.zip` or whatever you have configured in the configuration options.
 
-Now start the add-on.
+Now it's time to start Snips for the first time. You can configure the microphone and sound card using the Add-on interface. Now start the add-on.
 
-### Add-On configuration
+### {% linkable_title Add-On configuration %}
 
 ```json
 {
-  "mic": "1,0",
-  "speaker": "1,0",
-  "assistant": "assistant.zip",
   "mqtt_bridge": {
     "active": true,
     "host": "172.17.0.1",
     "port": 1883,
     "user": "",
     "password": ""
   },
+  "assistant": "assistant.zip",
+  "language": "en",
+  "custom_tts": false,
+  "tts_platform": "amazon_polly"
 }
 ```
 
 Configuration variables:
 
-- **mqtt_bridge** : Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
-- **mic**: This is the hardware address of your microphone. Look at the Snips output if you are using different hardware.
+- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
+- **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used.
+- **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported.
+- **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices.
+- **tts_platform**: Which TTS platform to use.
 
 ### {% linkable_title Home Assistant configuration %}
 
-Use the Home Assistant [Snips.ai component][comp] to integrate the add-on into Home Assistant.
+A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options.
 
 ```yaml
 snips:
 ```
 
-[Snips.ai]: https://snips.ai/
+### {% linkable_title Home Assistant configuration %}
+
+There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support.
+
+### {% linkable_title Examples %}
+
+So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba addon.
+
+Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksky/] and put the `api_key` in your `secrets.yaml` file.
+
+```yaml
+- platform: darksky
+  name: "Dark Sky Weather"
+  api_key: !secret dark_sky_key
+  update_interval:
+    minutes: 10
+  monitored_conditions:
+    - summary
+    - hourly_summary
+    - temperature
+    - temperature_max
+    - temperature_min
+```
+Next add this to your `configuration.yaml` file to reference a new `intent_script` component. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
+
+```yaml
+intent_script: !include intent_script.yaml
+```
+
+Finally, create this `intent_script.yaml` file in your configuration directory.
+
+{% raw %}
+```yaml
+searchWeatherForecast:
+  speech:
+    type: plain
+    text: >
+      The weather is currently
+      {{ states('sensor.dark_sky_weather_temperature') | round(0) }}
+      degrees outside and {{ states('sensor.dark_sky_weather_summary') }}.
+      The high today will be
+      {{ states('sensor.dark_sky_weather_daily_high_temperature') | round(0)}}
+      and {{ states('sensor.dark_sky_weather_hourly_summary') }}
+```
+{% endraw %}
+
+Now just restart HassIO and ask it what the weather is like.
+
 [their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle
-[Samba]: /addons/samba/
-[comp]: /components/snips/
+

source/_components/alarm_control_panel.alarmdecoder.markdown

@@ -27,7 +27,9 @@ The Alarm Decoder component gives you access to several services for you to cont
 - `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered.
 - `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state.
 
-**Note**: `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder component.
+<p class='note'>
+`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform. 
+</p>
 
 ### {% linkable_title Attributes %}
 

source/_components/binary_sensor.hive.markdown

@@ -14,11 +14,12 @@ ha_iot_class: "Cloud Polling"
 ---
 
 
-The 'hive' binary sensor component integrates your Hive sensors into Home Assistant.
+The `hive` binary sensor component integrates your Hive sensors into Home Assistant.
 
-The Hive binary sensor component supports the following Hive products:
-- **Hive Window or Door Sensor**
-- **Hive Motion Sensor**
+The platform supports the following Hive products:
+
+- Hive Window or Door Sensor
+- Hive Motion Sensor
 
 
 <p class='note'>

source/_components/binary_sensor.qwikswitch.markdown

@@ -0,0 +1,18 @@
+---
+layout: page
+title: "QwikSwitch Binary Sensor"
+description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant."
+date: 2016-05-04 00:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: qwikswitch.png
+ha_category: Sensor
+ha_iot_class: "Local Push"
+ha_release: "0.68"
+---
+
+The `qwikswitch` binary_sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors within Home Assistant.
+
+The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

source/_components/binary_sensor.random.markdown

@@ -16,6 +16,8 @@ ha_release: 0.57
 
 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.
 
+## {% linkable_title Configuration %}
+
 To enable the random binary sensor, add the following lines to your `configuration.yaml`:
 
 ```yaml

source/_components/binary_sensor.workday.markdown

@@ -26,7 +26,7 @@ To enable the `workday` sensor in your installation, add the following to your `
 binary_sensor:
   - platform: workday
     country: DE
-    workdays: [ mon, wed, fri ]
+    workdays: [mon, wed, fri]
 ```
 
 Configuration variables:

source/_components/calendar.google.markdown

@@ -16,7 +16,7 @@ ha_release: 0.33
 
 The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see.
 
-### {% linkable_title Prerequisites %}
+## {% linkable_title Prerequisites %}
 
 Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar).
 
@@ -30,7 +30,7 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co
 1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file.
 1. Click on "Library", search for "Google Calendar API" and enable it.
 
-### {% linkable_title Basic Setup %}
+## {% linkable_title Configuration %}
 
 To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file:
 
@@ -61,7 +61,7 @@ The next steps will require you to have Home Assistant running.
 
 After you have it running complete the Google authentication that pops up. It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars.
 
-### {% linkable_title Calendar Configuration %}
+## {% linkable_title Calendar Configuration %}
 
 Editing the `google_calendars.yaml` file.
 

source/_components/camera.local_file.markdown

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: "Local File"
-description: "Instructions on how to use Local File as a Camera within Home Assistant."
+description: "Instructions how to use Local File as a Camera within Home Assistant."
 date: 2016-06-12 17:00
 sidebar: true
 comments: false
@@ -13,9 +13,9 @@ ha_iot_class: "Local Polling"
 ha_release: 0.22
 ---
 
-The `local_file` camera platform allows you to integrate any readable image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated.
+The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file_update_file_path` can be used to update the image using an automation.
 
-This can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
+The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
 
 To enable this camera in your installation, add the following to your `configuration.yaml` file:
 
@@ -31,7 +31,11 @@ Configuration variables:
  - **file_path** (*Required*): File to serve as the camera.
  - **name** (*Optional*): Name of the camera
 
-<p class='note'>
-The given `file_path` must be an existing file because the camera platform setup make a readable check on it.
-</p>
+### {% linkable_title Service `camera.local_file_update_file_path` %}
 
+Use this service to change the file displayed by the camera.
+
+| Service data attribute | Description |
+| -----------------------| ----------- |
+| `entity_id` | String of the `entity_id` of the camera to update. |
+| `file_path` | The full path to the new image file to be displayed. |

source/_components/climate.hive.markdown

@@ -14,13 +14,15 @@ ha_iot_class: "Cloud Polling"
 ---
 
 
-The 'hive' climate component integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
+The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
+
 A short boost for Hive Heating or Hive Hot water can be set by using the **Aux Heat** function, this will turn on the boost feature for Hive Heating or Hive Hot water for 30 minutes at 0.5 degrees higher than the current temperature.
 
-The Hive climate component supports the following Hive products:
-- **Hive Active Heating**
-- **Hive Multizone**
-- **Hot water control**
+The platform supports the following Hive products:
+
+- Hive Active Heating
+- Hive Multizone
+- Hot water control
 
 
 <p class='note'>

source/_components/deconz.markdown

@@ -34,7 +34,7 @@ ha_iot_class: "Local Push"
 
 Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
 
-If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in `deconz.conf` inside the `.homeassistant` folder.
+If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in `.config_entries.json` inside the `.homeassistant` folder.
 
 You can add the following to your configuration.yaml file if you are not using the `discovery:` component:
 

source/_components/device_tracker.google_maps.markdown

@@ -29,9 +29,9 @@ To integrate Google Maps Location Sharing in Home Assistant, add the following s
 ```yaml
 # Example configuration.yaml entry
 device_tracker:
-  platform: google_maps
-  username: [email protected]
-  password: password
+  - platform: google_maps
+    username: YOUR_USERNAME
+    password: YOUR_PASSWORD
 ```
 
 {% configuration %}

source/_components/device_tracker.markdown

@@ -40,6 +40,10 @@ The following optional parameters can be used with any platform. However device
 | `consider_home`      | 180     | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`)  |
 | `new_device_defaults`|         | Default values for new discovered devices. Available options `track_new_devices` (default: `True`), `hide_if_away` (default: `False`)                                                                                                                                                                                                                                                     |
 
+<p class='note'>
+  Note that setting `track_new_devices: False` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: no`).
+</p>
+
 The extended example from above would look like the following sample:
 
 ```yaml