From ae81f7ad11aac1479993af3804f2192cb1692e6b Mon Sep 17 00:00:00 2001 From: Daniel Shokouhi Date: Fri, 12 Oct 2018 10:12:38 -0700 Subject: [PATCH 01/64] Capitalize the company Neato (#6716) --- source/_components/vacuum.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index 59f7699392d..a72a22e7ca5 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -29,7 +29,7 @@ Before calling one of these services, make sure your vacuum platform supports it #### {% linkable_title Service `vacuum.turn_on` %} -Start a new cleaning task. For the Xiaomi Vacuum and neato use `vacuum.start` instead. +Start a new cleaning task. For the Xiaomi Vacuum and Neato use `vacuum.start` instead. | Service data attribute | Optional | Description | |---------------------------|----------|-------------------------------------------------------| @@ -37,7 +37,7 @@ Start a new cleaning task. For the Xiaomi Vacuum and neato use `vacuum.start` in #### {% linkable_title Service `vacuum.turn_off` %} -Stop the current cleaning task and return to the dock. For the Xiaomi Vacuum and neato use `vacuum.stop` instead. +Stop the current cleaning task and return to the dock. For the Xiaomi Vacuum and Neato use `vacuum.stop` instead. | Service data attribute | Optional | Description | |---------------------------|----------|-------------------------------------------------------| From a5970253dcaf5d0417a852683b7d573969f47117 Mon Sep 17 00:00:00 2001 From: Tyler Bigler Date: Fri, 12 Oct 2018 13:20:31 -0400 Subject: [PATCH 02/64] Corrected the Aruba OID (#6708) The previous OID was the MAC address of the access point itself. The new OID is client mac addresses. --- source/_components/device_tracker.snmp.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index 0e79012f0b1..a7fe4236902 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -25,7 +25,7 @@ The following OID examples pull the current MAC Address table from a router. Thi |---|---|---|---| | Mikrotik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` | | Mikrotik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` | -| Aruba | (untested) | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2` | +| Aruba | (untested) | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` | | pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` | | BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` | | OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` | From 30f0977b3733978749ff4c61ee17771acd20a57b Mon Sep 17 00:00:00 2001 From: cgtobi Date: Fri, 12 Oct 2018 19:39:29 +0200 Subject: [PATCH 03/64] Fix netatmo sensor config formatting (#6711) * Fix config formatting * Remove copy & paste error --- source/_components/sensor.netatmo.markdown | 72 +++++++++++++++------- 1 file changed, 50 insertions(+), 22 deletions(-) diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown index 856ccc0ec47..cf38ea961d9 100644 --- a/source/_components/sensor.netatmo.markdown +++ b/source/_components/sensor.netatmo.markdown @@ -39,28 +39,56 @@ sensor: - battery_vp ``` -Configuration variables: - -- **station** (*Optional*): The name of the weather station. Needed if several stations are associated with the account. -- **modules** (*Required*): Modules to use. Multiple entries allowed. Please check the next section about how to retrieve the module names. - - **module_name** array (*Required*): Name of the module. - - **temperature**: Current temperature. - - **co2**: CO2 concentration in ppm. - - **pressure**: Pressure in mbar. - - **noise**: Noise level in dB. - - **humidity**: Humidity in %. - - **rain**: Estimated rainfall for today in mm. - - **sum_rain_1**: Rainfall in the last hour in mm. - - **sum_rain_24**: Rainfall in mm from 00:00am - 23:59pm. - - **windangle**: Wind angle - - **windstrength**: Wind strength - - **gustangle**: Wind gust angle - - **guststrength**: Wind gust strength - - **min_temp**: Min temperature for today - - **max_temp**: Max temperature for today - - **rf_status**: Current radio status per module. (90=low, 60=highest) - - **wifi_status**: Wifi status per Base station - - **battery_vp**: Current battery status per module. +{% configuration %} +station: + required: false + description: The name of the weather station. Needed if several stations are associated with the account. + type: string +modules: + required: true + description: Modules to use. Multiple entries allowed. Please check the next section about how to retrieve the module names. + type: list + keys: + module_name: + type: list + required: true + description: Name of the module. + keys: + temperature: + description: Current temperature. + co2: + description: CO2 concentration in ppm. + pressure: + description: Pressure in mbar. + noise: + description: Noise level in dB. + humidity: + description: "Humidity in %." + rain: + description: Estimated rainfall for today in mm. + sum_rain_1: + description: Rainfall in the last hour in mm. + sum_rain_24: + description: "Rainfall in mm from 00:00am - 23:59pm." + windangle: + description: Wind angle + windstrength: + description: Wind strength + gustangle: + description: Wind gust angle + guststrength: + description: Wind gust strength + min_temp: + description: Min temperature for today + max_temp: + description: Max temperature for today + rf_status: + description: "Current radio status per module. (90=low, 60=highest)" + wifi_status: + description: Wifi status per Base station + battery_vp: + description: Current battery status per module. +{% endconfiguration %} ### {% linkable_title Find your modules name %} From 968403251a64b70949f32ccfb6525ec95b4a1988 Mon Sep 17 00:00:00 2001 From: Travis Carr Date: Fri, 12 Oct 2018 11:08:42 -0700 Subject: [PATCH 04/64] Update history_graph and netatmo config specifications. (#6707) * Clean up configuration options for history_graph * Update netatmo config formatting * Remove title * Minor fixes --- source/_components/history_graph.markdown | 29 ++++++++++++++++------- source/_components/netatmo.markdown | 28 ++++++++++++++++++---- 2 files changed, 44 insertions(+), 13 deletions(-) diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index 5059d1ba1cb..a929385fa18 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -30,14 +30,27 @@ history_graph: ``` -### {% linkable_title Configuration variables %} - -| Attribute | Optional | Default | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entities` | no | | List of entities whose history to show as a graph. | -| `name` | yes | ID | Name to display. | -| `hours_to_show` | yes | 24 | Number of hours to show. | -| `refresh` | yes | 0 | Number of seconds between graph refreshes. 0 for no refreshes. | +{% configuration %} +entities: + description: List of entities whose history to show as a graph. + required: true + type: string +name: + description: Name to display. + required: false + default: ID + type: string +hours_to_show: + description: Number of hours to show in the graph. + required: false + default: 24 + type: integer +refresh: + description: Number of seconds between graph refreshes. 0 to disable refreshing. + required: false + default: 0 + type: integer +{% endconfiguration %} ### {% linkable_title Full Example %} diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 0efe4ac968c..8735db3992c 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -29,11 +29,29 @@ netatmo: Configuration variables: -- **api_key** (*Required*): The `client id` form your Netatmo app. -- **secret_key** (*Required*): The `client secret` form your Netatmo app. -- **username** (*Required*): Username for the Netatmo account. -- **password** (*Required*): Password for the Netatmo account. -- **discovery** (*Optional)*: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add (default True). +{% configuration %} +api_key: + description: The `client id` from your Netatmo app. + required: true + type: string +secret_key: + description: The `client secret` from your Netatmo app. + required: true + type: integer +username: + description: Username for the Netatmo account. + required: true + type: string +password: + description: Password for the Netatmo account. + required: true + type: string +discovery: + description: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add. + required: false + type: string + default: true +{% endconfiguration %} ### {% linkable_title Get API and Secret Key %} From af1ba2aa7e538f3ea4a33dad5eb456ed55882fda Mon Sep 17 00:00:00 2001 From: Travis Carr Date: Fri, 12 Oct 2018 11:08:53 -0700 Subject: [PATCH 05/64] Convert configs to new format for camera.yi (#6706) * Convert configs to new format for camera.yi * Minor changes --- source/_components/camera.yi.markdown | 34 ++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index e366ab46e32..19faa147f80 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -67,12 +67,34 @@ camera: Configuration variables: -- **name** (*Required*): A human-friendly name for the camera. -- **host** (*Required*): The IP address or hostname of the camera. -- **password** (*Required*): The password to the FTP server on the camera (from above). -- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`. -- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`. -- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). +{% configuration %} +name: + description: A human-friendly name for the camera. + required: true + type: string +host: + description: The IP address or hostname of the camera. + required: true + type: string +password: + description: The password for the FTP server running on the camera. Can be any string as the current firmware doesn't allow setting FTP passwords. + required: true + type: string +path: + description: The path to the raw MP4 files. + required: false + default: /media/mmcblk0p1/record + type: string +username: + description: The user that can access the FTP server. + required: false + default: root + type: string +ffmpeg_arguments: + description: Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). + required: false + type: string +{% endconfiguration %} ## {% linkable_title Image quality %} From a68794ae0e9c7b218a8ecc889f2efdec0cefbaed Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 12 Oct 2018 21:24:30 +0200 Subject: [PATCH 06/64] Update Zoneminder component configuration variable (#6718) * Update Zoneminder component configuration variable * Fix description --- source/_components/sensor.zoneminder.markdown | 33 ++++++++++----- source/_components/switch.zoneminder.markdown | 16 ++++--- source/_components/zoneminder.markdown | 42 +++++++++++++++---- 3 files changed, 66 insertions(+), 25 deletions(-) diff --git a/source/_components/sensor.zoneminder.markdown b/source/_components/sensor.zoneminder.markdown index e60e2742058..654c6e57e71 100644 --- a/source/_components/sensor.zoneminder.markdown +++ b/source/_components/sensor.zoneminder.markdown @@ -13,7 +13,6 @@ ha_release: 0.31 ha_iot_class: "Local Polling" --- - The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events and the current state of the cameras.

@@ -29,13 +28,25 @@ sensor: include_archived: false ``` -Configuration variables: - -- **include_archived** (*Optional*): Whether to include archived ZoneMinder events in event counts. Default is `false`. -- **monitored_conditions** array (*Optional*): Event count sensors to display in the frontend. Default is 'all'. - - **all**: All events. - - **month**: Events in the last month. - - **week**: Events in the last week. - - **day**: Events in the last day. - - **hour**: Events in the last hour. - +{% configuration %} +include_archived: + description: Whether to include archived ZoneMinder events in event counts. + required: false + default: false + type: boolean +monitored_conditions: + description: Event count sensors to display in the frontend. + required: false + type: list + keys: + all: + description: All events. + month: + description: Events in the last month. + week: + description: Events in the last week. + day: + description: Events in the last day. + hour: + description: Events in the last hour. +{% endconfiguration %} diff --git a/source/_components/switch.zoneminder.markdown b/source/_components/switch.zoneminder.markdown index dd55a07ec95..f194544715c 100644 --- a/source/_components/switch.zoneminder.markdown +++ b/source/_components/switch.zoneminder.markdown @@ -13,7 +13,6 @@ ha_release: 0.31 ha_iot_class: "Local Polling" --- - The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.

@@ -30,11 +29,16 @@ switch: command_off: Monitor ``` -Configuration variables: - -- **command_on** (*Required*): The function you want the camera to run when turned on. -- **command_off** (*Required*): The function you want the camera to run when turned off. - +{% configuration %} +command_on: + description: The function you want the camera to run when turned on. + required: true + type: string +command_off: + description: The function you want the camera to run when turned off. + required: true + type: string +{% endconfiguration %}

The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect. diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown index 06e206f12db..520366e14e8 100644 --- a/source/_components/zoneminder.markdown +++ b/source/_components/zoneminder.markdown @@ -22,14 +22,40 @@ zoneminder: host: ZM_HOST ``` -Configuration variables: -- **host** (*Required*): Your ZoneMinder server's host (and optional port), not including the scheme. -- **path** (*Optional*): Path to your ZoneMinder install. Defaults to `/zm/`. -- **path_zms** (*Optional*): Path to the CGI script for streaming. This should match `PATH_ZMS` in ZM's "Paths" settings. Defaults to `/zm/cgi-bin/nph-zms`. -- **ssl** (*Optional*): Set to `true` if your ZoneMinder installation is using SSL. Default to `false`. -- **verify_ssl** (*Optional*): Verify the certification of the endpoint. Default to `true`. -- **username** (*Optional*): Your ZoneMinder username. -- **password** (*Optional*): Your ZoneMinder password. Required if `OPT_USE_AUTH` is enabled in ZM. +{% configuration %} +host: + description: Your ZoneMinder server's host (and optional port), not including the scheme. + required: true + type: string +path: + description: Path to your ZoneMinder install. + required: false + default: "`/zm/`" + type: string +path_zms: + description: Path to the CGI script for streaming. This should match `PATH_ZMS` in ZM's "Paths" settings. + required: false + default: "`/zm/cgi-bin/nph-zms`" + type: string +ssl: + description: Set to `true` if your ZoneMinder installation is using SSL. + required: false + default: false + type: boolean +verify_ssl: + description: Verify the certification of the endpoint. + required: false + default: true + type: boolean +username: + description: Your ZoneMinder username. + required: false + type: string +password: + description: Your ZoneMinder password. Required if `OPT_USE_AUTH` is enabled in ZM. + required: false + type: string +{% endconfiguration %} ### {% linkable_title Full configuration %} From bc891e7a88e0df3d415d9966d94382478d9bf102 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 12 Oct 2018 21:37:50 +0200 Subject: [PATCH 07/64] Update Zha component configuration variable (#6719) --- source/_components/zha.markdown | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 8e622bdde56..477b89178c7 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -41,11 +41,25 @@ zha: database_path: /home/homeassistant/.homeassistant/zigbee.db ``` -Configuration variables: - - - **radio_type** (*Optional*): One of `ezsp` (default) or `xbee` - - **usb_path** (*Required*): Path to the serial device for the radio. - - **baudrate** (*Optional*): Baud rate of the serial device. - - **database_path** (*Required*): _Full_ path to the database which will keep persistent network data. +{% configuration %} +radio_type: + description: One of `ezsp` or `xbee`. + required: false + default: ezsp + type: string +usb_path: + description: Path to the serial device for the radio. + required: true + type: string +baudrate: + description: Baud rate of the serial device. + required: false + default: 57600 + type: integer +database_path: + description: _Full_ path to the database which will keep persistent network data. + required: true + type: string +{% endconfiguration %} To add new devices to the network, call the `permit` service on the `zha` domain, and then follow the device instructions for doing a scan or factory reset. In case you want to add Philips Hue bulbs that have previously been added to another bridge, have a look at: [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/) From ea128c97b689bc6df99878ea55a97b832f7e3d42 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 12 Oct 2018 21:38:49 +0200 Subject: [PATCH 08/64] Update Zabbix component configuration variable (#6721) --- source/_components/zabbix.markdown | 31 +++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index bda90be47f7..1056bef232c 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -26,13 +26,30 @@ zabbix: host: 192.168.0.100 ``` -Configuration variables: - -- **host** (*Required*): Your Zabbix server. -- **path** (*Optional*): Path to your Zabbix install. Defaults to `/zabbix/`. -- **ssl** (*Optional*): Set to `True` if your Zabbix installation is using SSL. Default to `False`. -- **username** (*Optional*): Your Zabbix username. -- **password** (*Optional*): Your Zabbix password. +{% configuration %} +host: + description: Your Zabbix server. + required: true + type: string +path: + description: Path to your Zabbix install. + required: false + default: "`/zabbix/`" + type: string +ssl: + description: Set to `True` if your Zabbix installation is using SSL. + required: false + default: false + type: boolean +username: + description: Your Zabbix username. + required: false + type: string +password: + description: Your Zabbix password. + required: false + type: string +{% endconfiguration %} ### {% linkable_title Full configuration %} From 6d2102771ef21cab1cde122c7423fd381431a45e Mon Sep 17 00:00:00 2001 From: Brian J King Date: Fri, 12 Oct 2018 16:51:35 -0500 Subject: [PATCH 09/64] Updates to MQTT Broker to standardize docs (#6725) * All instances of `Mosquitto` are capitalized **outside of** instances that refer to code/configuration blocks/file names to comply with the [docs standardization](https://developers.home-assistant.io/docs/en/documentation_standards.html). * Standardization for displaying file paths, code/configuration blocks in `plaintext`. --- source/_docs/mqtt/broker.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 3bd4a98369a..8923f93f3ff 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -117,7 +117,7 @@ If you get this error `AttributeError: module 'ssl' has no attribute 'PROTOCOL_T

-If you are running a Mosquitto instance on the same server as Home Assistant then you must ensure that the Mosquitto service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the file /etc/systemd/system/home-assistant@homeassistant.service as root (e.g., sudo nano /etc/systemd/system/home-assistant@homeassistant.service) and add the mosquitto service: +If you are running a Mosquitto instance on the same server as Home Assistant then you must ensure that the Mosquitto service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the file `/etc/systemd/system/home-assistant@homeassistant.service` as `root` (e.g., `sudo nano /etc/systemd/system/home-assistant@homeassistant.service`) and add the Mosquitto service: ``` [Unit] Description=Home Assistant From a8978b54b18f7999780185bca5e977c402faf97a Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 12 Oct 2018 23:55:39 +0200 Subject: [PATCH 10/64] Update Vera component configuration variable (#6724) --- source/_components/vera.markdown | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/source/_components/vera.markdown b/source/_components/vera.markdown index 1dfa965fb40..df3f6e31c62 100644 --- a/source/_components/vera.markdown +++ b/source/_components/vera.markdown @@ -23,9 +23,12 @@ vera: vera_controller_url: http://192.168.1.161:3480/ ``` -Configuration variables: - -- **vera_controller_url** (*Required*): The URL for your Vera device. +{% configuration %} +vera_controller_url: + description: The URL for your Vera device. + required: true + type: string +{% endconfiguration %}

It is recommended to assign a static IP address to your Vera Controller. This ensures that it won't change IP addresses, so you won't have to change the `vera_controller_url` if it reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Vera, check the label on the bottom. From f955037f81076176e01d444cc3ef1d5415149049 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 12 Oct 2018 23:56:52 +0200 Subject: [PATCH 11/64] Update Ring binary sensor component configuration variable (#6730) --- source/_components/binary_sensor.ring.markdown | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/source/_components/binary_sensor.ring.markdown b/source/_components/binary_sensor.ring.markdown index c2f48c7163c..f06297d9cec 100644 --- a/source/_components/binary_sensor.ring.markdown +++ b/source/_components/binary_sensor.ring.markdown @@ -25,10 +25,16 @@ binary_sensor: - platform: ring ``` -Configuration variables: - -- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. - - **ding**: Return a boolean value when the doorbell button was pressed. - - **motion**: Return a boolean value when a movement was detected by the Ring doorbell. +{% configuration %} +monitored_conditions: + description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. + required: false + type: list + keys: + ding: + description: Return a boolean value when the doorbell button was pressed. + motion: + description: Return a boolean value when a movement was detected by the Ring doorbell. +{% endconfiguration %} Currently it supports doorbell, external chimes and stickup cameras. From 654f5906eaa3eb4f3050ae655ec92021079626ab Mon Sep 17 00:00:00 2001 From: Kevin Fronczak Date: Fri, 12 Oct 2018 18:00:30 -0400 Subject: [PATCH 12/64] Add missing info to blink docs (#6727) * Add missing info to blink docs Missing information about camera services and alarm_control_panel * Fix typo --- source/_components/blink.markdown | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index a764ec59ab7..7dbd23d868f 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -65,6 +65,12 @@ sensors: default: all (`battery`, `temperature`, `status`, `wifi_strength`) {% endconfiguration %} +Once home-assistant starts, the `blink` component will create the following components: + +- An `alarm_control_panel` to arm/disarm the whole blink system (note, `alarm_arm_home` is not implemented and will not actually do anything, despite it being an option in the GUI). +- A `camera` for each camera linked to your Blink sync module. +- A `sensor` per camera for every item listed in `monitored_conditions` (if no items specified in your `configuration.yaml`, all of them will be added by default). +- A `binary_sensor` for each item listed in `monitored_conditions` (if no items specified in your `configuration.yaml`, all of them will be added by default). Since the cameras are battery operated, setting the `scan_interval` must be done with care so as to not drain the battery too quickly, or hammer Blink's servers with too many API requests. The cameras can be manually updated via the `trigger_camera` service which will ignore the throttling caused by `scan_interval`. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended. @@ -126,3 +132,7 @@ homeassistant: - '/tmp' - '/path/to/whitelist' ``` + +### {% linkable_title Other Services %} + +In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. From c70d8451036da0a52ec5d41ac5c5e12fae70bafa Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 13 Oct 2018 00:05:05 +0200 Subject: [PATCH 13/64] Various fixes --- source/_components/blink.markdown | 71 +++++++++++++++---------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 7dbd23d868f..2a26969ceab 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -13,11 +13,11 @@ ha_release: "0.40" ha_iot_class: "Cloud Polling" --- -The `blink` component lets you view camera images and motion events -from [Blink](http://blinkforhome.com) camera and security systems. +The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems. -You will need your Blink login information (username, which is -usually your email address, and password) to use this module. +## {% linkable_title Setup %} + +You will need your Blink login information (username, which is usually your email address, and password) to use this module. ## {% linkable_title Configuration %} @@ -32,40 +32,40 @@ blink: {% configuration %} username: - description: The username for accessing your Blink account. - required: true - type: string + description: The username for accessing your Blink account. + required: true + type: string password: - description: The password for accessing your Blink account. - required: true - type: string + description: The password for accessing your Blink account. + required: true + type: string scan_interval: - description: How frequently to query for new data. Defaults to 60 seconds. - required: false - type: integer + description: How frequently to query for new data. Defaults to 60 seconds. + required: false + type: integer binary_sensors: - description: Binary sensor configuration options. - required: false - type: map - keys: - monitored_conditions: - description: The conditions to create sensors from. - required: false - type: list - default: all (`motion_enabled`, `motion_detected`) + description: Binary sensor configuration options. + required: false + type: map + keys: + monitored_conditions: + description: The conditions to create sensors from. + required: false + type: list + default: all (`motion_enabled`, `motion_detected`) sensors: - description: Sensor configuration options. - required: false - type: map - keys: - monitored_conditions: - description: The conditions to create sensors from. - required: false - type: list - default: all (`battery`, `temperature`, `status`, `wifi_strength`) + description: Sensor configuration options. + required: false + type: map + keys: + monitored_conditions: + description: The conditions to create sensors from. + required: false + type: list + default: all (`battery`, `temperature`, `status`, `wifi_strength`) {% endconfiguration %} -Once home-assistant starts, the `blink` component will create the following components: +Once Home Assistant starts, the `blink` component will create the following platforms: - An `alarm_control_panel` to arm/disarm the whole blink system (note, `alarm_arm_home` is not implemented and will not actually do anything, despite it being an option in the GUI). - A `camera` for each camera linked to your Blink sync module. @@ -74,7 +74,7 @@ Once home-assistant starts, the `blink` component will create the following comp Since the cameras are battery operated, setting the `scan_interval` must be done with care so as to not drain the battery too quickly, or hammer Blink's servers with too many API requests. The cameras can be manually updated via the `trigger_camera` service which will ignore the throttling caused by `scan_interval`. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended. -**Note:** Each camera reports two different states, one as `sensor.blink__status` and the other as `binary_sensor.blink__motion_enabled`. The `motion_enabled` property reports if the `camera` is ready to detect motion *regardless if the system is actually armed**. The `status` property is more descriptive, and can be one of the following states: +Please note that each camera reports two different states: one as `sensor.blink__status` and the other as `binary_sensor.blink__motion_enabled`. The `motion_enabled` property reports if the `camera` is ready to detect motion *regardless if the system is actually armed**. The `status` property is more descriptive, and can be one of the following states: - `disabled`: System is disabled. - `disarmed`: Camera and/or system are disarmed and not ready to detect motion. @@ -100,7 +100,6 @@ blink: - wifi_strength ``` - ## {% linkable_title Services %} ### {% linkable_title `blink.blink_update` %} @@ -117,7 +116,7 @@ Trigger a camera to take a new still image. ### {% linkable_title `blink.save_video` %} -Save the last recorded video of a camera to a local file. Note that in most cases, home-assistant will need to know that the directory is writable via the `whitelist_external_dirs` in your `configuration.yaml` file (see example below). +Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `whitelist_external_dirs` in your `configuration.yaml` file (see example below). | Service Data Attribute | Optional | Description | |------------------------|----------|------------------------------------------| @@ -135,4 +134,4 @@ homeassistant: ### {% linkable_title Other Services %} -In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. +In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. From f9c3aa9b1d96e0a6c6eeed29170022678ebeebfa Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 00:05:47 +0200 Subject: [PATCH 14/64] Update TravisCi component configuration variable (#6726) * Update TravisCi component configuration variable * :ambulance: Try to fix * Remove scan_interval --- source/_components/sensor.travisci.markdown | 45 +++++++++++++++------ 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/source/_components/sensor.travisci.markdown b/source/_components/sensor.travisci.markdown index 82698ab737a..4cf18089651 100644 --- a/source/_components/sensor.travisci.markdown +++ b/source/_components/sensor.travisci.markdown @@ -24,16 +24,35 @@ sensor: api_key: 123456789 ``` -Configuration variables: - -- **api_key** (*Required*): GitHub [access token](https://github.com/settings/tokens) with the following scopes: *read:org*, *user:email*, *repo_deployment*, *repo:status*, *write:repo_hook*. -- **branch** (*Optional*): Determine which default branch should be used by the **state** condition. Defaults to *master*. -- **scan_interval** (*Optional*): How frequently to query for new data. Defaults to 30 seconds. -- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored. - - **last_build_id**: Turn the last build job ID. - - **last_build_duration**: Return the time elapsed in seconds to run the last test job. - - **last_build_finished_at**: Return the timestamp of when the last test job finished. - - **last_build_started_at**: Return the timestamp of when the last test job started. - - **last_build_state**: Return the state from the latest test job/PR. The conditions can be: 'passed', 'failed' or 'started'. - - **state**: Return the build test from the branch specified at by **branch** parameter. -- **repository:** array (*Optional*): Name from the GitHub repositories to be monitored. If not specified, all GitHub repositories linked to Travis-CI will be enabled by default. +{% configuration %} +api_key: + description: "GitHub [access token](https://github.com/settings/tokens) with the following scopes: *read:org*, *user:email*, *repo_deployment*, *repo:status*, *write:repo_hook*." + required: true + type: string +branch: + description: "Determine which default branch should be used by the **state** condition." + required: false + default: master + type: string +monitored_conditions: + description: Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored. + required: false + type: list + keys: + last_build_id: + description: Turn the last build job ID. + last_build_duration: + description: Return the time elapsed in seconds to run the last test job. + last_build_finished_at: + description: Return the timestamp of when the last test job finished. + last_build_started_at: + description: Return the timestamp of when the last test job started. + last_build_state: + description: "Return the state from the latest test job/PR. The conditions can be: 'passed', 'failed' or 'started'." + state: + description: "Return the build test from the branch specified at by **branch** parameter." +repository: + description: Name from the GitHub repositories to be monitored. If not specified, all GitHub repositories linked to Travis-CI will be enabled by default. + required: false + type: list +{% endconfiguration %} From 18a734a04d0d6bf571fa0de1e3abceca3a019820 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 00:05:58 +0200 Subject: [PATCH 15/64] Update Enocean component configuration variable (#6728) * Update Enocean component configuration variable * Minor update --- .../binary_sensor.enocean.markdown | 20 +++++++++++++----- source/_components/enocean.markdown | 9 +++++--- source/_components/light.enocean.markdown | 20 +++++++++++++----- source/_components/sensor.enocean.markdown | 20 +++++++++++------- source/_components/switch.enocean.markdown | 21 ++++++++++++++----- 5 files changed, 65 insertions(+), 25 deletions(-) diff --git a/source/_components/binary_sensor.enocean.markdown b/source/_components/binary_sensor.enocean.markdown index fe4ea3dd681..ff59c3f8e06 100644 --- a/source/_components/binary_sensor.enocean.markdown +++ b/source/_components/binary_sensor.enocean.markdown @@ -30,11 +30,21 @@ binary_sensor: id: [0x01,0x90,0x84,0x3C] ``` -Configuration variables: - -- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer. -- **name** (*Optional*): An identifier for the switch in the frontend. -- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. +{% configuration %} +id: + description: The ID of the device. This is the 4 bytes long number written on the dimmer. + required: true + type: list +name: + description: An identifier for the switch in the frontend. + required: false + default: EnOcean binary sensor + type: string +device_class: + description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. + required: false + type: device_class +{% endconfiguration %} EnOcean binary sensors only generate 'button_pressed' events. The event data has following four fields: diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown index 4e38d204446..e22c07ec2af 100644 --- a/source/_components/enocean.markdown +++ b/source/_components/enocean.markdown @@ -41,6 +41,9 @@ enocean: device: /dev/ttyUSB0 ``` -Configuration variables: - -- **device** (*Required*): The port where your device is connected to your Home Assistant host. +{% configuration %} +device: + description: The port where your device is connected to your Home Assistant host. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/light.enocean.markdown b/source/_components/light.enocean.markdown index 9203497d937..1933e8f4390 100644 --- a/source/_components/light.enocean.markdown +++ b/source/_components/light.enocean.markdown @@ -26,8 +26,18 @@ light: sender_id: [0xFF,0xC6,0xEA,0x04] ``` -Configuration variables: - -- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer. -- **sender_id** (*Required*): The Sender ID of the device. This is a 4 bytes long number. -- **name** (*Optional*): An identifier for the Ligh in the frontend. +{% configuration %} +id: + description: The ID of the device. This is the 4 bytes long number written on the dimmer. + required: true + type: list +sender_id: + description: The Sender ID of the device. This is a 4 bytes long number. + required: true + type: list +name: + description: An identifier for the Ligh in the frontend. + required: false + default: EnOcean Light + type: string +{% endconfiguration %} diff --git a/source/_components/sensor.enocean.markdown b/source/_components/sensor.enocean.markdown index 669c07825aa..d75ef524801 100644 --- a/source/_components/sensor.enocean.markdown +++ b/source/_components/sensor.enocean.markdown @@ -21,13 +21,19 @@ To use your EnOcean device, you first have to set up your [EnOcean hub](../enoce ```yaml # Example configuration.yaml entry sensor: - - name: Television - platform: enocean + - platform: enocean + name: Television id: [0x01,0x90,0x84,0x3C] ``` -Configuration variables: - -- **id** (*Required*): The ID of the device. This is a 4 bytes long number. -- **platform** (*Required*): Set to `enocean`. -- **name** (*Required*): An identifier for the switch +{% configuration %} +id: + description: The ID of the device. This is a 4 bytes long number. + required: true + type: list +name: + description: An identifier for the switch + required: true + default: EnOcean sensor + type: string +{% endconfiguration %} diff --git a/source/_components/switch.enocean.markdown b/source/_components/switch.enocean.markdown index 2676b51dbae..f891b939306 100644 --- a/source/_components/switch.enocean.markdown +++ b/source/_components/switch.enocean.markdown @@ -24,11 +24,22 @@ switch: id: [0x01,0x90,0x84,0x3C] ``` -Configuration variables: - -- **id** (*Required*): The ID of the device. This is a 4 bytes long number. -- **name** (*Optional*): An identifier for the switch. Default to `EnOcean Switch`. -- **channel** (*Optional*): The number of the channel (typically 0 or 1) for the output channel to switch. Default to `0`. +{% configuration %} +id: + description: The ID of the device. This is a 4 bytes long number. + required: true + type: list +name: + description: An identifier for the switch. + required: false + default: EnOcean Switch + type: string +channel: + description: The number of the channel (typically 0 or 1) for the output channel to switch. + required: false + default: 0 + type: integer +{% endconfiguration %} ```yaml # Example entries for a switch with 2 outputs (channels), e.g., the Nod On SIN-2-1-01 From f1a269a3b7b7a095d7d65f31ba92eaf05f707627 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 13 Oct 2018 00:16:46 +0200 Subject: [PATCH 16/64] Move instructions to section section --- source/_components/sensor.travisci.markdown | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/source/_components/sensor.travisci.markdown b/source/_components/sensor.travisci.markdown index 4cf18089651..262f7359d71 100644 --- a/source/_components/sensor.travisci.markdown +++ b/source/_components/sensor.travisci.markdown @@ -15,18 +15,30 @@ ha_iot_class: "Cloud Polling" With this sensor platform, you will be able to integrate the test build results reported by [Travis-CI](https://travis-ci.org/) working within Home Assistant. +## {% linkable_title Setup %} + +Create a GitHub [access token](https://github.com/settings/tokens) with the following scopes: + +- **read:org** +- **user:email** +- **repo_deployment** +- **repo:status** +- **write:repo_hook** + +## {% linkable_title Configuration %} + To enable this platform, please add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: travisci - api_key: 123456789 + api_key: YOUR_ACCESS_TOKEN ``` {% configuration %} api_key: - description: "GitHub [access token](https://github.com/settings/tokens) with the following scopes: *read:org*, *user:email*, *repo_deployment*, *repo:status*, *write:repo_hook*." + description: The acces token for GitHub. required: true type: string branch: From 93393bf1f032b76144a600952e5966d71306c931 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 00:25:26 +0200 Subject: [PATCH 17/64] Update Netatmo camera and climate component configuration variable (#6731) --- source/_components/camera.netatmo.markdown | 18 +++++++++++++----- source/_components/climate.netatmo.markdown | 18 +++++++++++++----- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/source/_components/camera.netatmo.markdown b/source/_components/camera.netatmo.markdown index e452d26b413..eb11c1a1a49 100644 --- a/source/_components/camera.netatmo.markdown +++ b/source/_components/camera.netatmo.markdown @@ -29,11 +29,19 @@ camera: - platform: netatmo ``` -Configuration variables: - -- **home** (*Optional*): Will display the cameras of this home only. -- **cameras** array (*Optional*): Cameras to use. Multiple entities allowed. - - **camera_name**: Name of the camera to display. +{% configuration %} +home: + description: Will display the cameras of this home only. + required: false + type: string +cameras: + description: Cameras to use. Multiple entities allowed. + required: false + type: list + keys: + camera_name: + description: Name of the camera to display. +{% endconfiguration %} If **home** and **cameras** are not provided, all cameras will be displayed. For more control over your cameras check the configuration sample below. diff --git a/source/_components/climate.netatmo.markdown b/source/_components/climate.netatmo.markdown index a90a1f4353c..bb9e538de08 100644 --- a/source/_components/climate.netatmo.markdown +++ b/source/_components/climate.netatmo.markdown @@ -26,11 +26,19 @@ climate: - platform: netatmo ``` -Configuration variables: - -- **relay** (*Optional*): Will display the thermostats of this relay only. -- **thermostat** array (*Optional*): Thermostat to use. - - **thermostat_name**: Name of the thermostat to display. +{% configuration %} +relay: + description: Will display the thermostats of this relay only. + required: false + type: string +thermostat: + description: Thermostat to use. + required: false + type: list + keys: + thermostat_name: + description: Name of the thermostat to display. +{% endconfiguration %} If **relay** and **thermostat** are not provided, all thermostats will be displayed. From 94b4ab370719a60abc4bc2b9fa10eb542b3a4897 Mon Sep 17 00:00:00 2001 From: Victor Cerutti Date: Sat, 13 Oct 2018 09:54:05 +0200 Subject: [PATCH 18/64] Remove duplicate title attribute (#6740) --- source/_lovelace/gauge.markdown | 1 - 1 file changed, 1 deletion(-) diff --git a/source/_lovelace/gauge.markdown b/source/_lovelace/gauge.markdown index 32528d7371f..a9e5d80e0f0 100644 --- a/source/_lovelace/gauge.markdown +++ b/source/_lovelace/gauge.markdown @@ -90,7 +90,6 @@ Define the severity map: ```yaml - type: gauge title: With Severity - title: CPU Usuage unit_of_measurement: '%' entity: sensor.cpu_usuage severity: From 0e987955a8ffb842aac01ac08f2a298687b730df Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 09:54:55 +0200 Subject: [PATCH 19/64] Update Ring camera component configuration variable (#6734) --- source/_components/camera.ring.markdown | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/source/_components/camera.ring.markdown b/source/_components/camera.ring.markdown index 7499d2a14a5..98d03ff0e65 100644 --- a/source/_components/camera.ring.markdown +++ b/source/_components/camera.ring.markdown @@ -25,10 +25,17 @@ camera: - platform: ring ``` -Configuration variables: - -- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options. -- **scan_interval**: (*Optional*): How frequently to query for new video. Defaults to 90 seconds. +{% configuration %} +ffmpeg_arguments: + description: Extra options to pass to ffmpeg, e.g., image quality or video filter options. + required: false + type: string +scan_interval: + description: How frequently to query for new video in seconds. + required: false + default: 90 + type: integer +{% endconfiguration %} **Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation. From 99131191de299bf2579b892c69851b0c3172204b Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 09:56:19 +0200 Subject: [PATCH 20/64] Update Synology component configuration variable (#6735) --- source/_components/camera.synology.markdown | 41 +++++- .../_components/notify.synology_chat.markdown | 14 +- .../_components/sensor.synologydsm.markdown | 137 +++++++++++++----- 3 files changed, 140 insertions(+), 52 deletions(-) diff --git a/source/_components/camera.synology.markdown b/source/_components/camera.synology.markdown index 93a2e78ff36..7d0a4946187 100644 --- a/source/_components/camera.synology.markdown +++ b/source/_components/camera.synology.markdown @@ -27,14 +27,39 @@ camera: password: YOUR_PASSWORD ``` -Configuration variables: - -- **url** (*Required*): The URL to your synology, including port. -- **username** (*Required*): The username for accessing surveillance station. -- **password** (*Required*): The password for accessing surveillance station. -- **timeout** (*Optional*): The timeout in seconds used when connecting to the Surveillance Station. Defaults to 5. -- **whitelist** (*Optional*): A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added. -- **verify_ssl** (*Optional*): True to require a valid certificate, False to disable certificate checking. Defaults to `True`. +{% configuration %} +name: + description: A name for this synology camera component. + required: false + default: Synology Camera + type: string +url: + description: The URL to your synology, including port. + required: true + type: string +username: + description: The username for accessing surveillance station. + required: true + type: string +password: + description: The password for accessing surveillance station. + required: true + type: string +timeout: + description: The timeout in seconds used when connecting to the Surveillance Station. + required: false + default: 5 + type: integer +whitelist: + description: A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added. + required: false + type: list +verify_ssl: + description: True to require a valid certificate, False to disable certificate checking. + required: false + default: true + type: boolean +{% endconfiguration %} A full sample configuration for the `synology` platform is shown below: diff --git a/source/_components/notify.synology_chat.markdown b/source/_components/notify.synology_chat.markdown index 5fbbae6a046..a42f3934eed 100644 --- a/source/_components/notify.synology_chat.markdown +++ b/source/_components/notify.synology_chat.markdown @@ -26,9 +26,15 @@ notify: resource: https://example.your.synology.com/webapi/entry.cgi?api=SYNO.Chat.External&method=incoming&version=1&token=ABCDEFG ``` -Configuration variables: - -- **name** (*Required*): Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. -- **resource** (*Required*): The incoming webhook URL. +{% configuration %} +name: + description: "Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`." + required: true + type: string +resource: + description: The incoming webhook URL. + required: true + type: string +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/sensor.synologydsm.markdown b/source/_components/sensor.synologydsm.markdown index 886a357bdaa..62fed833080 100644 --- a/source/_components/sensor.synologydsm.markdown +++ b/source/_components/sensor.synologydsm.markdown @@ -33,46 +33,103 @@ sensor: - network_up ``` -Configuration variables: - -- **host** (*Required*): The IP address of the Synology NAS to monitor. -- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5001`. -- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details). -- **password** (*Required*): The password of the user to connect to the Synology NAS. -- **ssl** (*Optional*): Determine if HTTPS should be used. Defaults to `True` which by default runs on port `5001`. -- **volumes** (*Optional*): Array of volumes to monitor. Defaults to all volumes. -- **disks** (*Optional*): Array of disks to monitor. Defaults to all disks. -- **monitored_conditions** (*Required*): Defines a [template](/topics/templating/) to extract a value from the payload. - - **cpu_other_load**: Displays unspecified load in percentage. - - **cpu_user_load**: Displays user load in percentage. - - **cpu_system_load**: Displays system load in percentage. - - **cpu_total_load**: Displays combined load in percentage. - - **cpu_1min_load**: Displays maximum load in past minute. - - **cpu_5min_load**: Displays maximum load in past 5 minutes. - - **cpu_15min_load**: Displays maximum load in past 15 minutes. - - **memory_real_usage**: Displays percentage of memory used. - - **memory_size**: Displays total size of memory in MB. - - **memory_cached**: Displays total size of cache in MB. - - **memory_available_swap**: Displays total size of available swap in MB. - - **memory_available_real**: Displays total size of memory used (based on real memory) in MB. - - **memory_total_swap**: Displays total size of actual memory in MB. - - **memory_total_real**: Displays total size of real memory in MB. - - **network_up**: Displays total up speed of network interfaces (combines all interfaces). - - **network_down**: Displays total down speed of network interfaces (combines all interfaces). - - **disk_name**: Displays the name of the hard disk (creates a new entry for each disk). - - **disk_device**: Displays the path of the hard disk (creates a new entry for each disk). - - **disk_smart_status**: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk). - - **disk_status**: Displays the status of the hard disk (creates a new entry for each disk). - - **disk_exceed_bad_sector_thr**: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk). - - **disk_below_remain_life_thr**: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk). - - **disk_temp**: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F). - - **volume_status**: Displays the status of the volume (creates a new entry for each volume). - - **volume_device_type**: Displays the volume type (RAID, etc) (creates a new entry for each volume). - - **volume_size_total**: Displays the total size of the volume in GB's (creates a new entry for each volume). - - **volume_size_used**: Displays the used space on this volume in GB's (creates a new entry for each volume). - - **volume_percentage_used**: Displays the percentage used for this volume in GB's (creates a new entry for each volume). - - **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume). - - **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume). +{% configuration %} +host: + description: The IP address of the Synology NAS to monitor. + required: true + type: string +port: + description: The port number on which the Synology NAS is reachable. + required: false + default: 5001 + type: integer +username: + description: An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details). + required: true + type: string +password: + description: The password of the user to connect to the Synology NAS. + required: true + type: string +ssl: + description: Determine if HTTPS should be used. + required: false + default: true + type: boolean +volumes: + description: Array of volumes to monitor. Defaults to all volumes. + required: false + type: list +disks: + description: Array of disks to monitor. Defaults to all disks. + required: false + type: list +monitored_conditions: + description: Defines a [template](/topics/templating/) to extract a value from the payload. + required: true + type: list + keys: + cpu_other_load: + description: Displays unspecified load in percentage. + cpu_user_load: + description: Displays user load in percentage. + cpu_system_load: + description: Displays system load in percentage. + cpu_total_load: + description: Displays combined load in percentage. + cpu_1min_load: + description: Displays maximum load in past minute. + cpu_5min_load: + description: Displays maximum load in past 5 minutes. + cpu_15min_load: + description: Displays maximum load in past 15 minutes. + memory_real_usage: + description: Displays percentage of memory used. + memory_size: + description: Displays total size of memory in MB. + memory_cached: + description: Displays total size of cache in MB. + memory_available_swap: + description: Displays total size of available swap in MB. + memory_available_real: + description: Displays total size of memory used (based on real memory) in MB. + memory_total_swap: + description: Displays total size of actual memory in MB. + memory_total_real: + description: Displays total size of real memory in MB. + network_up: + description: Displays total up speed of network interfaces (combines all interfaces). + network_down: + description: Displays total down speed of network interfaces (combines all interfaces). + disk_name: + description: Displays the name of the hard disk (creates a new entry for each disk). + disk_device: + description: Displays the path of the hard disk (creates a new entry for each disk). + disk_smart_status: + description: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk). + disk_status: + description: Displays the status of the hard disk (creates a new entry for each disk). + disk_exceed_bad_sector_thr: + description: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk). + disk_below_remain_life_thr: + description: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk). + disk_temp: + description: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F). + volume_status: + description: Displays the status of the volume (creates a new entry for each volume). + volume_device_type: + description: Displays the volume type (RAID, etc) (creates a new entry for each volume). + volume_size_total: + description: Displays the total size of the volume in GB's (creates a new entry for each volume). + volume_size_used: + description: Displays the used space on this volume in GB's (creates a new entry for each volume). + volume_percentage_used: + description: Displays the percentage used for this volume in GB's (creates a new entry for each volume). + volume_disk_temp_avg: + description: Displays the average temperature of all disks in the volume (creates a new entry for each volume). + volume_disk_temp_max: + description: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume). +{% endconfiguration %}

After booting Home Assistant it can take up to 15 minutes for the sensors to show up. This is due to the fact that sensors are created after Home Assistant has fully been initialized. From 642ebe85b694f0b0a95041768ade71c5f3ba3607 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 13 Oct 2018 09:59:24 +0200 Subject: [PATCH 21/64] Minor changes --- source/_components/camera.synology.markdown | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/source/_components/camera.synology.markdown b/source/_components/camera.synology.markdown index 7d0a4946187..78010327625 100644 --- a/source/_components/camera.synology.markdown +++ b/source/_components/camera.synology.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" 　 The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant. +## {% linkable_title Configuration %} + To enable your Surveillance Station cameras in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -29,20 +31,20 @@ camera: {% configuration %} name: - description: A name for this synology camera component. + description: A name for this Synology camera. required: false default: Synology Camera type: string url: - description: The URL to your synology, including port. + description: The URL to your Synology, including port. required: true type: string username: - description: The username for accessing surveillance station. + description: The username for accessing Surveillance Station. required: true type: string password: - description: The password for accessing surveillance station. + description: The password for accessing Surveillance Station. required: true type: string timeout: @@ -51,17 +53,19 @@ timeout: default: 5 type: integer whitelist: - description: A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added. + description: A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added. required: false type: list verify_ssl: - description: True to require a valid certificate, False to disable certificate checking. + description: Verify SSL/TLS certificate for HTTPS request. required: false default: true type: boolean {% endconfiguration %} -A full sample configuration for the `synology` platform is shown below: +## {% linkable_title Full example %} + +A full sample configuration for the `synology` camera platform is shown below: ```yaml # Example configuration.yaml entry @@ -75,5 +79,5 @@ camera: ```

-Most users will need to set `verify_ssl` to false unless they have installed a valid SSL certificate in place of the built in self-signed certificate. +Most users will need to set `verify_ssl` to false unless they have installed a valid SSL/TLS certificate in place of the built in self-signed certificate.

From c3926e3b4903277288f82d79fcde0be4c689f09c Mon Sep 17 00:00:00 2001 From: Austin Drummond Date: Sat, 13 Oct 2018 04:18:16 -0400 Subject: [PATCH 22/64] Fixed a link on z-wave entities (#6737) --- source/_docs/z-wave/entities.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown index 2826e777bfb..2d45b69d097 100644 --- a/source/_docs/z-wave/entities.markdown +++ b/source/_docs/z-wave/entities.markdown @@ -177,7 +177,7 @@ binary_sensor: - **254**: Deep sleep - **255**: Case open -If your device has a `burglar` entity, but not a `binary_sensor` equivalent, you can use a [template binary sensor](/components/binary_sensor.template/) to create one (here we've defined it as a motion sensor, but you can use [any relevant device class](/components/binary_sensor/#device-class: +If your device has a `burglar` entity, but not a `binary_sensor` equivalent, you can use a [template binary sensor](/components/binary_sensor.template/) to create one (here we've defined it as a motion sensor, but you can use [any relevant device class](/components/binary_sensor/#device-class): {% raw %} ```yaml From e3aa2f9f282447c7980a8e695b331a900aed67b3 Mon Sep 17 00:00:00 2001 From: longman391 Date: Sat, 13 Oct 2018 03:12:05 -0700 Subject: [PATCH 23/64] Update secrets.markdown (#6741) Fixed typos, comma splices, and missing punctuation. --- source/_docs/configuration/secrets.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index 0f1728cc013..438896ed5c5 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /topics/secrets/ --- -The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from you configuration files. This separation can also help you to keep easier track of your passwords and API keys. As they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple yaml files if you [split up your configuration](/docs/configuration/splitting_configuration/). +The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple yaml files if you [split up your configuration](/docs/configuration/splitting_configuration/). ### {% linkable_title Using secrets.yaml %} @@ -42,9 +42,9 @@ When you start splitting your configuration into multiple files, you might end u - A `secrets.yaml` located in the same folder as the YAML file referencing the secret, - next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`, -- lastly, `keyring` will be queried for the secret (more info below) +- lastly, `keyring` will be queried for the secret (more info below). -To see where secrets are being loaded from you can either add an option to your `secrets.yaml` file or use the `check_config` script. +To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. *Option 1*: Print where secrets are retrieved from to the Home Assistant log by adding the following to `secrets.yaml`: @@ -53,7 +53,7 @@ logger: debug ``` This will not print the actual secret's value to the log. -*Option 2*: View where secrets are retrieved from and the contents of all `secrets.yaml` files used, you can use the [`check_config` script](/docs/tools/check_config/) from the command line: +*Option 2*: To view where secrets are retrieved from and the contents of all `secrets.yaml` files used, you can use the [`check_config` script](/docs/tools/check_config/) from the command line: ```bash $ hass --script check_config --secrets From 5f86763e72d8719d49d86438be2a9d339bb093f4 Mon Sep 17 00:00:00 2001 From: Markus Nigbur Date: Sat, 13 Oct 2018 12:55:11 +0200 Subject: [PATCH 24/64] Changed filename to reflect the actual sensor name (#6744) --- .../{sensor.api_stream.markdown => sensor.api_streams.markdown} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename source/_components/{sensor.api_stream.markdown => sensor.api_streams.markdown} (86%) diff --git a/source/_components/sensor.api_stream.markdown b/source/_components/sensor.api_streams.markdown similarity index 86% rename from source/_components/sensor.api_stream.markdown rename to source/_components/sensor.api_streams.markdown index f3178306615..0a5e744e645 100644 --- a/source/_components/sensor.api_stream.markdown +++ b/source/_components/sensor.api_streams.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Local Push" ha_qa_scale: internal --- -The `api_stream` sensor platform shows how many clients are connected to the stream API +The `api_streams` sensor platform shows how many clients are connected to the stream API ## {% linkable_title Configuration %} From 56855dec14ef8884e4ce5d5c4c083e0f71e4389b Mon Sep 17 00:00:00 2001 From: Travis Carr Date: Sat, 13 Oct 2018 04:09:06 -0700 Subject: [PATCH 25/64] Update configuration description for binary_sensor.tcp (#6704) * Update configuration description for binary_sensor.tcp * Fix some mistakes...oops. --- source/_components/binary_sensor.tcp.markdown | 43 +++++++++++++++---- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/source/_components/binary_sensor.tcp.markdown b/source/_components/binary_sensor.tcp.markdown index ff5aed010c6..e5651d954b6 100644 --- a/source/_components/binary_sensor.tcp.markdown +++ b/source/_components/binary_sensor.tcp.markdown @@ -30,12 +30,37 @@ binary_sensor: Configuration options for the a TCP Sensor: -- **name** (*Required*): The name you'd like to give the sensor in Home Assistant. -- **host** (*Required*): The hostname/IP address to connect to. -- **port** (*Required*): The port to connect to the host on. -- **payload** (*Required*): What to send to the host in order to get the response we're interested in. -- **value_on** (*Required*): The value returned when the device is "on". -- **timeout** (*Optional*): How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10. -- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. By default it's assumed that the entire response is the value. -- **buffer_size** (*Optional*): The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024. - +{% configuration %} +name: + required: true + description: The name you'd like to give the sensor in Home Assistant. + type: string +host: + required: true + description: The hostname/IP address to connect to. + type: string +port: + required: true + description: The port to connect to the host on. + type: integer +payload: + required: true + description: What to send to the host in order to get the response we're interested in. + type: string +value_on: + required: true + description: The value returned when the device is "on". + type: string +timeout: + required: false + description: How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10. + type: integer +value_template: + required: false + description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. By default it's assumed that the entire response is the value. + type: string +buffer_size: + required: false + description: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024. + type: integer +{% endconfiguration %} \ No newline at end of file From 11808dee0415d1b4000713c482ddf7c2f62df817 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 13:15:06 +0200 Subject: [PATCH 26/64] Fix ring sensor configuration (#6746) * Fix ring sensor configuration * Fix type --- source/_components/sensor.ring.markdown | 30 ++++++++++++++++--------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/source/_components/sensor.ring.markdown b/source/_components/sensor.ring.markdown index e8059abc990..648b93ce4f5 100644 --- a/source/_components/sensor.ring.markdown +++ b/source/_components/sensor.ring.markdown @@ -25,15 +25,25 @@ sensor: - platform: ring ``` -Configuration variables: - -- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. - - **battery**: Return the battery level from device - - **last_activity**: Return the timestamp from the last event captured (ding/motion/on demand) by the Ring doorbell camera - - **last_ding**: Return the timestamp from the last time the Ring doorbell button was pressed - - **last_motion**: Return the timestamp from the last motion event captured by the Ring doorbell camera - - **volume**: Return the volume level from the device. - - **wifi_signal_category**: Return the WiFi signal level from the device. - - **wifi_signal_strength**: Return the WiFi signal strength (dBm) from the device. +{% configuration %} +monitored_conditions: + type: list + required: false + description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled. + battery: + description: Return the battery level from device. + last_activity: + description: Return the timestamp from the last event captured (ding/motion/on demand) by the Ring doorbell camera. + last_ding: + description: Return the timestamp from the last time the Ring doorbell button was pressed. + last_motion: + description: Return the timestamp from the last motion event captured by the Ring doorbell camera. + volume: + description: Return the volume level from the device. + wifi_signal_category: + description: Return the WiFi signal level from the device. + wifi_signal_strength: + description: Return the WiFi signal strength (dBm) from the device. +{% endconfiguration %} Currently it supports doorbell, external chimes and stickup cameras. From aa8b39736e6e199d4a0e557bb06973ef0691c873 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 13:23:14 +0200 Subject: [PATCH 27/64] Update Wink component configuration variable (#6723) * Update Wink component configuration variable * Minor changes --- source/_components/wink.markdown | 38 ++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index c849971fc26..ade545e1374 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -44,11 +44,10 @@ When using the configurator make sure the initial setup is performed on the same wink: ``` -### {% linkable_title Full oauth authentication (legacy). %} +### {% linkable_title Full oauth authentication (legacy) %} This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existence. - ```yaml wink: email: YOUR_WINK_EMAIL_ADDRESS @@ -57,23 +56,38 @@ wink: client_secret: YOUR_WINK_CLIENT_SECRET ``` -Configuration variables: +Please pay attention that the required entries are only needed for legacy OAuth access. -- **email** (*Required for legacy OAuth*): Your Wink login email. -- **password** (*Required for legacy OAuth*): Your Wink login password. -- **client_id** (*Required for legacy OAuth*): Your provided Wink client_id. -- **client_secret** (*Required for legacy OAuth*): Your provided Wink client_secret. -- **local_control** (*Optional*): If set to `True` state changes for lights, locks, and switches will be issued to the local hub. +{% configuration %} +email: + description: Your Wink login email address. + required: true + type: string +password: + description: Your Wink login password. + required: true + type: string +client_id: + description: Your provided Wink `client_id`. + required: true + type: string +client_secret: + description: Your provided Wink `client_secret`. + required: true + type: string +local_control: + description: If set to `true` state changes for lights, locks and switches will be issued to the local hub. + required: false + default: false + type: boolean +{% endconfiguration %} Local control: -- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `False`. +- Wink's local control API isn't officially documented and therefore could be broken by a hub update. For these reasons `local_control` defaults to `false`. - Using local control doesn't appear to make commands any quicker, but does function in an internet/Wink outage. - - Local control is also only available for the Wink hub v1 and v2, not the Wink relay. - - Local control isn't used during start-up of Home Assistant; this means initial setup requires an active internet connection. - - Local control requests are first sent to the controlling hub. If a request fails, that request will attempt to go online.

From cd3d7d70aa94edfc5b7eda4aa7ed8a0721b1b7fa Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 13:25:50 +0200 Subject: [PATCH 28/64] Fix skybell configuration (#6743) * Fix skybell configuration * Fix type * Fix type --- .../_components/binary_sensor.skybell.markdown | 16 +++++++++++----- source/_components/sensor.skybell.markdown | 13 +++++++++---- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/source/_components/binary_sensor.skybell.markdown b/source/_components/binary_sensor.skybell.markdown index 25558eb1cd5..5ca42b98c33 100644 --- a/source/_components/binary_sensor.skybell.markdown +++ b/source/_components/binary_sensor.skybell.markdown @@ -28,8 +28,14 @@ binary_sensor: - motion ``` -Configuration variables: - -- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored. - - **button**: Return a boolean value when the doorbell button was pressed. - - **motion**: Return a boolean value when movement was detected by the Skybell doorbell. +{% configuration %} +monitored_conditions: + type: list + required: true + description: Conditions to display in the frontend. The following conditions can be monitored. + keys: + button: + description: Returns whether the doorbell button was pressed. + motion: + description: Returns whether movement was detected by the Skybell doorbell. +{% endconfiguration %} diff --git a/source/_components/sensor.skybell.markdown b/source/_components/sensor.skybell.markdown index 023ee75738f..39699978b99 100644 --- a/source/_components/sensor.skybell.markdown +++ b/source/_components/sensor.skybell.markdown @@ -27,7 +27,12 @@ sensor: - chime_level ``` -Configuration variables: - -- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored. - - **chime_level**: Return a value between 0-3, indicating no chime, low, medium, and high respectively. +{% configuration %} +monitored_conditions: + type: list + required: true + description: Conditions to display in the frontend. The following conditions can be monitored. + keys: + chime_level: + description: Return a value between 0-3, indicating no chime, low, medium, and high respectively. +{% endconfiguration %} From ccd5340b9c70cf728e601da6962ec7674968b559 Mon Sep 17 00:00:00 2001 From: Markus Nigbur Date: Sat, 13 Oct 2018 14:44:27 +0200 Subject: [PATCH 29/64] Updated nuki component configuration section (#6745) * Updated nuki component configuration section Related to #6385. * Changed port type to integer --- source/_components/lock.nuki.markdown | 33 ++++++++++++--------------- 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/source/_components/lock.nuki.markdown b/source/_components/lock.nuki.markdown index 6d10c73f9ad..bc5299d61ab 100644 --- a/source/_components/lock.nuki.markdown +++ b/source/_components/lock.nuki.markdown @@ -27,24 +27,21 @@ lock: token: fe2345ef ``` -Configuration variables: - -- **host** (*Required*): The IP or hostname of the Nuki bridge. -- **port** (*Optional*): The port on which the Nuki bridge is listening on. Defaults to `8080`. -- **token** (*Required*): The token that was defined when setting up the bridge. - -## {% linkable_title Full configuration %} - -Here's a full configuration example for a Nuki bridge: - -```yaml -# Example configuration.yaml entry -lock: - - platform: nuki - host: 192.168.1.120 - port: 8080 - token: fe2345ef -``` +{% configuration %} +host: + description: The IP or hostname of the Nuki bridge. + required: true + type: string +port: + description: The port on which the Nuki bridge is listening on. + required: false + default: 8080 + type: integer +token: + description: The token that was defined when setting up the bridge. + required: true + type: string +{% endconfiguration %} ## {% linkable_title Services %} From be2fbceb3c1c1be74151f7b484bcf8cb4ff6a7aa Mon Sep 17 00:00:00 2001 From: Jan van Helvoort Date: Sat, 13 Oct 2018 17:07:31 +0200 Subject: [PATCH 30/64] Add zwave.network_complete_some_dead event (#6749) --- source/_components/homekit.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 08d4835bd67..77ec79577f6 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -190,6 +190,8 @@ automation: event_type: zwave.network_ready - platform: event event_type: zwave.network_complete + - platform: event + event_type: zwave.network_complete_some_dead action: - service: homekit.start ``` From 38bad7af6e6e75bb2f7415488e4cb4d438ce6b13 Mon Sep 17 00:00:00 2001 From: Luuk Date: Sat, 13 Oct 2018 17:12:34 +0200 Subject: [PATCH 31/64] Update yeelight configuration (#6747) * Update Yeelight configuration variables to new format * Remove optional configuration variables from main example and added additional examples --- source/_components/light.yeelight.markdown | 77 ++++++++++++++++++---- 1 file changed, 65 insertions(+), 12 deletions(-) diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index d5d5adb4e80..c6019083e95 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -26,20 +26,39 @@ light: devices: 192.168.1.25: name: Living Room - transition: 1000 - use_music_mode: True #(defaults to False) - save_on_change: True #(defaults to False) - 192.168.1.13: - name: Front Door ``` -Configuration variables: - -- **ip** (*Required*): IP(s) of your Wifi bulbs -- **name** (*Optional*): A friendly name for the device. -- **transition** (*Optional*, default 350): Smooth transitions over time (in ms). -- **use_music_mode** (*Optional*, default False): Enable music mode. -- **save_on_change** (*Optional*, default False): Saves the bulb state in its nonvolatile memory when changed from Home Assistant. +{% configuration %} +devices: + required: true + description: List of Yeelight devices. + type: map + keys: + ip: + description: IP address of the bulb. + required: true + type: map + keys: + name: + description: A friendly name for the device. + required: false + type: string + transition: + description: Smooth transitions over time (in ms). + required: false + type: integer + default: 350 + use_music_mode: + description: Enable music mode. + required: false + type: boolean + default: False + save_on_change: + description: Saves the bulb state in its nonvolatile memory when changed from Home Assistant. + required: false + type: boolean + default: False +{% endconfiguration %} #### {% linkable_title Music mode %} Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the component and it tries to keep the connection open, which may not be wanted in all use-cases. @@ -80,3 +99,37 @@ Set an operation mode. |---------------------------|----------|---------------------------------------------------------------------------------------------| | `entity_id` | yes | Only act on a specific yeelight. Else targets all. | | `mode` | no | Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'. | + +## {% linkable_title Examples %} + +In this section you find some real-life examples of how to use this light. + +### {% linkable_title Full configuration %} + +This example shows how you can use the optional configuration options. + +```yaml +# Example configuration.yaml entry +light: + - platform: yeelight + devices: + 192.168.1.25: + name: Living Room + transition: 1000 + use_music_mode: True + save_on_change: True +``` + +### {% linkable_title Multiple bulbs %} + +This example shows how you can add multiple bulbs in your configuration. + +```yaml +light: + - platform: yeelight + devices: + 192.168.1.25: + name: Living Room + 192.168.1.13: + name: Front Door +``` From 1bf83491761937352f0391dfaa67baa0fb9d3033 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 17:24:48 +0200 Subject: [PATCH 32/64] Update Buienradar weather component configuration variable (#6717) * Update Buienradar weather component configuration variable * :ambulance: Fix * :pencil2: Tweak --- .../_components/weather.buienradar.markdown | 26 ++++++++++++++----- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index 0b4ef3f0db8..8ec59346cc8 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -27,13 +27,25 @@ weather: - platform: buienradar ``` -Configuration variables: - -- **name** (*Optional*): You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains. -- **latitude** (*Optional*): Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. -- **longitude**(*Optional*): Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. -- **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it. - +{% configuration %} +name: + description: "You can specify a name of the component, but do not have to. If you specify a name, the weather component will get an entity name of `weather.[name]`; if no name is specified, it will try to set its name to `weather.BR_[stationname]`. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named `weather.BR_unknown_station`. Later the station name will be known and get updated, but the entity name remains." + required: false + type: string +latitude: + description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. + required: false + type: float +longitude: + description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this component to select a different location for Buienradar. + required: false + type: float +forecast: + description: "'True' to add a temperature forecast, 'False' to suppress it." + required: false + default: true + type: boolean +{% endconfiguration %} A full configuration example: From efc99cedfecbcd2a026143f9b1e70e179c099206 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 21:39:56 +0200 Subject: [PATCH 33/64] Fix sonarr configuration (#6754) * Fix sonarr configuration * Close configuration tag --- source/_components/sensor.sonarr.markdown | 76 +++++++++++++++++------ 1 file changed, 58 insertions(+), 18 deletions(-) diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index b752a2a702d..9b70848868d 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -27,24 +27,64 @@ sensor: api_key: YOUR_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): Your Sonarr API key, found in Settings > General in the Sonarr Web UI. -- **host** (*Optional*): The host Sonarr is running on. Defaults to `localhost`. -- **port** (*Optional*): The port Sonarr is running on. Defaults to 8989. -- **monitored_conditions** array (*Optional*): Conditions to display on the frontend. Defaults to `upcoming`. - - **series**: The number of series in Sonarr. - - **upcoming**: The number of upcoming episodes. - - **wanted**: The number of episodes still 'wanted'. - - **queue**: The number of episodes in the queue. - - **commands**: The number of commands being run. - - **diskspace**: Available disk space. - -- **urlbase** (*Optional*): The base URL Sonarr is running under. Defaults to `/`. -- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1. -- **include_paths** (*Optional*): Array of file paths to include when calculating diskspace. Leave blank to include all. -- **unit**: (*Optional*): The unit to display disk space in. Defaults to GB. -- **ssl**: boolean (*Optional*): Whether or not to use SSL for Sonarr. +{% configuration %} +api_key: + required: true + type: string + description: "Your Sonarr API key, found in Settings > General in the Sonarr Web UI." +host: + required: false + type: string + description: The host Sonarr is running on. + default: "`localhost`" +port: + required: false + type: integer + description: The port Sonarr is running on. + default: 8989 +monitored_conditions: + type: list + required: false + description: Conditions to display on the frontend. + default: "`upcoming`" + keys: + series: + description: The number of series in Sonarr. + upcoming: + description: The number of upcoming episodes. + wanted: + description: The number of episodes still 'wanted'. + queue: + description: The number of episodes in the queue. + commands: + description: The number of commands being run. + diskspace: + description: Available disk space. +urlbase: + required: false + type: string + description: The base URL Sonarr is running under. + default: "`/`" +days: + required: false + type: integer + description: How many days to look ahead for the upcoming sensor, 1 means today only. + default: 1 +include_paths: + required: false + type: list + description: Array of file paths to include when calculating diskspace. Leave blank to include all. +unit: + required: false + type: string + description: The unit to display disk space in. + default: GB +ssl: + required: false + type: boolean + description: Whether or not to use SSL for Sonarr. + default: false +{% endconfiguration %} ## {% linkable_title Examples %} From e74d12ff579d1db2a6e1756d59404e0e2d4950a2 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 21:41:00 +0200 Subject: [PATCH 34/64] Fix radarr configuration (#6753) --- source/_components/sensor.radarr.markdown | 71 ++++++++++++++++++----- 1 file changed, 55 insertions(+), 16 deletions(-) diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 11635a8d18d..08bb928d472 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -26,22 +26,61 @@ sensor: api_key: YOUR_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): Your Radarr API key, found in Settings > General in the Radarr Web UI. -- **host** (*Optional*): The host Radarr is running on. Defaults to `localhost`. -- **port** (*Optional*): The port Radarr is running on. Defaults to 7878. -- **urlbase** (*Optional*): The base URL Radarr is running under. Defaults to `/`. -- **monitored_conditions** array (*Optional*): Conditions to display on the frontend. Defaults to `movies`. - - **movies**: The number of movies in Radarr. - - **upcoming**: The number of upcoming movie releases (physical and in cinemas). - - **commands**: The number of commands being run. - - **diskspace**: The available disk space. - - **status**: The current system status information. -- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1. -- **include_paths** (*Optional*): Array of file paths to include when calculating diskspace. Leave blank to include all. -- **unit**: (*Optional*): The unit to display disk space in. Defaults to GB. -- **ssl**: boolean (*Optional*): Whether or not to use SSL for Radarr. +{% configuration %} +api_key: + required: true + type: string + description: Your Radarr API key, found in Settings > General in the Radarr Web UI. +host: + required: false + type: string + description: The host Radarr is running on. + default: "`localhost`" +port: + required: false + type: integer + description: The port Radarr is running on. + default: 7878 +urlbase: + required: false + type: string + description: The base URL Radarr is running under. Defaults to `/`. +monitored_conditions: + required: false + type: list + description: Conditions to display on the frontend. + default: "`movies`" + keys: + movies: + description: The number of movies in Radarr. + upcoming: + description: The number of upcoming movie releases (physical and in cinemas). + commands: + description: The number of commands being run. + diskspace: + description: The available disk space. + status: + description: The current system status information. +days: + required: false + type: integer + description: How many days to look ahead for the upcoming sensor, 1 means today only. + default: 1 +include_paths: + required: false + type: list + description: Array of file paths to include when calculating diskspace. Leave blank to include all. +unit: + required: false + type: string + description: The unit to display disk space in. + default: GB +ssl: + required: false + type: boolean + description: Whether or not to use SSL for Radarr. + default: false +{% endconfiguration %} ## {% linkable_title Examples %} From ca98712887607bd02287bd8a3817a02ef3ab4dd7 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 21:41:52 +0200 Subject: [PATCH 35/64] Fix nzbget configuration (#6752) * Fix nzbget configuration * Fix stupidness --- source/_components/sensor.nzbget.markdown | 71 +++++++++++++++++------ 1 file changed, 52 insertions(+), 19 deletions(-) diff --git a/source/_components/sensor.nzbget.markdown b/source/_components/sensor.nzbget.markdown index cb3b45fc5a5..bd32c3a2142 100644 --- a/source/_components/sensor.nzbget.markdown +++ b/source/_components/sensor.nzbget.markdown @@ -28,22 +28,55 @@ sensor: - download_paused ``` -Configuration variables: - -- **host** (*Required*): IP address where your NZBGet installation is running. -- **port** (*Optional*): The port of your NZBGet installation. Defaults to 6789. -- **ssl** (*Optional*): Whether or not to use SSL to access NZBGet. Defaults to false. -- **name** (*Optional*): The prefix to use for your sensor. Defaults to NZBGet. -- **username** (*Optional*): The username to access your NZBGet installation. -- **password** (*Optional*): The password to access your NZBGet installation. -- **monitored_variables** array (*Required*): List of monitored details. - - **article_cache**: Number of cached articles. - - **average_download_rate**: Average download rate - - **download_paused**: Paused downloads - - **download_rate**: Current download rate - - **download_size**: The size to download - - **free_disk_space**: Free disk space at the storage location of NZBGet - - **post_paused**: Paused posts - - **remaining_size**: Remaining size to download - - **uptime**: Uptime of NZBGet - +{% configuration %} +host: + required: true + type: string + description: IP address where your NZBGet installation is running. +port: + required: false + type: integer + description: The port of your NZBGet installation. + default: 6789 +ssl: + required: false + type: boolean + description: Whether or not to use SSL to access NZBGet. + default: false +name: + required: false + type: string + description: The prefix to use for your sensor. + default: NZBGet +username: + required: false + type: string + description: The username to access your NZBGet installation. +password: + required: false + type: string + description: The password to access your NZBGet installation. +monitored_variables: + required: true + type: list + description: List of monitored details. + keys: + article_cache: + description: Number of cached articles. + average_download_rate: + description: Average download rate + download_paused: + description: Paused downloads + download_rate: + description: Current download rate + download_size: + description: The size to download + free_disk_space: + description: Free disk space at the storage location of NZBGet + post_paused: + description: Paused posts + remaining_size: + description: Remaining size to download + uptime: + description: Uptime of NZBGet +{% endconfiguration %} From 7017eb4cd59f281f94895c4ec6e4b6a9169262e2 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sat, 13 Oct 2018 20:43:48 +0100 Subject: [PATCH 36/64] `is_state` needs quotes all the way (#6751) Apparently `is_state` treats the value as a string --- source/_docs/z-wave/entities.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown index 2d45b69d097..50da0e4d028 100644 --- a/source/_docs/z-wave/entities.markdown +++ b/source/_docs/z-wave/entities.markdown @@ -161,7 +161,7 @@ binary_sensor: YOUR_SENSOR: friendly_name: "Friendly name here" device_class: door - value_template: "{{ is_state('sensor.YOUR_ORIGINAL_SENSOR_access_control', 22) }}" + value_template: "{{ is_state('sensor.YOUR_ORIGINAL_SENSOR_access_control', '22') }}" ``` {% endraw %} @@ -187,7 +187,7 @@ binary_sensor: YOUR_SENSOR: friendly_name: "Friendly name here" device_class: motion - value_template: "{{ is_state('sensor.YOUR_SENSOR_burglar', 8) }}" + value_template: "{{ is_state('sensor.YOUR_SENSOR_burglar', '8') }}" ``` {% endraw %} From ff0f41fe5034feae3cf4a2fcc03c521e18ced5e3 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 21:55:34 +0200 Subject: [PATCH 37/64] Fix deluge configuration (#6748) * Fix deluge configuration * Fix eg., * Fix required username and password * Add default --- source/_components/sensor.deluge.markdown | 46 +++++++++++++++++------ source/_components/switch.deluge.markdown | 31 +++++++++++---- 2 files changed, 59 insertions(+), 18 deletions(-) diff --git a/source/_components/sensor.deluge.markdown b/source/_components/sensor.deluge.markdown index 948849b0aad..e82d6a264e6 100644 --- a/source/_components/sensor.deluge.markdown +++ b/source/_components/sensor.deluge.markdown @@ -31,14 +31,38 @@ sensor: - 'upload_speed' ``` -Configuration variables: - -- **host** (*Required*): This is the IP address of your Deluge daemon, eg. 192.168.1.32. -- **port** (*Optional*): The port your Deluge daemon uses. Defaults to 58846. Warning, this is not the port of the WebUI. -- **name** (*Optional*): The name to use when displaying this Deluge instance. -- **username** (*Required*): Your Deluge daemon username. -- **password** (*Required*): Your Deluge daemon password. -- **monitored_variables** array (*Required*): Conditions to display in the frontend. - - **current_status**: The status of your Deluge daemon. - - **download_speed**: The current download speed. - - **upload_speed**: The current upload speed. +{% configuration %} +host: + required: true + type: string + description: This is the IP address of your Deluge daemon, e.g., 192.168.1.32. +port: + required: false + type: integer + description: The port your Deluge daemon uses. Warning, this is not the port of the WebUI. + default: 58846 +name: + required: false + type: string + default: Deluge + description: The name to use when displaying this Deluge instance. +username: + required: true + type: string + description: Your Deluge daemon username. +password: + required: true + type: string + description: Your Deluge daemon password. +monitored_variables: + required: true + type: list + description: Conditions to display in the frontend. + keys: + current_status: + description: The status of your Deluge daemon. + download_speed: + description: The current download speed. + upload_speed: + description: The current upload speed. + {% endconfiguration %} diff --git a/source/_components/switch.deluge.markdown b/source/_components/switch.deluge.markdown index b9673415c39..43afb1976f6 100644 --- a/source/_components/switch.deluge.markdown +++ b/source/_components/switch.deluge.markdown @@ -27,10 +27,27 @@ switch: password : PASSWORD ``` -Configuration variables: - -- **host** (*Required*): This is the IP address of your Deluge daemon, eg. 192.168.1.32. -- **username** (*Required*): Your Deluge username, if you use authentication. -- **password** (*Required*): Your Deluge password, if you use authentication. -- **port** (*Optional*): The port your Deluge daemon uses, defaults to 58846. Warning,this is not the port of the WebUI -- **name** (*Optional*): The name to use when displaying this Deluge instance. +{% configuration %} +host: + required: true + type: string + description: This is the IP address of your Deluge daemon, eg., 192.168.1.32. +username: + required: true + type: string + description: Your Deluge username, if you use authentication. +password: + required: true + type: string + description: Your Deluge password, if you use authentication. +port: + required: false + type: integer + default: 58846 + description: "The port your Deluge daemon uses. (Warning: This is not the port of the WebUI.)" +name: + required: false + type: string + default: Deluge Switch + description: The name to use when displaying this Deluge instance. +{% endconfiguration %} From 78384bc7cdcea44166ae5428a664d6279b072cff Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 21:55:47 +0200 Subject: [PATCH 38/64] Fix Yi camera component configuration variable (#6760) --- source/_components/camera.yi.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index 19faa147f80..dada5b76b48 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -65,8 +65,6 @@ camera: password: my_password_123 ``` -Configuration variables: - {% configuration %} name: description: A human-friendly name for the camera. From fbca47dfa514edbb8c12b9b8e892cf6aab61943d Mon Sep 17 00:00:00 2001 From: cgtobi Date: Sat, 13 Oct 2018 21:56:01 +0200 Subject: [PATCH 39/64] Fix transmission switch configuration (#6755) * Fix transmission switch configuration * Minor change --- .../_components/switch.transmission.markdown | 32 ++++++++++++++----- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/source/_components/switch.transmission.markdown b/source/_components/switch.transmission.markdown index 888f1470a0d..cf7db2f2f32 100644 --- a/source/_components/switch.transmission.markdown +++ b/source/_components/switch.transmission.markdown @@ -25,11 +25,27 @@ switch: host: IP_ADDRESS ``` -Configuration variables: - -- **host** (*Required*): This is the IP address of your Transmission daemon, eg. 192.168.1.32. -- **port** (*Optional*): The port your Transmission daemon uses, defaults to 9091. -- **name** (*Optional*): The name to use when displaying this Transmission instance. -- **username** (*Optional*): Your Transmission username, if you use authentication. -- **password** (*Optional*): Your Transmission password, if you use authentication. - +{% configuration %} +host: + required: true + type: string + description: This is the IP address of your Transmission daemon, e.g., 192.168.1.32. +port: + required: false + type: integer + default: 9091 + description: The port your Transmission daemon uses. +name: + required: false + type: string + default: Transmission Turtle Mode + description: The name to use when displaying this Transmission instance. +username: + required: false + type: string + description: Your Transmission username, if you use authentication. +password: + required: false + type: string + description: Your Transmission password, if you use authentication. +{% endconfiguration %} From 1599305a7b0551f4dd1dfaab1a9fb4c57e95fd6d Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 21:56:12 +0200 Subject: [PATCH 40/64] Update Skybell switch component configuration variable (#6757) * Update Skybell switch component configuration variable * Remove old content --- source/_components/switch.skybell.markdown | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/source/_components/switch.skybell.markdown b/source/_components/switch.skybell.markdown index 632f5d770c9..8bf27738c33 100644 --- a/source/_components/switch.skybell.markdown +++ b/source/_components/switch.skybell.markdown @@ -28,8 +28,14 @@ switch: - motion_sensor ``` -Configuration variables: - -- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored. - - **do_not_disturb**: Control the state of your doorbells indoor chime. - - **motion_sensor**: Control the state of your doorbells motion sensor. +{% configuration %} +monitored_conditions: + description: Conditions to display in the frontend. + required: true + type: list + keys: + do_not_disturb: + description: Control the state of your doorbells indoor chime. + motion_sensor: + description: Control the state of your doorbells motion sensor. +{% endconfiguration %} From 9d13c99849b109f2e8dc99d67e3bb1462fa8ad4b Mon Sep 17 00:00:00 2001 From: Nicholas Westerhausen Date: Sat, 13 Oct 2018 16:30:15 -0400 Subject: [PATCH 41/64] dovado sensor configuration variable format (#6700) * Update configuration variable for dovado Update configuration variable format. Remove two optional configurations from the example configuration. Section underneath configuration variable has a list of allowed values for the *sensors* array there. I am not sure how to describe this using the configuration block format. Possibly related to home-assistant/developers.home-assistant/issues/107 * Change format of accepted keys Change format of accepted keys to pattern seen in other components. Move additional information about the component (registering an SMS notifier) up to the top of the document. * Minor changes --- source/_components/sensor.dovado.markdown | 53 +++++++++++++++-------- 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/source/_components/sensor.dovado.markdown b/source/_components/sensor.dovado.markdown index bbbd0bae3c5..d862ef3fef3 100644 --- a/source/_components/sensor.dovado.markdown +++ b/source/_components/sensor.dovado.markdown @@ -13,7 +13,7 @@ ha_release: 0.32 ha_iot_class: "Local Polling" --- -The `dovado` platform let you monitor your router from [Dovado](http://www.dovado.com/) +The `dovado` platform let you monitor your router from [Dovado](http://www.dovado.com/). If the router provides SMS functionality, a service for sending SMS will also be registered in Home Assistant. To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file: @@ -23,23 +23,42 @@ sensor: - platform: dovado username: YOUR_USERNAME password: YOUR_PASSWORD - host: IP_ADDRESS - port: PORT sensors: - network ``` -Configuration variables: - -- **username** (*Required*): Your username. -- **password** (*Required*): Your password. -- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`. If no host is provided, the gateway for the same network as Home Assistant will automatically be used. -- **port** (*Optional*): The port number of your router, e.g., `999`. If no port is provided, the default API port (6435) will be used. -- **sensors** array (*Required*): Conditions to display in the frontend. - - **network**: Network state (3G, 4G, etc). - - **signal**: The signal strength (%). - - **download**: The download speed. - - **upload**: The upload speed. - - **sms**: Number of unread text messages - -If the router provides SMS functionality, a service for sending SMS will also be registered in Home Assistant. +{% configuration %} +username: + description: Your Dovado username. + required: true + type: string +password: + description: Your Dovado password. + required: true + type: string +host: + description: The IP address of your router. + required: false + type: string + default: Home Assistant's default gateway +port: + description: The port number of your router. + required: false + type: integer + default: 6435 +sensors: + description: Conditions to display in the frontend. Only accepts the values listed here. + required: true + type: list + keys: + network: + description: Creates a sensor for Network State (3G, 4G, etc.). + signal: + description: Creates a sensor for the signal strength. + download: + description: Creates a sensor for download speed. + upload: + description: Creates a sensor for download speed. + sms: + description: Creates a sensor for number of unread text messages. +{% endconfiguration %} From 4a43b29d4772c06d8b3f5ba3c5bf6d9198765331 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 23:02:51 +0200 Subject: [PATCH 42/64] Update Tellstick component configuration variable (#6762) * Update Tellstick component configuration variable * Minor changes --- source/_components/tellstick.markdown | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index 4f9e03870dd..232fd9e1525 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -14,6 +14,8 @@ ha_category: Hub The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). +## {% linkable_title Configuration %} + To get started, add the devices to your `configuration.yaml` file. ```yaml @@ -22,14 +24,23 @@ tellstick: ``` ```yaml -# Example configuration.yaml entry for hass.io with TellStick add-on +# Example configuration.yaml entry for Hass.io with the TellStick add-on tellstick: host: core-tellstick port: [50800, 50801] ``` -Configuration variables: - -- **signal_repetitions** (*Optional*): Because the tellstick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly. -- **host** (*Optional*): If you run tellstick on another server or with a hass.io add-on. -- **port** (*Optional*): If needed with host config option. Must be port pair, for example `[50800, 50801]`. +{% configuration %} +signal_repetitions: + description: Because the TellStick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly. + required: false + type: integer +host: + description: If you run TellStick on another server or with the Hass.io add-on. + required: inclusive + type: string +port: + description: Needed with the `host` configuration variable. Must be port pair, for example `[50800, 50801]`. + required: inclusive + type: list +{% endconfiguration %} From c657851de1db20e4973475fbc9f15cea1966eb5c Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sat, 13 Oct 2018 23:49:07 +0200 Subject: [PATCH 43/64] Update Splunk component configuration variable (#6764) * Update Splunk component configuration variable * Minor changes --- source/_components/splunk.markdown | 33 +++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index 274bbbad758..06eefe86577 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -22,10 +22,29 @@ splunk: token: B4415DFF-683C-5C6C-3994-4F6D4A5DB03A ``` -Configuration variables: - -- **token** (*Required*): The HTTP Event Collector Token already created in your Splunk instance. -- **host** (*Optional*): IP address or host name of your Splunk host, eg. 192.168.1.10. Will default to `localhost` if not supplied. -- **port** (*Optional*): Port to use. Defaults to 8088. -- **ssl** (*Optional*): Use https instead of http to connect. Defaults to False. -- **name** (*Optional*): This parameter allows you to specify a friendly to send to Splunk as the host, instead of using the name of the HEC. Defaults to HASS +{% configuration %} +token: + description: The HTTP Event Collector Token already created in your Splunk instance. + required: true + type: string +host: + description: "IP address or host name of your Splunk host e.g., 192.168.1.10." + required: false + default: localhost + type: string +port: + description: Port to use. + required: false + default: 8080 + type: integer +ssl: + description: Use HTTPS instead of HTTP to connect. + required: false + default: false + type: boolean +name: + description: This parameter allows you to specify a friendly name to send to Splunk as the host, instead of using the name of the HEC. + required: false + default: HASS + type: string +{% endconfiguration %} From 66689c908f1e180690142706630607d6db08926c Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 08:51:57 +0200 Subject: [PATCH 44/64] Update Twilio component configuration variable (#6758) --- source/_components/notify.twilio_call.markdown | 15 +++++++++++---- source/_components/notify.twilio_sms.markdown | 15 +++++++++++---- source/_components/twilio.markdown | 14 ++++++++++---- 3 files changed, 32 insertions(+), 12 deletions(-) diff --git a/source/_components/notify.twilio_call.markdown b/source/_components/notify.twilio_call.markdown index 7f0fa2a989e..3733c6ef33f 100644 --- a/source/_components/notify.twilio_call.markdown +++ b/source/_components/notify.twilio_call.markdown @@ -27,10 +27,17 @@ notify: from_number: E164_PHONE_NUMBER ``` -Configuration variables: - -- **from_number** (*Required*): An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information. -- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +{% configuration %} +from_number: + description: "An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information." + required: true + type: string +name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: "`notify`" + type: string +{% endconfiguration %} ### {% linkable_title Usage %} diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown index 7cec94cf339..162b34b34e8 100644 --- a/source/_components/notify.twilio_sms.markdown +++ b/source/_components/notify.twilio_sms.markdown @@ -26,10 +26,17 @@ notify: from_number: E164_PHONE_NUMBER ``` -Configuration variables: - -- **from_number** (*Required*): An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information. -- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +{% configuration %} +from_number: + description: An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information. + required: true + type: string +name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: "`notify`" + type: string +{% endconfiguration %} ### {% linkable_title Usage %} diff --git a/source/_components/twilio.markdown b/source/_components/twilio.markdown index ed3752a9e25..f92ee5ab670 100644 --- a/source/_components/twilio.markdown +++ b/source/_components/twilio.markdown @@ -26,10 +26,16 @@ twilio: auth_token: AUTH_TOKEN_FROM_TWILIO ``` -Configuration variables: - -- **account_sid** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It starts with the letters `AC`. -- **auth_token** (*Required*): Your Twilio AUTH TOKEN which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`. +{% configuration %} +account_sid: + description: "Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It starts with the letters `AC`." + required: true + type: string +auth_token: + description: "Your Twilio AUTH TOKEN which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`." + required: true + type: string +{% endconfiguration %} ### {% linkable_title Usage %} After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality. From bf5f49d47b4d7817668737129506e82a9dfdcbad Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 08:53:25 +0200 Subject: [PATCH 45/64] Update Met Office component configuration variable (#6763) --- source/_components/sensor.metoffice.markdown | 65 +++++++++++++------ source/_components/weather.metoffice.markdown | 22 ++++++- 2 files changed, 65 insertions(+), 22 deletions(-) diff --git a/source/_components/sensor.metoffice.markdown b/source/_components/sensor.metoffice.markdown index 38447940de0..de9f1eca3dc 100644 --- a/source/_components/sensor.metoffice.markdown +++ b/source/_components/sensor.metoffice.markdown @@ -41,27 +41,54 @@ sensor: Your location will be detected from your home `latitude` and `longitude` settings. -Configuration variables: - -- **api_key** (*Required*): Your personal API key from the [Datapoint website](https://www.metoffice.gov.uk/datapoint). -- **name** (*Optional*): Additional name for the sensors. Default to platform name. -- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`. -- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`. -- **monitored_conditions** array (*Required*): Conditions to display in the frontend. - - **weather**: A human-readable text summary of the current conditions. - - **temperature**: The current temperature. - - **feels_like_temperature**: A numerical value representing the apparent (or "feels like") temperature. - - **wind_speed**: The wind speed. - - **wind_direction**: Where the wind is coming from. - - **wind_gust**: If there are wind gusts. - - **visibility**: The average visibility. - - **visibility_distance**: The visibility distance. - - **uv**: The UV index. - - **precipitation**: The average expected intensity of precipitation occurring. - - **humidity**: The relative humidity. +{% configuration %} +api_key: + description: "Your personal API key from the [Datapoint website](https://www.metoffice.gov.uk/datapoint)." + required: true + type: string +name: + description: Additional name for the sensors. + required: false + defaults: Met Office + type: string +latitude: + description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`." + required: inclusive + type: float +longitude: + description: "Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`." + required: inclusive + type: float +monitored_conditions: + description: Conditions to display in the frontend. + required: true + type: list + keys: + weather: + description: A human-readable text summary of the current conditions. + temperature: + description: The current temperature. + feels_like_temperature: + description: A numerical value representing the apparent (or "feels like") temperature. + wind_speed: + description: The wind speed. + wind_direction: + description: Where the wind is coming from. + wind_gust: + description: If there are wind gusts. + visibility: + description: The average visibility. + visibility_distance: + description: The visibility distance. + uv: + description: The UV index. + precipitation: + description: The average expected intensity of precipitation occurring. + humidity: + description: The relative humidity. +{% endconfiguration %}

This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform. The weather platform is easier to configure but less customizable.

- diff --git a/source/_components/weather.metoffice.markdown b/source/_components/weather.metoffice.markdown index df624d2a9ca..1d38510de48 100644 --- a/source/_components/weather.metoffice.markdown +++ b/source/_components/weather.metoffice.markdown @@ -26,9 +26,25 @@ weather: api_key: YOUR_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint). +{% configuration %} +api_key: + description: "Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint)." + required: true + type: string +name: + description: Additional name for the weather component in Home Assistant. + required: false + default: Met Office + type: string +latitude: + description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`." + required: inclusive + type: float +longitude: + description: "Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`." + required: inclusive + type: float +{% endconfiguration %}

This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor. From 2840f5729eee1d37d0cec7f8922492eb4a4bc981 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 08:55:22 +0200 Subject: [PATCH 46/64] Update Honeywell climate component configuration variable (#6765) --- source/_components/climate.honeywell.markdown | 44 +++++++++++++++---- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/source/_components/climate.honeywell.markdown b/source/_components/climate.honeywell.markdown index 64270441aac..bb174d8f5c8 100644 --- a/source/_components/climate.honeywell.markdown +++ b/source/_components/climate.honeywell.markdown @@ -33,12 +33,38 @@ climate: Scan interval is expressed in seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell.

-Configuration variables: - -- **username** (*Required*): The username of an user with access. -- **password** (*Required*): The password for your given admin account. -- **region** (*Optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided. -- **scan_interval**(*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 120 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell. -- **away_temperature** (*Optional*) (*only for eu region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. -- **away_cool_temperature** (*Optional*) (*only for us region*): Cooling setpoint when away mode is on. If omitted it defaults to 30.0 deg C. -- **away_heat_temperature** (*Optional*) (*only for us region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. +{% configuration %} +username: + description: The username of an user with access. + required: true + type: string +password: + description: The password for your given admin account. + required: true + type: string +region: + description: Region identifier (either 'eu' or 'us'). + required: false + default: eu + type: string +scan_interval: + description: Scan interval is expressed in seconds. Recommended value of 600 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell. + required: false + default: 120 + type: integer +away_temperature: + description: "(*only for eu region*) Heating setpoint when away mode is on, in deg C." + required: false + default: 16.0 + type: float +away_cool_temperature: + description: "(*only for us region*) Cooling setpoint when away mode is on, in deg C." + required: false + default: 30.0 + type: float +away_heat_temperature: + description: "(*only for us region*) Heating setpoint when away mode is on, in deg C." + required: false + default: 16.0 + type: float +{% endconfiguration %} From a0fb3c46d0e8672c38da2c341b54f210c25a1b9e Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 08:57:05 +0200 Subject: [PATCH 47/64] Update Comfoconnect component configuration variable (#6766) --- source/_components/comfoconnect.markdown | 33 +++++++++++++++++++----- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown index 7394042b84d..6494ed5c8a6 100644 --- a/source/_components/comfoconnect.markdown +++ b/source/_components/comfoconnect.markdown @@ -28,13 +28,32 @@ comfoconnect: host: 192.168.1.213 ``` -Configuration variables: - -- **host** (*Required*): The ip or hostname of the ComfoConnect LAN C bridge. -- **name** (*Optional*): The name of this device as you want to see it in Home Assistant. -- **token** (*Optional*): The token you want to use when registering with the device. This is a random 32 char hexadecimal string. The default value is `00000000000000000000000000000001`. -- **user_agent** (*Optional*): The name you want to supply when registering with the device. The default value is `Home Assistant`. -- **pin** (*Optional*): The pin code to use when registering. This is `0000` by default. You only need to change this if you have changed the factory default pin. +{% configuration %} +host: + description: The IP or hostname of the ComfoConnect LAN C bridge. + required: true + type: string +name: + description: The name of this device as you want to see it in Home Assistant. + required: false + default: ComfoAirQ + type: string +token: + description: The token you want to use when registering with the device. This is a random 32 char hexadecimal string. + required: false + default: "`00000000000000000000000000000001`" + type: string +user_agent: + description: The name you want to supply when registering with the device. + required: false + default: "`Home Assistant`" + type: string +pin: + description: The pin code to use when registering. You only need to change this if you have changed the factory default pin. + required: false + default: "`0000`" + type: integer +{% endconfiguration %} To register the sensors, add the following to your `configuration.yaml` file: From e780bcd49c29510555acf6ab40d9414e133f3994 Mon Sep 17 00:00:00 2001 From: noxhirsch <30938717+noxhirsch@users.noreply.github.com> Date: Sun, 14 Oct 2018 08:57:53 +0200 Subject: [PATCH 48/64] Added sensor & gauge to Lovelace Changelog (#6767) --- source/lovelace/changelog.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown index 39bc13598b8..f1ecc65e22d 100644 --- a/source/lovelace/changelog.markdown +++ b/source/lovelace/changelog.markdown @@ -8,6 +8,10 @@ comments: false sharing: true footer: true --- +## {% linkable_title Changes in 0.80.0 %} +- 📣 New card type: `sensor` ❤️ +- 📣 New card type: `gauge` ❤️ + ## {% linkable_title Changes in 0.77.0 %} - 📣 New notification drawer ❤️ From e253177a1c7cb00988c0efd56b049879a115e1e8 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 08:58:49 +0200 Subject: [PATCH 49/64] Update Ecobee component configuration variable (#6768) --- source/_components/ecobee.markdown | 15 +++++++++++---- source/_components/notify.ecobee.markdown | 11 +++++++---- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 217922806b2..8a73869f5b6 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -51,10 +51,17 @@ ecobee: api_key: asdfghjklqwertyuiopzxcvbnm ``` -Configuration variables: - -- **api_key** (*Required*): Your ecobee API key. This is only needed for the initial setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. -- **hold_temp** (*Optional*): True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. Defaults to `False`. +{% configuration %} +api_key: + description: Your ecobee API key. This is only needed for the initial setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. + required: true + type: string +hold_temp: + description: True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. + required: false + default: "`false`" + type: boolean +{% endconfiguration %}

diff --git a/source/_components/notify.ecobee.markdown b/source/_components/notify.ecobee.markdown index 53f97f69d12..0dbdf6b8ade 100644 --- a/source/_components/notify.ecobee.markdown +++ b/source/_components/notify.ecobee.markdown @@ -23,9 +23,12 @@ notify: platform: ecobee ``` -Configuration variables: - -- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +{% configuration %} +name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: "`notify`" + type: string +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). - From e6673d206dd2957af07f2673d32a653049abc1b1 Mon Sep 17 00:00:00 2001 From: Glenn Morrison Date: Sun, 14 Oct 2018 01:59:57 -0500 Subject: [PATCH 50/64] Spelling correction (#6785) --- source/_components/media_player.itunes.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.itunes.markdown b/source/_components/media_player.itunes.markdown index 6885a333855..cced6a1953a 100644 --- a/source/_components/media_player.itunes.markdown +++ b/source/_components/media_player.itunes.markdown @@ -16,7 +16,7 @@ ha_iot_class: "Local Polling" The iTunes platform allows you to control [iTunes](http://apple.com/itunes/) from Home Assistant. It uses a 3rd party server that you run on your Mac called [itunes-api](https://github.com/maddox/itunes-api). Play, pause, or skip songs remotely on iTunes running on your Mac. -In addition to controlling iTunes, your available AirPlay endpoints will be added as media players as well. You can then individually address them append turn them on, turn them off, or adjust their volume. +In addition to controlling iTunes, your available AirPlay endpoints will be added as media players as well. You can then individually address them and turn them on, turn them off, or adjust their volume. To add iTunes to your installation, add the following to your `configuration.yaml` file: From 813fc62d50d41bc8204b5b28e43f5b954d43e4bf Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 09:00:48 +0200 Subject: [PATCH 51/64] Update Juicenet component configuration variable (#6769) --- source/_components/juicenet.markdown | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index a6eae2eb3cd..421b981a02e 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -24,6 +24,9 @@ juicenet: access_token: ACCESS_TOKEN ``` -Configuration variables: - -- **access_token** (*Required*): Your eMotorWerks API Token can be found in the [dashboard](https://dashboard.emotorwerks.com/Manage). +{% configuration %} +access_token: + description: "Your eMotorWerks API Token can be found in the [dashboard](https://dashboard.emotorwerks.com/Manage)." + required: true + type: string +{% endconfiguration %} From 7d6e0943fe49490ad47d71c94326d661097c727e Mon Sep 17 00:00:00 2001 From: Glenn Morrison Date: Sun, 14 Oct 2018 02:01:43 -0500 Subject: [PATCH 52/64] Grammar correction (#6784) --- source/_components/media_player.bluesound.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.bluesound.markdown b/source/_components/media_player.bluesound.markdown index 69372c8c332..fd9ac670de7 100644 --- a/source/_components/media_player.bluesound.markdown +++ b/source/_components/media_player.bluesound.markdown @@ -49,7 +49,7 @@ media_player: ### {% linkable_title Service `bluesound_join` %} -Group players together under a single master speaker. That will make a new group or join to exists group. +Group players together under a single master speaker. That will make a new group or join an existing group. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | From 51ef26b6ba666afa939b55f1a364b61e5a8bfd3b Mon Sep 17 00:00:00 2001 From: Glenn Morrison Date: Sun, 14 Oct 2018 02:02:27 -0500 Subject: [PATCH 53/64] Grammar correction (#6782) Improper grammar in opening sentence of description --- source/_components/binary_sensor.template.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index d2365b7638c..bf0b6d75594 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -14,7 +14,7 @@ logo: home-assistant.png ha_qa_scale: internal --- -The `template` platform supports sensors which breaks out the `state` and +The `template` platform supports sensors which break out the `state` and `state_attributes` from other entities. The state of a Template Binary Sensor can only be `on` or `off`. From d1842c5db9891a863d707dcb8eebbceaad2abf68 Mon Sep 17 00:00:00 2001 From: Glenn Morrison Date: Sun, 14 Oct 2018 02:03:34 -0500 Subject: [PATCH 54/64] Spelling correction (#6783) "pays" should have been "pause" --- source/_components/media_player.anthemav.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.anthemav.markdown b/source/_components/media_player.anthemav.markdown index 8e59296db99..9e95937eddf 100644 --- a/source/_components/media_player.anthemav.markdown +++ b/source/_components/media_player.anthemav.markdown @@ -43,7 +43,7 @@ Configuration variables: ## Notes and Limitations -- The tuner is currently unsupported as are the `media_player` play, pays, prev, and next controls. +- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. - Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. - Only Zone 1 is currently supported. From b1852c03593c3f11b43af824886201adedcf68e3 Mon Sep 17 00:00:00 2001 From: javicalle <31999997+javicalle@users.noreply.github.com> Date: Sun, 14 Oct 2018 09:09:09 +0200 Subject: [PATCH 55/64] Duplicated variables declaration at cover.rflink (#6779) Probably from a copy&paste `fire_event` and `signal_repetitions` were duplicated at "Device coonfiguration variables" point --- source/_components/cover.rflink.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown index bc4d18538db..ad441726553 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -87,8 +87,6 @@ Device configuration variables: - **aliases** (*Optional*): Alternative Rflink ID's this device is known by. - **fire_event** (*Optional*): Fire a `button_pressed` event if this device is turned on or off (default: False). - **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1). -- **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below). -- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below). - **group** (*Optional*): Allow light to respond to group commands (ALLON/ALLOFF). (default: yes) - **group_aliases** (*Optional*): `aliases` which only respond to group commands. - **no_group_aliases** (*Optional*): `aliases` which do not respond to group commands. From 06ab18d9d0679cff1bf2b420684b07895c43e11f Mon Sep 17 00:00:00 2001 From: noxhirsch <30938717+noxhirsch@users.noreply.github.com> Date: Sun, 14 Oct 2018 09:12:07 +0200 Subject: [PATCH 56/64] Update sensor.imap.markdown (#6775) * Update sensor.imap.markdown Update IMAP Sensor configuration variable * Update sensor.imap.markdown --- source/_components/sensor.imap.markdown | 36 +++++++++++++++++++------ 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown index f09956e9648..27ae8f63c78 100644 --- a/source/_components/sensor.imap.markdown +++ b/source/_components/sensor.imap.markdown @@ -30,11 +30,31 @@ sensor: password: YOUR_PASSWORD ``` -Configuration variables: - -- **server** (*Required*): The IP address or hostname of the IMAP server. -- **port** (*Optional*): The port where the server is accessible. -- **name** (*Optional*): Name of the IMAP sensor. -- **username** (*Required*): Username for the IMAP server. -- **password** (*Required*): Password for the IMAP server. -- **folder** (*Optional*): The IMAP folder to watch. +{% configuration %} +server: + description: The IP address or hostname of the IMAP server. + required: true + type: string +port: + description: The port where the server is accessible. + required: false + default: 993 + type: integer +name: + description: Name of the IMAP sensor. + required: false + type: string +username: + description: Username for the IMAP server. + required: true + type: string +password: + description: Password for the IMAP server. + required: true + type: string +folder: + description: The IMAP folder to watch. + required: false + default: inbox + type: string +{% endconfiguration %} From b5ff2b75bbc1282267a5a413e342ccf0cbcbcc05 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 09:13:12 +0200 Subject: [PATCH 57/64] Update hddtemp component configuration variable (#6776) --- source/_components/sensor.hddtemp.markdown | 28 ++++++++++++++++------ 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/source/_components/sensor.hddtemp.markdown b/source/_components/sensor.hddtemp.markdown index 0116bedde19..4146109d07a 100644 --- a/source/_components/sensor.hddtemp.markdown +++ b/source/_components/sensor.hddtemp.markdown @@ -30,10 +30,24 @@ sensor: - /dev/sda1 ``` -Configuration variables: - -- **name** (*Optional*): Friendly name to use for the frontend. Default to "HD Temperature". -- **host** (*Optional*): Host where `hddtemp` is running. Default to `localhost`. -- **port** (*Optional*): Port that is used by `hddtemp` . Default to `7634`. -- **disks** (*Optional*): Disk to be monitored. Example: `/dev/sda1` - +{% configuration %} +name: + description: Friendly name to use for the frontend. + required: false + default: HD Temperature + type: string +host: + description: Host where `hddtemp` is running. + required: false + default: localhost + type: string +port: + description: Port that is used by `hddtemp`. + required: false + default: 7634 + type: integer +disks: + description: "Disk to be monitored. Example: `/dev/sda1`." + required: false + type: list +{% endconfiguration %} From 7720618914c17279d4dae9bb2f6fefb3ae987ca0 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 09:14:05 +0200 Subject: [PATCH 58/64] Update Scene component configuration variable (#6774) --- source/_components/scene.markdown | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index 48998818971..f0bb6a2b479 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -34,10 +34,16 @@ scene: source: HDMI 1 ``` -Configuration variables: - -- **name** (*Required*): Friendly name of scene. -- **entities** (*Required*): Entities to control. +{% configuration %} +name: + description: Friendly name of scene. + required: true + type: string +entities: + description: Entities to control. + required: true + type: list +{% endconfiguration %} As you can see, there are two ways to define the states of each `entity_id`: From 2ca656480db939c2e7e02620473438beb4894c51 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 14 Oct 2018 09:16:15 +0200 Subject: [PATCH 59/64] Update Flux_led light component configuration variable (#6773) --- source/_components/light.flux_led.markdown | 36 +++++++++++++++------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/source/_components/light.flux_led.markdown b/source/_components/light.flux_led.markdown index d53ebb88a69..426feb16ae1 100644 --- a/source/_components/light.flux_led.markdown +++ b/source/_components/light.flux_led.markdown @@ -40,17 +40,31 @@ light: - platform: flux_led ``` -Configuration variables: - -- **automatic_add** (*Optional*): To enable the automatic addition of lights on startup. -- **devices** (*Optional*): A list of devices with their ip address - -Configuration variables within devices list: - -- **name** (*Optional*): A friendly name for the device. -- **mode** (*Optional*): The chosen brightness mode; options are 'rgbw' and 'rgb', defaults to rgbw. -- **protocol** (*Optional*): Set this to 'ledenet' if you are using a ledenet bulb. - +{% configuration %} +automatic_add: + description: To enable the automatic addition of lights on startup. + required: false + default: false + type: boolean +devices: + description: A list of devices with their ip address + required: false + type: list + keys: + name: + description: A friendly name for the device. + required: false + type: string + mode: + description: "The chosen brightness mode, options are: 'rgbw' and 'rgb'." + required: false + default: rgbw + type: string + protocol: + description: Set this to 'ledenet' if you are using a ledenet bulb. + required: false + type: string +{% endconfiguration %}

Depending on your controller or bulb type, there are two ways to configure brightness. From 4c0ac8ac1f8a6db08d08c97ae0d8585e07d7e522 Mon Sep 17 00:00:00 2001 From: noxhirsch <30938717+noxhirsch@users.noreply.github.com> Date: Sun, 14 Oct 2018 09:24:11 +0200 Subject: [PATCH 60/64] Added URL example internal (#6770) Added an example for weblink with which you not only can link to external URLs - you also can link to internal pages or panels --- source/_lovelace/entities.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index 5e91cb65d80..6bc9a5271e5 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -107,7 +107,7 @@ icon: type: string url: required: true - description: "Website URL." + description: "Website URL (or internal URL e.g. `/hassio/dashboard` or `/panel_custom_name`)" type: string {% endconfiguration %} From 744b362b88e252456131070376557eef399768a7 Mon Sep 17 00:00:00 2001 From: lennartk Date: Sun, 14 Oct 2018 09:24:34 +0200 Subject: [PATCH 61/64] Fixed a grammar mistake in the database docs (#6771) "The `VACUUM` command cleans the your database." --- source/_docs/backend/database.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/backend/database.markdown b/source/_docs/backend/database.markdown index 652ef13f05f..7b265ba00c7 100644 --- a/source/_docs/backend/database.markdown +++ b/source/_docs/backend/database.markdown @@ -116,7 +116,7 @@ If you don't want to keep certain entities, you can delete them permanently: sqlite> DELETE FROM states WHERE entity_id="sensor.cpu"; ``` -The `VACUUM` command cleans the your database. +The `VACUUM` command cleans your database. ```bash sqlite> VACUUM; From d7bea0840217ace984b4660d9e4beaedd005075d Mon Sep 17 00:00:00 2001 From: noxhirsch <30938717+noxhirsch@users.noreply.github.com> Date: Sun, 14 Oct 2018 09:25:17 +0200 Subject: [PATCH 62/64] Update IMAP Email Content Sensor configuration variable (#6777) * Update IMAP Email Content Sensor configuration variable * Update sensor.imap_email_content.markdown * :pencil2: Tweak --- .../sensor.imap_email_content.markdown | 54 ++++++++++++++----- 1 file changed, 40 insertions(+), 14 deletions(-) diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown index e67340b7ef7..706b10b3e25 100644 --- a/source/_components/sensor.imap_email_content.markdown +++ b/source/_components/sensor.imap_email_content.markdown @@ -32,17 +32,43 @@ sensor: - example@gmail.com ``` -Configuration variables: - -- **server** (*Required*): The IP address or hostname of the IMAP server. -- **port** (*Required*): The port where the server is accessible. -- **name** (*Optional*): Name of the IMAP sensor to use in the frontend. -- **username** (*Required*): Username for the IMAP server. -- **password** (*Required*): Password for the IMAP server. -- **senders** (*Required*): A list of sender email addresses that are allowed to report state via email. Only emails received from these addresses will be processed. -- **value_template** (*Optional*): If specified this template will be used to render the state of the sensor. If a template is not supplied the message subject will be used for the sensor value. The following attributes will be supplied to the template: - - * **from**: The from address of the email - * **body**: The body of the email - * **subject**: The subject of the email - * **date**: The date and time the email was sent +{% configuration %} +server: + description: The IP address or hostname of the IMAP server. + required: true + type: string +port: + description: The port where the server is accessible. + required: false + default: 993 + type: integer +name: + description: Name of the IMAP sensor. + required: false + type: string +username: + description: Username for the IMAP server. + required: true + type: string +password: + description: Password for the IMAP server. + required: true + type: string +senders: + description: A list of sender email addresses that are allowed to report state via email. Only emails received from these addresses will be processed. + required: true + type: string +value_template: + description: If specified this template will be used to render the state of the sensor. If a template is not supplied the message subject will be used for the sensor value. The following attributes will be supplied to the template. + required: false + type: template + keys: + from: + description: The from address of the email. + body: + description: The body of the email. + subject: + description: The subject of the email. + date: + description: The date and time the email was sent. +{% endconfiguration %} From 3551e14e61fbeb4d0b2fc6db38e992152fa1b095 Mon Sep 17 00:00:00 2001 From: Ryan Bahm Date: Sun, 14 Oct 2018 00:31:11 -0700 Subject: [PATCH 63/64] Update homematic.markdown config variables style (#6459) * Update homematic.markdown config variables style Per #6385 updating the configuration description. * Changes based on code review Change "int" to "integer" and restore section about fetching names. --- source/_components/homematic.markdown | 89 ++++++++++++++++++++++----- 1 file changed, 72 insertions(+), 17 deletions(-) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 64783bc44e2..86ff3df552e 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -34,28 +34,83 @@ homematic: Configuration variables (global): -- **interfaces** (*Required*): Configuration for each XML-RPC interface to integrate into Home Assistant. -- **hosts** (*Optional*): Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant. -- **local_ip** (*Optional*): IP of device running Home Assistant. Override auto-detected value for exotic network setups. -- **local_port** (*Optional*): Port for connection with Home Assistant. By default it is randomly assigned. +{% configuration %} +interfaces: + description: Configuration for each XML-RPC interface to integrate into Home Assistant. + required: true + type: list +hosts: + description: Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant. + required: false + type: list +local_ip: + description: IP of device running Home Assistant. Override auto-detected value for exotic network setups. + required: false + type: string +local_port: + description: Port for connection with Home Assistant. By default it is randomly assigned. + required: false + type: integer +{% endconfiguration %} Configuration variables (interface): -- **host** (*Required*): IP address or Hostname of CCU/Homegear device or Hass.io add-on. -- **port** (*Optional*): Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292. -- **callback_ip** (*Optional*): Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). -- **callback_port** (*Optional*): Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.). -- **resolvenames** (*Optional*): [`metadata`, `json`, `xml`] Try to fetch device names. Defaults to `false` if not specified. -- **jsonport** (*Optional*): Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker. -- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. -- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. -- **path** (*Optional*): Set to `/groups` when using port 9292. +{% configuration %} +host: + description: IP address or Hostname of CCU/Homegear device or Hass.io add-on. + required: true + type: string +port: + description: "Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292." + required: false + type: integer +callback_ip: + description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). + required: false + type: string +callback_port: + description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). + required: false + type: integer +resolvenames: + description: Try to fetch device names. Defaults to `false` if not specified. + required: false + type: string + default: false +jsonport: + description: Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker. + required: false + type: integer +username: + description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. + required: false + type: string +password: + description: When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. + required: false + type: string +path: + description: Set to `/groups` when using port 9292. + required: false + type: string +{% endconfiguration %} Configuration variables (host): -- **host** (*Required*): IP address of CCU/Homegear device. -- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. -- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. +{% configuration %} +host: + description: IP address of CCU/Homegear device. + required: true + type: string +username: + description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. + required: false + type: string +password: + description: When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. + required: false + type: string +{% endconfiguration %} #### Example configuration with multiple protocols and some other options set: @@ -320,7 +375,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi string now = system.Date("%d.%m.%Y %H:%M:%S"); obj.State(now); ``` - + The HomeMatic CCU will execute all active programs which meet their conditions (none in this case) on every reboot. 3. Set up a template sensor in Home Assistant, which contains the value of the system variable: From d39f744a12f8032f6f6ca26ff2d5ddc92a9fe131 Mon Sep 17 00:00:00 2001 From: Travis Carr Date: Sun, 14 Oct 2018 00:33:38 -0700 Subject: [PATCH 64/64] Fixes for media_player.FireTV config language (#6720) * Fixes for media_player.FireTV config language * Resolve comments * More fixes * Remove title line... --- .../_components/media_player.firetv.markdown | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index 0abf2b3dadc..abcfd873600 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -56,13 +56,28 @@ media_player: - platform: firetv ``` -Configuration variables: - -- **host** (*Optional*): The host where `firetv-server` is running. Default is localhost. -- **port** (*Optional*): The port where `firetv-server` is running. Default is 5556. -- **device** (*Optional*): The device ID. Defaults to `default`. -- **name** (*Optional*): The friendly name of the device, default is 'Amazon Fire TV'. - +{% configuration %} +host: + description: "The host where `firetv-server` is running." + required: false + type: string + default: localhost +port: + description: "The port where `firetv-server` is running." + required: false + type: integer + default: 5556 +device: + description: The device ID. + required: false + type: string + default: default +name: + description: The friendly name of the device. + required: false + type: string + default: Amazon Fire TV +{% endconfiguration %}

Note that python-firetv has support for multiple Amazon Fire TV devices. If you have more than one configured, be sure to specify the device ID in `device`. Run `firetv-server -h` and/or view the source for complete capabilities.