Merge branch 'next' into xmpp_async

home-assistant · Oct 13, 2018 · 9d05ad7 · 9d05ad7
2 parents 6c6dea0 + e45b563
commit 9d05ad7
Show file tree

Hide file tree

Showing 264 changed files with 5,360 additions and 2,136 deletions.
diff --git a/.themes/classic/source/javascripts/libs/swfobject-dynamic.js b/.themes/classic/source/javascripts/libs/swfobject-dynamic.js
@@ -202,7 +202,7 @@ var swfobject = function() {
 	function hasPlayerVersion(rv) {
 		var pv = ua.pv, v = rv.split(".");
 		v[0] = parseInt(v[0], 10);
-		v[1] = parseInt(v[1], 10) || 0; // supports short notation, e.g. "9" instead of "9.0.0"
+		v[1] = parseInt(v[1], 10) || 0; // supports short notation, e.g., "9" instead of "9.0.0"
 		v[2] = parseInt(v[2], 10) || 0;
 		return (pv[0] > v[0] || (pv[0] == v[0] && pv[1] > v[1]) || (pv[0] == v[0] && pv[1] == v[1] && pv[2] >= v[2])) ? true : false;
 	}

diff --git a/_config.yml b/_config.yml
@@ -141,14 +141,14 @@ social:
 
 # Home Assistant release details
 current_major_version: 0
-current_minor_version: 79
-current_patch_version: 3
-date_released: 2018-10-02
+current_minor_version: 80
+current_patch_version: 0
+date_released: 2018-10-12
 
 # 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-0793---october-2"
+patch_version_notes: "#"
 # Minor release (Example #release-0431---april-25):
 
 # Date we moved to Discourse for comments

diff --git a/plugins/filters.rb b/plugins/filters.rb
@@ -32,16 +32,16 @@ def site_url
     # input - a url
     #
     # Returns input with all urls expanded to include the full site url
-    # e.g. /images/awesome.gif => http://example.com/images/awesome.gif
+    # e.g., /images/awesome.gif => http://example.com/images/awesome.gif
     #
     def full_url(input)
       expand_url(input, site_url)
     end
 
     # Prepends input with a url fragment
     #
-    # input - An absolute url, e.g. /images/awesome.gif
-    # url   - The fragment to prepend the input, e.g. /blog
+    # input - An absolute url, e.g., /images/awesome.gif
+    # url   - The fragment to prepend the input, e.g., /blog
     #
     # Returns the modified url, e.g /blog
     #

diff --git a/sass/inuitcss/generic/_helper.scss b/sass/inuitcss/generic/_helper.scss
@@ -5,7 +5,7 @@
 /**
  * A series of helper classes to use arbitrarily. Only use a helper class if an
  * element/component doesn’t already have a class to which you could apply this
- * styling, e.g. if you need to float `.main-nav` left then add `float:left;` to
+ * styling, e.g., if you need to float `.main-nav` left then add `float:left;` to
  * that ruleset as opposed to adding the `.float--left` class to the markup.
  *
  * A lot of these classes carry `!important` as you will always want them to win

diff --git a/sass/inuitcss/objects/_beautons.scss b/sass/inuitcss/objects/_beautons.scss
@@ -175,15 +175,15 @@
 .btn--tertiary{}
 
 /**
- * Positive actions; e.g. sign in, purchase, submit, etc.
+ * Positive actions; e.g., sign in, purchase, submit, etc.
  */
 .btn--positive{
     background-color:#4A993E;
     color:#fff;
 }
 
 /**
- * Negative actions; e.g. close account, delete photo, remove friend, etc.
+ * Negative actions; e.g., close account, delete photo, remove friend, etc.
  */
 .btn--negative{
     background-color:#b33630;

diff --git a/sass/inuitcss/objects/_sprite.scss b/sass/inuitcss/objects/_sprite.scss
@@ -22,7 +22,7 @@
  *
  * Where ‘&#xF000;’ might map to a star in your particular icon font.
  *
- * These all require extension in your theme stylesheet, e.g. in your own CSS:
+ * These all require extension in your theme stylesheet, e.g., in your own CSS:
  *
    .sprite{
        background-image:url(path/to/your/sprite.png);

diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown
@@ -14,7 +14,7 @@ featured: false
 You should not use this if you are also using the [DuckDNS add-on]. The DuckDNS add-on has integrated Let's Encrypt support.
 </p>
 
-Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This addon will create a certificate on the first run and will auto-renew if the certificate is within 30 days of expiration. This add-on uses port 80 to verify the certificate request. You will need to stop all other add-ons that also use this port.
+Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This add-on will create a certificate on the first run and will auto-renew if the certificate is within 30 days of expiration. This add-on uses port 80 to verify the certificate request. You will need to stop all other add-ons that also use this port.
 
 ```json
 {
@@ -43,7 +43,7 @@ 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.
+Out of the box, the add-on will not automatically renew your certificate. In fact, it only starts, tries to get/renew your certificate, 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.
 

diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown
@@ -10,7 +10,7 @@ footer: true
 featured: true
 ---
 
-This addon allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares.
+This add-on allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares.
 
 ```json
 {

diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown
@@ -15,7 +15,7 @@ The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so
 
 Home Assistant 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.
+The Snips add-on 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:
 
@@ -71,7 +71,7 @@ There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for
 
 ### {% 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.
+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 add-on.
 
 Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksky/] and put the `api_key` in your `secrets.yaml` file.
 

diff --git a/source/_addons/ssh.markdown b/source/_addons/ssh.markdown
@@ -35,7 +35,7 @@ To start this add-on for the first time, you either need to include a key (enclo
 
 The username for login over SSH is `root`. The complete login command is `ssh [email protected]`.
 
-After logging in, you will find yourself in this add-ons container. The Home Assistant configuration directory is mounted on the path `/config`.
+After logging in, you will find yourself in this add-on's container. The Home Assistant configuration directory is mounted on the path `/config`.
 
 Configuration variables:
 

diff --git a/source/_components/alarm_control_panel.nx584.markdown b/source/_components/alarm_control_panel.nx584.markdown
@@ -22,8 +22,20 @@ alarm_control_panel:
   - platform: nx584
 ```
 
-Configuration variables:
-
-- **host** (*Optional*): The host where the nx584 server process is running. Defaults to `localhost`.
-- **port** (*Optional*): The port where the Alarm panel is listening. Defaults to `5007`.
-
+{% configuration %}
+host:
+  description: The host where the nx584 server process is running.
+  required: false
+  default: localhost
+  type: string
+name:
+  description: This parameter allows you to override the name.
+  required: false
+  default: NX584
+  type: string
+port:
+  description: The port where the Alarm panel is listening.
+  required: false
+  default: 5007
+  type: integer
+{% endconfiguration %}
diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown
@@ -51,13 +51,13 @@ alert:
 
 {% configuration %}
 name:
-  description: The friendly name of the alert.
+  description: The friendly name of the alert. This can include a [template][template].
   required: true
   type: string
 done_message:
   description: >
     A message sent after an alert transitions from `on` to `off`. Is only sent
-    if an alert notification was sent for transitioning from `off` to `on`.
+    if an alert notification was sent for transitioning from `off` to `on`. This can include a [template][template].
   required: false
   type: string
 entity_id:
@@ -191,3 +191,5 @@ sent 30 minutes after that, and a 60 minute delay will fall between every
 following notification.
 For example, if the garage door opens at 2:00, a notification will be
 sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
+
+[template]: /docs/configuration/templating/
diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown
@@ -25,49 +25,92 @@ android_ip_webcam:
   - host: 192.168.1.10
 ```
 
-Configuration variables:
-
-- **host** (*Required*): The IP Address of the phone on the network.
-- **port** (*Optional*): Default is set 8080. The port the IP Webcam listens on.
-- **name** (*Optional*): Override the name of the phone.
-- **username** (*Optional*): The username to access the phone.
-- **password** (*Optional*): The password to access the phone.
-- **scan_interval** (*Optional*): Default is 10 seconds. Defines the update interval of the phone.
-- **sensors** array (*Optional*): Conditions to display sensor in the frontend. See the list of supported sensors.
-- **switches** array (*Optional*): Conditions to display settings in the frontend. See the list of supported settings.
-- **motion_sensor** (*Optional*): Activate motion sensor if auto_discovery is disabled.
+{% configuration %}
+host:
+  description: The IP Address of the phone on the network.
+  required: true
+  type: string
+port:
+  description: The port the IP Webcam listens on.
+  required: false
+  default: 8080
+  type: integer
+name:
+  description: Override the name of the phone.
+  required: false
+  default: IP Webcam
+  type: string
+username:
+  description: The username to access the phone.
+  required: inclusive
+  type: string
+password:
+  description: The password to access the phone.
+  required: inclusive
+  type: string
+scan_interval:
+  description: Defines the update interval of the phone.
+  required: false
+  default: 10
+  type: integer
+sensors:
+  description: Conditions to display sensor in the frontend. See the list of supported sensors.
+  required: false
+  type: list
+  keys:
+    audio_connections:
+      description: Audio Connections
+    battery_level:
+      description: Battery Level
+    battery_temp:
+      description: Battery Temperature
+    battery_voltage:
+      description: Battery Voltage
+    light:
+      description: Light Level
+    motion:
+      description: Motion
+    pressure:
+      description: Pressure
+    proximity:
+      description: Proximity
+    sound:
+      description: Sound
+    video_connections:
+      description: Video Connections
+switches:
+  description: Conditions to display settings in the frontend. See the list of supported switches.
+  required: false
+  type: list
+  keys:
+    exposure_lock:
+      description: Exposure Lock
+    ffc:
+      description: Front-facing Camera
+    focus:
+      description: Focus
+    gps_active:
+      description: GPS Active
+    night_vision:
+      description: Night Vision
+    overlay:
+      description: Overlay
+    torch:
+      description: Torch
+    whitebalance_lock:
+      description: White Balance Lock
+    video_recording:
+      description: Video Recording
+motion_sensor:
+  description: Activate motion sensor if auto_discovery is disabled.
+  required: false
+  type: boolean
+{% endconfiguration %}
 
 <p class='note'>
   You need to enable logging in the Android app (`Data logging` > `Enable data logging`), if you wish to see the sensor states in Home Assistant. The sensor states stays as `unknown`, until it's enabled.
 </p>
 
-### {% linkable_title Supported features %}
-
-Sensors:
-
-- audio_connections
-- battery_level
-- battery_temp
-- battery_voltage
-- light
-- motion
-- pressure
-- proximity
-- sound
-- video_connections
-
-Settings (Switches):
-
-- exposure_lock
-- ffc
-- focus
-- gps_active
-- night_vision
-- overlay
-- torch
-- whitebalance_lock
-- video_recording
-
 ## {% linkable_title Full example %}
 
 ```yaml

diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown
@@ -42,13 +42,28 @@ apple_tv:
     credentials: CREDENTIALS_2
 ```
 
-Configuration variables:
-
-- **host** (*Required*): The IP-address of the device.
-- **login_id** (*Required*): An identifier used to login to the device, see below.
-- **name** (*Optional*): The name of the device used in the frontend.
-- **start_off** (*Optional*): Set to true if the device should start in fake standby.
-- **credentials** (*Optional*): Credentials used for AirPlay playback.
+{% configuration %}
+host:
+  description: The IP-address of the device.
+  required: true
+  type: string
+login_id:
+  description: An identifier used to login to the device, see below.
+  required: true
+  type: string
+name:
+  description: The name of the device used in the frontend.
+  required: false
+  type: string
+start_off:
+  description: Set to true if the device should start in fake standby.
+  required: false
+  type: boolean
+credentials:
+  description: Credentials used for AirPlay playback.
+  required: false
+  type: string
+{% endconfiguration %}
 
 In order to connect to the device, you need a *login id*. The easiest way to obtain this identifier is to use the `apple_tv_scan` service (described below). Additional information about `start_off` and `credentials` can also be found under the guides section.