From 3ce8cd71c5d0dfadedbdbb45d9ae678153b8b56d Mon Sep 17 00:00:00 2001 From: Nate Clark Date: Thu, 23 Aug 2018 14:49:30 -0400 Subject: [PATCH 001/116] update documentation for device id format validation --- source/_components/konnected.markdown | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index 8a5f245af0e..df50d5abc37 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -23,7 +23,7 @@ The component currently supports the following device types in Home Assistant: This component requires the [`discovery`](https://www.home-assistant.io/components/discovery) component to be enabled. -## {% linkable_title Configuration %} +### {% linkable_title Configuration %} A `konnected` section must be present in the `configuration.yml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them: @@ -32,13 +32,13 @@ A `konnected` section must be present in the `configuration.yml` file that speci konnected: access_token: REPLACE_ME_WITH_A_RANDOM_STRING devices: - - id: 8bcd53 + - id: 6001948bcd53 binary_sensors: - zone: 1 type: door switches: - zone: out - - id: 438a38 + - id: 5ccf7f438a38 binary_sensors: - pin: 2 type: door @@ -62,7 +62,7 @@ devices: type: list keys: id: - description: The MAC address of the WiFi module with colons/punctuation removed. You can either use the full 12-character MAC address or only the last 6 characters. This is visible in the device's WiFi SSID and hostname. + description: The MAC address of the NodeMCU WiFi module with colons/punctuation removed, for example `68c63a8bcd53`. You can usually find the mac address in your router's client list. Or, check the home-assistant.log for log messages from automatically discovered devices. required: true type: string binary_sensors: @@ -118,14 +118,14 @@ devices: - Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition. - Pin `D8` or the `out` zone will only work when activation is set to high (the default). -## {% linkable_title Full Configuration %} +### {% linkable_title Extended Configuration %} ```yaml # Example configuration.yaml entry konnected: access_token: REPLACE_ME_WITH_A_RANDOM_STRING devices: - - id: 8bcd53 + - id: 6001948bcd53 binary_sensors: - zone: 1 type: door @@ -149,7 +149,7 @@ konnected: momentary: 65 pause: 55 repeat: -1 - - id: 438a38 + - id: 5ccf7f438a38 binary_sensors: - pin: 1 type: motion @@ -179,3 +179,16 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use | 5 | D7 | 7 | GPIO13 | | 6 | RX | 9 | GPIO3 | | ALARM or OUT | D8 | 8 | GPIO15 | + +### {% linkable_title Revision History %} + +#### 0.77 +* Added support for momentary and beep/blink switches. [[#15973](https://github.com/home-assistant/home-assistant/pull/15973)] +* Decouple entity initialization from discovery, enabling devices to recover faster after a Home Assistant reboot. [[#16146](https://github.com/home-assistant/home-assistant/pull/16146)] +* **Breaking change:** Device `id` in `configuration.yaml` must now be the full 12-character device MAC address. Previously, omitting the first 6 characters was allowed. + +#### 0.72 +* Adds `api_host` configuration option [[#14896](https://github.com/home-assistant/home-assistant/pull/14896)] + +#### 0.70 +* Initial release From faf70d334940c91a93940185f8fec2e3b59501ba Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 29 Aug 2018 12:56:35 +0200 Subject: [PATCH 002/116] Fix typo --- source/_posts/2018-08-29-release-77.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown index fdaf74551a6..36e35235bf9 100644 --- a/source/_posts/2018-08-29-release-77.markdown +++ b/source/_posts/2018-08-29-release-77.markdown @@ -23,7 +23,7 @@ Once logged in, you will have access to the following new features: - Configure multifactor authentication (TOTP) - Manage other users (limited to account created during onboarding) -Although it's possible to configure authentication, we stronlgy recommend to stick with the default authentication configuration. If you had auth providers configured in a previous Home Assistant release, we recommend to remove the configuration and start using the default. +Although it's possible to configure authentication, we strongly recommend to stick with the default authentication configuration. If you had auth providers configured in a previous Home Assistant release, we recommend to remove the configuration and start using the default. It will take some time before all of the Home Assistant ecosystem has been migrated over to the new auth system. Home Assistant will print a warning whenever an application connects to Home Assistant with the legacy authentication. This will help users notify the application developers to transition to use the new [OAuth2](https://developers.home-assistant.io/docs/en/auth_api.html) authentication. For non-interactive scripts or other applications that are unable to update, we are planning to introduce a migration path for components to adopt url specific auth tokens and also introduce long lived access tokens to replace API passwords. A list of impacted components can be found [here](https://github.com/home-assistant/home-assistant/issues/15376#issuecomment-415890552). From 23ab489c79647dec5725393f4a9d49e348eb3d13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Gross=20Alstr=C3=B6m?= Date: Wed, 29 Aug 2018 20:18:51 +0200 Subject: [PATCH 003/116] Corrected spelling error (#6108) --- source/_docs/authentication.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index e32349a9693..bb575db1b7e 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -12,7 +12,7 @@ footer: true Access to Home Assistant is secured by our authentication system. Each member of your household will get their own user account to log in and access Home Assistant. -Home Assistant contains two different user types: the owner user account and normal users. The owner user account is created when you start Home Assitant for the first time. This account has some special privileges compared to the other users of the system: +Home Assistant contains two different user types: the owner user account and normal users. The owner user account is created when you start Home Assistant for the first time. This account has some special privileges compared to the other users of the system: - Manage users - Configure integrations and other settings (soon) From 8fe7e21a9c2e2b087e41b2ab936a434fb555a5b1 Mon Sep 17 00:00:00 2001 From: TimVa Date: Wed, 29 Aug 2018 20:19:16 +0200 Subject: [PATCH 004/116] Update knx.markdown (#6109) fixed typo --- source/_components/knx.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 7acfae76761..89e9a0c4129 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -105,7 +105,7 @@ KNX component is able to expose time or sensor values to KNX bus. The component ```yaml # Example configuration.yaml entry knx: - expose:: + expose: - type: 'temperature' entity_id: 'sensor.owm_temperature' address: '0/0/2' From b7447c01194c1db13f27f532781cf1f02b5cd4cf Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 29 Aug 2018 23:25:00 +0200 Subject: [PATCH 005/116] Release 77.1 --- _config.yml | 4 ++-- source/_posts/2018-08-29-release-77.markdown | 13 +++++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index 60823e3e2d0..6aaba3a71e1 100644 --- a/_config.yml +++ b/_config.yml @@ -142,13 +142,13 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 77 -current_patch_version: 0 +current_patch_version: 1 date_released: 2018-08-29 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#" +patch_version_notes: "#release-0771---august-29" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown index 36e35235bf9..f0c708d0b32 100644 --- a/source/_posts/2018-08-29-release-77.markdown +++ b/source/_posts/2018-08-29-release-77.markdown @@ -48,6 +48,19 @@ You didn't think we would forget about Lovelace, did you? This release include a - Add support for NOAA tide information (new PR) ([@jcconnell] - [#15947]) ([sensor.noaa_tides docs]) (new-platform) - Hangouts ([@hobbypunk90] - [#16049]) ([hangouts docs]) ([notify docs]) (new-platform) +## {% linkable_title Release 0.77.1 - August 29 %} + +- Fix trusted networks login error ([@awarecan]) +- Fix data_key override by parent class ([@syssi] - [#16278]) ([binary_sensor.xiaomi_aqara docs]) +- Fix error when vacuum is idling ([@cnrd] - [#16282]) ([vacuum.xiaomi_miio docs]) + +[#16278]: https://github.com/home-assistant/home-assistant/pull/16278 +[#16282]: https://github.com/home-assistant/home-assistant/pull/16282 +[@cnrd]: https://github.com/cnrd +[@syssi]: https://github.com/syssi +[binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. From 1ce0d2df6a5623490c8d1fbc8786ab59fc715d60 Mon Sep 17 00:00:00 2001 From: MartinP Date: Thu, 30 Aug 2018 17:03:41 +1000 Subject: [PATCH 006/116] Update fail2ban.markdown (#6104) * Update fail2ban.markdown Updated using more consistent paths for the filter and jail configuration. Added additional checks to help confirm everything working as expected. Added steps to unblock an IP address. Updated jail conf file includes email alerts. Removed the syslog section, this step is not required for fail2ban thus optional and only required if you want HA logs to be sent to syslog, should be covered by another page. * Update fail2ban.markdown * Update fail2ban.markdown * Update fail2ban.markdown * Update fail2ban.markdown * Update fail2ban.markdown --- source/_cookbook/fail2ban.markdown | 169 +++++++++++++++++++---------- 1 file changed, 109 insertions(+), 60 deletions(-) diff --git a/source/_cookbook/fail2ban.markdown b/source/_cookbook/fail2ban.markdown index 505fad6272d..a7e5d64b573 100644 --- a/source/_cookbook/fail2ban.markdown +++ b/source/_cookbook/fail2ban.markdown @@ -2,7 +2,7 @@ layout: page title: "fail2ban" description: "Setting up fail2ban to read Home Assistant's log files to improve security." -date: 2017-05-24 10:05 +date: 2018-08-29 15:30 AEST sidebar: true comments: false sharing: true @@ -10,12 +10,29 @@ footer: true ha_category: Infrastructure --- -This is a quick guide on how to setup fail2ban for Home Assistant. This was originally in the [forum](https://community.home-assistant.io/t/is-there-a-log-file-for-invalid-logins-blocking-hackers/2892) but I created this here for people. +This is a quick guide on how to setup fail2ban for Home Assistant. Contains extracts from [Is there a log file for invalid logins? \(Blocking hackers\)](https://community.home-assistant.io/t/is-there-a-log-file-for-invalid-logins-blocking-hackers/2892). -First install `fail2ban`. On Debian/Ubuntu this would be `apt-get install fail2ban`. On other distros you can google it. +**Installing fail2ban** -Then make sure logging is enabled in your `configuration.yaml` file for your Home Assistant instance: +Debian/Ubuntu: +```bash +sudo apt-get install fail2ban +``` +CentOS/RHEL: +```bash +sudo yum install epel-release +sudo yum install -y fail2ban +``` +Fedora: +```bash +sudo dnf install -y fail2ban +``` +For other package managers use the appropriate commands. + +**Enable Home Assistant Logging** + +First, enable http.ban logging in `configuration.yaml` file for your Home Assistant instance: ```yaml logger: default: critical @@ -23,82 +40,114 @@ logger: homeassistant.components.http.ban: warning ``` -Next we will be creating these three files : - -- `/etc/fail2ban/fail2ban.local` -- `/etc/fail2ban/filter.d/hass.local` -- `/etc/fail2ban/jail.local` - -Contents of `/etc/fail2ban/fail2ban.local`: - -```text -[Definition] -logtarget = SYSLOG +Restart Home Assistant to activate the changes: +```bash +sudo systemctl restart home-assistant ``` -Contents of `/etc/fail2ban/filter.d/hass.local`: +Tail the Home Assistant log then log out of the Home Assistant web interface and attempt logging in with an incorrect password, look for a line like `Login attempt or request with invalid authentication from xxx.xxx.xxx.xxx`: +```bash +tail -f /home/homeassistant/.homeassistant/home-assistant.log | grep WARNING +2018-08-29 14:28:15 WARNING (MainThread) [homeassistant.components.http.ban] Login attempt or request with invalid authentication from xxx.xxx.xxx.xxx +``` -```text +**Configure fail2ban** + +Next we will create a filter and jail file for fail2ban: +- `/etc/fail2ban/filter.d/ha.conf` +- `/etc/fail2ban/jail.d/ha.conf` + +Contents of `/etc/fail2ban/filter.d/ha.conf`: +```ini [INCLUDES] before = common.conf [Definition] failregex = ^%(__prefix_line)s.*Login attempt or request with invalid authentication from .*$ - ignoreregex = ``` -Contents of `/etc/fail2ban/jail.local` (Note that you'll need to change the `logpath` to match your logfile which will be different from the path listed.): +Contents of `/etc/fail2ban/jail.d/ha.conf` (Note that you'll need to change the `logpath` to match your logfile which will be different from the path listed.): +```ini +[DEFAULT] +# Email config +sender = email@address.com +destemail = email@address.com -```text -[hass-iptables] +# Action "%(action_mwl)s" will ban the IP and send an email notification including whois data and log entries. +action = %(action_mwl)s + +[ha] enabled = true -filter = hass -action = iptables-allports[name=HASS] +filter = ha logpath = /home/homeassistant/.homeassistant/home-assistant.log -maxretry = 5 + +# 3600 seconds = 1 hour +bantime = 3600 +bantime = 30 # during testing it is useful to have a short ban interval, comment out this line later + +# Maximum amount of login attempts before IP is blocked +maxretry = 3 ``` -Finally restart fail2ban : `sudo systemctl restart fail2ban` - -Check your log to make sure it read in your settings : `tail -100 /var/log/syslog|grep fail` - -If all is well you should see this from your syslog: - +Restart fail2ban: ```bash -May 24 20:58:01 homeauto fail2ban.server[14997]: INFO Stopping all jails -May 24 20:58:02 homeauto fail2ban.jail[14997]: INFO Jail 'sshd' stopped -May 24 20:58:02 homeauto fail2ban-client[15206]: Shutdown successful -May 24 20:58:02 homeauto fail2ban.server[14997]: INFO Exiting Fail2ban -May 24 20:58:02 homeauto fail2ban-client[15213]: 2017-05-24 20:58:02,342 fail2ban.server [15215]: INFO Starting Fail2ban v0.9.6 -May 24 20:58:02 homeauto fail2ban-client[15213]: 2017-05-24 20:58:02,343 fail2ban.server [15215]: INFO Starting in daemon mode -May 24 20:58:02 homeauto fail2ban.server[15217]: INFO Changed logging target to SYSLOG (/dev/log) for Fail2ban v0.9.6 -May 24 20:58:02 homeauto fail2ban.database[15217]: INFO Connected to fail2ban persistent database '/var/lib/fail2ban/fail2ban.sqlite3' -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Creating new jail 'sshd' -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Jail 'sshd' uses pyinotify {} -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Initiated 'pyinotify' backend -May 24 20:58:02 homeauto fail2ban.actions[15217]: INFO Set banTime = 600 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set findtime = 600 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set maxRetry = 5 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Added logfile = /var/log/auth.log -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set jail log file encoding to UTF-8 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set maxlines = 10 -May 24 20:58:02 homeauto fail2ban.server[15217]: INFO Jail sshd is not a JournalFilter instance -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Creating new jail 'hass-iptables' -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Jail 'hass-iptables' uses pyinotify {} -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Initiated 'pyinotify' backend -May 24 20:58:02 homeauto fail2ban.actions[15217]: INFO Set banTime = 600 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set findtime = 600 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set maxRetry = 5 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Added logfile = /opt/hass-prod-cfg/home-assistant.log -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Set jail log file encoding to UTF-8 -May 24 20:58:02 homeauto fail2ban.filter[15217]: INFO Date pattern set to `'^%y-%m-%d %H:%M:%S'`: `^Year2-Month-Day 24hour:Minute:Second` -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Jail 'sshd' started -May 24 20:58:02 homeauto fail2ban.jail[15217]: INFO Jail 'hass-iptables' started +sudo systemctl restart fail2ban ``` -That's it! +Confirm fail2ban is running: +```bash +sudo systemctl status fail2ban +``` +Check that the ha jail is active: +```bash +sudo fail2ban-client status +Status +|- Number of jail: 1 +`- Jail list: ha +``` + +**Testing fail2ban** + +Tail the fail2ban log file then log out of the Home Assistant web interface and attempt to log in again with an incorrect password. +```bash +sudo tail -f -n 20 /var/log/fail2ban.log +2018-08-29 13:25:37,907 fail2ban.server [10208]: INFO Starting Fail2ban v0.10.3.fix1 +2018-08-29 13:25:37,916 fail2ban.database [10208]: INFO Connected to fail2ban persistent database '/var/lib/fail2ban/fail2ban.sqlite3' +2018-08-29 13:25:37,918 fail2ban.jail [10208]: INFO Creating new jail 'ha' +2018-08-29 13:25:37,922 fail2ban.jail [10208]: INFO Jail 'ha' uses poller {} +2018-08-29 13:25:37,922 fail2ban.jail [10208]: INFO Initiated 'polling' backend +2018-08-29 13:25:37,932 fail2ban.filter [10208]: INFO Added logfile: '/home/homeassistant/.homeassistant/home-assistant.log' (pos = 5873, hash = 02ec3aefc005465a6cd8db91eff2d5e57c45757e) +2018-08-29 13:25:37,932 fail2ban.filter [10208]: INFO encoding: UTF-8 +2018-08-29 13:25:37,933 fail2ban.filter [10208]: INFO maxRetry: 3 +2018-08-29 13:25:37,934 fail2ban.filter [10208]: INFO findtime: 600 +2018-08-29 13:25:37,934 fail2ban.actions [10208]: INFO banTime: 30 +2018-08-29 13:25:37,938 fail2ban.jail [10208]: INFO Jail 'ha' started +2018-08-29 13:27:49,125 fail2ban.filter [10208]: INFO [ha] Found xxx.xxx.xxx.xxx - 2018-08-29 13:27:48 +2018-08-29 13:27:51,330 fail2ban.filter [10208]: INFO [ha] Found xxx.xxx.xxx.xxx - 2018-08-29 13:27:51 +2018-08-29 13:27:52,533 fail2ban.filter [10208]: INFO [ha] Found xxx.xxx.xxx.xxx - 2018-08-29 13:27:52 +2018-08-29 13:27:52,678 fail2ban.actions [10208]: NOTICE [ha] Ban xxx.xxx.xxx.xxx +2018-08-29 13:28:23,941 fail2ban.actions [10208]: NOTICE [ha] Unban xxx.xxx.xxx.xxx +``` + +Now that fail2ban is working it can be enabled for startup at boot time, also raise the bantime from 30 seconds to what ever you would like, I used 8 hours which is 28800 seconds: +```bash +sudo sed -i 's/bantime = 30/bantime = 28800/g' /etc/fail2ban/jail.d/ha.conf +sudo systemctl enable fail2ban +sudo systemctl restart fail2ban +``` + +A final note, if you need to unban an IP it can be done with fail2ban-client: +```bash +sudo fail2ban-client set JAILNAME unbanip IPADDRESS +``` +eg: +```bash +sudo fail2ban-client set ha unbanip xxx.xxx.xxx.xxx +``` + +Fail2ban should now be configured and running, if an IP address is banned you will recieve an email with whois details about the IP address that attempted to connect, if not you will need configure postfix or another MTA (Mail Transport Agent). If you want to read more about fail2ban, some links are below: - [fail2ban Split config](http://www.fail2ban.org/wiki/index.php/FEATURE_Split_config) From 5108fcc19d3c93f4bb6e4756d4d2c65c92a82744 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 30 Aug 2018 10:00:35 +0200 Subject: [PATCH 007/116] Fix style issues (#6114) --- source/_cookbook/fail2ban.markdown | 67 +++++++++++++++++++----------- 1 file changed, 42 insertions(+), 25 deletions(-) diff --git a/source/_cookbook/fail2ban.markdown b/source/_cookbook/fail2ban.markdown index a7e5d64b573..d5c5275a1c7 100644 --- a/source/_cookbook/fail2ban.markdown +++ b/source/_cookbook/fail2ban.markdown @@ -10,29 +10,34 @@ footer: true ha_category: Infrastructure --- -This is a quick guide on how to setup fail2ban for Home Assistant. Contains extracts from [Is there a log file for invalid logins? \(Blocking hackers\)](https://community.home-assistant.io/t/is-there-a-log-file-for-invalid-logins-blocking-hackers/2892). +This is a quick guide on how to set up `fail2ban` for Home Assistant. Contains extracts from [Is there a log file for invalid logins? \(Blocking hackers\)](https://community.home-assistant.io/t/is-there-a-log-file-for-invalid-logins-blocking-hackers/2892). -**Installing fail2ban** +## {% linkable_title Installing fail2ban %} Debian/Ubuntu: + ```bash -sudo apt-get install fail2ban +$ sudo apt-get install fail2ban ``` + CentOS/RHEL: + ```bash -sudo yum install epel-release -sudo yum install -y fail2ban +$ sudo yum install epel-release +$ sudo yum install -y fail2ban ``` Fedora: + ```bash -sudo dnf install -y fail2ban +$ sudo dnf install -y fail2ban ``` For other package managers use the appropriate commands. -**Enable Home Assistant Logging** +## {% linkable_title Enable Home Assistant Logging %} + +First, enable `http.ban` logging in `configuration.yaml` file for your Home Assistant instance: -First, enable http.ban logging in `configuration.yaml` file for your Home Assistant instance: ```yaml logger: default: critical @@ -41,23 +46,27 @@ logger: ``` Restart Home Assistant to activate the changes: + ```bash -sudo systemctl restart home-assistant +$ sudo systemctl restart home-assistant ``` Tail the Home Assistant log then log out of the Home Assistant web interface and attempt logging in with an incorrect password, look for a line like `Login attempt or request with invalid authentication from xxx.xxx.xxx.xxx`: + ```bash -tail -f /home/homeassistant/.homeassistant/home-assistant.log | grep WARNING +$ tail -f /home/homeassistant/.homeassistant/home-assistant.log | grep WARNING 2018-08-29 14:28:15 WARNING (MainThread) [homeassistant.components.http.ban] Login attempt or request with invalid authentication from xxx.xxx.xxx.xxx ``` -**Configure fail2ban** +## {% linkable_title Configure fail2ban %} + +Next we will create a filter and jail file for `fail2ban`: -Next we will create a filter and jail file for fail2ban: - `/etc/fail2ban/filter.d/ha.conf` - `/etc/fail2ban/jail.d/ha.conf` Contents of `/etc/fail2ban/filter.d/ha.conf`: + ```ini [INCLUDES] before = common.conf @@ -67,7 +76,8 @@ failregex = ^%(__prefix_line)s.*Login attempt or request with invalid authentica ignoreregex = ``` -Contents of `/etc/fail2ban/jail.d/ha.conf` (Note that you'll need to change the `logpath` to match your logfile which will be different from the path listed.): +Contents of `/etc/fail2ban/jail.d/ha.conf`. Note that you'll need to change the `logpath` to match your logfile which will be different from the path listed.: + ```ini [DEFAULT] # Email config @@ -90,17 +100,20 @@ bantime = 30 # during testing it is useful to have a short ban interval, comment maxretry = 3 ``` -Restart fail2ban: +Restart `fail2ban`: + ```bash sudo systemctl restart fail2ban ``` -Confirm fail2ban is running: +Confirm `fail2ban` is running: + ```bash sudo systemctl status fail2ban ``` Check that the ha jail is active: + ```bash sudo fail2ban-client status Status @@ -108,7 +121,7 @@ Status `- Jail list: ha ``` -**Testing fail2ban** +## {% linkable_title Testing fail2ban %} Tail the fail2ban log file then log out of the Home Assistant web interface and attempt to log in again with an incorrect password. ```bash @@ -131,24 +144,28 @@ sudo tail -f -n 20 /var/log/fail2ban.log 2018-08-29 13:28:23,941 fail2ban.actions [10208]: NOTICE [ha] Unban xxx.xxx.xxx.xxx ``` -Now that fail2ban is working it can be enabled for startup at boot time, also raise the bantime from 30 seconds to what ever you would like, I used 8 hours which is 28800 seconds: +Now that fail2ban is working it can be enabled for startup at boot time, also raise the bantime from 30 seconds to what ever you would like. 8 hours is 28800 seconds. + ```bash -sudo sed -i 's/bantime = 30/bantime = 28800/g' /etc/fail2ban/jail.d/ha.conf -sudo systemctl enable fail2ban -sudo systemctl restart fail2ban +$ sudo sed -i 's/bantime = 30/bantime = 28800/g' /etc/fail2ban/jail.d/ha.conf +$ sudo systemctl enable fail2ban +$ sudo systemctl restart fail2ban ``` -A final note, if you need to unban an IP it can be done with fail2ban-client: +A final note, if you need to unban an IP it can be done with `fail2ban-client`: + ```bash -sudo fail2ban-client set JAILNAME unbanip IPADDRESS +$ sudo fail2ban-client set JAILNAME unbanip IPADDRESS ``` eg: + ```bash -sudo fail2ban-client set ha unbanip xxx.xxx.xxx.xxx +$ sudo fail2ban-client set ha unbanip xxx.xxx.xxx.xxx ``` -Fail2ban should now be configured and running, if an IP address is banned you will recieve an email with whois details about the IP address that attempted to connect, if not you will need configure postfix or another MTA (Mail Transport Agent). +Fail2ban should now be configured and running, if an IP address is banned you will recieve an email with WHOIS details about the IP address that attempted to connect, if not you will need configure Postfix or another MTA (Mail Transport Agent). + +If you want to read more about `fail2ban`, some links are below: -If you want to read more about fail2ban, some links are below: - [fail2ban Split config](http://www.fail2ban.org/wiki/index.php/FEATURE_Split_config) - [How To Protect SSH with Fail2Ban on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-protect-ssh-with-fail2ban-on-ubuntu-14-04) From 55be4864a7355c97eec2ee0cda6dc9e23b8b1da5 Mon Sep 17 00:00:00 2001 From: Daniel Shokouhi Date: Thu, 30 Aug 2018 01:01:09 -0700 Subject: [PATCH 008/116] Small correction from home to base (#6112) --- source/_components/vacuum.neato.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/vacuum.neato.markdown b/source/_components/vacuum.neato.markdown index 48a31aa24c9..51cf2cc1d81 100644 --- a/source/_components/vacuum.neato.markdown +++ b/source/_components/vacuum.neato.markdown @@ -24,5 +24,5 @@ Currently supported features are: - `start` - `pause` - `stop` -- `return_to_home` +- `return_to_base` - `locate` From 5839ed2002e0ac6d4f6c69c65db08ffe38eb01df Mon Sep 17 00:00:00 2001 From: mh-daedalus <32991541+mh-daedalus@users.noreply.github.com> Date: Thu, 30 Aug 2018 18:02:10 +1000 Subject: [PATCH 009/116] Update incorrect service return call (#6111) The vacuum service return_to_home should be return_to_base as listed in the services tool. Users using return_to_home will result in the service failing. --- source/_components/vacuum.xiaomi_miio.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index c2fdfde0253..3adcbc43c45 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -20,7 +20,7 @@ Currently supported features are: - `start` - `pause` - `stop` -- `return_to_home` +- `return_to_base` - `locate` - `clean_spot` - `set_fan_speed` From 0fef498baf5f5ff5e26396a6ee0dbf69838cd25f Mon Sep 17 00:00:00 2001 From: Rudi Middel Date: Thu, 30 Aug 2018 15:22:15 +0200 Subject: [PATCH 010/116] Activation of the notifications (#6115) Changed the place where notifications can be activated (update since 0.77) --- source/_components/notify.html5.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown index 36dd74067e6..57e6ce10e38 100644 --- a/source/_components/notify.html5.markdown +++ b/source/_components/notify.html5.markdown @@ -72,7 +72,7 @@ The `html5` platform can only function if all of the following requirements are Assuming you have already added the platform to your configuration: 1. Open Home Assistant in Chrome or Firefox. -2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider for Push Notifications through the sidebar Configuration > General. +2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider for Push Notifications through the profile page Profile > Push notifications. 3. Slide it to the on position. 4. Within a few seconds you should be prompted to allow notifications from Home Assistant. 5. Assuming you accept, that's all there is to it! From 135a11cb2a1067d206b01603e99d314fb36ae230 Mon Sep 17 00:00:00 2001 From: Daniel Reimer Date: Fri, 31 Aug 2018 07:40:47 +0200 Subject: [PATCH 011/116] Update sensor.fritzbox_callmonitor.markdown (#6122) data: is wrong here. -> data_template: --- source/_components/sensor.fritzbox_callmonitor.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown index 6e50df044b1..013a8af18ec 100644 --- a/source/_components/sensor.fritzbox_callmonitor.markdown +++ b/source/_components/sensor.fritzbox_callmonitor.markdown @@ -84,7 +84,7 @@ automation: entity_id: sensor.phone action: - service: notify.notify - data: + data_template: title: "Phone" message: >- {% if is_state("sensor.phone", "idle") %} From 4813bf8039f655f8188b453161f2efe3b70ff5da Mon Sep 17 00:00:00 2001 From: Charles Garwood Date: Fri, 31 Aug 2018 01:47:14 -0400 Subject: [PATCH 012/116] Remove info on creating an api_password (#6120) --- source/_docs/configuration/basic.markdown | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index 2c085217a6c..f862052b3cf 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -36,20 +36,4 @@ Configuration variables: - **customize** (*Optional*): [Customize](/docs/configuration/customizing-devices/) entities. - **customize_domain** (*Optional*): [Customize](/docs/configuration/customizing-devices/) all entities in a domain. - **customize_glob** (*Optional*): [Customize](/docs/configuration/customizing-devices/) entities matching a pattern. -- **whitelist_external_dirs** (*Optional*): List of folders that can be used as sources for sending files. - -### {% linkable_title Password protecting the web interface %} - -First, you'll want to add a password for the Home Assistant web interface. Use your favorite text editor to open `configuration.yaml` and edit the `http` section: - -```yaml -http: - api_password: YOUR_PASSWORD -``` - -

-If you decide to expose your Home Assistant instance to the internet and forget to set a password, your installation could be accessed by everybody. -

- -See the [HTTP component documentation](/components/http/) for more options, such as the use of HTTPS encryption. - +- **whitelist_external_dirs** (*Optional*): List of folders that can be used as sources for sending files. \ No newline at end of file From c9e8f61edeb5d4f1bf7d57bef9ae372782759e2b Mon Sep 17 00:00:00 2001 From: Matt Caminiti Date: Fri, 31 Aug 2018 00:48:00 -0500 Subject: [PATCH 013/116] Create configuration_yaml_by_mcaminiti.markdown (#6119) --- .../configuration_yaml_by_mcaminiti.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 source/_cookbook/configuration_yaml_by_mcaminiti.markdown diff --git a/source/_cookbook/configuration_yaml_by_mcaminiti.markdown b/source/_cookbook/configuration_yaml_by_mcaminiti.markdown new file mode 100644 index 00000000000..007a785d36c --- /dev/null +++ b/source/_cookbook/configuration_yaml_by_mcaminiti.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Configuration.yaml by mcaminiti" +description: "" +date: 2018-08-30 09:51 +0700 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Example configuration.yaml +ha_external_link: https://github.com/mcaminiti/homeassistant +--- From 4fafc660f5c33c8747bcaca009a43b20b6fe399f Mon Sep 17 00:00:00 2001 From: Jerad Meisner Date: Thu, 30 Aug 2018 22:48:53 -0700 Subject: [PATCH 014/116] Add default_zoom to map card docs. (#6113) --- source/_lovelace/map.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/_lovelace/map.markdown b/source/_lovelace/map.markdown index 503d4ee0bb7..6f8f81b1a0a 100644 --- a/source/_lovelace/map.markdown +++ b/source/_lovelace/map.markdown @@ -40,17 +40,29 @@ aspect_ratio: description: "The map's height:width ratio." type: string default: "100%" +default_zoom: + required: false + description: The default zoom level of the map. + type: integer + default: 14 (or whatever zoom level is required to fit all visible markers) {% endconfiguration %}

Only entities that have latitude and longitude attributes will be displayed on the map.

+

+ The `default_zoom` value will be ignored if it is set higher than the current zoom level + after fitting all visible entity markers in the map window. In other words, this can only + be used to zoom the map _out_ by default. +

+ ## {% linkable_title Examples %} ```yaml - type: map aspect_ratio: 100% + default_zoom: 8 entities: - device_tracker.demo_paulus - zone.home From f1dbbbe0a019837fefcad5d520bfa622e5f26e99 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Fri, 31 Aug 2018 13:40:17 +0200 Subject: [PATCH 015/116] Version bump to 0.77.2 --- _config.yml | 6 +++--- source/_posts/2018-08-29-release-77.markdown | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/_config.yml b/_config.yml index 6aaba3a71e1..e56a21fade4 100644 --- a/_config.yml +++ b/_config.yml @@ -142,13 +142,13 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 77 -current_patch_version: 1 -date_released: 2018-08-29 +current_patch_version: 2 +date_released: 2018-08-31 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#release-0771---august-29" +patch_version_notes: "#release-0772---august-31" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown index f0c708d0b32..84b3c8906d6 100644 --- a/source/_posts/2018-08-29-release-77.markdown +++ b/source/_posts/2018-08-29-release-77.markdown @@ -61,6 +61,26 @@ You didn't think we would forget about Lovelace, did you? This release include a [binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ [vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ +## {% linkable_title Release 0.77.2 - August 31 %} + +- Correct wemo static device discovery issue. ([@lamiskin] - [#16292]) ([wemo docs]) +- Fix LIFX effects ([@amelchio] - [#16309]) ([light.lifx docs]) +- avoid error in debug log mode and rss entry without title ([@exxamalte] - [#16316]) ([feedreader docs]) +- Fix charts for climate devices ([@jeradM]) +- Fix header in Lovelace Glance cards ([@balloob]) +- Fix Profile page on Safari ([@balloob]) +- Fix redirect to login page on offline server ([@balloob]) + +[#16292]: https://github.com/home-assistant/home-assistant/pull/16292 +[#16309]: https://github.com/home-assistant/home-assistant/pull/16309 +[#16316]: https://github.com/home-assistant/home-assistant/pull/16316 +[@amelchio]: https://github.com/amelchio +[@exxamalte]: https://github.com/exxamalte +[@lamiskin]: https://github.com/lamiskin +[feedreader docs]: /components/feedreader/ +[light.lifx docs]: /components/light.lifx/ +[wemo docs]: /components/wemo/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. From 5959f92e90472ee4febc7f3f1a3f3554cf28dc29 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Fri, 31 Aug 2018 21:17:31 +0100 Subject: [PATCH 016/116] Adding troubleshooting section (#6124) We've had a *lot* of questions about how to wipe and start again, so adding a section on that --- source/_docs/authentication.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index bb575db1b7e..7bae172053b 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -37,3 +37,15 @@ Once you're logged in, you can access the profile page by clicking on the badge As a user, you can setup multi-factor authentication with time-based one-time passwords. This is an extra challenge that you have to solve after you finish your login. You will be able to set up these challenges from the profile page once you're logged in. Screenshot of setting up multi-factor authentication + +## {% linkable_title Troubleshooting %} + +### {% linkable_title Lost owner password %} + +While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](https://www.home-assistant.io/docs/configuration/): + +* `auth` +* `auth_provider.homeassistant` +* `onboarding` + +When you start Home Assistant next you'll be required to set up authentication again. From e062675eb9b8f574578591f8200cfed93e68ec39 Mon Sep 17 00:00:00 2001 From: Brian J King Date: Fri, 31 Aug 2018 20:23:57 -0500 Subject: [PATCH 017/116] Standardization & clarity changes for Google Hangouts component (#6129) * Standardize capitalization of Google Hangouts *(not Google hangouts or google hangouts)* * Standardize use of authentication when referring to 2 factor authentication, not *authorization* * Miscellaneous other changes for formatting and clarity. --- source/_components/hangouts.markdown | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown index 5400f81ecd0..8bc8948b600 100644 --- a/source/_components/hangouts.markdown +++ b/source/_components/hangouts.markdown @@ -12,21 +12,21 @@ ha_category: Hub ha_release: 0.77 --- -This component allows you to send messages to [Google Hangouts](http://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. +This component allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. ## {% linkable_title Setup the component via the frontend %} Menu: *Configuration* -> *Integrations* -Fill the form: -* Your **Google Mail Address** and **Password** -* If needed, you will be asked for a 2-factor authorization token +Configure the integration: +* Enter your **Google Mail Address** and **Password** +* If you secured your account with 2-factor authentication you will be asked for a 2-factor authentication token. -**BEST PRACTICE:** You can't write messages to yourself or get notifications in a group, if "you" write the message. The best way is to create a own google account for your hangouts bot. +**BEST PRACTICE:** You can't write messages to yourself or get notifications in a group, if "you" write the message. The best way is to create a new Google Hangouts account for this integration. -**IMPORTANT:** If you secured your account with 2 factor authorization: Only verification by app or SMS are supported. There is no support for verification by prompt on your phone. +**IMPORTANT:** If you secured your account with 2-factor authentication: Only verification by app or SMS are supported. There is no support for verification by prompt on your phone. -**IMPORTANT 2:** If you are sure your email and password is correct, but the component says the login is invalid. Wait a few hours and try it again, it might be, that google asks for a captcha which we can't support. Google official don't support bots at hangouts, that's why we have to work around this. +**IMPORTANT 2:** If you are sure your email and password is correct, but the component says the login is invalid. Wait a few hours and try it again, it might be, that google asks for a captcha which we can't support. Google does not provide official support for using bots with Google Hangouts, that's why we have to work around this. The authentication token will be generated and stored internally. From 8d9c2e9261a788a9f813a64b2f8de601ee2159b7 Mon Sep 17 00:00:00 2001 From: Marco Sousa Date: Sat, 1 Sep 2018 10:47:57 +0200 Subject: [PATCH 018/116] new changelog in lovelance (#6126) --- source/lovelace/changelog.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown index e32dbaf0bcf..39bc13598b8 100644 --- a/source/lovelace/changelog.markdown +++ b/source/lovelace/changelog.markdown @@ -2,12 +2,14 @@ layout: page title: "Lovelace Changelog" description: "Changelog of the Lovelace UI." -date: 2018-07-01 10:28 +00:00 +date: 2018-08-31 13:06 +02:00 sidebar: true comments: false sharing: true footer: true --- +## {% linkable_title Changes in 0.77.0 %} +- 📣 New notification drawer ❤️ ## {% linkable_title Changes in 0.75.0 %} From 8beb463c82f39c11060f4f6df5df9d3f8fed3bf6 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Sep 2018 11:04:55 +0200 Subject: [PATCH 019/116] Minor fix --- source/_components/binary_sensor.random.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index b1208681a8a..ac08186a313 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -18,7 +18,7 @@ The `random` binary sensor platform is creating random states (`True`, 1, `on` o ## {% linkable_title Configuration %} -To enable the random binary sensor, add the following lines to your `configuration.yaml`: +To enable the random binary sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry From 903483c2d4e963ca76022f1b777dedd3cc313942 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Sep 2018 11:06:13 +0200 Subject: [PATCH 020/116] Add title --- source/_components/sensor.dht.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_components/sensor.dht.markdown b/source/_components/sensor.dht.markdown index 1898ab35d4f..65a16633bda 100644 --- a/source/_components/sensor.dht.markdown +++ b/source/_components/sensor.dht.markdown @@ -14,7 +14,9 @@ ha_iot_class: "Local Polling" --- -The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device. +The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22 or AM2302 device. + +## {% linkable_title Configuration %} To use your DHTxx sensor in your installation, add the following to your `configuration.yaml` file: From 44cf07117e053876a6bc2b124eb89b8347bd427d Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Sep 2018 11:07:34 +0200 Subject: [PATCH 021/116] Add title --- source/_components/sensor.bme680.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_components/sensor.bme680.markdown b/source/_components/sensor.bme680.markdown index 05d42769c1b..d2496dd8a33 100644 --- a/source/_components/sensor.bme680.markdown +++ b/source/_components/sensor.bme680.markdown @@ -14,12 +14,14 @@ ha_iot_class: "Local Push" --- -The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement. +The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement. Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your BME680 sensor in your installation, add the following to your `configuration.yaml` file: ```yaml From c45ead8a010afb85840f71a29b55dd10bac5ea2d Mon Sep 17 00:00:00 2001 From: plyblu Date: Sat, 1 Sep 2018 04:07:57 -0500 Subject: [PATCH 022/116] Update multi-factor-auth.markdown (#6128) * Update multi-factor-auth.markdown improve spelling and grammar * Minor changes --- .../authentication/multi-factor-auth.markdown | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown index fd229645c24..90d51fe8f78 100644 --- a/source/_docs/authentication/multi-factor-auth.markdown +++ b/source/_docs/authentication/multi-factor-auth.markdown @@ -16,9 +16,9 @@ This is an advanced feature. If misconfigured, you will not be able to access Ho Besides the authentication providers, it's also possible to configure multi-factor authentication modules. These authentication modules will require the user to solve a second challenge besides just logging in. The idea is that you ask the user for something they know, their username/password, and something they have, like a time-based authentication token from their phone. -Multi-factor authentication module can be used mixed-match with authentication providers. After normal authentication provider validation, the login flow will ask user for addional challenge if there are multi-factor authentication modules enabled for this user. If more than one mutli-factor authentication module enabled, user can select one of them during the login. +The multi-factor authentication module can be used mixed-matched with authentication providers. After the normal authentication provider validation, the login flow will ask the user for additional challenge(s) if there are multi-factor authentication modules enabled for this user. If more than one mutli-factor authentication module is enabled, the user can select one of them during the login. -Multi-factor authentication module has to be enabled for user before it can be used in the login process, user can go to profile page enable it by himself. +The multi-factor authentication module has to be enabled for the user before it can be used in the login process. The user can go to the profile page enable it by himself. ## {% linkable_title Configuring mutli-factor authentication modules %} @@ -26,7 +26,7 @@ Multi-factor authentication module has to be enabled for user before it can be u By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system.

-Multi-factor authentication modules are configured in your `configuration.yaml` under the `homeassistant:` block: +Multi-factor authentication modules are configured in your `configuration.yaml` file under the `homeassistant:` block: ```yaml homeassistant: @@ -36,27 +36,26 @@ homeassistant: ## {% linkable_title Available mutli-factor authentication modules %} -Below is a list of currently available auth providers. +Below is a list of the currently available auth providers. ### {% linkable_title Time-based One-Time Password mutli-factor authentication module %} [Time-based One-Time Password](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm) is widely adopted in modern authencation system, it combines a secret key with the current timestamp using a cryptographic hash function to generate a one-time password. Whoever possessed the secret key will get same one-time password in certain time period. By verifying that password, Home Assistant knows the user have the right secrt key. -When try to set up TOTP module, a QR code will show up, user can scan it by an authenticator app, or set it up manauly using the code showed in UI. After setup, user need to input a six digit number generate in the autendicator app to verify the setup is good. If the verificaiton keep falling, you need to check whether the clock on Home Asistant is accurate. +When trying to set up TOTP module, a QR code will show up. The user can scan it by an authenticator app, or set it up manually using the code showed in the UI. After setup, the user needs to input a six digit number generated in the autendicator app to verify the setup is good. If the verification keeps failing, you need to check whether the clock on Home Assistant is accurate. -There are several authenctior apps on the market, we recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/) +There are several authenticator apps on the market, we recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/).

-Please treat the secret key like a password, never exposure it to others. +Please treat the secret key like a password, never expose it to others.

+By default, one TOTP multi-factor named "Authenticator app" will be auto loaded if no `auth_mfa_modules` configuration section defined in the `configuration.yaml` file. -By default one TOTP multi-factor named "Authenticator app" will be auto loaded if no `auth_mfa_modules` config section defined in `configuration.yaml`. - -Example of configuration +Example of configuration: ```yaml homeassistant: auth_mfa_modules: - type: totp -``` \ No newline at end of file +``` From 9d7a1dfbb1a67619a130cc63b5f095e313756033 Mon Sep 17 00:00:00 2001 From: Robert Svensson Date: Sat, 1 Sep 2018 11:08:09 +0200 Subject: [PATCH 023/116] Appdaemon example for deCONZ to control Sonos (#6133) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * deCONZ - Appdaemon example control Sonos Appdaemon example on how to control a Sonos system using an Ikea Trådfri remote * Minor changes --- source/_components/deconz.markdown | 62 +++++++++++++++++++++++++++--- 1 file changed, 57 insertions(+), 5 deletions(-) diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index ae079650aef..0026d0b7f86 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -118,9 +118,9 @@ For the IKEA Tradfri remote, 1 is the middle button, 2 is up, 3 is down, 4 is le ## {% linkable_title Examples %} -### {% linkable_title Step up and step down input number with wireless dimmer %} +### {% linkable_title YAML %} -#### YAML +#### {% linkable_title Step up and step down input number with wireless dimmer %} {% raw %} ```yaml @@ -171,15 +171,17 @@ automation: ``` {% endraw %} -#### Appdaemon +### {% linkable_title Appdaemon %} + +#### {% linkable_title Appdaemon remote template %} {% raw %} ```yaml -remote_control_living_room: +remote_control: module: remote_control class: RemoteControl event: deconz_event - id: dimmer_switch_3 + id: dimmer_switch_1 ``` ```python @@ -204,3 +206,53 @@ class RemoteControl(hass.Hass): self.log('Button off') ``` {% endraw %} + +#### {% linkable_title Appdaemon remote template %} + +Community app from Teachingbirds. This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track. + +{% raw %} +```yaml +sonos_remote_control: + module: sonos_remote + class: SonosRemote + event: deconz_event + id: sonos_remote + sonos: media_player.sonos +``` +{% endraw %} + +{% raw %} +```python +import appdaemon.plugins.hass.hassapi as hass + +class SonosRemote(hass.Hass): + + def initialize(self): + self.sonos = self.args['sonos'] + if 'event' in self.args: + self.listen_event(self.handle_event, self.args['event']) + + def handle_event(self, event_name, data, kwargs): + if data['id'] == self.args['id']: + if data['event'] == 1002: + self.log('Button toggle') + self.call_service("media_player/media_play_pause", entity_id = self.sonos) + + elif data['event'] == 2002: + self.log('Button volume up') + self.call_service("media_player/volume_up", entity_id = self.sonos) + + elif data['event'] == 3002: + self.log('Button volume down') + self.call_service("media_player/volume_down", entity_id = self.sonos) + + elif data['event'] == 4002: + self.log('Button previous') + self.call_service("media_player/media_previous_track", entity_id = self.sonos) + + elif data['event'] == 5002: + self.log('Button next') + self.call_service("media_player/media_next_track", entity_id = self.sonos) +``` +{% endraw %} From 82e8d05a8e8cb73c36d9ffec49845144885d2879 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Sep 2018 11:10:30 +0200 Subject: [PATCH 024/116] Add titles --- source/_components/sensor.noaa_tides.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_components/sensor.noaa_tides.markdown b/source/_components/sensor.noaa_tides.markdown index fca7249529b..2ae7a6875fc 100644 --- a/source/_components/sensor.noaa_tides.markdown +++ b/source/_components/sensor.noaa_tides.markdown @@ -14,8 +14,12 @@ logo: noaa.png The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. +## {% linkable_title Setup %} + This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164` +## {% linkable_title Configuration %} + To use this sensor, add the following to your `configuration.yaml` file: ```yaml From 61297bd4080ce60ae4d7fe5471a2c57a8aea3b50 Mon Sep 17 00:00:00 2001 From: ajobbins <5669088+ajobbins@users.noreply.github.com> Date: Sat, 1 Sep 2018 19:14:24 +1000 Subject: [PATCH 025/116] Update sensor.google_travel_time.markdown (#6125) * Update sensor.google_travel_time.markdown Google have removed the previous daily free API limit, instead requiring a billing account to be set up. Including details on limits and quotas and how to set them. * Update sensor.google_travel_time.markdown Updates as requested in feedback. Thanks * Minor changes * Again --- .../sensor.google_travel_time.markdown | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/source/_components/sensor.google_travel_time.markdown b/source/_components/sensor.google_travel_time.markdown index 4fb24f39d07..92046fd4a62 100644 --- a/source/_components/sensor.google_travel_time.markdown +++ b/source/_components/sensor.google_travel_time.markdown @@ -13,11 +13,19 @@ ha_iot_class: "Cloud Polling" ha_release: 0.19 --- -Sensor to provide travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/). +The `google_travel_time` sensor provides travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/). + +## {% linkable_title Setup %} You need to register for an API key by following the instructions [here](https://github.com/googlemaps/google-maps-services-python#api-keys). You only need to turn on the Distance Matrix API. -A free API Key allows 2500 requests per day. The sensor will update the travel time every 5 minutes. +[Google now require billing](https://mapsplatform.googleblog.com/2018/05/introducing-google-maps-platform.html) to be enabled (and a valid credit card loaded) to access Google Maps APIs. The Distance Matrix API is billed at US$10 per 1000 requests, however a US$200 per month credit is applied (20,000 requests). By default, the sensor will update the travel time every 5 minutes, making approximately 288 calls per day. Note that at this rate, more than 2 sensors will likely exceed the free credit amount. If you need to run more than 2 sensors, consider changing the [scan interval](/docs/configuration/platform_options/#scan-interval) to something longer than 5 minutes to stay within the free credit limit. + +A quota can be set against the API to avoid exceeding the free credit amount. Set the 'Elements per day' to a limit of 645 or less. Details on how to configure a quota can be found [here](https://developers.google.com/maps/documentation/distance-matrix/usage-and-billing#set-caps) + +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example entry for configuration.yaml @@ -40,9 +48,9 @@ Configuration variables: - **arrival_time** (*Optional*): See notes above for `departure_time`. `arrival_time` can not be `now`, only a Unix timestamp or time string. You can not provide both `departure_time` and `arrival_time`. If you do provide both, `arrival_time` will be removed from the request. - **units** (*Optional*): Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`. -##### {% linkable_title Dynamic Configuration %} +## {% linkable_title Dynamic Configuration %} -Tracking can be setup to track entities of type device_tracker, zone, and sensor. If an entity is placed in the origin or destination then every 5 minutes when the component updates it will use the latest location of that entity. +Tracking can be setup to track entities of type `device_tracker`, `zone` and `sensor`. If an entity is placed in the origin or destination then every 5 minutes when the platform updates it will use the latest location of that entity. ```yaml # Example entry for configuration.yaml @@ -67,10 +75,9 @@ sensor: destination: zone.home options: units: imperial # 'metric' for Metric, 'imperial' for Imperial - ``` -#### {% linkable_title Entity Tracking %} +## {% linkable_title Entity Tracking %} - **device_tracker** - If state is a zone then the zone location will be used From 4c7144c0edac395393086d385e10c1f01b7badab Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Sep 2018 11:19:42 +0200 Subject: [PATCH 026/116] Add link --- source/_components/deconz.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 0026d0b7f86..211e683fe15 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -31,7 +31,7 @@ Home Assistant will automatically discover deCONZ presence on your network, if ` If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a config entry. -You can add the following to your configuration.yaml file if you are not using the `discovery:` component: +You can add the following to your `configuration.yaml` file if you are not using the `discovery:` component: ```yaml # Example configuration.yaml entry @@ -209,7 +209,7 @@ class RemoteControl(hass.Hass): #### {% linkable_title Appdaemon remote template %} -Community app from Teachingbirds. This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track. +Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track. {% raw %} ```yaml From 506d408771746447b7882f9c7131f5d005ebb053 Mon Sep 17 00:00:00 2001 From: Phill Price Date: Sat, 1 Sep 2018 16:38:51 +0100 Subject: [PATCH 027/116] Standardised entity name throughout page from count0 and my_custom_counter to all be my_custom_counter in examples. --- source/_components/counter.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index f181d4755a7..123ebee79d9 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -44,7 +44,7 @@ Increments the counter with 1 or the given value for the steps. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | #### {% linkable_title Service `counter.decrement` %} @@ -52,7 +52,7 @@ Decrements the counter with 1 or the given value for the steps. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | #### {% linkable_title Service `counter.reset` %} @@ -60,7 +60,7 @@ With this service the counter is reset to its initial value. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | ### {% linkable_title Use the service %} @@ -69,7 +69,7 @@ Select serv ```json { - "entity_id": "counter.count0" + "entity_id": "counter.my_custom_counter" } ``` From 968783c45ce5acb852b60c364391b49a625bcf22 Mon Sep 17 00:00:00 2001 From: Tom Harris <tharris@harrisnj.net> Date: Sat, 1 Sep 2018 14:47:39 -0400 Subject: [PATCH 028/116] Add Cover platform to Insteon component (#6090) * Add Cover platform to Insteon Component * Fix reference to insteon component * Update .gitignore Remove VS pro file * Update cover.insteon.markdown Change version to 0.78 --- source/_components/cover.insteon.markdown | 22 ++++++++++++++++++++++ source/_components/insteon_local.markdown | 4 ++-- source/_components/insteon_plm.markdown | 5 ++--- 3 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 source/_components/cover.insteon.markdown diff --git a/source/_components/cover.insteon.markdown b/source/_components/cover.insteon.markdown new file mode 100644 index 00000000000..568e671a6ca --- /dev/null +++ b/source/_components/cover.insteon.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Insteon Cover" +description: "Instructions on how to setup the Insteon cover locally within Home Assistant." +date: 2018-08-20 16:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: insteon.png +ha_category: Cover +ha_iot_class: "Local Push" +ha_version: 0.78 +--- + +The `insteon` cover platform lets you control your [Open/Close Micro Module] +through an INSTEON Modem (PLM and Hub) device connected directly to your system +on a USB, serial port or TCPIP connection. To add support, set up the primary +[insteon] component. + +[insteon]: /components/insteon/ +[Open/Close Micro Module]: https://www.insteon.com/open-close-micro-module/ diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index 513e640778c..c79b46b2e4e 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -13,6 +13,6 @@ ha_iot_class: "Local Polling" ha_version: 0.36 --- -The `insteon_local` component is depreciated and has been replaced by the [Insteon] component. +The `insteon_local` component is depreciated and has been replaced by the [insteon] component. -[Insteon] /component/insteon +[insteon]: /component/insteon diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index b438d90e4fd..bed0e71ccb6 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Local Push" ha_version: 0.39 --- -The `insteon_plm` component is depreciated and has been replaced by the [Insteon] component. - -[Insteon] /component/insteon +The `insteon_plm` component is depreciated and has been replaced by the [insteon] component. +[insteon]: /component/insteon From b65b5c734199bd5709a336be218ea80c88c0014d Mon Sep 17 00:00:00 2001 From: DubhAd <DubhAd@users.noreply.github.com> Date: Sat, 1 Sep 2018 22:05:16 +0100 Subject: [PATCH 029/116] Added details about console access (#6140) Since there Date: Sat, 1 Sep 2018 22:06:12 +0100 Subject: [PATCH 030/116] Explicitly list available train attributes (#6139) * Explicitly list the available train attributes * A bit more detail on train attributes --- source/_components/sensor.uk_transport.markdown | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/source/_components/sensor.uk_transport.markdown b/source/_components/sensor.uk_transport.markdown index ccf0c1a5a77..17bebc15dad 100644 --- a/source/_components/sensor.uk_transport.markdown +++ b/source/_components/sensor.uk_transport.markdown @@ -46,7 +46,21 @@ Configuration variables: - **origin** (*Required*): Specify the three character long origin station code. - **destination** (*Required*): Specify the three character long destination station code. -A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. The status of the next departing train is accessed using the [template sensor](/components/sensor.template/) below, as are the train origin, estimated and scheduled departure times, and the departure platform. +A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. + +These attributes are available for each departing train: + +- `origin_name` +- `destination_name` +- `status` +- `scheduled`: (API attribute is `aimed_departure_time`) +- `estimated`: (API attribute is `expected_departure_time`) +- `platform` +- `operator_name` + +Refer to the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##request_uk_train_station_station_code_live_json) for definitions. + +Attributes can be accessed using the [template sensor](/components/sensor.template/) as per this example: ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. From a89e5cd754b188407266adf83fee5952f843f6ec Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sat, 1 Sep 2018 22:15:07 +0100 Subject: [PATCH 031/116] Images for the user profile menu (#6136) For updating the frontend docs --- source/images/frontend/user-language.png | Bin 0 -> 3563 bytes source/images/frontend/user-theme.png | Bin 0 -> 4032 bytes 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 source/images/frontend/user-language.png create mode 100644 source/images/frontend/user-theme.png diff --git a/source/images/frontend/user-language.png b/source/images/frontend/user-language.png new file mode 100644 index 0000000000000000000000000000000000000000..258c6f5ac788c5eb0e94b4f1f950368a0ed81fd1 GIT binary patch literal 3563 zcmbtX`#;nF7k^Vq^F<$RiOMB?(v+fH%3bP%<-Q?v$#MycF3ix3StHgubS#0I zovnC(eKaZf(-Vm1FaX@!hXVa&B64KlPf56$@Ha9rvWK8ybJP?+;Qy6~@~MB$vQ&;1 zutNreTp1pB8=FbS{o^h9w^NLkAKB(!Xp=c|VWc6~5ZgTdHS2qW(LX;sgaWvI@8@TS zOW5o#FWl0n^(g*K@U2_rEOa*)QXIyy}g}K=?|yaVGP?Q+uqC(+(X`1R~wx=efm}wI>aqw$xq#$G}}d4 zRWiZ#%=6ZU)@7hH`?Ny$wZ{k4XCLfUdMC1uTo~d7i+s}yXnjQwUsTV>wFh^XaE5}U zMJq1;Dxo2f-p~M(FaGJ)IK9q^*}XorGZH4zTMUJv+Iw|NJ(ZlvehrMuJZ z)hjhh9VC8mixZ)Fn6KHojaCTP2kS zLSsDTmp4D=o$Pybho38AUE&=wd zZ*N7eT|7cK?o4bb^b1;F9A)(ON+pTF+jXB~-E2`hY!Fs76S6zD*#-ssZd*6#S7TUO zT|Gdy$@<3K0DF)k#}(vpNGbScv5zl$*JoWT&t0FK^Z9AWH;7DRjY|mTQgFwpuJ{y)9F3>Xu=w^+mEmXS`pX zKLb>_O&yvnE$W~@Z|i3Vhvt`Fx!=9lLv~J%ELT;B!)7;YfStlVPW|&WbAcNA4?i^Yb>$WJ=$_RekR2ih`f_`b5{P-A7@A$OK5#6A4G)o*f zPAQP*<~`sJg<(jw`kkzxh0WL*)thzc+;IUD;o&iRDFc~4U%g_7{mv;8Xcpyle2GFuUKD&?5Q)cl<*g97C_Q)J=M>@Mz9RKQgtOvq8J z;B`fT1$|?Q&5&baVP`=4+m+U42O| zh+az#K$Wrx>iQc>Mt z8&$f1i)3vE7{^>}_nwH0O5#DvQrLpExm8^k9Q#Y>o3Yv&avz>|-amf}&C1z%W2-C7 zpB`VO7PGHl0!i$$pZvf5>QFEY9&2H{rBBOkKyTNtv;XD-oI?|Lm@a<;!hz^m^ww!y%>B%TL_@NLkJ{zR&(eC&t}~#!2V= z^V0B%mV9iAWR6iJGtVfpy`iCD_QPJ~u;D{}BqX5fnjNIR-)%NhQ!i|^ zzM4uZ?Y>qU%sS(-^*1g}O2VCy6R>|0JhHiW1%D*|x2BawSrET_N#)(#g~5R9GF=m#Ijni? zhTZ;DgiAkT_*LqgC`4Bh^?-Tr?LDLZf_VdZ9IRQlGHSb`wo++_14_#OsFe|9xcxJn z7p)=bmYky3ldyS8Z`GS86)?I9s3;`l_&#ijmK0^cC_iB-iFeA#Hd_a(^i)GbW0p}h z&+MeTR<#T<{Tk27z{keMy6CQF``@7~aK@WLgN(LtAj=9;)MsdAom6g9V$e1s z-d3Y>IkMy7oyCVL-q1twna)KH$;rs9YExwfcC0bZEbXKl(MhVMKQp_L9?yR~EfgRj zAzwge&yE^E63geW_(?OKW8=oa0iy3Ao-Us0#k*ttW!q(RgUVJrh+FN@Wa)jo{+@7= zx+4VklT}{c0yaM-%X3(A= z+kMH|$w@9IHd+)zUk$fc4S%G*l-UOdouwif?Fm%h;mA?5V_yi)9FMiQ@etG6`8!0I zhlvM;-&X!`Rmf7A#6?`mxF0Pt;_9K3@!t|9rx&=;eef-RZMFEzVj zeZiM;Bi1L<_J>Zks?Kzm=HHh_UnMTS#sYykdR!R6R=ScG2C)^)ZqW0CsDL7)OJ#oEnEW~hRX>0mE*kS zeDijs;Q3z8!L`HvMnbFabe*CqmNp!8ChcMgBO)4xCH}4h2aKlS*tUrm^+y_bLM_jo`xZ z=DZp1q|Wwb&oHjMAeb}gkM3p!yMZb$ww>#=UJo&ev1qx2RRh9yW9piS+I7#;oa74_ z^P*ll%v`D>Ys}+U#hbMGZ$pUwJ5dj*rLE1n8+7Xb8C=l*Leukyc*QSJ3r(V72e7_k KcbRd?JMQ1NO2qvD literal 0 HcmV?d00001 diff --git a/source/images/frontend/user-theme.png b/source/images/frontend/user-theme.png new file mode 100644 index 0000000000000000000000000000000000000000..28dd6248f92b09aff6e03681b8f45bf271e3e42e GIT binary patch literal 4032 zcmb7{c|2768^_NKqLI`MQ?j(&m}qDrg=~@1#b6jrV-2AhOUAyXrmib0dyBD@%vfe3 zjK-QoOeou63?Zr+`_7Qxx%cz)3W9c}@@ z?)QHWNQ)okIsi!8UNJUAhdNDjcixm@%eTy%+4h>*s#8nCDWZ69o4Y+|b1SnKl)S?t zd-q65S*uvbUzUTJ!XN=8>!e4hB!e6&gxF&M;)dAM@Ukg(-)~}#!k?u55mkF~GC34#0|)>Z8^=Py4S)W7!vP7Ddfi%HiGAsj`CWj&GSaE0e}|+( zWcShnOP!N{HRI-RO<3?)Q+(4PkXJPUhHIl@^@2v@=?4Rm}1tz|h zO86j#YQW!kB!eKmG`zFJ!Q0#0%|aTqY$!??kuwS!l=HXHCpw4t-0%j&gHZ}InzSB_I3=~yRpnis;U-+KbxAmxjNv8Lb<%Slvo%Yy*B5{ zP!!1@Yy)Hy9*9ypvUIRcPUH{c0a#`bmB{aF@5t7l?UUCIqL@E9{h{`F=kxRKQG%5c zLTT5?S^S`VbaY)>Mn<)kGbA`;2eM*1$`*q~y9pMkWDL`T?Kb6q6 zf>&p_c)`jvO&7RP$m=G-oxIwgYHCU7W^4MUi(jh1k7o-Yyo$73U&!bE*L4k!e-1T$ zs6f1J7PC4#;`dPhS5=l?ly+&)31#J$d%F&d4ZEn=a3Xw4y1p*S>jeKk*)v41oaR*jHxs_0=9#%RwIiJ(4zX~a=JRRFSmXvfGCW;WrMTg9-2bSYf zf&3O~n|KBUFt_Rf^0&VxDe4a=$?HrupQd7G*XG9`L(zB-An^lE92K!LRjN!5Z6vnj z|E6hx?|*&RLmtSXCdlS!kgtr}Y6914q1^?RA@5J*2~+;@Y_&{|#%q*2S>xl7JYhNeE(3F*+B=k3daZ0KxMZfRZrxy^~z5VM604X?Pm zruE$W3T;312&Q=F8;PI110jW9c|^hdhIPc^Qbp7AYWh}X=GJ-o2@pTor06e)H--3r zhbIkJ%^ab2cY10{L3_9+vCKund4nwVqVjA%mD=xWo1lH>@lbSq^w!WUiKkp@k)`di z_`Q>nj>Hc3m0}0tZ8LxV0@Cw@*i(b?4#jy z7?NAPw?@(^cpW0|I-gAs5v=m31}j)dcv?~T`swoFJd=c>;Gd1{ttrYyF*lu3K;khN zuC)jyE)L4?E_kQ|-+%}*oWiNilKllb&f0dYg@=`DVli$5xu47Un?!*_Fg424q%?})QMxtC zt-^`5Nu^QCuv^tVb+xaWND8C}wArSiNc|a02RZJbg*m3(;`P(J_ zEOg()VMM9I><1hdZO2N?r|Auwen?y4AWvb`&BKesl2u~YH#|iIYi@R>oC2lx?y!Y& z^TG+D{IeCV66KCQCT4IiLseR{GtHTXZ~2xnuq0X3Q9HTyJ7qS)L@UX%rOxpg3SLwBx0NbMv=$C~fG6;yH&uI>~x>an>tPdF(5 zBFT2KyjYKTbvMd1NiLv;;qnd|q851}NP(!wzg35p6lnnCx;h+D?0o@$CSa_I$4uIP zD(@0bnv90`TJZ(!6u@I9vUa%->#bbUz2~${&SVVQ)mc*QYmud${gp?W%{$=Bio)>8 zI~jCNYnNGwmE!B_Po%6GarShC@6{=~ps3CI2~2i;cWQM*o_Li}v(~n)+tnmYfBu3Q zU-70O%jKCQeMna<(CBrRQA5WejT;<8!!Z3_MmDZj@>OTCh6n+-FH>GTE?()vitD9r z^^p_A#b0oG5V6<2y}K+3(&m>v12ROO>5q)ko@~C>Fcea%vbi?Bj4?EQ_ua?;wRUH= zMBEp;R>t7t9GZ5Wv&civj+Q-=7QLf6f7I^QUJb{c&3@}SBC)c(`eK5B%VN}vjF#xy zW9VFV9NT|Brm#^tHo|h@P@p-|vE2XmJBHrR#*&0vYh(QCjL3xKxJPPT5vw!A&JXur z4ZQKf==W`K7=DaOJZBJ0c-i)6)~0k~h9#UjTU)PuqQY$7c(#`vzIe}GS0RL>(sZLH zoe{Gg?K@IeE3Q^ZcWei<@1)UR1t(KzB4&nvEVp)a1PhiHCp)tEaSl;DncXPIvtbM0 zWRam|5vv4vVbELSG~)w_c9zB5i1$KgF*&L(X&$*0%FTo=qLh`|4Kwc`5s=TS-0H=&q90 z6Bu&zo+Pr{WW*-c>c{0?=@6y<3?=m%LLu<7#pmZ>;L20v1*=hL-|!(yC`grKIu)?x zlpb$F{6XTMIVN_lUd$-1F}-d6yLqI+rq>>qTK}!`Y0EooL;C#!Hnp2`3Vu>rV|&eM zXhk^J4&v+KYLeKe3aqAoGyLX*`$95C9)?-zp}-tLy96g^N5+C$XPZcPbzM*H0a&RF zmV1vk#;aqcbfplD9s;UYCmF0xJQ(zEQ8#q->sn{s!FnY=-?ovDcyO0x_XKwSYWj%) zF3!i+`f93US>zhklG_MrV;}9^kbO>{L$lXGfmN~ny4(%^g`r>42^9Kk!I(Z5#qM8&h|?! zkwKO`QvpcdsnL2jL%qh+XuYPa)6zLUI%lW56)%P^2)cuzR!4amtvU?=ZrOjLX#f|BZ$YS97OMFtAu-w zk)Dc3I)T(BGUVKpa`E<$u&NsWkC*$lxK*5b=F8vz8y8lNIU4s=bjeqj7a+&DVUN+Q zZctUJGwomtJv(~pz(ZP$Qrm3gsq zpOW!RV|T#uLq0W+3S^#(Dn`D(#IR>FNkXZ!W<3T$q~n%+pMz9>WPH*Yxg6sXUs&a+ z;rJMqrQzIS26x&*obx!Md!@PAz*{cSD8705M|g3mPS!}$TbbP=X@0^GLr5V4Vahe; zz4D;|`7;O+ghXB6xg4_2*vdrlL5LaTXxOe)#qpQNx%&~sD5`kzEUk)f#M+r;;{I18 zVxF5ZSU^@TyIk>Kr_lS!RB%sllTm)YBvcbg?^ANAw&VXbu2kPIs4qv#P_ zW{Ri@U+^;Wve|Bw3Pz~bwj)gybFC_LA`LSH_=`vrkMSB`8L}5A+i&sN(mB6}?Rm>{ zWFHEY7q~yX;Q7MzVX%8PIz-}!9VW9G-djKz1&+a7!WGnP-ce$zAIGV&VPfed{t5Jwsq2gzC-RysG6G znmijWK0;FV$=^AGqg0DT89a`WLRY!lpyo?lTw7Uu?aGVq=GUsBTk8wUiLyE0xQ7s= z*;upzno)4$B(vGj`v5Mqp;o;&Q#R4cdNqY`e>KR8o#n*jIX~rz9jhQFPZ Date: Sat, 1 Sep 2018 22:15:37 +0100 Subject: [PATCH 032/116] Updated wording and images (#6137) This is to reflect the changes to the UI that got overlooked in the doc updates ;) Image updates in [this PR](https://github.com/home-assistant/home-assistant.io/pull/6136/) --- source/_components/frontend.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index eb8d14b42b2..9f6ab7ee33b 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -112,10 +112,10 @@ automation: ### {% linkable_title Manual Theme Selection %} -When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under **General** called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately. +When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (before 0.77 it was in the Configuration panel under **General** called "Set a theme"). You can then choose any installed theme from the dropdown list and it will be applied immediately.

- + Set a theme

@@ -137,9 +137,9 @@ Those will be loaded via `` on a ### {% linkable_title Manual Language Selection %} -The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select one from "Choose a Language". It will be applied immediately. +The browser language is automatically detected. To use a different language, go to the user profile menu (before 0.77 it was found in **General** in the Configuration panel) and select one. It will be applied immediately.

- + Choose a Language

From 6f413c66dcefc42a91f168e46073ff24a5e6c341 Mon Sep 17 00:00:00 2001 From: Maciej Bieniek Date: Sat, 1 Sep 2018 23:37:24 +0200 Subject: [PATCH 033/116] Add unique_id (#6121) --- source/_components/light.mqtt.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index e92f859fb7c..b7ca1ff13a5 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -35,6 +35,10 @@ name: required: false type: string default: MQTT Light +unique_id: + description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. + required: false + type: string command_topic: description: The MQTT topic to publish commands to change the switch state. required: true From 2b822cb9f602a83e7c602722100dc0a3c99196b2 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sat, 1 Sep 2018 22:38:44 +0100 Subject: [PATCH 034/116] Removed automation: line (#6116) One of the examples has two `automation:` lines, which clearly doesn't work. Removed after somebody had issues with it --- source/_components/input_number.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 9f7f65ed956..299543428d4 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -179,9 +179,8 @@ automation: entity_id: input_number.target_temp value: "{{ trigger.payload }}" -# This automation script runs when the target temperature slider is moved. +# This second automation script runs when the target temperature slider is moved. # It publishes its value to the same MQTT topic it is also subscribed to. -automation: - alias: Temp slider moved trigger: platform: state From d815772de4b5e2044cfc3f113019840cf0beb03a Mon Sep 17 00:00:00 2001 From: Brian J King Date: Sat, 1 Sep 2018 16:52:38 -0500 Subject: [PATCH 035/116] General updates for formatting & structure (#6102) * General updates for formatting & structure * Minor change --- source/_cookbook/track_battery_level.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_cookbook/track_battery_level.markdown b/source/_cookbook/track_battery_level.markdown index 696742b1c74..902e2e4aaa2 100644 --- a/source/_cookbook/track_battery_level.markdown +++ b/source/_cookbook/track_battery_level.markdown @@ -12,7 +12,7 @@ ha_category: Automation Examples ### {% linkable_title iOS Devices %} -If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/components/device_tracker.icloud/) is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). You can also the `battery` [sensor device class](/components/sensor/#device-class) to dynamically change the icon with the battery level. +If you have a device running iOS (iPhone, iPad, etc), The [iCloud](/components/device_tracker.icloud/) component is gathering various details about your device including the battery level. To display it in the Frontend use a [template sensor](/components/sensor.template/). You can also use the `battery` [sensor device class](/components/sensor/#device-class) to dynamically change the icon with the battery level. {% raw %} ```yaml From 4611a4349d6d9e34485e8f915210a06cecad566a Mon Sep 17 00:00:00 2001 From: Censored3 Date: Sat, 1 Sep 2018 23:54:46 +0200 Subject: [PATCH 036/116] Update addon/git_pull for PR home-assistant/hassio-addons#386 (#6073) --- source/_addons/git_pull.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_addons/git_pull.markdown b/source/_addons/git_pull.markdown index 8cb2c3a852b..9bfc6f8cca2 100644 --- a/source/_addons/git_pull.markdown +++ b/source/_addons/git_pull.markdown @@ -18,6 +18,7 @@ Load and update configuration files for Home Assistant from a [Git](https://git- "git_branch": "master", "git_command": "pull", "git_remote": "origin", + "git_prune": "false", "repeat": { "active": false, "interval": 300 @@ -38,8 +39,9 @@ Load and update configuration files for Home Assistant from a [Git](https://git- ``` - **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your GitHub repository URL (see example configuration) -- **git_branch** (*Required*): Branch name of the Git repo, leave this as 'master' if you are unsure. +- **git_branch** (*Required*): Branch name of the Git repo. If left empty, the currently checked out branch will be updated. Leave this as 'master' if you are unsure. - **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure. +- **git_prune** (*Required*): If set to true, the add-on will cleanup branches that are deleted on the remote repository, but still have cached entries on the local machine. Leave this as `false` if you are unsure. - **git_command** (*Required*): Must be either `pull` or `reset`. Leave this as `pull` if you are unsure. * **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files. From 377fa82b8e9d5434f445319395580dcbbb0be9bb Mon Sep 17 00:00:00 2001 From: Jesse Rizzo <32472573+jesserizzo@users.noreply.github.com> Date: Sat, 1 Sep 2018 17:08:49 -0500 Subject: [PATCH 037/116] IP address is no longer required for Enphase Envoy component (#6088) * IP address is no longer required * Change keys in monitored conditions from '7_days' to 'seven_days' * Minor changes --- .../_components/sensor.enphase_envoy.markdown | 39 ++++++++++++------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/source/_components/sensor.enphase_envoy.markdown b/source/_components/sensor.enphase_envoy.markdown index fb04d906ed4..ec6d8002162 100644 --- a/source/_components/sensor.enphase_envoy.markdown +++ b/source/_components/sensor.enphase_envoy.markdown @@ -23,33 +23,44 @@ To enable this sensor, add the following lines to your `configuration.yaml` file # Example configuration.yaml entry sensor: - platform: enphase_envoy - ip_address: ENVOY_LOCAL_IP_ADDRESS +``` + +```yaml +# Example configuration.yaml entry +sensor: + - platform: enphase_envoy + ip_address: LOCAL_IP_FOR_ENVOY + monitored_conditions: + - production + - consumption + - lifetime_production + - lifetime_consumption ``` {% configuration %} ip_address: - description: The local IP Address of your Envoy - required: true + description: The local IP Address of your Envoy. Leave blank to search for it, but this may not always be reliable. + required: false type: string monitored_conditions: - description: The list of conditions to monitor + description: The list of conditions to monitor. required: false type: list keys: production: - description: The power in W being produced by the solar panels + description: The power in W being produced by the solar panels. daily_production: - description: The energy in Wh produced that day - 7_days_production: - description: The energy in Wh produced the last 7 days + description: The energy in Wh produced that day. + seven_days_production: + description: The energy in Wh produced the last 7 days. lifetime_production: - description: The energy in Wh produced in the lifetime of the Envoy + description: The energy in Wh produced in the lifetime of the Envoy. consumption: - description: The power in W being consumed in the whole house + description: The power in W being consumed in the whole house. daily_consumption: - description: The energy in Wh consumed that day - 7_days_consumption: - description: The energy in Wh consumed the last 7 days + description: The energy in Wh consumed that day. + seven_days_consumption: + description: The energy in Wh consumed the last 7 days. lifetime_consumption: - description: The energy in Wh consumed in the lifetime of the Envoy + description: The energy in Wh consumed in the lifetime of the Envoy. {% endconfiguration %} From 1b6a78baca6187145b8750e5ee82a5af15914f67 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 00:38:58 +0200 Subject: [PATCH 038/116] Tschmidty69 patch 2 (#6141) * Added session_id and slotname_raw values. * Added session_id and slotname_raw values (#6078) * Added session_id and slotname_raw values * Minor changes --- source/_components/snips.markdown | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index f69b7f0b138..afe3d1f7e0a 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -38,17 +38,17 @@ $ sudo apt-get update $ sudo apt-get install -y snips-platform-voice ``` -Note: if the keyserver pgp.mit.edu is down try to use another one in the 4th line , like pgp.surfnet.nl: +Note that if the keyserver pgp.mit.edu is down then try to use another one in the 4th line, like pgp.surfnet.nl: ```bash -sudo apt-key adv --keyserver pgp.surfnet.nl --recv-keys D4F50CDCA10A2849 +$ sudo apt-key adv --keyserver pgp.surfnet.nl --recv-keys D4F50CDCA10A2849 ``` ### {% linkable_title Creating an assistant %} Head over to the [Snips Console](https://console.snips.ai) to create your assistant. Launch the training and download by clicking on the "Download Assistant" button. -The next step is to get the assistant to work on your device. Unzip and copy the assistant folder that you downloaded from the web console to the path. Assuming your downloaded assistant folder is on your desktop, just run: +The next step is to get the assistant to work on your device. Unzip and copy the `assistant` folder that you downloaded from the web console to the path. Assuming your downloaded `assistant` folder is on your desktop, just run: ```bash $ scp -r ~/Desktop/assistant pi@:/home/pi/. @@ -68,7 +68,7 @@ Then, move the assistant to the right folder: (pi) $ sudo mv /home/pi/assistant /usr/share/snips/assistant ``` -Note: if you already have an assistant installed and wish to replace it, start by removing the previous one, and then move the new one in its place: +Note that if you already have an assistant installed and wish to replace it then start by removing the previous one and then move the new one in its place: ```bash (pi) $ sudo rm -r /usr/share/snips/assistant @@ -161,22 +161,28 @@ In the `data_template` block, we have access to special variables, corresponding ### {% linkable_title Special slots %} -Two special values for slots are populated with the siteId the intent originated from and the probability value for the intent. +Several special values for slots are populated with the `siteId `the intent originated from and the probability value for the intent, the `sessionId` generate by the dialogue manager, and `slote_name` raw which will contain the raw, uninterpreted text of the slot value. -In the above example, the slots are plain strings. However, snips has a duration builtin value used for setting timers and this will be parsed to a seconds value. +In the above example, the slots are plain strings. However, Snips has a duration builtin value used for setting timers and this will be parsed to a seconds value. + +In this example if we had an intent triggered with 'Set a timer for five minutes', `duration:` would equal 300 and `duration_raw:` would be set to 'five minutes'. The duration can be easily used to trigger Home Assistant events and the `duration_raw:` could be used to send a human readable response or alert. + +In this example if we had an intent triggered with 'Set a timer for five minutes', duration would equal 300 and duration_raw would be set to 'five minutes'. The duration can be easily used to trigger HA events, and the duration_raw could be used to send a human readable response or alert. {% raw %} ```yaml SetTimer: speech: type: plain - text: weather + text: 'Set a timer' action: service: script.set_timer data_template: name: "{{ timer_name }}" duration: "{{ timer_duration }}" siteId: "{{ site_id }}" + sessionId: "{{ session_id }}" + duration_raw: "{{ raw_value }}" probability: "{{ probability }}" ``` {% endraw %} @@ -185,7 +191,7 @@ SetTimer: ### {% linkable_title Sending TTS Notifications %} -You can send TTS notifications to Snips using the snips.say and snips.say_action services. Say_action starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door". +You can send TTS notifications to Snips using the `snips.say` and `snips.say_action` services. `say_action` starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door". #### {% linkable_title Service `snips.say` %} @@ -240,9 +246,7 @@ intent_script: ##### {% linkable_title Intiating a query %} -Here is a more complex example. The automation is triggered if the garage door is open for more than 10 minutes. -Snips will then ask you if you want to close it and if you respond with something like "Close the garage door" it -will do so. Unfortunately there is no builtin support for yes and no responses. +Here is a more complex example. The automation is triggered if the garage door is open for more than 10 minutes. Snips will then ask you if you want to close it and if you respond with something like "Close the garage door" it will do so. Unfortunately there is no builtin support for yes and no responses. ```yaml automation: From d578cd54f28f3806e3097ce0ca94e8d4f8b70870 Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 09:44:15 +0200 Subject: [PATCH 039/116] Update sensor.tibber.markdown (#6145) Corrected category to Energy to match other similar type sensors --- source/_components/sensor.tibber.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.tibber.markdown b/source/_components/sensor.tibber.markdown index 81d11c7ac2b..3e71d8fc2a5 100644 --- a/source/_components/sensor.tibber.markdown +++ b/source/_components/sensor.tibber.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: tibber.png -ha_category: Sensor +ha_category: Energy ha_release: 0.55 ha_iot_class: "Cloud Polling" --- From 8a04b73d40eb9ecfd7c97ed4f6f689975bda77fc Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 09:45:00 +0200 Subject: [PATCH 040/116] Update sensor.systemmonitor.markdown (#6144) --- source/_components/sensor.systemmonitor.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 855dca71c04..8f4ee938fea 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -80,7 +80,7 @@ sensor: arg: 'Local Area Connection' ``` -If you need to use some other interface, open a command line prompt and type `ipconfig` to list all interface names. For example a wireless connection output from `ifconfig` might look like: +If you need to use some other interface, open a command line prompt and type `ipconfig` to list all interface names. For example a wireless connection output from `ipconfig` might look like: ```bash Wireless LAN adapter Wireless Network Connection: From ebe8eb7852b9bcc86cb2c02f6da43017da14c1ca Mon Sep 17 00:00:00 2001 From: plyblu Date: Sun, 2 Sep 2018 02:46:45 -0500 Subject: [PATCH 041/116] Update mailgun.markdown (#6143) Fix inconsistency where "domain" is required but "sandbox" can also be used to specify the domain. It appears that the package https://github.com/pschmitt/pymailgunner in def guess_domain allows multiple domains and "sandbox" can be used to choose a sandbox domain over a normal domain. As far as I can tell, this feature isn't used by the Mailgun component. There are also updates to the Mailgun Notify doc. --- source/_components/mailgun.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index 2f13d2c0625..e1ecaefc72a 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -12,7 +12,7 @@ ha_category: Notifications ha_release: 0.38 --- -The component supports push messages and generates events based on inbound data. To use, add a Route set to Store and Notify with a URL of the following form: `https:///api/mailgun?api_password=` +The component supports push messages and generates events based on inbound data. To generate inbound events, add a Route set to Store and Notify with a URL of the following form: `https:///api/mailgun?api_password=` To send messages, use the [Mailgun notify platform][notify]. @@ -24,11 +24,11 @@ To send messages, use the [Mailgun notify platform][notify]. # Example configuration.yaml entry mailgun: domain: mg.example.com - api_key: token-XXXXXXXXX + api_key: XXXXXXXXXXXXX ``` Configuration variables: - **domain** (*Required*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up. - **api_key** (*Required*): This is the API token that has been generated in your Mailgun account. -- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`. +- **sandbox** (*Deprecated*): Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed. Defaults to `False`. From ffee9ec2af190ecc5175ff2e1871ac4c880d480c Mon Sep 17 00:00:00 2001 From: John Arild Berentsen Date: Sun, 2 Sep 2018 09:53:51 +0200 Subject: [PATCH 042/116] Clarification Clarification of the config option --- source/_docs/z-wave/installation.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 586f319a68a..a118d2c97ce 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -103,7 +103,7 @@ device_config / device_config_domain / device_config_glob: type: integer default: 2 invert_openclose_buttons: - description: Inverts function of the open and close buttons for the cover domain. + description: Inverts function of the open and close buttons for the cover domain. This will not invert the positon and state reporting. required: false type: boolean default: False From 5eec4dfb806d9004f06e82ca81fb0bdc32c57ed4 Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 10:29:02 +0200 Subject: [PATCH 043/116] Update sensor.rainbird.markdown updated to correct category --- source/_components/sensor.rainbird.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.rainbird.markdown b/source/_components/sensor.rainbird.markdown index 750c2874979..e7f26af34c4 100644 --- a/source/_components/sensor.rainbird.markdown +++ b/source/_components/sensor.rainbird.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Sensor ha_release: 0.61 ha_iot_class: "Local Polling" --- From 2d242bd78642073992468ac626416e01d0f907d1 Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 10:29:35 +0200 Subject: [PATCH 044/116] Update switch.rainbird.markdown updated to correct category --- source/_components/switch.rainbird.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/switch.rainbird.markdown b/source/_components/switch.rainbird.markdown index 673c4d19287..5b15bd486fe 100644 --- a/source/_components/switch.rainbird.markdown +++ b/source/_components/switch.rainbird.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Switch ha_release: 0.57 ha_iot_class: "Local Polling" --- From b3c6fe44bc6e28f24f5c7dd5fb43149c5eace9dc Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 10:30:46 +0200 Subject: [PATCH 045/116] Update sensor.ted5000.markdown updated to correct category --- source/_components/sensor.ted5000.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.ted5000.markdown b/source/_components/sensor.ted5000.markdown index 20e94ba3e8d..1dd451255c7 100644 --- a/source/_components/sensor.ted5000.markdown +++ b/source/_components/sensor.ted5000.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ted.png -ha_category: Sensor +ha_category: Energy ha_release: "0.30" ha_iot_class: "Local Polling" --- From 997ae0612c6ae1849f5191b1dc1a89b9901814fd Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 10:33:42 +0200 Subject: [PATCH 046/116] Update switch.homekit_controller.markdown updated to correct category --- source/_components/switch.homekit_controller.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/switch.homekit_controller.markdown b/source/_components/switch.homekit_controller.markdown index 43bf3be57b1..d4b50659595 100644 --- a/source/_components/switch.homekit_controller.markdown +++ b/source/_components/switch.homekit_controller.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: apple-homekit.png -ha_category: Light +ha_category: Switch ha_iot_class: "Local Polling" ha_release: 0.68 --- From ba46f2e850f4dedf63911095012ce044761cc0bb Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 15:51:29 +0200 Subject: [PATCH 047/116] Update APCUPSd docs (#6159) --- source/_components/apcupsd.markdown | 18 ++++++-- .../binary_sensor.apcupsd.markdown | 12 +++-- source/_components/sensor.apcupsd.markdown | 44 ++----------------- 3 files changed, 27 insertions(+), 47 deletions(-) diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index fd25d00d0d5..ff6f732484e 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -14,6 +14,8 @@ ha_release: 0.13 [APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -21,8 +23,16 @@ To enable this sensor, add the following lines to your `configuration.yaml`: apcupsd: ``` -Configuration variables: - -- **host** (*Optional*): The hostname/IP address on which the APCUPSd NIS is being served. Defaults to `localhost`. -- **port** (*Optional*): The port on which the APCUPSd NIS is listening. Defaults to `3551`. +{% configuration %} +host: + description: The hostname/IP address on which the APCUPSd NIS is being served. + required: false + type: string + default: localhost +port: + description: The port on which the APCUPSd NIS is listening. + required: false + type: int + default: 3551 +{% endconfiguration %} diff --git a/source/_components/binary_sensor.apcupsd.markdown b/source/_components/binary_sensor.apcupsd.markdown index 6c599b75b15..30a124785a2 100644 --- a/source/_components/binary_sensor.apcupsd.markdown +++ b/source/_components/binary_sensor.apcupsd.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times. +## {% linkable_title Configuration %} + To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/), and add the following lines to your `configuration.yaml` file: ```yaml @@ -23,6 +25,10 @@ binary_sensor: - platform: apcupsd ``` -Configuration variables: - -- **name** (*Optional*): Name to use in the front end. +{% configuration %} +name: + description: Name to use in the frontend. + required: false + type: string + default: UPS Online Status +{% endconfiguration %} diff --git a/source/_components/sensor.apcupsd.markdown b/source/_components/sensor.apcupsd.markdown index 54db50e7520..bfaf33769b6 100644 --- a/source/_components/sensor.apcupsd.markdown +++ b/source/_components/sensor.apcupsd.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command. +## {% linkable_title Configuration %} + To use this sensor platform, you first have to set up [apcupsd](/components/apcupsd/), and add the following to your `configuration.yaml` file: ```yaml @@ -24,14 +26,6 @@ sensor: resources: - bcharge - linev - - loadpct - - nominv - - nompower - - numxfers - - outputv - - status - - timeleft - - tonbatt ``` Configuration variables: @@ -64,37 +58,7 @@ MAXTIME : 0 Seconds MAXLINEV : 249.6 Volts MINLINEV : 244.4 Volts OUTPUTV : 218.4 Volts -SENSE : High -DWAKE : 0 Seconds -DSHUTD : 180 Seconds -DLOWBATT : 2 Minutes -LOTRANS : 196.0 Volts -HITRANS : 253.0 Volts -RETPCT : 15.0 Percent -ITEMP : 30.6 C -ALARMDEL : Low Battery -BATTV : 27.6 Volts -LINEFREQ : 50.0 Hz -LASTXFER : High line voltage -NUMXFERS : 0 -TONBATT : 0 Seconds -CUMONBATT: 0 Seconds -XOFFBATT : N/A -SELFTEST : NO -STESTI : 336 -STATFLAG : 0x0500000A -DIPSW : 0x00 -REG1 : 0x00 -REG2 : 0x00 -REG3 : 0x00 -MANDATE : 07/13/99 -SERIALNO : GS9888761008 -BATTDATE : 13/11/15 -NOMOUTV : 230 Volts -NOMBATTV : 24.0 Volts -EXTBATTS : 0 -FIRMWARE : 70.11.I -END APC : 2016-02-09 17:13:46 +0000 +[...] ``` Use the (case insensitive) values from the left hand column: @@ -105,5 +69,5 @@ sensor: resources: - linev - loadpct - - itemp + - timeleft ``` From 4e2d299b287822980a61f3de44bb1f8828753028 Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 15:58:34 +0200 Subject: [PATCH 048/116] Update binary_sensor.rachio.markdown (#6157) updated to correct category --- source/_components/binary_sensor.rachio.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/binary_sensor.rachio.markdown b/source/_components/binary_sensor.rachio.markdown index 568e9e0c558..c46bf398794 100644 --- a/source/_components/binary_sensor.rachio.markdown +++ b/source/_components/binary_sensor.rachio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rachio.png -ha_category: Hub +ha_category: Sensor ha_iot_class: "Cloud Push" ha_release: 0.73 --- From 1f9a34d67f413335610dff4df65cdd81fcbe2c1f Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 15:59:00 +0200 Subject: [PATCH 049/116] Update sensor.trafikverket_weatherstation.markdown (#6155) updated to correct category --- source/_components/sensor.trafikverket_weatherstation.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.trafikverket_weatherstation.markdown b/source/_components/sensor.trafikverket_weatherstation.markdown index 272c4e09941..2fcd0e28465 100644 --- a/source/_components/sensor.trafikverket_weatherstation.markdown +++ b/source/_components/sensor.trafikverket_weatherstation.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: trafikverket.png -ha_category: Sensor +ha_category: Weather ha_release: 0.66.0 --- From b7a8b221d4d94ab2bfbcc03a47b46eb67a6be749 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 16:09:03 +0200 Subject: [PATCH 050/116] Fix formatting --- source/_components/switch.tesla.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/switch.tesla.markdown b/source/_components/switch.tesla.markdown index 2ded4d7d100..9e11d6cfde3 100644 --- a/source/_components/switch.tesla.markdown +++ b/source/_components/switch.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Switch +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.54 --- -The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging, max range switch) from within Home Assistant. +The `tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging, max range switch) from within Home Assistant. -The switch platform will be automatically configured if Tesla component is configured. +The `switch` platform will be automatically configured if the `tesla` component is configured. -For more configuration information see the [Tesla component](/components/tesla/) documentation. +For more configuration information see the [`tesla` component](/components/tesla/) documentation. From 73a70f8d0d688846ee6079820048f1fd48f0dfef Mon Sep 17 00:00:00 2001 From: Daniel Lashua Date: Sun, 2 Sep 2018 09:10:33 -0500 Subject: [PATCH 051/116] List all available options for method. (#6160) * List all available options for method. * Minor change --- source/_components/notify.rest.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown index 4d1d83c5813..d46ca8e932d 100644 --- a/source/_components/notify.rest.markdown +++ b/source/_components/notify.rest.markdown @@ -29,7 +29,7 @@ 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`. - **resource** (*Required*): The resource or endpoint that will receive the value. -- **method** (*Optional*): The method of the request. Default is GET. +- **method** (*Optional*): The method of the request. Default is `GET`. Other valid options are `POST` or `POST_JSON`. - **headers** (*Optional*): The headers for the request. - **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`. - **title_param_name** (*Optional*): Parameter name for the title. Defaults to none. From 9aafcbe934b96f2de0fd53fa7ed55bea9f1628fa Mon Sep 17 00:00:00 2001 From: Denix Date: Sun, 2 Sep 2018 16:42:01 +0200 Subject: [PATCH 052/116] added more detailed instructions for razberry (#6162) * added more detailed instructions for razberry * Minor changes --- source/_docs/z-wave/device-specific.markdown | 21 ++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index bb84afca590..add87e6abdc 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -49,7 +49,7 @@ $ echo -e -n "\x01\x08\x00\xF2\x51\x01\x01\x05\x01\x50" > /dev/serial/by-id/usb- You need to disable the on-board Bluetooth since the board requires the use of the hardware UART (and there's only one on the Pi3). You do this by adding the following to the end of `/boot/config.txt`: -``` +```text dtoverlay=pi3-disable-bt ``` @@ -59,7 +59,24 @@ Then disable the Bluetooth modem service: $ sudo systemctl disable hciuart ``` -Finally, reboot to make those changes active. It's been reported that this is also required on the Pi2. +Once Bluetooth is off, enable the serial interface via the `raspi-config` tool. After reboot run: + +```bash +$ sudo systemctl mask serial-getty@ttyAMA0.service +``` + +so that your serial interface looks like: + +```text +crw-rw---- 1 root dialout 204, 64 Sep 2 14:38 /dev/ttyAMA0 +``` +at this point simply add your user (homeassistant) to the dialout group: + +```bash +$ sudo usermod -a -G dialout homeassistant +``` + +Finally, reboot again to make those changes active. It's has been tested on hassbian and has been reported that this is also required on the Pi2.

If you've installed the Z-Way software, you'll need to ensure you disable it before you install Home Assistant or you won't be able to access the board. Do this with `sudo /etc/init.d/z-way-server stop; sudo update-rc.d z-way-server disable`. From 4d493d8612b54b089b4252d4ac03f3b08349fe6b Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 2 Sep 2018 18:08:59 +0100 Subject: [PATCH 053/116] Fixing formatting (#6165) With the three ticks on the same line as the command it collapsed to a single line --- source/_docs/installation/hassbian.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_docs/installation/hassbian.markdown b/source/_docs/installation/hassbian.markdown index 9c12947cd46..9fdcd566a0a 100644 --- a/source/_docs/installation/hassbian.markdown +++ b/source/_docs/installation/hassbian.markdown @@ -23,4 +23,5 @@ When instructions tell you to activate the virtual environment to install a Pyth ```bash $ sudo -u homeassistant -H -s -$ source /srv/homeassistant/bin/activate``` +$ source /srv/homeassistant/bin/activate +``` From 27a53313ca2298b97cec1d5c5ddb3f1e387b310f Mon Sep 17 00:00:00 2001 From: Totoo Date: Sun, 2 Sep 2018 19:14:45 +0200 Subject: [PATCH 054/116] Added image attachment example for discord component (#6135) * Added image attachment to example * Minor addition --- source/_components/notify.discord.markdown | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/source/_components/notify.discord.markdown b/source/_components/notify.discord.markdown index 01029fb4b1c..16c82bbfc1f 100644 --- a/source/_components/notify.discord.markdown +++ b/source/_components/notify.discord.markdown @@ -35,7 +35,7 @@ Configuration variables: ### {% linkable_title Setting up the bot %} -Bots can only send messages to servers. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me). +Bots can only send messages to servers or attach local available images. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me).

@@ -69,7 +69,12 @@ This channel ID has to be used as the target when calling the notification servi "target": [ "1234567890", "0987654321" - ] + ], + "data": { + "images": [ + "/tmp/garage_cam.jpg" + ] + } } ``` From b87d7e8a41b46605964834599df7e0358b3429f2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 19:25:59 +0200 Subject: [PATCH 055/116] Move to new car category --- source/_components/sensor.nsw_fuel_station.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.nsw_fuel_station.markdown b/source/_components/sensor.nsw_fuel_station.markdown index 5ebdb8fc51e..9a560f322c3 100644 --- a/source/_components/sensor.nsw_fuel_station.markdown +++ b/source/_components/sensor.nsw_fuel_station.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Fuel +ha_category: Car ha_release: 0.72 ha_iot_class: "Cloud Polling" --- From c1f7bce30405c2eea6e7027b5bf2e0766bdaab17 Mon Sep 17 00:00:00 2001 From: plyblu Date: Sun, 2 Sep 2018 12:30:25 -0500 Subject: [PATCH 056/116] Update notify.mailgun.markdown (#6142) * Update notify.mailgun.markdown Fix inconsistency where "domain" is required in the Mailgun Component https://www.home-assistant.io/components/mailgun/ but "sandbox" can also be used to specify the domain. It appears that the package https://github.com/pschmitt/pymailgunner in def guess_domain(...) allows multiple domains and "sandbox" can be used to choose a sandbox domain over a normal domain. As far as I can tell, this feature isn't used by the Mailgun component. Also removed all references to the obsolete word "token" to avoid confusion. Also used a different name for the notify service to differentiate it from the mailgun component. Note: There are also updates to the aforementioned Mailgun Component doc. * There is no need for the postfix --- source/_components/notify.mailgun.markdown | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/source/_components/notify.mailgun.markdown b/source/_components/notify.mailgun.markdown index 9e98d180524..93695c7e458 100644 --- a/source/_components/notify.mailgun.markdown +++ b/source/_components/notify.mailgun.markdown @@ -22,8 +22,7 @@ The Mailgun notification service allows you to send emails via Mailgun's REST AP # Example configuration.yaml entry mailgun: domain: mg.example.com - api_key: token-XXXXXXXXX - sandbox: False + api_key: XXXXXXXXXXXXXX notify: - name: mailgun @@ -33,11 +32,11 @@ notify: Configuration variables: -- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up. -- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`. -- **token** (*Required*): This is the API token that has been generated in your Mailgun account. +- **domain** (*Required*): This is the domain name to be used when sending out mail. +- **sandbox** (*Deprecated*): If a sandboxed domain is used, specify it in `domain`. Defaults to `False`. +- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account. - **recipient** (*Required*): The email address of the recipient. -- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries. +- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry. ## {% linkable_title Example automation %} From 5c9e396a518e95b3f8f6a2ecf6ebaac8a521fc52 Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 19:39:35 +0200 Subject: [PATCH 057/116] Update tesla.markdown (#6154) updated to new category Car --- source/_components/tesla.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index 8673396fc68..f912af94f82 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Hub +ha_category: Car ha_release: 0.53 ha_iot_class: "Cloud Polling" --- From daff356b3c56cf0b1fc945bf834b187a4ab8e98d Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 19:40:02 +0200 Subject: [PATCH 058/116] Update volvooncall.markdown (#6153) updated to new category Car --- source/_components/volvooncall.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index 6482d372ccf..103bafd4937 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: volvo.png -ha_category: Hub +ha_category: Car ha_release: 0.39 ha_iot_class: "Cloud Polling" --- From 81be88e5f2072427ad25eb009467f10091922671 Mon Sep 17 00:00:00 2001 From: ottersen <42288505+ottersen@users.noreply.github.com> Date: Sun, 2 Sep 2018 19:40:16 +0200 Subject: [PATCH 059/116] Update bmw_connected_drive.markdown (#6152) Update new category Car --- source/_components/bmw_connected_drive.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index 30c60fa32b7..7e4148e26eb 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Hub +ha_category: Car ha_release: 0.64 --- From 024ea83d2e20881370476810cb478de2a2cdfa00 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 21:25:10 +0200 Subject: [PATCH 060/116] Move to DIY category (#6168) --- source/_components/binary_sensor.arest.markdown | 4 +++- source/_components/binary_sensor.bbb_gpio.markdown | 4 +++- source/_components/sensor.arest.markdown | 4 +++- source/_components/sensor.bme280.markdown | 4 +++- source/_components/sensor.bme680.markdown | 2 +- source/_components/switch.arest.markdown | 4 +++- source/_components/switch.bbb_gpio.markdown | 4 +++- source/_components/zabbix.markdown | 2 ++ 8 files changed, 21 insertions(+), 7 deletions(-) diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown index d18a2d321a7..1cf17934b7f 100644 --- a/source/_components/binary_sensor.arest.markdown +++ b/source/_components/binary_sensor.arest.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Binary Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.9 --- @@ -16,6 +16,8 @@ ha_release: 0.9 The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +## {% linkable_title Configuration %} + To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.bbb_gpio.markdown b/source/_components/binary_sensor.bbb_gpio.markdown index be2a9bd9fb3..f35f488a7ea 100644 --- a/source/_components/binary_sensor.bbb_gpio.markdown +++ b/source/_components/binary_sensor.bbb_gpio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: beaglebone-black.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.37 ha_iot_class: "Local Push" --- The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). +## {% linkable_title Configuration %} + To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.arest.markdown b/source/_components/sensor.arest.markdown index 4f7c68732fc..4bb0a11ad78 100644 --- a/source/_components/sensor.arest.markdown +++ b/source/_components/sensor.arest.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: pre 0.7 --- @@ -16,6 +16,8 @@ ha_release: pre 0.7 The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +## {% linkable_title Configuration %} + To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 7dd524405a3..7887aff3dde 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,8 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bme680.markdown b/source/_components/sensor.bme680.markdown index d2496dd8a33..b32f23ab5d7 100644 --- a/source/_components/sensor.bme680.markdown +++ b/source/_components/sensor.bme680.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.62 ha_iot_class: "Local Push" --- diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index e0b63695371..a6a61d7ae98 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Switch +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.16 --- The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +## {% linkable_title Configuration %} + To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.bbb_gpio.markdown b/source/_components/switch.bbb_gpio.markdown index 7b02e6a927b..fc41a25db14 100644 --- a/source/_components/switch.bbb_gpio.markdown +++ b/source/_components/switch.bbb_gpio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: beaglebone-black.png -ha_category: Switch +ha_category: DIY ha_release: 0.36 ha_iot_class: "Local Push" --- The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). +## {% linkable_title Configuration %} + To use yourBeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index e4630839993..bda90be47f7 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `zabbix` component is the main component to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. +## {% linkable_title Configuration %} + To set the Zabbix component up, add the following information to your `configuration.yaml` file: ```yaml From c99c8c3c38e9390b4cf377c12dbc8787ca3b4dab Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 21:25:34 +0200 Subject: [PATCH 061/116] Move to Health category (#6167) --- .../binary_sensor.eight_sleep.markdown | 4 +-- .../_components/binary_sensor.openuv.markdown | 12 +++---- .../binary_sensor.sleepiq.markdown | 2 +- source/_components/eight_sleep.markdown | 4 +-- source/_components/openuv.markdown | 31 ++++++------------- .../_components/sensor.eight_sleep.markdown | 2 +- source/_components/sensor.openuv.markdown | 12 +++---- source/_components/sensor.sleepiq.markdown | 2 +- source/_components/sleepiq.markdown | 6 +++- 9 files changed, 29 insertions(+), 46 deletions(-) diff --git a/source/_components/binary_sensor.eight_sleep.markdown b/source/_components/binary_sensor.eight_sleep.markdown index cf9f2c52bfd..6811a640dda 100644 --- a/source/_components/binary_sensor.eight_sleep.markdown +++ b/source/_components/binary_sensor.eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Binary Sensor +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- @@ -16,4 +16,4 @@ ha_iot_class: "Cloud Polling" The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant. -Devices will be configured automatically. Please refer to the [component](/components/eight_sleep/) configuration on how to setup. +Devices will be configured automatically. Please refer to the [`eight_sleep` component](/components/eight_sleep/) configuration on how to setup. diff --git a/source/_components/binary_sensor.openuv.markdown b/source/_components/binary_sensor.openuv.markdown index 21cd0cb2bc0..0eda9c2426d 100644 --- a/source/_components/binary_sensor.openuv.markdown +++ b/source/_components/binary_sensor.openuv.markdown @@ -8,16 +8,12 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Binary Sensor +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` binary sensor platform allows you to view binary sensor data from -[OpenUV](http://openuv.io). +The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io). + +You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear. -

-You must have the [OpenUV component](/components/openuv/) configured to use -this platform. After configuring that component, binary sensors will -automatically appear. -

diff --git a/source/_components/binary_sensor.sleepiq.markdown b/source/_components/binary_sensor.sleepiq.markdown index 0d2170b84c0..3f355cc2780 100644 --- a/source/_components/binary_sensor.sleepiq.markdown +++ b/source/_components/binary_sensor.sleepiq.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Binary Sensor +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 3a455d4ab50..74df0d234eb 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Hub +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- @@ -17,7 +17,7 @@ The `eight_sleep` component allows Home Assistant to fetch data from your [Eight ## {% linkable_title Configuration %} -It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. +It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component. diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index 69e22a94e60..a4893d35c97 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -8,23 +8,19 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Hub +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` component displays UV and Ozone data from -[openuv.io](http://openuv.io). +The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io). ## {% linkable_title Generating an API Key %} To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google).

-The "Limited" plan (which is what new users are given by default) is limited to -500 API requests per day. In order to leave a buffer, the `openuv` component -queries the API every 30 minutes by default. This value can be modifed (via the -`scan_interval` key), but please note that over-running the API will require +The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require you to upgrade to a paid plan (and may disable your access in the meantime).

@@ -38,9 +34,7 @@ openuv: api_key: YOUR_OPENUV_API_KEY ``` -To configure additional functionality, add configuration options beneath -a `binary_sensor` and/or `sensor` key within the `openuv` section of -`configuration.yaml` as below: +To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of `configuration.yaml` as below: ```yaml openuv: @@ -87,8 +81,7 @@ sensors: ### {% linkable_title `uv_protection_window` %} -This sensor displays `true` if UV protection (sunscreen, etc.) is recommended -at the current date and time; displays `false` otherwise. +This sensor displays `true` if UV protection (sunscreen, etc.) is recommended at the current date and time; displays `false` otherwise. ## {% linkable_title Sensor Types %} @@ -102,19 +95,15 @@ This sensor displays the current UV index. ### {% linkable_title `current_uv_level` %} -This sensor displays the level of current UV index, which is calculated based -on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). +This sensor displays the level of current UV index, which is calculated based on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). ### {% linkable_title `max_uv_index` %} -This sensor displays the maximum UV index that will be encountered that day (at -solar noon). +This sensor displays the maximum UV index that will be encountered that day (at solar noon). ### {% linkable_title `safe_exposure_time_type_X` %} -These sensors display the approximate number of minutes a particular skin type -can be exposed to the sun before burning/tanning starts. Each sensor depicts -a skin type based on the +These sensors display the approximate number of minutes a particular skin type can be exposed to the sun before burning/tanning starts. Each sensor depicts a skin type based on the [Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale): * Skin Type I @@ -125,7 +114,5 @@ a skin type based on the * Skin Type VI

-The above guidelines constitude estimates and are intended to help informed -decision making. They should not replace analysis, advice, or diagnosis from a -trained medical professional. +The above guidelines constitude estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from a trained medical professional.

diff --git a/source/_components/sensor.eight_sleep.markdown b/source/_components/sensor.eight_sleep.markdown index 2d78d94f705..23e4ce46ed2 100644 --- a/source/_components/sensor.eight_sleep.markdown +++ b/source/_components/sensor.eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Sensor +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.openuv.markdown b/source/_components/sensor.openuv.markdown index f777be94262..61240520043 100644 --- a/source/_components/sensor.openuv.markdown +++ b/source/_components/sensor.openuv.markdown @@ -8,16 +8,12 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Sensor +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` sensor platform allows you to view sensor data from -[OpenUV](http://openuv.io). +The `openuv` sensor platform allows you to view sensor data from [OpenUV](http://openuv.io). + +You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, sensors will automatically appear. -

-You must have the [OpenUV component](/components/openuv/) configured to use -this platform. After configuring that component, sensors will automatically -appear. -

diff --git a/source/_components/sensor.sleepiq.markdown b/source/_components/sensor.sleepiq.markdown index 6740af6ab83..616c54e56ba 100644 --- a/source/_components/sensor.sleepiq.markdown +++ b/source/_components/sensor.sleepiq.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Sensor +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sleepiq.markdown b/source/_components/sleepiq.markdown index a3efeaa0a0c..bb006c23cdc 100644 --- a/source/_components/sleepiq.markdown +++ b/source/_components/sleepiq.markdown @@ -8,15 +8,19 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Hub +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- The SleepIQ implementation lets you view sensor data from [SleepIQ by SleepNumber](http://www.sleepnumber.com/sn/en/sleepiq-sleep-tracker). In particular, it lets you see the occupancy and current SleepNumber (ie current firmness) of each side of a SleepNumber bed. +## {% linkable_title Setup %} + You will need an account on [SleepIQ](https://sleepiq.sleepnumber.com/) to use this component. +## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml From 82e3b82dd5ae3574fafd2cfa671fe690ae469ccb Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 21:25:55 +0200 Subject: [PATCH 062/116] Move all parts to the car category (#6166) --- .../_components/binary_sensor.bmw_connected_drive.markdown | 4 ++-- source/_components/binary_sensor.tesla.markdown | 4 ++-- source/_components/bmw_connected_drive.markdown | 2 +- source/_components/climate.tesla.markdown | 4 ++-- .../_components/device_tracker.bmw_connected_drive.markdown | 4 ++-- source/_components/device_tracker.tesla.markdown | 4 ++-- source/_components/device_tracker.volvooncall.markdown | 2 +- source/_components/lock.bmw_connected_drive.markdown | 4 ++-- source/_components/lock.tesla.markdown | 6 +++--- source/_components/sensor.bmw_connected_drive.markdown | 4 ++-- source/_components/sensor.tesla.markdown | 6 +++--- source/_components/switch.tesla.markdown | 2 +- source/_components/switch.volvooncall.markdown | 2 +- source/_components/volvooncall.markdown | 4 +++- 14 files changed, 27 insertions(+), 25 deletions(-) diff --git a/source/_components/binary_sensor.bmw_connected_drive.markdown b/source/_components/binary_sensor.bmw_connected_drive.markdown index 74330ec5635..03a78c80bb6 100755 --- a/source/_components/binary_sensor.bmw_connected_drive.markdown +++ b/source/_components/binary_sensor.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Binary Sensor +ha_category: Car ha_release: 0.66 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` binary sensor platform allows you to import data on your BMW into Home Assistant. The binary sensors will be automatically configured if `bmw_connected_drive` component is configured. diff --git a/source/_components/binary_sensor.tesla.markdown b/source/_components/binary_sensor.tesla.markdown index c7c1948ae39..4561d8e4c8f 100644 --- a/source/_components/binary_sensor.tesla.markdown +++ b/source/_components/binary_sensor.tesla.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Binary Sensor +ha_category: Car ha_iot_class: "Cloud polling" ha_release: 0.53 --- -The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. +The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. They will be automatically discovered if the Tesla component is loaded. diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index 7e4148e26eb..56432369dd8 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -12,7 +12,7 @@ ha_category: Car ha_release: 0.64 --- -This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. +The `bmw_connected_drive` component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github. diff --git a/source/_components/climate.tesla.markdown b/source/_components/climate.tesla.markdown index 1d5720f65a9..282f7615702 100644 --- a/source/_components/climate.tesla.markdown +++ b/source/_components/climate.tesla.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Climate +ha_category: Car ha_iot_class: "Cloud push" ha_release: 0.53 --- -The `Tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant. +The `tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant. The climate platform will be automatically configured if Tesla component is configured. diff --git a/source/_components/device_tracker.bmw_connected_drive.markdown b/source/_components/device_tracker.bmw_connected_drive.markdown index 4f390c5fa3a..53da0530db1 100644 --- a/source/_components/device_tracker.bmw_connected_drive.markdown +++ b/source/_components/device_tracker.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.64 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` device tracker platform allows you to import data on your BMW into Home Assistant. The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured. diff --git a/source/_components/device_tracker.tesla.markdown b/source/_components/device_tracker.tesla.markdown index affbe9a1a85..e9cb8b34c04 100644 --- a/source/_components/device_tracker.tesla.markdown +++ b/source/_components/device_tracker.tesla.markdown @@ -8,11 +8,11 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.53 --- -The `Tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant. +The `tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant. The device tracker platform will be automatically configured if Tesla component is configured. diff --git a/source/_components/device_tracker.volvooncall.markdown b/source/_components/device_tracker.volvooncall.markdown index f4de42f5011..0177adf5ded 100644 --- a/source/_components/device_tracker.volvooncall.markdown +++ b/source/_components/device_tracker.volvooncall.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: volvo.png -ha_category: Presence Detection +ha_category: Car ha_release: "0.30" --- diff --git a/source/_components/lock.bmw_connected_drive.markdown b/source/_components/lock.bmw_connected_drive.markdown index 4c6c7a2edcf..262b2ffb473 100755 --- a/source/_components/lock.bmw_connected_drive.markdown +++ b/source/_components/lock.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Lock +ha_category: Car ha_release: 0.66 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` lock platform allows you to import data on your BMW into Home Assistant. The lock will be automatically configured if `bmw_connected_drive` component is configured. diff --git a/source/_components/lock.tesla.markdown b/source/_components/lock.tesla.markdown index 9708ea52205..bc050bf8b4a 100644 --- a/source/_components/lock.tesla.markdown +++ b/source/_components/lock.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Lock +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.53 --- -The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant. +The `tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant. -The lock platform will be automatically configured if Tesla component is configured. +The lock platform will be automatically configured if `tesla` component is configured. For more configuration information see the [Tesla component](/components/tesla/) documentation. diff --git a/source/_components/sensor.bmw_connected_drive.markdown b/source/_components/sensor.bmw_connected_drive.markdown index 083e5124a69..9100fb4b71b 100644 --- a/source/_components/sensor.bmw_connected_drive.markdown +++ b/source/_components/sensor.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Sensor +ha_category: Car ha_release: 0.64 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` sensor platform allows you to import data on your BMW into Home Assistant. The sensors will be automatically configured if the `bmw_connected_drive` component is configured. diff --git a/source/_components/sensor.tesla.markdown b/source/_components/sensor.tesla.markdown index 262a18910e2..1b9dfcca155 100644 --- a/source/_components/sensor.tesla.markdown +++ b/source/_components/sensor.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Sensor +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.53 --- -The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. +The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. -The sensor platform will be automatically configured if Tesla component is configured. +The sensor platform will be automatically configured if `tesla` component is configured. For more configuration information see the [Tesla component](/components/tesla/) documentation. diff --git a/source/_components/switch.tesla.markdown b/source/_components/switch.tesla.markdown index 9e11d6cfde3..5b184f2fa46 100644 --- a/source/_components/switch.tesla.markdown +++ b/source/_components/switch.tesla.markdown @@ -15,6 +15,6 @@ ha_release: 0.54 The `tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging, max range switch) from within Home Assistant. -The `switch` platform will be automatically configured if the `tesla` component is configured. +The switch platform will be automatically configured if the `tesla` component is configured. For more configuration information see the [`tesla` component](/components/tesla/) documentation. diff --git a/source/_components/switch.volvooncall.markdown b/source/_components/switch.volvooncall.markdown index f4de42f5011..0177adf5ded 100644 --- a/source/_components/switch.volvooncall.markdown +++ b/source/_components/switch.volvooncall.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: volvo.png -ha_category: Presence Detection +ha_category: Car ha_release: "0.30" --- diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index 103bafd4937..8160d19882f 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -14,7 +14,9 @@ ha_iot_class: "Cloud Polling" --- -The `volvooncall` platform offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. +The `volvooncall` component offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. + +## {% linkable_title Configuration %} To use Volvo On Call in your installation, add the following to your `configuration.yaml` file: From c44ad38a2de89f6ce2ca7d818f70b8c698ce4e64 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Sun, 2 Sep 2018 21:01:58 +0100 Subject: [PATCH 063/116] Improve warning for yi-hack-v3 versions (#6169) * Improve warning for yi-hack-v3 versions * Update camera.yi.markdown --- source/_components/camera.yi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index cb8975a86c2..e366ab46e32 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -31,7 +31,7 @@ In order to integrate the camera with Home Assistant, it is necessary to install Once installed, please ensure that you have enabled FTP and Telnet on your device.

-Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. +Currently, version 0.1.4-beta2 of the custom firmware is the highest supported without having to make additional modifications. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. To use higher firmware versions you must also follow [this workaround](https://github.com/shadow-1/yi-hack-v3/issues/129#issuecomment-361723075) to revert back to ftpd.

From 95102edbd41ec311aa63096538bd9a2656a52fe3 Mon Sep 17 00:00:00 2001 From: Wim Haanstra Date: Sun, 2 Sep 2018 22:20:26 +0200 Subject: [PATCH 064/116] Ritassist dependency update to 0.9.2 (#6038) * Ritassist dependency update to 0.9.2 * Try #1, Fix table rendering * Removed double line --- source/_components/device_tracker.ritassist.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/_components/device_tracker.ritassist.markdown b/source/_components/device_tracker.ritassist.markdown index e8f170f2026..255d17fe79a 100644 --- a/source/_components/device_tracker.ritassist.markdown +++ b/source/_components/device_tracker.ritassist.markdown @@ -78,5 +78,8 @@ See the [device tracker component page](/components/device_tracker/) for instruc | coolant_temperature | Temperature of the coolant [1] | | power_voltage | Power voltage measured by the hardware [1] | | distance_from_home | How far is your vehicle located from your Home Assistant Home location | +| current_max_speed | The maximum speed on the road the device is currently on (if available) | +| current_address | Object with address information the device is currently on. This resolves to the closest address to the coordinates of the device. | -[1] Only available on certain cars and hardware revisions. + +[1] Only available on certain cars and hardware revisions. \ No newline at end of file From 278de848afbdb377ac91baf11542253e87f31c45 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 22:48:36 +0200 Subject: [PATCH 065/116] Move to different category --- source/_components/sensor.opensky.markdown | 30 +++++++++++----------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/source/_components/sensor.opensky.markdown b/source/_components/sensor.opensky.markdown index cf16befa77e..39bbb600b4b 100644 --- a/source/_components/sensor.opensky.markdown +++ b/source/_components/sensor.opensky.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: opensky.png -ha_category: Sensor +ha_category: Transport featured: false ha_release: 0.43 ha_iot_class: "Cloud Polling" @@ -16,9 +16,9 @@ ha_iot_class: "Cloud Polling" The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. -## Configuration +## {% linkable_title Configuration %} -To enable this sensor, add the following lines to your `configuration.yaml`. +To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml sensor: @@ -28,24 +28,24 @@ sensor: Configuration options for the OpenSky Network sensor: -- **radius** (*Required*): Radius of region to monitor, in kilometers -- **latitude** (*Optional*): Region latitude (defaults to home zone latitude) -- **longitude** (*Optional*): Region longitude (defaults to home zone longitude) -- **altitude** (*Optional*): The maximum altitude(in meters) for planes to be detected in, 0 sets it to unlimited (defaults to 0) -- **name** (*Optional*): Sensor name (defaults to `opensky`) +- **radius** (*Required*): Radius of region to monitor, in kilometers. +- **latitude** (*Optional*): Region latitude. Defaults to home zone latitude. +- **longitude** (*Optional*): Region longitude. Defaults to home zone longitude. +- **altitude** (*Optional*): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0). +- **name** (*Optional*): Sensor name. Defaults to opensky. -## Events +## {% linkable_title Events %} -- **opensky_entry**: Fired when a flight enters the region -- **opensky_exit**: Fired when a flight exits the region +- **opensky_entry**: Fired when a flight enters the region. +- **opensky_exit**: Fired when a flight exits the region. Both events have two attributes: -- **sensor**: Name of `opensky` sensor that fired the event -- **callsign**: Callsign of the flight -- **altitude**: Altitude of the flight in meters +- **sensor**: Name of `opensky` sensor that fired the event. +- **callsign**: Callsign of the flight. +- **altitude**: Altitude of the flight in meters. -To receive notifications of the entering flights, add the following lines to your `configuration.yaml`. +To receive notifications of the entering flights, add the following lines to your `configuration.yaml` file: {% raw %} ```yaml From adba00c68ee4a43f5ef73f2d7b93d4e4a0a4f20f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 22:49:24 +0200 Subject: [PATCH 066/116] Mior fix --- source/_components/sensor.random.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown index cbe6049cf30..b56d1f3d591 100644 --- a/source/_components/sensor.random.markdown +++ b/source/_components/sensor.random.markdown @@ -18,7 +18,7 @@ The `random` sensor platform is creating random sensor values (integers) out of ## {% linkable_title Configuration %} -To enable the random sensor, add the following lines to your `configuration.yaml`: +To enable the random sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry From 6867750560697a4aa75643f83d998d94084cd32d Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 22:57:53 +0200 Subject: [PATCH 067/116] Move to Car category (#6170) * Move to Car category * Move to Car category --- .../binary_sensor.mercedesme.markdown | 4 ++-- .../binary_sensor.mychevy.markdown | 11 +++++++--- .../device_tracker.mercedesme.markdown | 4 ++-- source/_components/mercedesme.markdown | 2 +- source/_components/mychevy.markdown | 22 +++++++++---------- source/_components/sensor.mercedesme.markdown | 4 ++-- source/_components/sensor.mychevy.markdown | 12 +++++++--- source/_components/sensor.torque.markdown | 7 +++--- 8 files changed, 39 insertions(+), 27 deletions(-) diff --git a/source/_components/binary_sensor.mercedesme.markdown b/source/_components/binary_sensor.mercedesme.markdown index e1df898d498..a51f2e85d08 100644 --- a/source/_components/binary_sensor.mercedesme.markdown +++ b/source/_components/binary_sensor.mercedesme.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Binary Sensor +ha_category: Car ha_iot_class: "Cloud polling" ha_release: 0.63 --- -The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant. +The `mercedesme` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant. They will be automatically discovered if the Mercedes me component is loaded. diff --git a/source/_components/binary_sensor.mychevy.markdown b/source/_components/binary_sensor.mychevy.markdown index b04312b2ae5..42ce754d87a 100644 --- a/source/_components/binary_sensor.mychevy.markdown +++ b/source/_components/binary_sensor.mychevy.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "MyChevy Binary Sensors" +title: "MyChevy Binary Sensor" description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant." date: 2017-08-28 17:00 sidebar: true @@ -8,9 +8,14 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Binary Sensor +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -For configuration instructions, see [main component config](/components/mychevy/). +The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant. + +The binary sensor platform will be automatically configured if the `mychevy` component is configured. + +For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation. + diff --git a/source/_components/device_tracker.mercedesme.markdown b/source/_components/device_tracker.mercedesme.markdown index ad59c95e0d5..3707d5ca1cd 100644 --- a/source/_components/device_tracker.mercedesme.markdown +++ b/source/_components/device_tracker.mercedesme.markdown @@ -8,11 +8,11 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.63 --- -The `Mercedes me` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant. +The `mercedesme` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant. The device tracker platform will be automatically configured if Mercedes me component is configured. diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index db5774c5183..c533bc7f2bb 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Hub +ha_category: Car ha_release: 0.63 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 15a6b88ff19..a737ba764a4 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Hub +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The `MyChevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user, and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data. +The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data. This component provides the following platforms: @@ -33,21 +33,21 @@ mychevy: {% configuration %} username: - description: The email address associated with your my.chevrolet account. - required: true - type: string + description: The email address associated with your my.chevrolet account. + required: true + type: string password: - description: The password for your given my.chevrolet account. - required: true - type: string + description: The password for your given my.chevrolet account. + required: true + type: string {% endconfiguration %} -#### {% linkable_title Installation %} +### {% linkable_title Installation %} -Because this uses selenium behind the scenes, installation is more complicated than merely pip install. See the [installation instructions](https://github.com/sdague/mychevy). +Because this uses selenium behind the scenes, installation is more complicated than merely `pip` install. See the [installation instructions](https://github.com/sdague/mychevy). -#### {% linkable_title Limitations %} +### {% linkable_title Limitations %} The architecture of the GM automotive networking imposes some limitations on the functionality of the component. diff --git a/source/_components/sensor.mercedesme.markdown b/source/_components/sensor.mercedesme.markdown index da5fd9ba453..205955639dc 100644 --- a/source/_components/sensor.mercedesme.markdown +++ b/source/_components/sensor.mercedesme.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Sensor +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.63 --- -The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant. +The `mercedesme` sensor platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant. The sensor platform will be automatically configured if Mercedes me component is configured. diff --git a/source/_components/sensor.mychevy.markdown b/source/_components/sensor.mychevy.markdown index 03b3146f5f9..33747f5aab1 100644 --- a/source/_components/sensor.mychevy.markdown +++ b/source/_components/sensor.mychevy.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "MyChevy Sensors" +title: "MyChevy Sensor" description: "Instructions on how to integrate Chevy Bolt sensors car into Home Assistant." date: 2017-08-28 17:00 sidebar: true @@ -8,9 +8,15 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Sensor +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -For configuration instructions, see [main component config](/components/mychevy/). + +The `mychevy` sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant. + +The sensor platform will be automatically configured if the `mychevy` component is configured. + +For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation. + diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index 38379ccd675..91d45e4d7b9 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -8,14 +8,15 @@ comments: false sharing: true footer: true logo: torque.png -ha_category: Transport +ha_category: Car ha_release: "0.10" ha_iot_class: "Cloud Polling" --- The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a Bluetooth OBD2 stick via the Torque mobile application. -## {% linkable_title Configuration %} +## {% linkable_title Setup %} + To use Torque sensors with your installation, you must configure both the Torque mobile application and Home Assistant. ### {% linkable_title Torque application %} @@ -34,7 +35,7 @@ Under the **Realtime Web Upload** header: - Enter an email address in **User Email Address**. - Optionally set the **Web Logging Interval**. The 2-second default may quickly fill up the Home Assistant history database. -### {% linkable_title Home Assistant %} +### {% linkable_title Configuration %} Add the following to your `configuration.yaml` file: From 990885e5b8f6ce588bda00796456e243b701acc0 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 22:58:27 +0200 Subject: [PATCH 068/116] Update Mycroft documentation (#6171) --- source/_components/mycroft.markdown | 17 ++++++++++------- source/_components/notify.mycroft.markdown | 7 ++++++- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/source/_components/mycroft.markdown b/source/_components/mycroft.markdown index 9754096be00..827ecccaf18 100644 --- a/source/_components/mycroft.markdown +++ b/source/_components/mycroft.markdown @@ -14,18 +14,21 @@ ha_release: 0.53 [Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant. +## {% linkable_title Configuration %} + +To use Mycroft in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry mycroft: host: 0.0.0.0 ``` -`host` is your IP address of your mycroft instance. Once you have added your host to your `configuration.yaml` file, restart your Home Assistant server. This will load up the Mycroft component and make a service available to notify on Mycroft and more eventually. +{% configuration %} +host: + description: The IP address of your Mycroft instance. + required: true + type: string +{% endconfiguration %} -The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). - -To use this notification platform you simply need to input into the configuration that mycroft is your notification platform like seen above. - - -To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.mycroft.markdown b/source/_components/notify.mycroft.markdown index 81917884998..d868b43331a 100644 --- a/source/_components/notify.mycroft.markdown +++ b/source/_components/notify.mycroft.markdown @@ -12,4 +12,9 @@ ha_category: Notifications ha_release: "0.53" --- -Please see the main [Mycroft Component](/components/mycroft) +The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). + +Please check the [`mycroft` component](/components/mycroft/) for details. + +To use notifications, please see the [getting started with automation page](/getting-started/automation/). + From d9b46a57f52cb315d33f9c7fc2afe0ab92e9850f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 23:17:53 +0200 Subject: [PATCH 069/116] Move to Finance category (#6172) --- source/_components/coinbase.markdown | 5 ++++- source/_components/sensor.coinbase.markdown | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index f5d657ab4fb..bbe82837d40 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "coinbase" +title: "Coinbase" description: "Instructions for how to add Coinbase sensors to Home Assistant." date: 2017-12-08 17:54 sidebar: true @@ -8,6 +8,7 @@ comments: false sharing: true footer: true logo: coinbase.png +ha_category: Finance ha_release: 0.61 ha_iot_class: "Cloud Polling" --- @@ -17,6 +18,8 @@ The `coinbase` component lets you access account balances and exchange rates fro You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data. +## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.coinbase.markdown b/source/_components/sensor.coinbase.markdown index c506d823417..537b10f9973 100644 --- a/source/_components/sensor.coinbase.markdown +++ b/source/_components/sensor.coinbase.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: coinbase.png -ha_category: Sensor +ha_category: Finance ha_release: 0.61 --- From 2d9a74d19c0674a8f8575038bce3d424e429d3e5 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 2 Sep 2018 23:36:26 +0200 Subject: [PATCH 070/116] Move to DIY category (#6173) --- source/_components/binary_sensor.raspihats.markdown | 4 +++- source/_components/binary_sensor.rpi_gpio.markdown | 4 +++- source/_components/binary_sensor.rpi_pfio.markdown | 4 +++- source/_components/camera.rpi_camera.markdown | 4 +++- source/_components/cover.rpi_gpio.markdown | 4 +++- source/_components/light.rpi_gpio_pwm.markdown | 6 ++++-- source/_components/switch.raspihats.markdown | 4 +++- source/_components/switch.rpi_gpio.markdown | 4 +++- source/_components/switch.rpi_pfio.markdown | 4 +++- source/_components/switch.rpi_rf.markdown | 4 +++- 10 files changed, 31 insertions(+), 11 deletions(-) diff --git a/source/_components/binary_sensor.raspihats.markdown b/source/_components/binary_sensor.raspihats.markdown index 50d031c4574..be5891b19be 100644 --- a/source/_components/binary_sensor.raspihats.markdown +++ b/source/_components/binary_sensor.raspihats.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspihats.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.44 ha_iot_class: "Local Push" --- The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards. +## {% linkable_title Configuration %} + To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rpi_gpio.markdown b/source/_components/binary_sensor.rpi_gpio.markdown index a59333d82cb..5b95daed1ca 100644 --- a/source/_components/binary_sensor.rpi_gpio.markdown +++ b/source/_components/binary_sensor.rpi_gpio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Binary Sensor +ha_category: DIY ha_release: pre 0.7 ha_iot_class: "Local Push" --- The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). +## {% linkable_title Configuration %} + To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rpi_pfio.markdown b/source/_components/binary_sensor.rpi_pfio.markdown index d02cfaf2dab..29cda1530da 100644 --- a/source/_components/binary_sensor.rpi_pfio.markdown +++ b/source/_components/binary_sensor.rpi_pfio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.45 ha_iot_class: "Local Push" --- The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) . +## {% linkable_title Configuration %} + To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index 2033dc5d281..b6fc4094c09 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Camera +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.17 --- @@ -16,6 +16,8 @@ ha_release: 0.17 The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. +## {% linkable_title Configuration %} + To enable this camera in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown index 62c22bb0427..37427a321d8 100644 --- a/source/_components/cover.rpi_gpio.markdown +++ b/source/_components/cover.rpi_gpio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Cover +ha_category: DIY ha_release: 0.23 ha_iot_class: "Local Push" --- @@ -22,6 +22,8 @@ It uses two pins on the Raspberry Pi. Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup). +## {% linkable_title Configuration %} + To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/light.rpi_gpio_pwm.markdown b/source/_components/light.rpi_gpio_pwm.markdown index 7202b82297c..1ea0438332d 100644 --- a/source/_components/light.rpi_gpio_pwm.markdown +++ b/source/_components/light.rpi_gpio_pwm.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "PWM LED" +title: "PWM LED Light" description: "Instructions on how to setup PWM LEDs within Home Assistant." date: 2017-04-04 13:00 sidebar: true @@ -8,7 +8,7 @@ layout: page comments: false sharing: true footer: true -ha_category: Light +ha_category: DIY ha_iot_class: "Local Push" ha_release: 0.43 logo: raspberry-pi.png @@ -18,6 +18,8 @@ The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). +## {% linkable_title Configuration %} + To enable this platform, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/switch.raspihats.markdown b/source/_components/switch.raspihats.markdown index f31a33edaac..c1f65847dc3 100644 --- a/source/_components/switch.raspihats.markdown +++ b/source/_components/switch.raspihats.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspihats.png -ha_category: Switch +ha_category: DIY ha_release: 0.45 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `raspihats` switch platform allows you to control the digital outputs of your [raspihats](http://www.raspihats.com/) boards. +## {% linkable_title Configuration %} + To use your raspihats boards in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown index 5b3a888e240..f6d62a4935b 100644 --- a/source/_components/switch.rpi_gpio.markdown +++ b/source/_components/switch.rpi_gpio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Switch +ha_category: DIY ha_release: pre 0.7 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). +## {% linkable_title Configuration %} + To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rpi_pfio.markdown b/source/_components/switch.rpi_pfio.markdown index 30498f7d990..57f4ba2a6dc 100644 --- a/source/_components/switch.rpi_pfio.markdown +++ b/source/_components/switch.rpi_pfio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Switch +ha_category: DIY ha_release: 0.45 ha_iot_class: "Local Polling" --- The `rpi_pfio` switch platform allows you to control the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) module. +## {% linkable_title Configuration %} + To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown index b9813ceb560..43d2e5a30d5 100644 --- a/source/_components/switch.rpi_rf.markdown +++ b/source/_components/switch.rpi_rf.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Switch +ha_category: DIY ha_release: 0.19 ha_iot_class: "Assumed state" --- @@ -19,6 +19,8 @@ The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/S Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch). For more info see the PyPi module description: [rpi-rf](https://pypi.python.org/pypi/rpi-rf). +## {% linkable_title Configuration %} + To enable, add the following to your `configuration.yaml`: ```yaml From f9f4452176b7e4fc2975e86627e6123202522e4f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 07:30:31 +0200 Subject: [PATCH 071/116] Move to DIY category (#6174) --- .../binary_sensor.mysensors.markdown | 2 +- source/_components/climate.mysensors.markdown | 2 +- source/_components/cover.mysensors.markdown | 2 +- .../device_tracker.mysensors.markdown | 3 +-- .../light.blinksticklight.markdown | 20 +++++++++++---- source/_components/light.blinkt.markdown | 5 +++- source/_components/light.mysensors.markdown | 2 +- source/_components/light.sensehat.markdown | 10 ++++---- source/_components/mysensors.markdown | 2 +- source/_components/notify.mysensors.markdown | 2 +- source/_components/sensor.mysensors.markdown | 2 +- source/_components/sensor.sense.markdown | 25 +++++++++++-------- source/_components/sensor.sensehat.markdown | 10 +++++--- source/_components/switch.mysensors.markdown | 2 +- 14 files changed, 53 insertions(+), 36 deletions(-) diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 6138b927af7..814f79d9b6c 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.14 ha_iot_class: "Local Push" --- diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index 6f5379449b0..f7cc81bec3e 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Climate +ha_category: DIY ha_release: 0.29 ha_iot_class: "Local Push" --- diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown index b4ded3e1b4b..2731b5c9a3c 100644 --- a/source/_components/cover.mysensors.markdown +++ b/source/_components/cover.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Cover +ha_category: DIY ha_release: "0.30" ha_iot_class: "Local Push" --- diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index 5366c68ea78..0a886e1a2c6 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -8,8 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Presence Detection -featured: false +ha_category: DIY ha_release: "0.38" ha_iot_class: "Local Push" --- diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index c11da280aca..d5cc53a99fc 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: blinkstick.png -ha_category: Light +ha_category: DIY ha_release: 0.7.5 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. +## {% linkable_title Configuration %} + To add blinkstick to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -23,10 +25,18 @@ To add blinkstick to your installation, add the following to your `configuration light: - platform: blinksticklight serial: BS000795-1.1 - name: Living Room ``` -Configuration variables: +{% configuration %} +serial: + description: The serial number of your stick. + required: true + default: 640 + type: string +name: + description: Name of the stick. + required: false + type: string + default: Blinkstick +{% endconfiguration %} -- **serial** (*Required*): The serial number of your stick. -- **name** (*Required*): Name of the stick. diff --git a/source/_components/light.blinkt.markdown b/source/_components/light.blinkt.markdown index ad2d6200f87..69b72eb1d13 100644 --- a/source/_components/light.blinkt.markdown +++ b/source/_components/light.blinkt.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Light +ha_category: DIY ha_iot_class: "Local Push" ha_release: 0.44 --- The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs. +## {% linkable_title Configuration %} + To enable `blinkt` in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -22,3 +24,4 @@ To enable `blinkt` in your installation, add the following to your `configuratio light: - platform: blinkt ``` + diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index 5f91aa43fe1..4e62f705bcd 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Light +ha_category: DIY ha_release: 0.13 ha_iot_class: "Local Push" --- diff --git a/source/_components/light.sensehat.markdown b/source/_components/light.sensehat.markdown index 7c7a4d0b378..30d9eb88c8d 100644 --- a/source/_components/light.sensehat.markdown +++ b/source/_components/light.sensehat.markdown @@ -8,20 +8,20 @@ comments: false sharing: true footer: true logo: sense-hat.png -ha_category: Light +ha_category: DIY ha_iot_class: "Assumed State" ha_release: 0.44 --- The `sensehat` light platform lets you control the [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) board's 8x8 RGB LED matrix on your Raspberry Pi from within Home Assistant. -To add `sensehat` to your installation, add the following to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +To add `sensehat` light to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry light: - platform: sensehat - name: SenseHAT + - platform: sensehat ``` -For setting up the Sense HAT sensors, please see the [Sense HAT sensor component](/components/sensor.sensehat/). diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 3cd360e2d26..97a48746a27 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Hub +ha_category: DIY featured: true ha_iot_class: "Local Push" --- diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown index 3dab5bc10dd..085f9b87cfc 100644 --- a/source/_components/notify.mysensors.markdown +++ b/source/_components/notify.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Notifications +ha_category: DIY ha_release: 0.36 ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index a6e8657014a..ae77bb096eb 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Sensor +ha_category: DIY featured: false ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.sense.markdown b/source/_components/sensor.sense.markdown index e13e45dd937..f894c5312e2 100644 --- a/source/_components/sensor.sense.markdown +++ b/source/_components/sensor.sense.markdown @@ -15,6 +15,9 @@ ha_release: 0.65 Integrate your [Sense](https://sense.com) meter information into Home Assistant. + +## {% linkable_title Configuration %} + To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -31,9 +34,9 @@ sensor: ``` Two types of sensors can be monitored and will be created with the following names: + - **Active Usage/Production**: Current active power usage/production in Watts. Updated every 30 seconds. - **Daily Usage/Production**: Daily power usage/production in kWh. Updated every 5 minutes. -- ... Weekly, Monthly and Yearly variants are also available. @@ -52,23 +55,23 @@ monitored_conditions: type: list keys: active_usage: - description: The current power usage in W + description: The current power usage in W. active_production: - description: The current solar production in W + description: The current solar production in W. daily_usage: - description: Total power used for current day in kWh + description: Total power used for current day in kWh. daily_production: - description: Total power produced for current day in kWh + description: Total power produced for current day in kWh. weekly_usage: - description: Total power used for current week in kWh + description: Total power used for current week in kWh. weekly_production: - description: Total power produced for current week in kWh + description: Total power produced for current week in kWh. monthly_usage: - description: Total power used for current month in kWh + description: Total power used for current month in kWh. monthly_production: - description: Total power produced for current month in kWh + description: Total power produced for current month in kWh. yearly_usage: - description: Total power used for current year in kWh + description: Total power used for current year in kWh. yearly_production: - description: Total power produced for current year in kWh + description: Total power produced for current year in kWh. {% endconfiguration %} diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index 640ea7b1a52..a2236c2fb5f 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sense-hat.png -ha_category: Sensor +ha_category: DIY ha_release: 0.35 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi. +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -23,9 +25,9 @@ To add this platform to your installation, add the following to your `configurat sensor: - platform: sensehat display_options: - - temperature - - humidity - - pressure + - temperature + - humidity + - pressure ``` Configuration variables: diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown index a0fffa84e36..91d5c2e17aa 100644 --- a/source/_components/switch.mysensors.markdown +++ b/source/_components/switch.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Switch +ha_category: DIY featured: false ha_iot_class: "Local Push" --- From f50debada0c3bc5d53a6f61e2f5e81aa1f98d070 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 07:30:47 +0200 Subject: [PATCH 072/116] Move to System Monitor category (#6175) * Move to System Monitor category * Move to System Monitor category --- .../binary_sensor.digital_ocean.markdown | 2 ++ .../_components/binary_sensor.linode.markdown | 2 ++ source/_components/digital_ocean.markdown | 6 +++++- source/_components/linode.markdown | 17 +++++++++++------ .../_components/switch.digital_ocean.markdown | 4 +++- .../_components/switch.digitalloggers.markdown | 2 ++ source/_components/switch.vultr.markdown | 2 +- source/_components/vultr.markdown | 2 +- 8 files changed, 27 insertions(+), 10 deletions(-) diff --git a/source/_components/binary_sensor.digital_ocean.markdown b/source/_components/binary_sensor.digital_ocean.markdown index e4bc04ac1cb..516abfe6e9a 100644 --- a/source/_components/binary_sensor.digital_ocean.markdown +++ b/source/_components/binary_sensor.digital_ocean.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets. +### {% linkable_title Configuration %} + To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.linode.markdown b/source/_components/binary_sensor.linode.markdown index 0ffbddb5817..cf6392993f5 100644 --- a/source/_components/binary_sensor.linode.markdown +++ b/source/_components/binary_sensor.linode.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" The `linode` binary sensor platform allows you to monitor your Linode nodes. +## {% linkable_title Configuration %} + Add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 4554819ee2a..fd5d744376b 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: System Monitor ha_release: "0.30" logo: digital_ocean.png ha_iot_class: "Local Polling" @@ -16,8 +16,12 @@ ha_iot_class: "Local Polling" The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. +### {% linkable_title Setup %} + Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). +### {% linkable_title Configuration %} + To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index 623132c0448..5b6dad85214 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: Move to System Monitor category logo: linode.png ha_release: 0.57 ha_iot_class: "Cloud Polling" @@ -15,12 +15,17 @@ ha_iot_class: "Cloud Polling" The `linode` component allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. +## {% linkable_title sETUP %} + Obtain your oAuth2 Access Token from Linode account. -* -* Log in -* Select API Tokens -* Create a Personal Access Token, -* Assigned scope (Please choose the least possible access required.) + +* +* Log in +* Select API Tokens +* Create a Personal Access Token, +* Assigned scope (Please choose the least possible access required.) + +## {% linkable_title Configuration %} To integrate Linode with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/switch.digital_ocean.markdown b/source/_components/switch.digital_ocean.markdown index e17a74ab35c..dc59db6f96e 100644 --- a/source/_components/switch.digital_ocean.markdown +++ b/source/_components/switch.digital_ocean.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: digital_ocean.png -ha_category: Switch +ha_category: System Monitor ha_release: "0.30" ha_iot_class: "Local Polling" --- The `digital_ocean` switch platform allows you to control (start/stop) your Digital Ocean droplets. +### {% linkable_title Configuration %} + To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown index c0c2272d172..01fc3f88190 100755 --- a/source/_components/switch.digitalloggers.markdown +++ b/source/_components/switch.digitalloggers.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. +### {% linkable_title Configuration %} + To use your digitalloggers switch in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.vultr.markdown b/source/_components/switch.vultr.markdown index 087be7fe925..c02e5273b1e 100644 --- a/source/_components/switch.vultr.markdown +++ b/source/_components/switch.vultr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: vultr.png -ha_category: Switch +ha_category: System Monitor ha_release: "0.58" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown index 187ddaab3f3..98051d2038c 100644 --- a/source/_components/vultr.markdown +++ b/source/_components/vultr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true featured: false -ha_category: Hub +ha_category: System Monitor ha_release: "0.58" logo: vultr.png ha_iot_class: "Cloud Polling" From 566f9816d001976b64ea0150bc13655e292d2b82 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:15:45 +0200 Subject: [PATCH 073/116] Fix category --- source/_components/linode.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index 5b6dad85214..581f4822c16 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Move to System Monitor category +ha_category: System Monitor logo: linode.png ha_release: 0.57 ha_iot_class: "Cloud Polling" From 11c9561badac682a1c2adddc15d600ee4e1c97aa Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:17:47 +0200 Subject: [PATCH 074/116] Move to DIY category --- source/_components/sensor.envirophat.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.envirophat.markdown b/source/_components/sensor.envirophat.markdown index 9863a4ab3b5..0e41d737225 100644 --- a/source/_components/sensor.envirophat.markdown +++ b/source/_components/sensor.envirophat.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.44 --- From 8751e1f1e3352725b794889c03359251909be654 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:29:10 +0200 Subject: [PATCH 075/116] Move to Car category --- source/_components/device_tracker.ritassist.markdown | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/source/_components/device_tracker.ritassist.markdown b/source/_components/device_tracker.ritassist.markdown index e8f170f2026..307b2a91daa 100644 --- a/source/_components/device_tracker.ritassist.markdown +++ b/source/_components/device_tracker.ritassist.markdown @@ -8,17 +8,19 @@ comments: false sharing: true footer: true logo: ritassist.png -ha_category: Presence Detection +ha_category: Car ha_iot_class: Cloud Polling ha_release: 0.76 --- -This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. +The `ritassist` platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. + +## {% linkable_title Setup %} -## API key To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key). -## Configuration +## {% linkable_title Configuration %} + To use this device tracker in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -58,7 +60,7 @@ include: See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. -## Available Attributes +## {% linkable_title Available attributes %} | Attribute | Description | |---|---| From 100a5bb7a6802dce6269c9004bbbc9f1e5560040 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:30:44 +0200 Subject: [PATCH 076/116] Move to Car category --- source/_components/device_tracker.automatic.markdown | 8 ++++++-- source/_components/device_tracker.ritassist.markdown | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/source/_components/device_tracker.automatic.markdown b/source/_components/device_tracker.automatic.markdown index f3e63a648dd..c109862af84 100644 --- a/source/_components/device_tracker.automatic.markdown +++ b/source/_components/device_tracker.automatic.markdown @@ -8,18 +8,22 @@ comments: false sharing: true footer: true logo: automatic.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.28 ha_iot_class: "Cloud Push" --- -The `automatic` platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service. +The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service. + +## {% linkable_title Setup %} To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication. Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml. +## {% linkable_title Configuration %} + Once your developer account is created, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/device_tracker.ritassist.markdown b/source/_components/device_tracker.ritassist.markdown index 307b2a91daa..39ac0aa906c 100644 --- a/source/_components/device_tracker.ritassist.markdown +++ b/source/_components/device_tracker.ritassist.markdown @@ -13,7 +13,7 @@ ha_iot_class: Cloud Polling ha_release: 0.76 --- -The `ritassist` platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. +The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. ## {% linkable_title Setup %} From 739f1e246f610e3126f98686444c1ec612e84f8f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:34:05 +0200 Subject: [PATCH 077/116] Move to Car category --- source/_components/sensor.mopar.markdown | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index 65146841838..3e2afbb9270 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mopar.png -ha_category: Sensor +ha_category: Car featured: false ha_release: 0.53 ha_iot_class: "Cloud Polling" @@ -19,8 +19,12 @@ The `mopar` sensor provides the following for owners of FCA vehicles with a uCon - Sensor per vehicle with vehicle health report and other meta-data - Service for remote commands: Lock/unlock, Engine on/off, Horn & lights +## {% linkable_title Setup %} + Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`. ```yaml From d85049cd8264d6517074ea5792a42d814bb62fb2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:35:00 +0200 Subject: [PATCH 078/116] Fix description --- source/_components/sensor.mopar.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index 3e2afbb9270..ab620c56d9e 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -46,7 +46,7 @@ password: required: true type: string pin: - description: v + description: The pin for your account. required: true type: string {% endconfiguration %} From 301280915fffba305a38f0bce552d47342c975da Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:36:29 +0200 Subject: [PATCH 079/116] Move to DIY category --- source/_components/cover.opengarage.markdown | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/source/_components/cover.opengarage.markdown b/source/_components/cover.opengarage.markdown index 2ac83c83bc9..d9327afa2a6 100644 --- a/source/_components/cover.opengarage.markdown +++ b/source/_components/cover.opengarage.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: opengarage.png -ha_category: Cover +ha_category: DIY ha_release: 0.44 --- The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant. +## {% linkable_title Configuration %} + To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -87,7 +89,7 @@ sensor: {% endif %} {% else %} n/a - {% endif %}'{% endraw %} + {% endif %}' group: garage: @@ -104,3 +106,4 @@ customize: sensor.garage_car_present: icon: mdi:car ``` +{% endraw %} From 5aee278ebfc5cb7815ec7edec2c084c4edc3ddd5 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:37:52 +0200 Subject: [PATCH 080/116] Move to Social category --- source/_components/spaceapi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/spaceapi.markdown b/source/_components/spaceapi.markdown index eaf817cb351..bd5c356c337 100644 --- a/source/_components/spaceapi.markdown +++ b/source/_components/spaceapi.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: spaceapi.png -ha_category: Other +ha_category: Social ha_release: "0.70" --- From ec731130ef431ccab676f0dbf58d95542be84456 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:39:34 +0200 Subject: [PATCH 081/116] Move to Transport category --- source/_components/sensor.citybikes.markdown | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/source/_components/sensor.citybikes.markdown b/source/_components/sensor.citybikes.markdown index 7b4aced03ac..c23e5783aaa 100644 --- a/source/_components/sensor.citybikes.markdown +++ b/source/_components/sensor.citybikes.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "CityBikes API sensor" +title: "CityBikes Sensor" description: "Instructions on how to integrate data from the CityBikes API into Home Assistant." date: 2017-06-25 14:20 sidebar: true @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: citybikes.png -ha_category: Sensor +ha_category: Transport ha_release: 0.49 --- The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml @@ -33,6 +35,8 @@ Configuration options: - **radius** (*Optional*): The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored. - **stations** array (*Optional*): A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API. +## {% linkable_title Example %} + Additional configuration samples: ```yaml From f99fa3a5f77a5f168c4ab5afe71077f508b4065f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:40:52 +0200 Subject: [PATCH 082/116] Move to DIY category (#6178) --- source/_components/binary_sensor.pilight.markdown | 4 ++-- source/_components/light.piglow.markdown | 4 +++- source/_components/pilight.markdown | 2 +- source/_components/sensor.pilight.markdown | 2 +- source/_components/switch.pilight.markdown | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) diff --git a/source/_components/binary_sensor.pilight.markdown b/source/_components/binary_sensor.pilight.markdown index ee7a729196a..b34cc955bfa 100644 --- a/source/_components/binary_sensor.pilight.markdown +++ b/source/_components/binary_sensor.pilight.markdown @@ -8,14 +8,14 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.44 ha_iot_class: "Local Polling" --- The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). - +## {% linkable_title Configuration %} To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/light.piglow.markdown b/source/_components/light.piglow.markdown index c2664af84cf..919dbc298d6 100644 --- a/source/_components/light.piglow.markdown +++ b/source/_components/light.piglow.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Light +ha_category: DIY ha_release: 0.37 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant. +## {% linkable_title Configuration %} + To add piglow to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 45e98323815..05b3ce1fbec 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Hub +ha_category: DIY ha_release: 0.26 ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.pilight.markdown b/source/_components/sensor.pilight.markdown index 2a33cc2a1dd..a78f5a1d391 100644 --- a/source/_components/sensor.pilight.markdown +++ b/source/_components/sensor.pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Sensor +ha_category: DIY ha_release: 0.31 ha_iot_class: depends --- diff --git a/source/_components/switch.pilight.markdown b/source/_components/switch.pilight.markdown index ca2c837986d..d70f748cfa5 100644 --- a/source/_components/switch.pilight.markdown +++ b/source/_components/switch.pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Switch +ha_category: DIY ha_release: 0.26 ha_iot_class: "Local Polling" --- From f49c12d76e9659a70ef3aaca30ea4b2f7b9d69bb Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:41:10 +0200 Subject: [PATCH 083/116] Move to Mailbox category (#6179) --- source/_components/asterisk_mbox.markdown | 4 +++- source/_components/sensor.imap_email_content.markdown | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index f040acd99bb..23cb489269f 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: asterisk.png -ha_category: Other +ha_category: Mailbox ha_iot_class: "Local Push" ha_release: 0.51 --- @@ -19,6 +19,8 @@ To enable the component, a configuration is required in both Home Assistant as w First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server) +## {% linkable_title Configuration %} + Once that is complete, add the following entry `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown index 22212426f6a..e67340b7ef7 100644 --- a/source/_components/sensor.imap_email_content.markdown +++ b/source/_components/sensor.imap_email_content.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: smtp.png -ha_category: Sensor +ha_category: Mailbox ha_iot_class: "Local Polling" ha_release: 0.25 --- @@ -16,6 +16,8 @@ ha_release: 0.25 The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml From 4d5e2e3a240777c0dfbdf5bdded2a7b0cdbc926f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:54:50 +0200 Subject: [PATCH 084/116] Update category and other fixes --- source/_components/sensor.bh1750.markdown | 3 ++- source/_components/sensor.fedex.markdown | 4 +++- source/_components/sensor.fints.markdown | 7 ++++--- source/_components/sensor.htu21d.markdown | 4 +++- source/_components/sensor.imap.markdown | 4 +++- source/_components/sensor.mhz19.markdown | 4 +++- source/_components/sensor.postnl.markdown | 2 +- source/_components/sensor.radarr.markdown | 2 +- source/_components/sensor.sonarr.markdown | 2 +- source/_components/sensor.spotcrime.markdown | 6 +++++- source/_components/sensor.temper.markdown | 4 +++- source/_components/sensor.ups.markdown | 4 +++- source/_components/sensor.uscis.markdown | 8 +++++--- source/_components/sensor.usps.markdown | 2 +- source/_components/sensor.yahoo_finance.markdown | 2 ++ source/_components/usps.markdown | 2 +- 16 files changed, 41 insertions(+), 19 deletions(-) diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index 4910cdfba0a..b7bae73cf1e 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.fedex.markdown b/source/_components/sensor.fedex.markdown index acbdf251d62..00e8a6c1b62 100644 --- a/source/_components/sensor.fedex.markdown +++ b/source/_components/sensor.fedex.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: fedex.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.fints.markdown b/source/_components/sensor.fints.markdown index 79351f765e3..e871ba3cb97 100644 --- a/source/_components/sensor.fints.markdown +++ b/source/_components/sensor.fints.markdown @@ -7,14 +7,16 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor -ha_release: 0.70 +ha_category: Finance +ha_release: "0.70" ha_iot_class: "Local Push" logo: home-assistant.png --- With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline. +## {% linkable_title Configuration %} + For each account you have with the bank, a separate sensor is created. If you have several accounts with a bank, you can select which ones you want to have, and you can also give the accounts a name. {% raw %} @@ -70,5 +72,4 @@ To find out the configuration for your bank, check their website or call their h description: (optional) Use this field to give the account a meaningful name. required: false type: string - {% endconfiguration %} diff --git a/source/_components/sensor.htu21d.markdown b/source/_components/sensor.htu21d.markdown index a485fb0c382..fbb513aef4a 100644 --- a/source/_components/sensor.htu21d.markdown +++ b/source/_components/sensor.htu21d.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,8 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown index a3b9af23b29..f09956e9648 100644 --- a/source/_components/sensor.imap.markdown +++ b/source/_components/sensor.imap.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: smtp.png -ha_category: Sensor +ha_category: Mailbox ha_release: 0.25 ha_iot_class: "Cloud Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Push" The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mhz19.markdown b/source/_components/sensor.mhz19.markdown index 25cd6405ce7..142eeed155f 100644 --- a/source/_components/sensor.mhz19.markdown +++ b/source/_components/sensor.mhz19.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mhz19_logo.png -ha_category: Sensor +ha_category: DIY ha_release: 0.27 ha_iot_class: "Local Polling" --- @@ -17,6 +17,8 @@ The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level. Check out the [Open Home Automation web site](https://www.open-homeautomation.com/2016/08/24/monitor-co2-levels-in-your-house/) for a quick guide how to connect the sensor to your PC or Raspberry Pi. +## {% linkable_title Configuration %} + To use this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.postnl.markdown b/source/_components/sensor.postnl.markdown index 3fa41230239..0510b0dd14b 100644 --- a/source/_components/sensor.postnl.markdown +++ b/source/_components/sensor.postnl.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: postnl.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.69 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 94a46655485..8795896f9e7 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: radarr.png -ha_category: Sensor +ha_category: Downloading ha_release: 0.47 --- diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 13a4944feaa..93b070adcee 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sonarr.png -ha_category: Sensor +ha_category: Downloading ha_release: 0.34 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.spotcrime.markdown b/source/_components/sensor.spotcrime.markdown index b36d01b4b46..73bda02a894 100644 --- a/source/_components/sensor.spotcrime.markdown +++ b/source/_components/sensor.spotcrime.markdown @@ -7,15 +7,19 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Social ha_release: 0.65 ha_iot_class: "Cloud Polling" --- The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](http://spotcrime.com). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. +## {% linkable_title Setup %} + You will need to request an API key from [Spotcrime](mailto:pyrrhus@spotcrime.com). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. 0.01 = 1 mile. ```yaml diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index 09626f0984e..65fd75fd725 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -7,13 +7,15 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Push" ha_release: pre 0.7 --- This `temper` sensor platform allows you to get the current temperature from a TEMPer device. +## {% linkable_title Configuration %} + To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.ups.markdown b/source/_components/sensor.ups.markdown index 6e1989bfe22..fe1ae61a91a 100644 --- a/source/_components/sensor.ups.markdown +++ b/source/_components/sensor.ups.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ups.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/mychoice). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.uscis.markdown b/source/_components/sensor.uscis.markdown index 3d214dc818a..8dbedc2a3cb 100644 --- a/source/_components/sensor.uscis.markdown +++ b/source/_components/sensor.uscis.markdown @@ -3,7 +3,7 @@ layout: page title: USCIS Sensor description: "Instructions on how to set up USCIS within Home Assistant." date: 2018-03-21 08:00 -sidebar: false +sidebar: true comments: false sharing: true footer: true @@ -15,7 +15,9 @@ ha_iot_class: "Cloud Polling" The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) -## Example for `configuration.yaml` : +## {% linkable_title Configuration %} + +To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml sensor: @@ -25,7 +27,7 @@ sensor: ``` {% configuration %} -friendly_name: +name: description: Name of the sensor in Home Assistant. required: false default: USCIS diff --git a/source/_components/sensor.usps.markdown b/source/_components/sensor.usps.markdown index 46244107308..89d7029a0a8 100644 --- a/source/_components/sensor.usps.markdown +++ b/source/_components/sensor.usps.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: usps.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.36 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.yahoo_finance.markdown b/source/_components/sensor.yahoo_finance.markdown index 0e8d12c0fbe..937dc442b44 100644 --- a/source/_components/sensor.yahoo_finance.markdown +++ b/source/_components/sensor.yahoo_finance.markdown @@ -20,6 +20,8 @@ ha_release: 0.29 The `yahoo_finance` platform uses [Yahoo Finance](https://finance.yahoo.com/) to monitor the stock market. +## {% linkable_title Configuration %} + To enable the `yahoo_finance` platform, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 3a7c9a06abe..a95efd919ab 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: usps.png -ha_category: Hub +ha_category: Postal Service ha_release: 0.52 ha_iot_class: "Cloud Polling" --- From 38b3263ed059ff52a401ab9987e338673022f9c6 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 08:59:23 +0200 Subject: [PATCH 085/116] Update category --- source/_components/binary_sensor.ffmpeg_motion.markdown | 6 ++++-- source/_components/binary_sensor.ffmpeg_noise.markdown | 4 ++-- source/_components/ffmpeg.markdown | 4 +++- source/_components/image_processing.opencv.markdown | 2 ++ 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/source/_components/binary_sensor.ffmpeg_motion.markdown b/source/_components/binary_sensor.ffmpeg_motion.markdown index 6635bae9e69..0607a0127af 100644 --- a/source/_components/binary_sensor.ffmpeg_motion.markdown +++ b/source/_components/binary_sensor.ffmpeg_motion.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Binary Sensor +ha_category: Image Processing ha_release: 0.27 redirect_from: /components/binary_sensor.ffmpeg/ --- @@ -20,10 +20,12 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-### {% linkable_title Motion %} +## {% linkable_title Motion %} FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter. +## {% linkable_title Configuration %} + To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.ffmpeg_noise.markdown b/source/_components/binary_sensor.ffmpeg_noise.markdown index d68ec7d1630..842be8203e1 100644 --- a/source/_components/binary_sensor.ffmpeg_noise.markdown +++ b/source/_components/binary_sensor.ffmpeg_noise.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Binary Sensor +ha_category: Image Processing ha_release: 0.27 --- @@ -19,7 +19,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-### {% linkable_title Noise %} +## {% linkable_title Configuration %} To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index 56fd9779aed..38034e4e06a 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Hub +ha_category: Image Processing --- The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update. @@ -21,6 +21,8 @@ You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessi If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

+## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/image_processing.opencv.markdown b/source/_components/image_processing.opencv.markdown index 9e485ec6c30..06fc9061fd1 100644 --- a/source/_components/image_processing.opencv.markdown +++ b/source/_components/image_processing.opencv.markdown @@ -17,6 +17,8 @@ ha_release: 0.47 Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data). +## {% linkable_title Configuration %} + To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml From 6d35ffb58b6c5b5e6bdd2eddec950a10ade22b7e Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 09:27:25 +0200 Subject: [PATCH 086/116] Move to Irrigation category (#6180) --- source/_components/binary_sensor.hydrawise.markdown | 4 +++- source/_components/binary_sensor.raincloud.markdown | 4 +++- source/_components/binary_sensor.rainmachine.markdown | 2 +- source/_components/hydrawise.markdown | 4 +++- source/_components/rainbird.markdown | 4 +++- source/_components/raincloud.markdown | 4 +++- source/_components/rainmachine.markdown | 2 +- source/_components/sensor.hydrawise.markdown | 4 +++- source/_components/sensor.rainbird.markdown | 4 +++- source/_components/sensor.raincloud.markdown | 4 +++- source/_components/sensor.rainmachine.markdown | 2 +- source/_components/switch.hydrawise.markdown | 4 +++- source/_components/switch.rainbird.markdown | 2 +- source/_components/switch.raincloud.markdown | 4 +++- source/_components/switch.rainmachine.markdown | 2 +- source/_components/waterfurnace.markdown | 5 ++--- 16 files changed, 37 insertions(+), 18 deletions(-) diff --git a/source/_components/binary_sensor.hydrawise.markdown b/source/_components/binary_sensor.hydrawise.markdown index cd066354673..9ec42c031aa 100644 --- a/source/_components/binary_sensor.hydrawise.markdown +++ b/source/_components/binary_sensor.hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Binary Sensor +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. +## {% linkable_title Configuration %} + Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.raincloud.markdown b/source/_components/binary_sensor.raincloud.markdown index b5e1678d53b..5b853e13126 100644 --- a/source/_components/binary_sensor.raincloud.markdown +++ b/source/_components/binary_sensor.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Binary Sensor +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rainmachine.markdown b/source/_components/binary_sensor.rainmachine.markdown index 175a2d27bba..60cc6d982c3 100644 --- a/source/_components/binary_sensor.rainmachine.markdown +++ b/source/_components/binary_sensor.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Binary Sensor +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.71 --- diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index 3c29b449166..f45b1255bdc 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 413a612fdc5..187173c1f78 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.61 ha_iot_class: "Local Polling" --- This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index 3eb377e0468..b73766cac17 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Hub +ha_category: Irrigation ha_release: 0.55 --- The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index 42027fe9182..7bb254ef5d3 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.69 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.hydrawise.markdown b/source/_components/sensor.hydrawise.markdown index ed1fbd52e5e..6268b188504 100644 --- a/source/_components/sensor.hydrawise.markdown +++ b/source/_components/sensor.hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Sensor +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- Before setting up the [Hunter Hydrawise](https://hydrawise.com) sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. +## {% linkable_title Configuration %} + Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.rainbird.markdown b/source/_components/sensor.rainbird.markdown index e7f26af34c4..4c523a82c48 100644 --- a/source/_components/sensor.rainbird.markdown +++ b/source/_components/sensor.rainbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Sensor +ha_category: Irrigation ha_release: 0.61 ha_iot_class: "Local Polling" --- This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file to enable the rain sensor: ```yaml diff --git a/source/_components/sensor.raincloud.markdown b/source/_components/sensor.raincloud.markdown index 381599c785e..9435f1a7782 100644 --- a/source/_components/sensor.raincloud.markdown +++ b/source/_components/sensor.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Sensor +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.rainmachine.markdown b/source/_components/sensor.rainmachine.markdown index 7df129ab2b6..4db41b38eaf 100644 --- a/source/_components/sensor.rainmachine.markdown +++ b/source/_components/sensor.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Sensor +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.71 --- diff --git a/source/_components/switch.hydrawise.markdown b/source/_components/switch.hydrawise.markdown index b1ebab81998..b2e826b663b 100644 --- a/source/_components/switch.hydrawise.markdown +++ b/source/_components/switch.hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Switch +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- Before setting up the [Hunter Hydrawise](https://hydrawise.com) switches please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. +## {% linkable_title Configuration %} + Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rainbird.markdown b/source/_components/switch.rainbird.markdown index 5b15bd486fe..12b2f1019d4 100644 --- a/source/_components/switch.rainbird.markdown +++ b/source/_components/switch.rainbird.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Switch +ha_category: Irrigation ha_release: 0.57 ha_iot_class: "Local Polling" --- diff --git a/source/_components/switch.raincloud.markdown b/source/_components/switch.raincloud.markdown index 2e2af72de81..2844b924aed 100644 --- a/source/_components/switch.raincloud.markdown +++ b/source/_components/switch.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Switch +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rainmachine.markdown b/source/_components/switch.rainmachine.markdown index 51cba578c1e..982220ccacb 100644 --- a/source/_components/switch.rainmachine.markdown +++ b/source/_components/switch.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Switch +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.51 --- diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 2555b1fb804..15a88eb8565 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -8,13 +8,12 @@ comments: false sharing: true footer: true logo: waterfurnace.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your -system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. +The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. The sensors provided include: From a1277a8cb6319220cc60c29e4febf27f7a7ac0f4 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 10:21:56 +0200 Subject: [PATCH 087/116] Various fixes --- source/_components/netgear_lte.markdown | 7 ++- .../_components/sensor.tank_utility.markdown | 54 ++++++++++++------- 2 files changed, 40 insertions(+), 21 deletions(-) diff --git a/source/_components/netgear_lte.markdown b/source/_components/netgear_lte.markdown index 36ce55a6fdc..3c407ce0686 100644 --- a/source/_components/netgear_lte.markdown +++ b/source/_components/netgear_lte.markdown @@ -9,17 +9,22 @@ sharing: true footer: true logo: netgear.png ha_release: 0.72 -ha_category: Other +ha_category: Network ha_iot_class: "Local Polling" --- The Netgear LTE integration for Home Assistant allows you to observe and control [Netgear LTE modems](https://www.netgear.com/home/products/mobile-broadband/lte-modems/default.aspx), currently only tested with LB2120. The integration provides: + * a notify service that will send an SMS * a sensor with the number of unread SMS messages in the inbox * a sensor with data usage +## {% linkable_title Configuration %} + +To enable the component, add the following lines to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry netgear_lte: diff --git a/source/_components/sensor.tank_utility.markdown b/source/_components/sensor.tank_utility.markdown index 061c66ab918..6446f5e8949 100644 --- a/source/_components/sensor.tank_utility.markdown +++ b/source/_components/sensor.tank_utility.markdown @@ -8,37 +8,51 @@ comments: false sharing: true footer: true logo: tank_utility.png -ha_category: Sensor +ha_category: Energy ha_release: "0.53" --- Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant. +## {% linkable_title Setup %} + +### {% linkable_title Authentication %} + +Authentication for the Tank Utility API is performed with the same email and password credentials used at [https://app.tankutility.com](https://app.tankutility.com). + +### {% linkable_title Devices %} + +Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices). + +The device item value is the last segment of the URL path, e.g., the URL +[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000) would indicate `000000000000000000000000` as a device value. + +## {% linkable_title Configuration %} + +To enable the component, add the following lines to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry sensor: - platform: tank_utility - email: EMAIL - password: PASSWORD + email: YOUR_EMAIL_ADDRESS + password: YOUR_PASSWORD devices: - 000000000000000000000000 ``` -Configuration variables: +{% configuration %} +email: + description: "Your [https://app.tankutility.com](https://app.tankutility.com) email address." + required: true + type: string +password: + description: "Your [https://app.tankutility.com](https://app.tankutility.com) password." + required: true + type: string +unit_of_measurement: + description: All devices to monitor. + required: true + type: map +{% endconfiguration %} -* **email** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) email address -* **password** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) password -* **devices** *(Required)*: List of devices - -Authentication: - -Authentication for the Tank Utility API is performed with the same email and password credentials used at -[https://app.tankutility.com](https://app.tankutility.com). - -Devices: - -Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage -Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices). -The device item value is the last segment of the URL path, e.g., the URL -[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000) -would indicate `000000000000000000000000` as a device value. From 95546aa3fc8da7a22e2f2f27ce8d5bc988c29c22 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 10:48:27 +0200 Subject: [PATCH 088/116] Move to Network category (#6181) * Move to Network category * Update category and other fixes --- .../binary_sensor.bayesian.markdown | 4 +++- .../_components/binary_sensor.ping.markdown | 4 +++- .../_components/binary_sensor.random.markdown | 2 +- .../binary_sensor.threshold.markdown | 4 +++- .../_components/binary_sensor.trend.markdown | 4 +++- .../binary_sensor.uptimerobot.markdown | 11 ++++++---- .../binary_sensor.workday.markdown | 2 +- source/_components/cloudflare.markdown | 2 +- source/_components/cover.template.markdown | 6 +++--- .../_components/device_tracker.ping.markdown | 6 ++++-- source/_components/duckdns.markdown | 4 +++- source/_components/folder_watcher.markdown | 2 ++ source/_components/freedns.markdown | 6 ++++-- source/_components/google_domains.markdown | 4 +++- source/_components/namecheapdns.markdown | 4 +++- source/_components/no_ip.markdown | 4 +++- source/_components/sensor.api_stream.markdown | 4 +++- .../_components/sensor.crimereports.markdown | 12 +++++------ source/_components/sensor.discogs.markdown | 6 +++++- source/_components/sensor.dnsip.markdown | 6 ++++-- .../_components/sensor.duke_energy.markdown | 4 +++- source/_components/sensor.ebox.markdown | 6 ++++-- source/_components/sensor.fail2ban.markdown | 4 +++- source/_components/sensor.file.markdown | 4 +++- source/_components/sensor.filesize.markdown | 11 ++++++---- source/_components/sensor.filter.markdown | 5 +++-- source/_components/sensor.folder.markdown | 4 +++- .../_components/sensor.history_stats.markdown | 2 +- .../_components/sensor.magicseaweed.markdown | 6 +++++- source/_components/sensor.mfi.markdown | 2 +- source/_components/sensor.min_max.markdown | 10 +++++++--- .../sensor.mold_indicator.markdown | 8 ++++++-- source/_components/sensor.otp.markdown | 4 +++- .../_components/sensor.pocketcasts.markdown | 4 +++- source/_components/sensor.qnap.markdown | 2 +- source/_components/sensor.random.markdown | 2 +- source/_components/sensor.season.markdown | 16 +++++++++++---- source/_components/sensor.simulated.markdown | 10 +++++----- source/_components/sensor.startca.markdown | 8 +++++--- source/_components/sensor.statistics.markdown | 4 +++- source/_components/sensor.uptime.markdown | 20 +++++++++++++++---- source/_components/sensor.version.markdown | 16 +++++++++++---- source/_components/sensor.whois.markdown | 2 +- 43 files changed, 173 insertions(+), 78 deletions(-) diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index ad52a8e85fd..228e8ac15bf 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Binary Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.53 --- @@ -18,6 +18,8 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence. +## {% linkable_title Configuration %} + To enable the Bayesian sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/binary_sensor.ping.markdown b/source/_components/binary_sensor.ping.markdown index b0be6271369..37121004e44 100644 --- a/source/_components/binary_sensor.ping.markdown +++ b/source/_components/binary_sensor.ping.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Binary Sensor +ha_category: Network ha_release: 0.43 --- The `ping` binary sensor platform allows you to using `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system. +## {% linkable_title Configuration %} + To use this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index ac08186a313..3fdc95eb617 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.57 --- diff --git a/source/_components/binary_sensor.threshold.markdown b/source/_components/binary_sensor.threshold.markdown index 21cc02b9fd6..a33b404772c 100644 --- a/source/_components/binary_sensor.threshold.markdown +++ b/source/_components/binary_sensor.threshold.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Binary Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.34 --- @@ -26,6 +26,8 @@ It's an alternative to the template binary sensor's `value_template:` to get the ``` {% endraw %} +## {% linkable_title Configuration %} + To enable the threshold sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/binary_sensor.trend.markdown b/source/_components/binary_sensor.trend.markdown index dae3d1c9ed7..7530a164e80 100644 --- a/source/_components/binary_sensor.trend.markdown +++ b/source/_components/binary_sensor.trend.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Binary Sensor +ha_category: Utility logo: home-assistant.png ha_release: 0.28 ha_iot_class: "Local Push" @@ -15,6 +15,8 @@ ha_iot_class: "Local Push" The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend. +## {% linkable_title Configuration %} + To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.uptimerobot.markdown b/source/_components/binary_sensor.uptimerobot.markdown index 7b37252f399..759150fe332 100644 --- a/source/_components/binary_sensor.uptimerobot.markdown +++ b/source/_components/binary_sensor.uptimerobot.markdown @@ -8,19 +8,22 @@ comments: false sharing: true footer: true logo: uptimerobot.png -ha_category: Binary Sensor +ha_category: System Monitor ha_release: "0.72" ha_iot_class: "Cloud Polling" --- -The `uptimerobot` binary_sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com) +The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com). -## Example for `configuration.yaml` : +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml`: ```yaml +# Example configuration.yaml entry binary_sensor: - platform: uptimerobot - api_key: u432898-d2507e493b31217e6c64fd35 + api_key: YOUR_API_KEY ``` {% configuration %} diff --git a/source/_components/binary_sensor.workday.markdown b/source/_components/binary_sensor.workday.markdown index 1ba1f8bd8c7..21280a72ba4 100644 --- a/source/_components/binary_sensor.workday.markdown +++ b/source/_components/binary_sensor.workday.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Binary Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.41 --- diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index c088bc1e8f0..b2f5ad956cd 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: cloudflare.png -ha_category: Utility +ha_category: Network featured: false ha_release: 0.74 --- diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 06a4c09d9c5..77748e12b6c 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -13,9 +13,9 @@ ha_iot_class: "Local Push" logo: home-assistant.png --- -The `template` platform can create covers that combine components and provides -the ability to run scripts or invoke services for each of the open, close, -stop, position, and tilt commands of a cover. +The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover. + +## {% linkable_title Configuration %} To enable Template Covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/device_tracker.ping.markdown b/source/_components/device_tracker.ping.markdown index 1f343680127..04d2e764420 100644 --- a/source/_components/device_tracker.ping.markdown +++ b/source/_components/device_tracker.ping.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Presence Detection +ha_category: Network ha_release: 0.36 --- -The `ping` platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work. +The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work. + +## {% linkable_title Configuration %} To use this presence detection in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index bd18114a18e..96f9fc3c917 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: duckdns.png -ha_category: Utility +ha_category: Network featured: false ha_release: 0.55 --- With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. +## {% linkable_title Configuration %} + To use the component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index fffd1a68f8d..338f0c7fdb0 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -22,6 +22,8 @@ This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system m Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored. +## {% linkable_title Configuration %} + To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file: {% raw %} diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown index 960d1411d99..226c64dfb3d 100644 --- a/source/_components/freedns.markdown +++ b/source/_components/freedns.markdown @@ -7,13 +7,13 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Utility +ha_category: Network ha_release: 0.67 --- With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. -## {% linkable_title Configuration %} +## {% linkable_title Setup %} You need to determine your update URL or your access token. @@ -24,6 +24,8 @@ You need to determine your update URL or your access token. 5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN` 6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute. +## {% linkable_title Configuration %} + To use the component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/google_domains.markdown b/source/_components/google_domains.markdown index df42475a519..0fcebeca094 100644 --- a/source/_components/google_domains.markdown +++ b/source/_components/google_domains.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: google_domains.png -ha_category: Utility +ha_category: Network ha_release: 0.57 --- With the Google Domains component you can keep your Google Domains record up to date. +## {% linkable_title Configuration %} + To use the component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index 4f68adb4606..6f156306d7c 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: namecheap.png -ha_category: Utility +ha_category: Network featured: false ha_release: 0.56 --- @@ -19,6 +19,8 @@ With the `namecheapdns` component you can automatically update your dynamic DNS Namecheap only supports IPv4 addresses to update.

+## {% linkable_title Configuration %} + To use the component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/no_ip.markdown b/source/_components/no_ip.markdown index f070e2b4d5f..8456c6678dc 100644 --- a/source/_components/no_ip.markdown +++ b/source/_components/no_ip.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: noip.png -ha_category: Utility +ha_category: Network ha_release: 0.57 --- With the `no_ip` component you can keep your [NO-IP.com](https://www.noip.com) record up to date. + + To use the component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.api_stream.markdown b/source/_components/sensor.api_stream.markdown index c363e885332..cdc4541c29d 100644 --- a/source/_components/sensor.api_stream.markdown +++ b/source/_components/sensor.api_stream.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_release: 0.33 ha_iot_class: "Local Push" --- The `api_stream` sensor platform shows how many clients are connected to the stream API +## {% linkable_title Configuration %} + To add the connected clients to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.crimereports.markdown b/source/_components/sensor.crimereports.markdown index 1bb1b89d052..e80d504a51f 100644 --- a/source/_components/sensor.crimereports.markdown +++ b/source/_components/sensor.crimereports.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Social logo: crimereports.png ha_release: 0.42 ha_iot_class: "Cloud Polling" @@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling" The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. -## Configuration +## {% linkable_title Configuration %} To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. @@ -36,13 +36,13 @@ Configuration options for the Crime Reports Sensor: - **exclude** (*Optional*): List of incident types to exclude. -## Notes +## {% linkable_title Notes %} -### Area +### {% linkable_title Area %} Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone. -### Incident Types +### {% linkable_title Incident Types %} You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified. @@ -83,6 +83,6 @@ These incident types are available: - Vehicle Stop - Weapons Offense -### Events +### {% linkable_title Events %} The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, description, time, location, and coordinates of the incident. diff --git a/source/_components/sensor.discogs.markdown b/source/_components/sensor.discogs.markdown index 281852abc79..ec600a21b44 100644 --- a/source/_components/sensor.discogs.markdown +++ b/source/_components/sensor.discogs.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: https://www.magneticmag.com/.image/t_share/MTQ5OTE1NzU4NTczMzk3OTYw/discogs-vinyl-record-mark.png -ha_category: Sensor +ha_category: Multimedia ha_release: 0.61 logo: discogs.png ha_iot_class: "Cloud Polling" @@ -16,9 +16,13 @@ ha_iot_class: "Cloud Polling" The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection. +## {% linkable_title Setup %} + First, you'll need to get a personal access token from your Discogs account. You can generate a token from your profile's [Developer settings](https://www.discogs.com/settings/developers). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.dnsip.markdown b/source/_components/sensor.dnsip.markdown index 3eeff8b0c1e..0850e3696d3 100644 --- a/source/_components/sensor.dnsip.markdown +++ b/source/_components/sensor.dnsip.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "DNS IP" +title: "DNS IP Sensor" description: "Instructions on how to integrate a DNS IP sensor into Home Assistant." date: 2017-02-25 11:05 sidebar: true @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Network ha_iot_class: "Cloud Polling" ha_release: "0.40" --- @@ -21,6 +21,8 @@ The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.duke_energy.markdown b/source/_components/sensor.duke_energy.markdown index 1d1bb410d5e..2e120441b3d 100644 --- a/source/_components/sensor.duke_energy.markdown +++ b/source/_components/sensor.duke_energy.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: duke_energy.png -ha_category: Sensor +ha_category: Energy ha_release: "0.74" ha_iot_class: "Cloud Polling" --- The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters. +## {% linkable_title Setup %} + You will only have access to meters listed in your account at [Duke Energy Usage](https://www.duke-energy.com/my-account/usage-analysis). This supports both electric and gas meters. Along with previous days usage, each sensor will have attributes for the previous bills total usage and average usage. diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown index d2ad1a9cb5c..c71643c4c81 100644 --- a/source/_components/sensor.ebox.markdown +++ b/source/_components/sensor.ebox.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "EBox" +title: "EBox Sensor" description: "Instructions on how to integrate EBox data usage within Home Assistant." date: 2017-02-15 17:17 sidebar: true @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ebox.png -ha_category: Sensor +ha_category: Network ha_release: 0.39 ha_iot_class: "Cloud Polling" --- Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. +## {% linkable_title Configuration %} + To use your EBox sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.fail2ban.markdown b/source/_components/sensor.fail2ban.markdown index ca1467cf1b1..20f46f6f15c 100644 --- a/source/_components/sensor.fail2ban.markdown +++ b/source/_components/sensor.fail2ban.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Network ha_iot_class: "Local Polling" logo: fail2ban.png ha_release: 0.57 @@ -20,6 +20,8 @@ The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.o Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file.

+## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.file.markdown b/source/_components/sensor.file.markdown index 8ae7216a7d7..627e7f28ff2 100644 --- a/source/_components/sensor.file.markdown +++ b/source/_components/sensor.file.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: file.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.45 --- @@ -16,6 +16,8 @@ ha_release: 0.45 The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). +## {% linkable_title Configuration %} + To enable the `file` sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.filesize.markdown b/source/_components/sensor.filesize.markdown index 3178fa6e3cf..c52057294ee 100644 --- a/source/_components/sensor.filesize.markdown +++ b/source/_components/sensor.filesize.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "File size sensor" +title: "File size Sensor" description: "Component for monitoring the size of a file." date: 2018-02-06 14:00 sidebar: true @@ -8,13 +8,16 @@ comments: false sharing: true footer: true logo: file.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.64 --- -Component for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). -Add to your config: +The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). + +## {% linkable_title Configuration %} + +To enable the `filesize` sensor, add the following lines to your `configuration.yaml`: ```yaml sensor: diff --git a/source/_components/sensor.filter.markdown b/source/_components/sensor.filter.markdown index 5e2834eebca..a0a07337a70 100644 --- a/source/_components/sensor.filter.markdown +++ b/source/_components/sensor.filter.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility ha_release: 0.65 ha_iot_class: "Local Push" logo: home-assistant.png @@ -21,8 +21,9 @@ The `filter` platform enables sensors that process the states of other entities.

-To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file: +## {% linkable_title Configuration %} +To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.folder.markdown b/source/_components/sensor.folder.markdown index 292e7366ea6..878d8e45a0c 100644 --- a/source/_components/sensor.folder.markdown +++ b/source/_components/sensor.folder.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: file.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.64 --- Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes. +## {% linkable_title Configuration %} + To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.history_stats.markdown b/source/_components/sensor.history_stats.markdown index d1fa2cfa1dc..d324bc26b52 100644 --- a/source/_components/sensor.history_stats.markdown +++ b/source/_components/sensor.history_stats.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.39 --- diff --git a/source/_components/sensor.magicseaweed.markdown b/source/_components/sensor.magicseaweed.markdown index 8bfbc13d664..4160439956e 100644 --- a/source/_components/sensor.magicseaweed.markdown +++ b/source/_components/sensor.magicseaweed.markdown @@ -14,10 +14,14 @@ ha_release: "0.75" ha_iot_class: "Cloud Polling" --- -The 'magicseaweed' platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. +The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. + +## {% linkable_title Setup %} You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 1 spot for the free plan. +## {% linkable_title Configuration %} + To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown index 4498c4d3281..a0aeac788de 100644 --- a/source/_components/sensor.mfi.markdown +++ b/source/_components/sensor.mfi.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ubiquiti.png -ha_category: Sensor +ha_category: Network ha_iot_class: "Local Polling" ha_release: 0.32 --- diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index 428e8485666..4606862da2d 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: "0.31" --- @@ -18,15 +18,19 @@ The `min_max` sensor platform consumes the state from other sensors to determine This sensor is an alternative to the [template sensor](/components/sensor.template/)'s `value_template:` to get the average of multiple sensors. +{% raw %} ```yaml -{% raw %}{{ ((float(states.sensor.kitchen_temperature.state) + +{{ ((float(states.sensor.kitchen_temperature.state) + float(states.sensor.living_room_temperature.state) + float(states.sensor.office_temperature.state)) / 3) | round(2) -}}{% endraw %} +}} ``` +{% endraw %} Sensors with an unknown state will be ignored in the calculation. If the unit of measurement of the sensors differs, the `min_max` sensor will go to an error state where the value is `UNKNOWN` and unit of measurement is `ERR`. +## {% linkable_title Configuration %} + To enable the `min_max` sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index bc049af3e65..6b337c6967f 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -8,14 +8,18 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Climate ha_release: '0.20' ha_iot_class: "Local Polling" --- The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. -The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: +The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. + +## {% linkable_title Configuration %} + +To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.otp.markdown b/source/_components/sensor.otp.markdown index 849f2167184..3f0cd12d337 100644 --- a/source/_components/sensor.otp.markdown +++ b/source/_components/sensor.otp.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.49 --- The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. +## {% linkable_title Configuration %} + To enable the OTP sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.pocketcasts.markdown b/source/_components/sensor.pocketcasts.markdown index 89d48c79f3c..0a1c0d1fce8 100644 --- a/source/_components/sensor.pocketcasts.markdown +++ b/source/_components/sensor.pocketcasts.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: pocketcasts.png -ha_category: Sensor +ha_category: Multimedia ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `pocketcasts` sensor platform let one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.qnap.markdown b/source/_components/sensor.qnap.markdown index 3814f37bd00..7731bb33110 100644 --- a/source/_components/sensor.qnap.markdown +++ b/source/_components/sensor.qnap.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: qnap.png -ha_category: Sensor +ha_category: System Monitor ha_release: 0.38 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown index b56d1f3d591..e3515333eab 100644 --- a/source/_components/sensor.random.markdown +++ b/source/_components/sensor.random.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.32 --- diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index 875636fb7ce..9e2ecc39c74 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -7,13 +7,13 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility logo: home-assistant.png ha_iot_class: "Local Polling" ha_release: 0.53 --- -This sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the users setting in the config file. +The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file. All information about how the seasons work was taken from Wikipedia: @@ -21,6 +21,9 @@ All information about how the seasons work was taken from Wikipedia: - [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox) - [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice) +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -29,6 +32,11 @@ sensor: type: astronomical ``` -Configuration variables: +{% configuration %} +type: + description: "Type of season definition. Options are `meteorological` or `astronomical`." + required: false + type: string + default: astronomical +{% endconfiguration %} -- **type** (*Optional*): Type of season definition. Options are `meteorological` or `astronomical`. Default is `astronomical`. diff --git a/source/_components/sensor.simulated.markdown b/source/_components/sensor.simulated.markdown index 07b97c8fce1..ef4d98bd73d 100644 --- a/source/_components/sensor.simulated.markdown +++ b/source/_components/sensor.simulated.markdown @@ -8,16 +8,16 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.65 --- -The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal ```V(t)``` given by the [function](https://en.wikipedia.org/wiki/Sine_wave): +The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal `V(t)` given by the [function](https://en.wikipedia.org/wiki/Sine_wave): - ``` - V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s) - ``` +```text +V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s) +``` where: diff --git a/source/_components/sensor.startca.markdown b/source/_components/sensor.startca.markdown index cd92fe272ce..5d36a629eec 100644 --- a/source/_components/sensor.startca.markdown +++ b/source/_components/sensor.startca.markdown @@ -8,16 +8,18 @@ comments: false sharing: true footer: true logo: startca.png -ha_category: Sensor +ha_category: Network ha_release: 0.64 ha_iot_class: "Cloud Polling" --- Integrate your [Start.ca](https://www.start.ca/) account information into Home Assistant. -You can get your API key from: +## {% linkable_title Setup %} -[Start.ca Usage API](https://www.start.ca/support/usage/api) +You can get your API key from: [Start.ca Usage API](https://www.start.ca/support/usage/api) + +## {% linkable_title Configuration %} To use your Start.ca sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index 9bfd40dd39c..a169c2cc71d 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: "0.30" --- @@ -19,6 +19,8 @@ The `statistics` sensor platform consumes the state from other sensors. Besides If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup. If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation. +## {% linkable_title Configuration %} + To enable the statistics sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.uptime.markdown b/source/_components/sensor.uptime.markdown index f67feb188e4..30f8cdadb29 100644 --- a/source/_components/sensor.uptime.markdown +++ b/source/_components/sensor.uptime.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Pushing" logo: home-assistant.png ha_release: 0.56 @@ -16,6 +16,8 @@ ha_release: 0.56 The `uptime` sensor platform displays the time since the last Home Assistant restart. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -24,10 +26,20 @@ sensor: - platform: uptime ``` -Configuration variables: +{% configuration %} +name: + description: Name to use in the frontend. + required: false + type: string + default: Uptime +unit_of_measurement: + description: "Units for uptime measurement in either `days`, `hours`, or `minutes`." + required: false + type: string + default: days +{% endconfiguration %} -- **name** (*Optional*): Name of the sensor. Defaults to `Uptime`. -- **unit_of_measurement** (*Optional*): Units for uptime measurement in either `days`, `hours`, or `minutes`. Defaults to `days`. +## {% linkable_title Example %} ```yaml # Example with configuration variables diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown index a84c05f7a27..dda7b220fab 100644 --- a/source/_components/sensor.version.markdown +++ b/source/_components/sensor.version.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Pushing" logo: home-assistant.png ha_release: 0.52 @@ -16,6 +16,8 @@ ha_release: 0.52 The `version` sensor platform is displaying the current version of Home Assistant in the frontend. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: ```yaml @@ -24,9 +26,13 @@ sensor: - platform: version ``` -Configuration variables: - -- **name** (*Optional*): Name of the sensor. Defaults to `Current Version`. +{% configuration %} +name: + description: Name to use in the frontend. + required: false + type: string + default: Current Version +{% endconfiguration %} ## {% linkable_title Alternatives %} @@ -58,6 +64,7 @@ sensor: You might think that a [`rest` sensor](/components/sensor.rest/) could work, too, but it will not as Home Assistant is not ready when the sensor get initialized. +{% raw %} ```yaml sensor: - platform: rest @@ -65,3 +72,4 @@ sensor: name: Current Version value_template: '{{ value_json.version }}' ``` +{% endraw %} diff --git a/source/_components/sensor.whois.markdown b/source/_components/sensor.whois.markdown index 87e2e674cbc..95e351dd9e7 100644 --- a/source/_components/sensor.whois.markdown +++ b/source/_components/sensor.whois.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: icann.png -ha_category: Sensor +ha_category: Network ha_release: "0.57" ha_iot_class: "Cloud Polling" --- From dcd46c2d86214965d6e9f52f7e1bb173bc9ff23b Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 12:20:17 +0200 Subject: [PATCH 089/116] Update category (#6182) --- .../_components/binary_sensor.aurora.markdown | 4 +- .../binary_sensor.bloomsky.markdown | 4 +- .../binary_sensor.command_line.markdown | 4 +- .../_components/binary_sensor.rachio.markdown | 5 +- source/_components/climate.melissa.markdown | 2 +- source/_components/juicenet.markdown | 2 +- source/_components/melissa.markdown | 4 +- source/_components/rachio.markdown | 4 +- source/_components/sensor.airvisual.markdown | 100 ++++++------------ .../_components/sensor.command_line.markdown | 4 +- source/_components/sensor.daikin.markdown | 6 +- source/_components/sensor.dyson.markdown | 2 +- source/_components/sensor.fido.markdown | 8 +- source/_components/sensor.juicenet.markdown | 2 +- source/_components/sensor.lacrosse.markdown | 7 +- source/_components/sensor.melissa.markdown | 4 +- .../sensor.netatmo_public.markdown | 4 +- .../_components/sensor.netgear_lte.markdown | 28 ++--- source/_components/sensor.noaa_tides.markdown | 2 +- source/_components/sensor.openevse.markdown | 2 +- source/_components/sensor.sigfox.markdown | 21 ++-- source/_components/sensor.smappee.markdown | 2 +- .../_components/sensor.socialblade.markdown | 19 ++-- source/_components/sensor.sql.markdown | 2 +- source/_components/sensor.sytadin.markdown | 4 +- source/_components/sensor.tradfri.markdown | 2 +- .../sensor.worldtidesinfo.markdown | 2 +- .../_components/sensor.xiaomi_miio.markdown | 4 +- source/_components/switch.rachio.markdown | 4 +- 29 files changed, 133 insertions(+), 125 deletions(-) diff --git a/source/_components/binary_sensor.aurora.markdown b/source/_components/binary_sensor.aurora.markdown index 08c485a37cb..f1c165381ec 100644 --- a/source/_components/binary_sensor.aurora.markdown +++ b/source/_components/binary_sensor.aurora.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Binary Sensor +ha_category: Environment ha_release: 0.39 logo: noaa.png --- @@ -18,6 +18,8 @@ This service gives a number 0-100 representing the current likelihood of visible You can check the attributes of the sensor to see your exact forecast. +## {% linkable_title Configuration %} + To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.bloomsky.markdown b/source/_components/binary_sensor.bloomsky.markdown index 2a4ba02d575..a53c62e973d 100644 --- a/source/_components/binary_sensor.bloomsky.markdown +++ b/source/_components/binary_sensor.bloomsky.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: bloomsky.png -ha_category: Binary Sensor +ha_category: Environment ha_release: 0.14 ha_iot_class: "Cloud Polling" --- @@ -17,6 +17,8 @@ The `bloomsky` binary sensor platform allows you to get data from your BloomSky To get your BloomSky binary sensors working with Home Assistant, follow the instructions for the [BloomSky component](/components/bloomsky/) first. +## {% linkable_title Configuration %} + To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown index 93769da9729..f3f8af7f3e3 100644 --- a/source/_components/binary_sensor.command_line.markdown +++ b/source/_components/binary_sensor.command_line.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: command_line.png -ha_category: Binary Sensor +ha_category: Utility ha_release: 0.12 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `command_line` binary sensor platform issues specific commands to get data. +## {% linkable_title Configuration %} + To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rachio.markdown b/source/_components/binary_sensor.rachio.markdown index c46bf398794..badc5403a7c 100644 --- a/source/_components/binary_sensor.rachio.markdown +++ b/source/_components/binary_sensor.rachio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rachio.png -ha_category: Sensor +ha_category: Irrigation ha_iot_class: "Cloud Push" ha_release: 0.73 --- @@ -18,9 +18,10 @@ The `rachio` binary sensor platform allows you to view the status of your [Rachi Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers.

- You must have the [Rachio component](/components/rachio/) configured to use this switch. +You must have the [Rachio component](/components/rachio/) configured to use this switch.

+## {% linkable_title Configuration %} To add this platform to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/climate.melissa.markdown b/source/_components/climate.melissa.markdown index 9d648a83b59..1c9daadd671 100644 --- a/source/_components/climate.melissa.markdown +++ b/source/_components/climate.melissa.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling" ha_release: 0.63 --- -The `Melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant. +The `melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant. The climate platform will be automatically configured if Melissa component is configured. diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index 0ff22b9908e..a6eae2eb3cd 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: juicenet.png -ha_category: Hub +ha_category: Energy ha_release: 0.47 --- diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index 46be358b61d..fdd9f30d316 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Melissa Climate" +title: "Melissa" description: "Instructions on how to integrate Melissa Climate into Home Assistant." date: 2017-01-05 17:30 sidebar: true @@ -14,7 +14,7 @@ ha_release: 0.63 ha_iot_class: "Cloud Polling" --- -The `Melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. +The `melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control. ## {% linkable_title Configuration %} diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index b27edc4017d..25f54b65118 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rachio.png -ha_category: Hub +ha_category: Irrigation ha_iot_class: "Cloud Push" ha_release: 0.73 --- @@ -22,6 +22,8 @@ The `rachio` platform allows you to control your [Rachio irrigation system](http 1. Click "Get API Key" 1. Copy the API key from the dialog that opens. +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.airvisual.markdown b/source/_components/sensor.airvisual.markdown index 896c09234c3..2cde892cddb 100644 --- a/source/_components/sensor.airvisual.markdown +++ b/source/_components/sensor.airvisual.markdown @@ -13,30 +13,17 @@ ha_release: 0.53 ha_iot_class: "Cloud Polling" --- -The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) -API for air quality data. Data can be collected via latitude/longitude or by -city/state/country. The resulting information creates sensors for the Air -Quality Index (AQI), the human-friendly air quality level, and the main -pollutant of that area. Sensors that conform to either/both the -[U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) -can be created. +The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) can be created. -This platform requires an AirVisual API key, which can be obtained -[here](https://airvisual.com/api). Note that the platform was designed using -the "Community" package; the "Startup" and "Enterprise" package keys should -continue to function, but actual results may vary (or not work at all). +This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).

-The "Community" API key is limited to 10,000 calls per month. In order to leave -a buffer, the `airvisual` platform queries the API every 10 minutes by default. -Modification of this (via the `scan_interval` key) to a too-low value may -result in your API key being deactivated. +The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.

-## {% linkable_title Configuring the Platform via Latitude/Longitude %} +## {% linkable_title Configuration via Latitude/Longitude %} -To enable the platform and gather data via latitude/longitude, add the -following lines to your `configuration.yaml` file: +To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: ```yaml sensor: @@ -58,59 +45,53 @@ sensor: {% configuration %} api_key: - description: your AirVisual API key + description: Your AirVisual API key. required: required type: string monitored_conditions: - description: the air quality standard(s) to use (`us` for U.S., `cn` for Chinese) + description: "The air quality standard(s) to use (`us` for U.S., `cn` for Chinese)." required: required type: list default: ['us', 'cn'] show_on_map: - description: whether to show a marker on the map at the specified location + description: "Whether to show a marker on the map at the specified location." required: optional type: boolean default: true scan_interval: - description: the rate at which AirVisual should be polled for new data + description: "The rate at which AirVisual should be polled for new data." required: optional type: int default: 600 latitude: - description: the latitude of the location to monitor + description: The latitude of the location to monitor. required: optional type: str - default: the latitude defined under the `homeassistant` key in `configuration.yaml` + default: "The latitude defined under the `homeassistant` key in `configuration.yaml`." longitude: - description: the longitude of the location to monitor + description: The longitude of the location to monitor. required: optional - type: str - default: the longitude defined under the `homeassistant` key in `configuration.yaml` + type: string + default: "The longitude defined under the `homeassistant` key in `configuration.yaml`." city: - description: the city to monitor + description: The city to monitor. required: optional - type: str + type: string state: - description: the state the city belongs to + description: The state the city belongs to. required: optional - type: str + type: string country: - description: the country the state belongs to + description: The country the state belongs to. required: optional - type: str + type: string {% endconfiguration %} ## {% linkable_title Determining the City/State/Country %} -To easily determine the proper values for a particular location, use the -[AirVisual region directory](https://airvisual.com/world). Once you browse to -the particular city you want, take note of the breadcrumb title, which is of -the form `country > state/region > city`. Use this information to fill out -`configuration.yaml`. +To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`. -For example, Sao Paulo, Brazil shows a breadcrumb title of -`Brazil > Sao Paulo > Sao Paulo` – thus, the proper configuration would look -like this: +For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the proper configuration would look like this: ```yaml sensor: @@ -126,19 +107,14 @@ sensor: ## {% linkable_title Sensor Types %} -When configured, the platform will create three sensors for each configured -air quality standard: +When configured, the platform will create three sensors for each configured air quality standard: ### Air Quality Index -**Description:** This sensor displays a numeric air quality index (AQI), a -metric for the overall "health" of the air. - -**Example Sensor Name:** `sensor.chinese_air_quality_index` - -**Example Sensor Value:** `32` - -**Explanation:** +- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air. +- **Example Sensor Name:** `sensor.chinese_air_quality_index` +- **Example Sensor Value:** `32` +- **Explanation:** AQI | Status | Description ------- | :----------------: | ---------- @@ -151,23 +127,16 @@ AQI | Status | Description ### Air Pollution Level -**Description:** This sensor displays the associated `Status` (from the above -table) for the current AQI. - -**Sample Sensor Name:** `sensor.us_air_pollution_level` - -**Example Sensor Value:** `Moderate` +- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI. +- **Sample Sensor Name:** `sensor.us_air_pollution_level` +- **Example Sensor Value:** `Moderate` ### Main Pollutant -**Description:** This sensor displays the pollutant whose value is currently -highest. - -**Sample Sensor Name:** `sensor.us_main_pollutant` - -**Example Sensor Value:** `PM2.5` - -**Explanation:** +- **Description:** This sensor displays the pollutant whose value is currently highest. +- **Sample Sensor Name:** `sensor.us_main_pollutant` +- **Example Sensor Value:** `PM2.5` +- **Explanation:** Pollutant | Symbol | More Info ------- | :----------------: | ---------- @@ -176,3 +145,4 @@ Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution) Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution) Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution) + diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 238c46f7f61..94e85385128 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: command_line.png -ha_category: Sensor +ha_category: Utility ha_release: pre 0.7 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `command_line` sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line. +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.daikin.markdown b/source/_components/sensor.daikin.markdown index 20831781606..250da44a727 100644 --- a/source/_components/sensor.daikin.markdown +++ b/source/_components/sensor.daikin.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Daikin AC" +title: "Daikin AC Sensor" description: "Instructions on how to integrate Daikin AC(s) with Home Assistant." date: 2017-12-03 05:00 sidebar: True @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: daikin.png -ha_category: Sensor +ha_category: Environment ha_release: 0.59 ha_iot_class: "Local Polling" --- @@ -23,6 +23,8 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant.

+## {% linkable_title Configuration %} + To enable the platform manually, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.dyson.markdown b/source/_components/sensor.dyson.markdown index 022d778ceb6..8a1cd8a1efb 100644 --- a/source/_components/sensor.dyson.markdown +++ b/source/_components/sensor.dyson.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: dyson.png -ha_category: Sensor +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.47 --- diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index edb59195a38..4331701e3e4 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Fido" +title: "Fido Sensor" description: "Instructions on how to integrate Fido data usage within Home Assistant." date: 2017-01-01 17:17 sidebar: true @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: fido.png -ha_category: Sensor +ha_category: Network ha_release: 0.39 ha_iot_class: "Cloud Polling" --- @@ -16,7 +16,9 @@ ha_iot_class: "Cloud Polling" Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. -To enable this sensor, add the following lines to your `configuration.yaml`: +## {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.juicenet.markdown b/source/_components/sensor.juicenet.markdown index 03bad7fccc9..df9929c658e 100644 --- a/source/_components/sensor.juicenet.markdown +++ b/source/_components/sensor.juicenet.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: juicenet.png -ha_category: Sensor +ha_category: Energy ha_release: 0.47 --- diff --git a/source/_components/sensor.lacrosse.markdown b/source/_components/sensor.lacrosse.markdown index 5218a2b710b..b634ccbcd37 100644 --- a/source/_components/sensor.lacrosse.markdown +++ b/source/_components/sensor.lacrosse.markdown @@ -8,14 +8,14 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: DIY ha_release: 0.58 ha_iot_class: "Local Polling" --- The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip). -#### {% linkable_title Tested Devices %} +### {% linkable_title Tested Devices %} - Technoline TX 29 IT (temperature only) - Technoline TX 29 DTH-IT (including humidity) @@ -27,6 +27,9 @@ Since the sensor change their ID after each powercycle/battery change you can ch ```bash $ sudo pylacrosse -d /dev/ttyUSB0 scan ``` + +## {% linkable_title Configuration %} + To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.melissa.markdown b/source/_components/sensor.melissa.markdown index 4b18248d522..0b4360560d5 100644 --- a/source/_components/sensor.melissa.markdown +++ b/source/_components/sensor.melissa.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: mclimate.png -ha_category: Sensor +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.63 --- -The `Melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant. +The `melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant. The sensor platform will be automatically configured if Melissa component is configured. diff --git a/source/_components/sensor.netatmo_public.markdown b/source/_components/sensor.netatmo_public.markdown index 9c89a1c5a71..c1c61a1a05c 100644 --- a/source/_components/sensor.netatmo_public.markdown +++ b/source/_components/sensor.netatmo_public.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: netatmo.png -ha_category: Sensor +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.77 --- @@ -60,7 +60,7 @@ areas: type: string default: Netatmo Public Data type: - description: How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`. + description: "How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`." required: false type: string default: max diff --git a/source/_components/sensor.netgear_lte.markdown b/source/_components/sensor.netgear_lte.markdown index a8f82f8206a..b0031f161cf 100644 --- a/source/_components/sensor.netgear_lte.markdown +++ b/source/_components/sensor.netgear_lte.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: netgear.png ha_release: 0.72 -ha_category: Sensor +ha_category: Network ha_iot_class: "Local Polling" --- @@ -17,6 +17,10 @@ The `netgear_lte` sensor platform allows you to monitor your Netgear LTE modem. This requires you to have set up the [Netgear LTE component](/components/netgear_lte/). +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry sensor: @@ -28,16 +32,16 @@ sensor: {% configuration %} sensors: - description: Sensor types to create. - required: true - type: list - keys: - sms: - description: Number of unread SMS messages in the modem inbox. - usage: - description: Amount of data transferred. + description: Sensor types to create. + required: true + type: list + keys: + sms: + description: Number of unread SMS messages in the modem inbox. + usage: + description: Amount of data transferred. host: - description: The modem to use. Not needed if you only have one. - required: false - type: string + description: The modem to use. Not needed if you only have one. + required: false + type: string {% endconfiguration %} diff --git a/source/_components/sensor.noaa_tides.markdown b/source/_components/sensor.noaa_tides.markdown index 2ae7a6875fc..434d25dd621 100644 --- a/source/_components/sensor.noaa_tides.markdown +++ b/source/_components/sensor.noaa_tides.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Weather +ha_category: Environment ha_release: 0.75 logo: noaa.png --- diff --git a/source/_components/sensor.openevse.markdown b/source/_components/sensor.openevse.markdown index e9df04e8da0..df249bd1137 100644 --- a/source/_components/sensor.openevse.markdown +++ b/source/_components/sensor.openevse.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: openevse.png -ha_category: Sensor +ha_category: Car ha_release: "0.38" ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.sigfox.markdown b/source/_components/sensor.sigfox.markdown index f3f0bbb0ea5..e11dc9600e8 100644 --- a/source/_components/sensor.sigfox.markdown +++ b/source/_components/sensor.sigfox.markdown @@ -13,7 +13,20 @@ ha_iot_class: "Local Polling" ha_release: 0.68 --- -[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ( [snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). +[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). + +## {% linkable_title Setup %} + +Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following: + +1. Log into [Sigfox backend](https://backend.sigfox.com) +1. Select `GROUP` +1. Select `API ACCESS` +1. Click on `new` and create new access entry + +## {% linkable_title Configuration %} + +To use this sensor, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -39,9 +52,3 @@ name: type: string {% endconfiguration %} -Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following: - -1. Log into [Sigfox backend](https://backend.sigfox.com) -1. Select `GROUP` -1. Select `API ACCESS` -1. Click on `new` and create new access entry diff --git a/source/_components/sensor.smappee.markdown b/source/_components/sensor.smappee.markdown index 2886f2b4340..8a1e1c56e25 100644 --- a/source/_components/sensor.smappee.markdown +++ b/source/_components/sensor.smappee.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: smappee.png ha_release: "0.64" -ha_category: Sensor +ha_category: Energy --- [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. diff --git a/source/_components/sensor.socialblade.markdown b/source/_components/sensor.socialblade.markdown index cf106c9133e..143feb80e9d 100644 --- a/source/_components/sensor.socialblade.markdown +++ b/source/_components/sensor.socialblade.markdown @@ -3,25 +3,28 @@ layout: page title: Social Blade Sensor description: "Instructions on how to set up Social Blade Sensor within Home Assistant." date: 2018-04-23 08:00 -sidebar: false +sidebar: true comments: false sharing: true footer: true logo: socialblade.png -ha_category: Sensor +ha_category: Multimedia ha_release: 0.69 ha_iot_class: "Cloud Polling" --- -The `socialblade` sensor component allows you get updates on a youtube channel using your social blade channel id. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/) +The `socialblade` sensor platform allows you get updates on a Youtube channel using your social blade channel ID. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/). -to get the channel id you can go to [Social Blade Website]( https://socialblade.com/) and search for youtube channel by username, then select the channel and grab the id from the url. -The channel id will be the last part of the url : -https://socialblade.com/youtube/channel/{channel_id} +## {% linkable_title Setup %} -## Example for `configuration.yaml` : +To get the channel ID you can go to [Social Blade Website]( https://socialblade.com/) and search for Youtube channel by username, then select the channel and grab the ID from the URL. The channel ID will be the last part of the URL: https://socialblade.com/youtube/channel/{channel_id} + +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry sensor: - platform: socialblade channel_id: YOUR_CHANNEL_NUMBER @@ -29,7 +32,7 @@ sensor: {% configuration %} channel_id: - description: channel id number optained from the URL when you access Social Blade web client. + description: Channel id number optained from the URL when you access Social Blade web client. required: true type: string {% endconfiguration %} diff --git a/source/_components/sensor.sql.markdown b/source/_components/sensor.sql.markdown index a7484b1480c..201861f2620 100644 --- a/source/_components/sensor.sql.markdown +++ b/source/_components/sensor.sql.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sql.png -ha_category: Sensor +ha_category: Utility ha_release: 0.63 --- diff --git a/source/_components/sensor.sytadin.markdown b/source/_components/sensor.sytadin.markdown index 1c44a9bdd3f..4b62e198574 100644 --- a/source/_components/sensor.sytadin.markdown +++ b/source/_components/sensor.sytadin.markdown @@ -9,12 +9,14 @@ sharing: true footer: true logo: sytadin.png ha_release: 0.57 -ha_category: Sensor +ha_category: Car ha_iot_class: "Clound Polling" --- The `sytadin` sensor platform allows you to monitor traffic details from [Sytadin](http://www.sytadin.fr). +## {% linkable_title Configuration %} + To add Sytadin to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.tradfri.markdown b/source/_components/sensor.tradfri.markdown index fb78480fb1b..98d673d16a6 100644 --- a/source/_components/sensor.tradfri.markdown +++ b/source/_components/sensor.tradfri.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "IKEA Trådfri sensors" +title: "IKEA Trådfri sensor" description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors." date: 2017-04-12 22.04 sidebar: true diff --git a/source/_components/sensor.worldtidesinfo.markdown b/source/_components/sensor.worldtidesinfo.markdown index 471a09566b4..9dcde7eafbc 100644 --- a/source/_components/sensor.worldtidesinfo.markdown +++ b/source/_components/sensor.worldtidesinfo.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: worldtidesinfo.png -ha_category: Weather +ha_category: Environment ha_release: 0.52 --- diff --git a/source/_components/sensor.xiaomi_miio.markdown b/source/_components/sensor.xiaomi_miio.markdown index 26e1a4293b9..c5a1bebe3bf 100644 --- a/source/_components/sensor.xiaomi_miio.markdown +++ b/source/_components/sensor.xiaomi_miio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: xiaomi.png -ha_category: Sensor +ha_category: Health ha_iot_class: "Local Polling" ha_release: 0.66 --- @@ -26,6 +26,8 @@ Currently, the supported features are: Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. +## {% linkable_title Configuration %} + To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rachio.markdown b/source/_components/switch.rachio.markdown index e24fab29fae..89ece905556 100644 --- a/source/_components/switch.rachio.markdown +++ b/source/_components/switch.rachio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rachio.png -ha_category: Switch +ha_category: Irrigation ha_iot_class: "Cloud Push" ha_release: 0.46 --- @@ -21,6 +21,8 @@ Once configured, a switch will be added for every zone that is enabled on every You must have the [Rachio component](/components/rachio/) configured to use this switch.

+## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml From 8c539e8b1392db4331a07a28b19a69cf9ef30aaa Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 12:49:31 +0200 Subject: [PATCH 090/116] Minor updates --- source/_components/sensor.gpsd.markdown | 27 +++++++++-- source/_components/sensor.luftdaten.markdown | 4 ++ .../sensor.modem_callerid.markdown | 47 ++++++++++++++++--- 3 files changed, 66 insertions(+), 12 deletions(-) diff --git a/source/_components/sensor.gpsd.markdown b/source/_components/sensor.gpsd.markdown index 82448cd970b..d66cc20110f 100644 --- a/source/_components/sensor.gpsd.markdown +++ b/source/_components/sensor.gpsd.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: gpsd.png -ha_category: Sensor +ha_category: Utility ha_release: 0.26 ha_iot_class: "Local Polling" --- The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. +## {% linkable_title Setup %} + A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested. ```bash @@ -40,6 +42,8 @@ Escape character is '^]'. {"class":"VERSION","release":"3.15","rev":"3.15-2.fc23","proto_major":3,"proto_minor":11} ``` +## {% linkable_title Configuration %} + To setup a GPSD sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -48,8 +52,21 @@ sensor: - platform: gpsd ``` -Configuration variables: +{% configuration %} +host: + description: The host where GPSD is running. + required: false + type: string + default: localhost +port: + description: The port which GPSD is using. + required: false + type: int + default: 2947 +name: + description: Friendly name to use for the frontend. + required: false + type: string + default: GPS +{% endconfiguration %} -- **host** (*Optional*): The host where GPSD is running. Defaults to `localhost`. -- **port** (*Optional*): The port which GPSD is using. Defaults to `2947`. -- **name** (*Optional*): Friendly name to use for the frontend. Default to GPS. diff --git a/source/_components/sensor.luftdaten.markdown b/source/_components/sensor.luftdaten.markdown index 8e4a41cdefc..b368a6d8e9b 100644 --- a/source/_components/sensor.luftdaten.markdown +++ b/source/_components/sensor.luftdaten.markdown @@ -15,9 +15,13 @@ ha_iot_class: "Cloud Polling" The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station. +## {% linkable_title Setup %} + - To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID"). - To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.modem_callerid.markdown b/source/_components/sensor.modem_callerid.markdown index 6fa1ed1919d..4747aea5cf9 100644 --- a/source/_components/sensor.modem_callerid.markdown +++ b/source/_components/sensor.modem_callerid.markdown @@ -14,6 +14,26 @@ ha_iot_class: "Local Polling" The `modem_callerid` sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1). +When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number. + +## {% linkable_title Setup %} + +To find the path of your USB modem, run: + +```bash +$ ls /dev/ttyACM* +``` + +If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with: + +```bash +$ sudo usermod -a -G dialout homeassistant +``` + +Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). + +## {% linkable_title Configuration %} + To enable the sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -22,10 +42,19 @@ sensor: - platform: modem_callerid ``` -Configuration variables: +{% configuration %} +name: + description: Name of the sensor to use in the frontend. + required: false + type: string + default: "`modem_callerid`" +device: + description: The port to use. + required: false + type: string + default: "`/dev/ttyACM0`" +{% endconfiguration %} -- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `modem_callerid`. -- **device** (*Optional*): Device port name. Defaults to `/dev/ttyACM0`. To find the path of your USB modem, run: @@ -37,11 +66,15 @@ If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hass Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). -When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number. + + +## {% linkable_title Examples %} Some example automations: + +{% raw %} ```yaml -{% raw %}automation: +automation: - alias: Notify CallerID trigger: platform: state @@ -69,6 +102,6 @@ Some example automations: action: service: tts.google_say data_template: - message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} '{% endraw %} + message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }}' ``` - +{% endraw %} From c3c9bc745043c2af5976d87e9c5ea6904d76cf52 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 12:50:22 +0200 Subject: [PATCH 091/116] Update category (#6183) --- source/_components/august.markdown | 2 +- source/_components/binary_sensor.august.markdown | 2 +- source/_components/binary_sensor.ecobee.markdown | 2 +- source/_components/binary_sensor.ring.markdown | 4 +++- source/_components/binary_sensor.skybell.markdown | 4 +++- source/_components/binary_sensor.wemo.markdown | 2 +- source/_components/camera.ring.markdown | 2 ++ source/_components/camera.skybell.markdown | 2 ++ source/_components/light.skybell.markdown | 2 ++ source/_components/ring.markdown | 4 +++- source/_components/sensor.bbox.markdown | 4 +++- source/_components/sensor.canary.markdown | 2 +- source/_components/sensor.ecobee.markdown | 2 +- source/_components/sensor.moon.markdown | 5 ++++- source/_components/sensor.ring.markdown | 4 +++- source/_components/sensor.skybell.markdown | 4 +++- source/_components/sensor.teksavvy.markdown | 4 +++- source/_components/skybell.markdown | 2 +- source/_components/sun.markdown | 2 +- source/_components/switch.skybell.markdown | 2 ++ 20 files changed, 41 insertions(+), 16 deletions(-) diff --git a/source/_components/august.markdown b/source/_components/august.markdown index 818002e14c7..2d079065ec7 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: august.png -ha_category: Hub +ha_category: Door bell ha_release: "0.64" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/binary_sensor.august.markdown b/source/_components/binary_sensor.august.markdown index be793af19b8..20d2aec19d0 100644 --- a/source/_components/binary_sensor.august.markdown +++ b/source/_components/binary_sensor.august.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: august.png -ha_category: Binary Sensor +ha_category: Door bell ha_release: "0.64" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/binary_sensor.ecobee.markdown b/source/_components/binary_sensor.ecobee.markdown index 25f58c42cbc..103c818d495 100644 --- a/source/_components/binary_sensor.ecobee.markdown +++ b/source/_components/binary_sensor.ecobee.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ecobee.png -ha_category: Binary Sensor +ha_category: Environment ha_release: 0.9 ha_iot_class: "Local Push" --- diff --git a/source/_components/binary_sensor.ring.markdown b/source/_components/binary_sensor.ring.markdown index e663d6838cc..c2f48c7163c 100644 --- a/source/_components/binary_sensor.ring.markdown +++ b/source/_components/binary_sensor.ring.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ring.png -ha_category: Binary Sensor +ha_category: Doorbell ha_release: 0.42 ha_iot_class: "Cloud Polling" --- To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). +## {% linkable_title Configuration %} + Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.skybell.markdown b/source/_components/binary_sensor.skybell.markdown index d16766f316d..25558eb1cd5 100644 --- a/source/_components/binary_sensor.skybell.markdown +++ b/source/_components/binary_sensor.skybell.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: skybell.png -ha_category: Binary Sensor +ha_category: Doorbell ha_release: 0.56 ha_iot_class: "Cloud Polling" --- To get your [Skybell.com](https://skybell.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). +## {% linkable_title Configuration %} + Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.wemo.markdown b/source/_components/binary_sensor.wemo.markdown index 9b304f5fc61..48fd97bc842 100644 --- a/source/_components/binary_sensor.wemo.markdown +++ b/source/_components/binary_sensor.wemo.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Belkin WeMo Binary Sensors" +title: "Belkin WeMo Binary Sensor" description: "Instructions on how to integrate Belkin WeMo binary sensors into Home Assistant." date: 2016-02-20 00:45 sidebar: true diff --git a/source/_components/camera.ring.markdown b/source/_components/camera.ring.markdown index cd4844ae4b0..7499d2a14a5 100644 --- a/source/_components/camera.ring.markdown +++ b/source/_components/camera.ring.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan. +## {% linkable_title Configuration %} + Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/camera.skybell.markdown b/source/_components/camera.skybell.markdown index a6b1155d173..61df1aeeaba 100644 --- a/source/_components/camera.skybell.markdown +++ b/source/_components/camera.skybell.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" To get your [Skybell.com](https://www.skybell.com/) cameras working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). +## {% linkable_title Configuration %} + Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/light.skybell.markdown b/source/_components/light.skybell.markdown index 15723eaf076..889dbaf4caa 100644 --- a/source/_components/light.skybell.markdown +++ b/source/_components/light.skybell.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" To get your [Skybell.com](https://skybell.com/) LED light working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). +## {% linkable_title Configuration %} + Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 4daf012653f..e600e3e140a 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ring.png -ha_category: Hub +ha_category: Doorbell ha_release: 0.42 --- @@ -16,6 +16,8 @@ The `ring` implementation allows you to integrate your [Ring.com](https://ring.c Currently only doorbells are supported by this sensor. +## {% linkable_title Configuration %} + To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bbox.markdown b/source/_components/sensor.bbox.markdown index ec3be264acc..a45e4bdb5ed 100644 --- a/source/_components/sensor.bbox.markdown +++ b/source/_components/sensor.bbox.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: bbox.png -ha_category: Sensor +ha_category: Network ha_release: 0.31 ha_iot_class: "Local Push" --- @@ -19,6 +19,8 @@ The `bbox` platform uses the [Bbox Modem Router](https://fr.wikipedia.org/wiki/B Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.

+## {% linkable_title Configuration %} + To add Bbox sensors to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.canary.markdown b/source/_components/sensor.canary.markdown index 25efd713e39..79239f075bc 100644 --- a/source/_components/sensor.canary.markdown +++ b/source/_components/sensor.canary.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: canary.png -ha_category: Sensor +ha_category: Environment ha_release: "0.60" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.ecobee.markdown b/source/_components/sensor.ecobee.markdown index 19491a566eb..e05a714d371 100644 --- a/source/_components/sensor.ecobee.markdown +++ b/source/_components/sensor.ecobee.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ecobee.png -ha_category: Binary Sensor +ha_category: Environment ha_release: 0.9 ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.moon.markdown b/source/_components/sensor.moon.markdown index d80c1068988..6a292040da2 100644 --- a/source/_components/sensor.moon.markdown +++ b/source/_components/sensor.moon.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Weather +ha_category: Environment ha_iot_class: "Local Polling" ha_release: 0.38 --- @@ -16,6 +16,8 @@ ha_release: 0.38 The `moon` sensor platform is tracking the moon phases. +## {% linkable_title Configuration %} + To enable the moon sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -23,5 +25,6 @@ To enable the moon sensor, add the following lines to your `configuration.yaml`: sensor: - platform: moon ``` + This sensor will return one of the following values: `new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` . diff --git a/source/_components/sensor.ring.markdown b/source/_components/sensor.ring.markdown index 898a76ffa4c..e8059abc990 100644 --- a/source/_components/sensor.ring.markdown +++ b/source/_components/sensor.ring.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ring.png -ha_category: Sensor +ha_category: Doorbell ha_release: "0.40" ha_iot_class: "Cloud Polling" --- To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). +## {% linkable_title Configuration %} + Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.skybell.markdown b/source/_components/sensor.skybell.markdown index 4c9f3b5434c..023ee75738f 100644 --- a/source/_components/sensor.skybell.markdown +++ b/source/_components/sensor.skybell.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: skybell.png -ha_category: Sensor +ha_category: Doorbell ha_release: 0.56 ha_iot_class: "Cloud Polling" --- To get your [Skybell.com](https://skybell.com/) sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). +## {% linkable_title Configuration %} + Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.teksavvy.markdown b/source/_components/sensor.teksavvy.markdown index 9f7a8e70faa..c55d05f3f39 100644 --- a/source/_components/sensor.teksavvy.markdown +++ b/source/_components/sensor.teksavvy.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: teksavvy.png -ha_category: Sensor +ha_category: Network ha_release: 0.62 ha_iot_class: "Cloud Polling" --- @@ -17,6 +17,8 @@ Integrate your [TekSavvy](https://myaccount.teksavvy.com/) account information i You can get your API key from [TekSavvy My Account](https://myaccount.teksavvy.com/ApiKey/ApiKeyManagement). +## {% linkable_title Configuration %} + To use your TekSavvy sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/skybell.markdown b/source/_components/skybell.markdown index 189f3a1b999..379cf3248a0 100644 --- a/source/_components/skybell.markdown +++ b/source/_components/skybell.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: skybell.png -ha_category: Hub +ha_category: Doorbell ha_release: 0.56 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index 91d1f7903eb..2b8cf1e3313 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Weather +ha_category: Environment --- The sun component will use your current location to track if the sun is above or below the horizon. The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][automation-trigger]. diff --git a/source/_components/switch.skybell.markdown b/source/_components/switch.skybell.markdown index 511aa39c1aa..632f5d770c9 100644 --- a/source/_components/switch.skybell.markdown +++ b/source/_components/switch.skybell.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" To get your [Skybell.com](https://skybell.com/) switches working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). +## {% linkable_title Configuration %} + Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: ```yaml From 920d90f747af25d04f51ba6e3b5b573385af1dae Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 3 Sep 2018 14:27:06 +0200 Subject: [PATCH 092/116] Release 77.3 --- _config.yml | 6 +++--- source/_posts/2018-08-29-release-77.markdown | 12 ++++++++++++ 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/_config.yml b/_config.yml index e56a21fade4..c4e08b970b8 100644 --- a/_config.yml +++ b/_config.yml @@ -142,13 +142,13 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 77 -current_patch_version: 2 -date_released: 2018-08-31 +current_patch_version: 3 +date_released: 2018-09-03 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#release-0772---august-31" +patch_version_notes: "#release-0773---september-3" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown index 84b3c8906d6..d57d9910198 100644 --- a/source/_posts/2018-08-29-release-77.markdown +++ b/source/_posts/2018-08-29-release-77.markdown @@ -81,6 +81,18 @@ You didn't think we would forget about Lovelace, did you? This release include a [light.lifx docs]: /components/light.lifx/ [wemo docs]: /components/wemo/ +## {% linkable_title Release 0.77.3 - September 3 %} + +Frontend changes only: + +- Ask "save login" after hass connected [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1631) [@awarecan] +- Show an error when invalid client id or redirect uri [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1620) [@balloob] +- Disable autocapitalization of username field [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1627) [@timmo001] +- Upgrade MDI icons [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1630) [@balloob] +- Update translations + +[@timmo001]: https://github.com/timmo001 + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. From f8f79877eb3ce8f7c60a1a1aa421fe6e367e6c18 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 17:05:19 +0200 Subject: [PATCH 093/116] Update category --- source/_components/august.markdown | 2 +- .../_components/binary_sensor.august.markdown | 3 +- .../binary_sensor.upcloud.markdown | 2 ++ source/_components/digital_ocean.markdown | 4 +-- source/_components/doorbird.markdown | 6 ++-- .../light.blinksticklight.markdown | 2 +- source/_components/light.blinkt.markdown | 2 +- source/_components/plant.markdown | 4 ++- .../_components/sensor.cert_expiry.markdown | 4 ++- .../sensor.mold_indicator.markdown | 2 +- .../sensor.swiss_hydrological_data.markdown | 32 ++++++++++++++----- source/_components/sensor.syncthru.markdown | 2 +- source/_components/sensor.tradfri.markdown | 2 +- source/_components/sensor.upnp.markdown | 2 +- .../switch.acer_projector.markdown | 4 ++- source/_components/switch.upcloud.markdown | 4 ++- .../_components/switch.wake_on_lan.markdown | 2 +- source/_components/upcloud.markdown | 6 +++- source/_components/upnp.markdown | 4 +-- source/_components/wake_on_lan.markdown | 4 ++- source/_components/zeroconf.markdown | 2 +- 21 files changed, 65 insertions(+), 30 deletions(-) diff --git a/source/_components/august.markdown b/source/_components/august.markdown index 2d079065ec7..9231f7d2f13 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: august.png -ha_category: Door bell +ha_category: Doorbell ha_release: "0.64" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/binary_sensor.august.markdown b/source/_components/binary_sensor.august.markdown index 20d2aec19d0..4af76c345bc 100644 --- a/source/_components/binary_sensor.august.markdown +++ b/source/_components/binary_sensor.august.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: august.png -ha_category: Door bell +ha_category: Doorbell ha_release: "0.64" ha_iot_class: "Cloud Polling" --- @@ -20,3 +20,4 @@ If you have August Doorbell, once you have enabled the [August component](/compo * Doorbell ding sensor * Doorbell motion sensor * Doorbell online sensor + diff --git a/source/_components/binary_sensor.upcloud.markdown b/source/_components/binary_sensor.upcloud.markdown index 6cae22e876c..2723cefa5bf 100644 --- a/source/_components/binary_sensor.upcloud.markdown +++ b/source/_components/binary_sensor.upcloud.markdown @@ -15,6 +15,8 @@ ha_iot_class: Cloud Polling The `upcloud` binary sensor platform allows you to monitor your UpCloud servers. +## {% linkable_title Configuration %} + To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index fd5d744376b..c0dc3175c29 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -16,11 +16,11 @@ ha_iot_class: "Local Polling" The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. -### {% linkable_title Setup %} +## {% linkable_title Setup %} Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index 43f30816d94..839a77a2e91 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: doorbird.png -ha_category: Hub +ha_category: Doorbell ha_release: "0.54" ha_iot_class: "Local Polling" --- The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant. +## {% linkable_title Configuration %} + To connect your device, add the following to your `configuration.yaml` file: ```yaml @@ -94,4 +96,4 @@ Enabling any monitored condition will delete all registered notification service action: service: light.turn_on entity_id: light.side_entry_porch -``` \ No newline at end of file +``` diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index d5cc53a99fc..bdd41852704 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Blinkstick" +title: "Blinkstick Light" description: "Instructions on how to setup Blinkstick lights within Home Assistant." date: 2015-10-08 10:00 sidebar: true diff --git a/source/_components/light.blinkt.markdown b/source/_components/light.blinkt.markdown index 69b72eb1d13..cee02bd7118 100644 --- a/source/_components/light.blinkt.markdown +++ b/source/_components/light.blinkt.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Blinkt!" +title: "Blinkt! Light" description: "Instructions on how to setup Blinkt! RGB LED lights within Home Assistant." date: 2017-04-30 9:00 sidebar: true diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 6beaa00557f..df2947e19da 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: Environment ha_release: 0.44 --- This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. +## {% linkable_title Configuration %} + To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.cert_expiry.markdown b/source/_components/sensor.cert_expiry.markdown index 23682318933..99b0578b76b 100644 --- a/source/_components/sensor.cert_expiry.markdown +++ b/source/_components/sensor.cert_expiry.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: System Monitor +ha_category: Network ha_release: 0.44 ha_iot_class: "depends" --- The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. +## {% linkable_title Configuration %} + To add the Certificate Expiry sensor to your installation, add these options to `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index 6b337c6967f..e2d870f7924 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Climate +ha_category: Environment ha_release: '0.20' ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.swiss_hydrological_data.markdown b/source/_components/sensor.swiss_hydrological_data.markdown index 44f4d6100bd..c6110b8f7c5 100644 --- a/source/_components/sensor.swiss_hydrological_data.markdown +++ b/source/_components/sensor.swiss_hydrological_data.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: swiss-hydrological-data.png -ha_category: Weather +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.22 --- @@ -19,33 +19,49 @@ ha_release: 0.22 The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland. +## {% linkable_title Setup %} + The [station overview](http://www.hydrodaten.admin.ch/en/danger-levels-table.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: swiss_hydrological_data - station: STATION_ID + - platform: swiss_hydrological_data + station: STATION_ID ``` -Configuration variables: - -- **name** (*Optional*): Name to use in the frontend. -- **station** (*Required*): The ID of the measurement point. +{% configuration %} +station: + description: The ID of the measurement point. + required: true + type: string +name: + description: Name to use in the frontend. + required: false + type: string + default: +{% endconfiguration %} The hydrological measurings are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated almost in real-time. +## {% linkable_title Example %} + This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/). +{% raw %} ```yaml # Example configuration.yaml entry sensor: platform: template sensors: discharge: - value_template: '{% raw %}{{ states.sensor.aare.attributes.Discharge }}{% endraw %}' + value_template: '{{ states.sensor.aare.attributes.Discharge }}' friendly_name: 'Discharge' ``` +{% endraw %} + diff --git a/source/_components/sensor.syncthru.markdown b/source/_components/sensor.syncthru.markdown index 19b2e5d1399..f2238dda257 100644 --- a/source/_components/sensor.syncthru.markdown +++ b/source/_components/sensor.syncthru.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: samsung.png -ha_category: Sensor +ha_category: System Monitor ha_iot_class: "Local Polling" ha_release: 0.66 --- diff --git a/source/_components/sensor.tradfri.markdown b/source/_components/sensor.tradfri.markdown index 98d673d16a6..91827191509 100644 --- a/source/_components/sensor.tradfri.markdown +++ b/source/_components/sensor.tradfri.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "IKEA Trådfri sensor" +title: "IKEA Trådfri Sensor" description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors." date: 2017-04-12 22.04 sidebar: true diff --git a/source/_components/sensor.upnp.markdown b/source/_components/sensor.upnp.markdown index c9d31bcca21..027d76d9ede 100644 --- a/source/_components/sensor.upnp.markdown +++ b/source/_components/sensor.upnp.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: upnp.png -ha_category: "Other" +ha_category: Network ha_release: 0.48 ha_iot_class: "Local Polling" --- diff --git a/source/_components/switch.acer_projector.markdown b/source/_components/switch.acer_projector.markdown index 70e1ae5499f..7599cd6d96e 100644 --- a/source/_components/switch.acer_projector.markdown +++ b/source/_components/switch.acer_projector.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: acer.png -ha_category: Switch +ha_category: Multimedia ha_iot_class: "Local Polling" ha_release: 0.19 --- @@ -16,6 +16,8 @@ ha_release: 0.19 The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com). +## {% linkable_title Configuration %} + To use your Acer Projector in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.upcloud.markdown b/source/_components/switch.upcloud.markdown index 98f45d0e68d..bdd03f6af5e 100644 --- a/source/_components/switch.upcloud.markdown +++ b/source/_components/switch.upcloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: upcloud.png -ha_category: Switch +ha_category: System Monitor ha_release: 0.65 ha_iot_class: Cloud Polling --- The `upcloud` switch platform allows you to control (start/stop) your UpCloud servers. +## {% linkable_title Configuration %} + To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 161cfcd1b50..c487c602dac 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ethernet.png -ha_category: Switch +ha_category: Network ha_release: 0.16 ha_iot_class: "Local Polling" --- diff --git a/source/_components/upcloud.markdown b/source/_components/upcloud.markdown index dcb15e41fc4..abd6d945431 100644 --- a/source/_components/upcloud.markdown +++ b/source/_components/upcloud.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: System Monitor ha_release: 0.65 logo: upcloud.png ha_iot_class: Cloud Polling @@ -16,8 +16,12 @@ ha_iot_class: Cloud Polling The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant. +## {% linkable_title Setup %} + Set up your API user credentials in your [UpCloud control panel](https://my.upcloud.com/). +## {% linkable_title Configuration %} + To integrate your UpCloud servers with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown index 842e3b25ba4..02ba10a72fd 100644 --- a/source/_components/upnp.markdown +++ b/source/_components/upnp.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: upnp.png -ha_category: "Other" +ha_category: Network ha_release: 0.18 --- The `upnp` component enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the Internet Gateway Device (IGD) Protocol if enabled on your router. -The IGD automatically creates port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router. +The IGD automatically creates port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router. Please note that UPnP or NAT-PMP needs to be enabled on your router for this component to work. diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index 2f7b1d4532d..93787c4aaef 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ethernet.png -ha_category: Utility +ha_category: Network ha_release: "0.49" ha_iot_class: "Local Push" --- The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. +## {% linkable_title Configuration %} + To use this component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/zeroconf.markdown b/source/_components/zeroconf.markdown index 3d054ea4d59..d1459fdd1b1 100644 --- a/source/_components/zeroconf.markdown +++ b/source/_components/zeroconf.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: avahi.png -ha_category: "Other" +ha_category: Network ha_release: 0.18 --- From 458bcdd73737791065f773173895fea3bf38c16f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 17:07:04 +0200 Subject: [PATCH 094/116] Update category --- source/_components/sensor.miflora.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index 85ad3cd03b5..92d2a4ea4fd 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: miflora.png -ha_category: DIY +ha_category: Environment ha_release: 0.29 ha_iot_class: "Local Polling" --- From cd5f5dc54044269924564523848e959bf658ea1f Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Mon, 3 Sep 2018 18:48:10 +0200 Subject: [PATCH 095/116] Revert --- source/hassio/installation.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 88aac017cc6..1b17327d575 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -77,14 +77,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the [etcher]: https://etcher.io/ [Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md [hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md -[pi0-w]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi0-w-2.2.img.gz -[pi1]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi-2.2.img.gz -[pi2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi2-2.2.img.gz -[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi3-2.2.img.gz -[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi3-64-2.2.img.gz +[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi0-w-1.10.img.gz +[pi1]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi-1.10.img.gz +[pi2]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi2-1.10.img.gz +[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-1.10.img.gz +[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-64-1.10.img.gz [tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz [odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz -[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_ova-2.2.vmdk.gz +[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_ova-1.10.vmdk.gz [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 [samba]: /addons/samba/ From eda7b8ce9dcf9fadb251c58e6a4a14d0cddf1b30 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 3 Sep 2018 22:29:00 +0200 Subject: [PATCH 096/116] Update link --- source/_docs/configuration/securing.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 4ed3e20243e..664acbe217b 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -14,7 +14,7 @@ One major advantage of Home Assistant is that it's not dependent on cloud servic ### {% linkable_title Checklist %} -- [Protect your web interface with a password](/getting-started/basic/#password-protecting-the-web-interface) +- [Choose a strong password](/docs/authentication/). - Secure your host. Sources could be [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf), or the [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html). - Restrict network access to your devices. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. - Don't run Home Assistant as root – consider the Principle of Least Privilege. From f1c91676f6a82c83396344234713d30c3702eac8 Mon Sep 17 00:00:00 2001 From: "Andrey Mikhaylov (lolmaus)" Date: Tue, 4 Sep 2018 09:50:05 +0300 Subject: [PATCH 097/116] Added Razberry Board to supported devices table (#6193) since it already has it's own support page --- source/_docs/z-wave/controllers.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index fdaac560c3c..128b122649b 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -24,6 +24,7 @@ You need to have a [supported Z-Wave USB stick or module](https://github.com/Ope | Sigma Designs UZB Stick | | | | | Tricklestar | | | | | Vision USB Stick | | | | +| ZWave.me Razberry Board | ✓ | | | | ZWave.me UZB1 | ✓ | | |

From 5966611f26fe1888f000264829bbfc3eb5374473 Mon Sep 17 00:00:00 2001 From: jma89 Date: Tue, 4 Sep 2018 02:51:01 -0400 Subject: [PATCH 098/116] Clarify MQTT Advanced Configuration (#6192) Properly describe the flag that needs to be changed and provide additional info on where the .conf files need to live. (Information that took me far longer than necessary to figure out.) --- source/_addons/mosquitto.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index 2150b1a3080..70f591520c0 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -89,10 +89,11 @@ See the following links for more information: Add the following configuration to enable ACLs: -1. Set `customize` flag to `true` in your configuration. +1. Set the `active` flag within the `customize` section to `true` in your configuration. 2. Create a file in `/share/mosquitto` named `acl.conf` with the following contents: - ```text acl_file /share/mosquitto/accesscontrollist ``` 3. Create a file in `/share/mosquitto` named `accesscontrollist` and add contents according to your requirements. + +The `/share` folder can be found on the host filesystem under `/usr/share/hassio/share`, or via the `Share` folder through SMB (Samba). From 53c82a60675196bde2dd45e89ce2a70fa55c981a Mon Sep 17 00:00:00 2001 From: DubhAd Date: Tue, 4 Sep 2018 07:53:31 +0100 Subject: [PATCH 099/116] For the updates to the customize docs (#6188) For the updates to the customize docs, to explain how to change an entity ID --- source/images/frontend/entity_box.png | Bin 0 -> 351 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 source/images/frontend/entity_box.png diff --git a/source/images/frontend/entity_box.png b/source/images/frontend/entity_box.png new file mode 100644 index 0000000000000000000000000000000000000000..8336a978d985f1708815d427acee02f032a271f4 GIT binary patch literal 351 zcmeAS@N?(olHy`uVBq!ia0vp^LLkh+1|-AI^@Rf|wj^(N7l!{JxM1({$v_d#0*}aI z1_nK45N51cYF`EvWH0gbb!C6V$t=pKupxEr5}=S|iEBiObAE1aYF-J0b5UwyNotBh zd1gt5g1e`0KzJjcI8f1XPZ!4!i_>c_+h;L3iX8uVUdlU|MeNEUC+U;Edm5j~%{!px z9=Lu2^AoxVC!{2KwKgYF6PMfh~Zf2#}cDa&`PVdg8 z+;9zj{e&~Sr(WMmx2t`^`E3hq8fp>+zpda*X%6I^`S`{ajTV_CkJ!Z$n+|Bo^-c-2 zXIz|y=(@5#c2-Z#aeLLn p)@ Date: Tue, 4 Sep 2018 07:54:35 +0100 Subject: [PATCH 100/116] Reworking the customize docs (#6189) Reworking the customize docs: 1. Add information on using the UI to change the entity ID and name (where supported) 2. Document the use of the UI to customize 3. Rewrite the configuration block to use the new configuration block standard 4. Move the manual editing section towards the end [This change](https://github.com/home-assistant/home-assistant.io/pull/6188) provides the image referenced --- .../customizing-devices.markdown | 103 +++++++++++++----- 1 file changed, 78 insertions(+), 25 deletions(-) diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index a3dc6cc91a3..8de3aa169e0 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -10,8 +10,86 @@ footer: true redirect_from: /getting-started/customizing-devices/ --- +## {% linkable_title Changing the entity_id %} + +You can use the UI to change the `entity_id` and friendly name of supported entities. To do this: + +1. Select the entity, either from or from the frontend, or by clicking next to the entity in the dev-states menu +2. Click on the cog in the right corner of the entity's dialog +3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`) +4. Select *Save* + +## {% linkable_title Customizing entities %} + By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities. +### {% linkable_title Customization using the UI %} + +Under the *Configuration* menu you'll find the *Customization* menu. When you select an entity to customize, you'll see all the existing attributes listed and you can customize those, or select an additional supported attribute ([see below](/docs/configuration/customizing-devices/#possible-values)). + +#### {% linkable_title Possible values %} + +{% configuration customize %} +friendly_name: + description: Name of the entity as displayed in the UI. + required: false + type: string +homebridge_name: + description: Name of the entity in `HomeBridge`. + required: false + type: string +hidden: + description: Set to `true` to hide the entity. + required: false + type: boolean + default: False +homebridge_hidden: + description: Set to `true` to hide the entity from `HomeBridge`. + required: false + type: boolean + default: False +emulated_hue_hidden: + description: Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)). + required: false + type: boolean + default: False +entity_picture: + description: URL to use as picture for entity. + required: false + type: string +icon: + description: Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://materialdesignicons.com/cheatsheet)). Prefix name with `mdi:`, ie `mdi:home`. + required: false + type: string +assumed_state: + description: For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon. + required: false + type: boolean + default: True +device_class: + description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). + required: false + type: boolean +initial_state: + description: Sets the initial state for automations, `on` or `off`. + required: false + type: string +unit_of_measurement: + description: Defines the units of measurement, if any. + required: false + type: string +{% endconfiguration %} + +#### {% linkable_title Device Class %} + +Device class is currently supported by the following components: + +* [Binary Sensor](/components/binary_sensor/) +* [Sensor](/components/sensor/) +* [Cover](/components/cover/) + +### {% linkable_title Manual customization %} +

If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.

@@ -53,30 +131,6 @@ homeassistant: homebridge_hidden: true ``` -### {% linkable_title Possible values %} - -| Attribute | Description | -| --------- | ----------- | -| `friendly_name` | Name of the entity. -| `homebridge_name` | Name of the entity in `HomeBridge`. -| `hidden` | Set to `true` to hide the entity. -| `homebridge_hidden` | Set to `true` to hide the entity from `HomeBridge`. -| `emulated_hue_hidden` | Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)). -| `entity_picture` | Url to use as picture for entity. -| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://materialdesignicons.com/cheatsheet)). Prefix name with `mdi:`, ie `mdi:home`. -| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon. -| `device_class` | Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). -| `initial_state` | Sets the initial state for automations. `on` or `off`. -| `unit_of_measurement` | Defines the units of measurement, if any. - -### {% linkable_title Device Class %} - -Device class is currently supported by the following components: - -* [Binary Sensor](/components/binary_sensor/) -* [Sensor](/components/sensor/) -* [Cover](/components/cover/) - ### {% linkable_title Reloading customize %} Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant.reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the service developer tool icon service developer tools, select the service `homeassistant.reload_core_config` and click "CALL SERVICE". @@ -84,4 +138,3 @@ Home Assistant offers a service to reload the core configuration while Home Assi

New customize information will be applied the next time the state of the entity gets updated.

- From e2dcd24aabc00467cb706878d3ba5f0d9a13538b Mon Sep 17 00:00:00 2001 From: Charles Garwood Date: Tue, 4 Sep 2018 03:24:27 -0400 Subject: [PATCH 101/116] Update note about default auth_providers (#6184) * Update note about default auth_providers Update the warning note to specify that HA automatically configures auth_providers, and manually specifying auth_providers in configuration.yaml can cause issues * Minor changes --- source/_docs/authentication/providers.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index b672beb0967..728ecb58b2d 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -27,7 +27,7 @@ To make the transition from API password to authentication system easier, we've ## {% linkable_title Configuring auth providers %}

-By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system. +Home Assistant automatically configures the standard auth providers and you **do not** need to specify `auth_providers` in your `configuration.yaml` file. Specifying `auth_providers` in your configuration will disable all auth providers that are not listed and can reduce your security or create difficulties logging in.

Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block: From 02f5a1eca7bf402a4a7707c9e6657b786d693f2b Mon Sep 17 00:00:00 2001 From: Alexander Date: Tue, 4 Sep 2018 13:25:01 +0600 Subject: [PATCH 102/116] return_to_home -> return_to_base (#6185) --- source/_components/vacuum.xiaomi_miio.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 3adcbc43c45..5864b32bffb 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -48,7 +48,7 @@ Configuration variables: ## {% linkable_title Platform Services %} -In addition to all of the services provided by the `vacuum` component (`start`, `pause`, `stop`, `return_to_home`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: +In addition to all of the services provided by the `vacuum` component (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: - `xiaomi_remote_control_start` - `xiaomi_remote_control_stop` From d5c4ec7e304a914e3128f4cb9a8a44cfa4e922e7 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 4 Sep 2018 10:59:49 +0200 Subject: [PATCH 103/116] Update category and other minor changes --- source/_components/apcupsd.markdown | 20 +++++++++++++++----- source/_components/apple_tv.markdown | 2 +- source/_components/axis.markdown | 6 +++--- source/_components/bloomsky.markdown | 15 +++++++++++---- source/_components/camera.bloomsky.markdown | 2 ++ source/_components/eufy.markdown | 18 +++++++++++------- source/_components/microsoft_face.markdown | 6 +++++- source/_components/sensor.bloomsky.markdown | 2 ++ 8 files changed, 50 insertions(+), 21 deletions(-) diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index fd25d00d0d5..44265218d24 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: apcupsd.png -ha_category: Hub +ha_category: System Monitor ha_release: 0.13 --- [APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -21,8 +23,16 @@ To enable this sensor, add the following lines to your `configuration.yaml`: apcupsd: ``` -Configuration variables: - -- **host** (*Optional*): The hostname/IP address on which the APCUPSd NIS is being served. Defaults to `localhost`. -- **port** (*Optional*): The port on which the APCUPSd NIS is listening. Defaults to `3551`. +{% configuration %} +host: + description: The hostname/IP address on which the APCUPSd NIS is being served. + required: false + type: string + default: localhost +port: + description: The port on which the APCUPSd NIS is listening. + required: false + type: int + default: 3551 +{% endconfiguration %} diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown index 93d192a00c2..e9008af6385 100644 --- a/source/_components/apple_tv.markdown +++ b/source/_components/apple_tv.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: apple.png -ha_category: Hub +ha_category: Multimedia ha_iot_class: "Local Push" ha_release: 0.49 --- diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown index 6f9a2cc4826..6662b55300a 100644 --- a/source/_components/axis.markdown +++ b/source/_components/axis.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: axis.png -ha_category: Hub +ha_category: Camera ha_release: "0.45" ha_iot_class: "Local Polling" --- @@ -17,6 +17,8 @@ ha_iot_class: "Local Polling" Home Assistant will automatically discover their presence on your network. +## {% linkable_title Configuration %} + You can also manually configure your devices by adding the following lines to your `configuration.yaml` file: ```yaml @@ -28,8 +30,6 @@ axis: - camera ``` -Configuration variables: - ## {% linkable_title Configuration variables %} - **device** (*Required*): Unique name diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index 620b390e69b..1139ee7a9ad 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -8,15 +8,19 @@ comments: false sharing: true footer: true logo: bloomsky.png -ha_category: Hub +ha_category: Environment ha_release: 0.14 ha_iot_class: "Cloud Polling" --- The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant. +## {% linkable_title Setup %} + Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen. +## {% linkable_title Configuration %} + To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml @@ -25,6 +29,9 @@ bloomsky: api_key: YOUR_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): Your BloomSky API key. +{% configuration %} +api_key: + description: Your BloomSky API key. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/camera.bloomsky.markdown b/source/_components/camera.bloomsky.markdown index bd6f8a58b9e..6c600b20a84 100644 --- a/source/_components/camera.bloomsky.markdown +++ b/source/_components/camera.bloomsky.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky). +## {% linkable_title Configuration %} + To enable this camera in your installation, set up the [BloomSky component](/components/bloomsky) with your API key and add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown index 60ec2a470dd..e2c00424fd5 100644 --- a/source/_components/eufy.markdown +++ b/source/_components/eufy.markdown @@ -38,17 +38,21 @@ eufy: name: Smart Switch ``` -access_token can be obtained by running: +`access_token can be obtained by running: -``` -curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq +```bash +$ curl -H "Content-Type: application/json" \ + -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' \ + https://home-api.eufylife.com/v1/user/email/login \ + | jq ``` -replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run: +replacing USERNAME and PASSWORD with the Eufy username and password. This will give an `access_token`. Then run: -``` -curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq +```bash +$ curl -H token:TOKEN -H category:Home \ + https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq ``` -replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device. +replacing TOKEN with the `access_token` from the previous command. This will provide the local_code for each device. diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index d7d8cdc7ed0..2d9cb4318f4 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -8,14 +8,18 @@ comments: false sharing: true footer: true logo: microsoft.png -ha_category: Hub +ha_category: Image Processing ha_release: "0.37" --- The `microsoft_face` component platform is the main component for Microsoft Azure Cognitive service [Face](https://www.microsoft.com/cognitive-services/en-us/face-api). All data are stored in your own private instance in the Azure cloud. +## {% linkable_title Setup %} + You need an API key, which is free, but requires an [Azure registration](https://azure.microsoft.com/de-de/free/) using your Microsoft ID. The free resource (*F0*) is limited to 20 requests per minute and 30k requests in a month. If you don't want to use the Azure cloud, you can also get an API key by registering with [cognitive-services](https://www.microsoft.com/cognitive-services/en-us/subscriptions). Please note that all keys on cognitive services must be recreated every 90 days. +## {% linkable_title Configuration %} + To enable the Microsoft Face component, add the following to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.bloomsky.markdown b/source/_components/sensor.bloomsky.markdown index 61b850de1e1..d2e1ca31a50 100644 --- a/source/_components/sensor.bloomsky.markdown +++ b/source/_components/sensor.bloomsky.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling" The `bloomsky` sensor component allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](/components/camera.bloomsky). +## {% linkable_title Configuration %} + To enable these sensors in your installation, set up the [BloomSky component](/components/bloomsky) with your API key add the following to your `configuration.yaml` file: ```yaml From 7eb35fcac71ba53768413eccb27b6d68992577d5 Mon Sep 17 00:00:00 2001 From: itineric <35140497+itineric@users.noreply.github.com> Date: Tue, 4 Sep 2018 11:04:15 +0200 Subject: [PATCH 104/116] Add missing color_state_address (#6194) --- source/_components/light.knx.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 5587f134ecc..4e0e7560801 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -37,6 +37,7 @@ Configuration variables: - **state_address** (*Optional*): separate KNX group address for retrieving the switch state of the light. - **brightness_state_address** (*Optional*): separate KNX group address for retrieving the dimmed state of the light. - **color_address** (*Optional*): separate KNX group address for setting the color of the light. +- **color_state_address** (*Optional*): separate KNX group address for retrieving the color of the light. Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. From ae19e9e8db12209cb2d7a131678dddb9da60c9f8 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Tue, 4 Sep 2018 14:55:32 +0200 Subject: [PATCH 105/116] Remove reference to HASS alexa skill via website --- source/cloud/alexa.markdown | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/source/cloud/alexa.markdown b/source/cloud/alexa.markdown index 7e140825afd..8e90a4d8eef 100644 --- a/source/cloud/alexa.markdown +++ b/source/cloud/alexa.markdown @@ -10,13 +10,13 @@ footer: true redirect_from: /components/cloud.alexa/ --- -The Alexa integration allows users to control the entities via the [Home Assistant Smart Home skill for Alexa][alexa skill]. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant. +The Alexa integration allows users to control the entities via the Home Assistant Smart Home skill for Alexa. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant. To use this integration, you need to have: - The cloud component set up. [Learn more](/components/cloud/) - An Alexa enabled device like the Amazon Echo - - Activated the [Home Assistant Smart Home skill for Alexa][alexa skill] + - Activated the Home Assistant Smart Home skill via the Alexa app You can use `configuration.yaml` to configure the entities that are being shown to Alexa and how they are exposed. @@ -110,5 +110,3 @@ Currently, the following domains are available to be used with Alexa: - scene - script (enables/disables) - switch - -[alexa skill]: https://alexa.amazon.com/spa/index.html#skills/dp/B0772J1QKB/?ref=skill_dsk_skb_sr_2 From 90246b21673c1d3d4127b86abab52265c5d729da Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 4 Sep 2018 15:08:39 +0200 Subject: [PATCH 106/116] Remove duplicate content --- source/_components/climate.daikin.markdown | 6 +----- source/_components/daikin.markdown | 18 +++++++++--------- source/_components/sensor.daikin.markdown | 11 ++--------- 3 files changed, 12 insertions(+), 23 deletions(-) diff --git a/source/_components/climate.daikin.markdown b/source/_components/climate.daikin.markdown index 2201872a15b..904b3e5fa13 100644 --- a/source/_components/climate.daikin.markdown +++ b/source/_components/climate.daikin.markdown @@ -23,11 +23,7 @@ The `daikin` climate platform integrates Daikin air conditioning systems into Ho Current temperature is displayed. -

-Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. BRP069A42 does not support setting of fan speed or fan swing mode. -

- -The platform has been integrated with discovery so all your Daikin AC's climate devices can be automatically discovered. +## {% linkable_title Configuration %} To enable the platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 84624b5af04..d4b25765958 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: daikin.png -ha_category: Hub +ha_category: Climate ha_release: 0.59 ha_iot_class: "Local Polling" --- @@ -16,11 +16,15 @@ ha_iot_class: "Local Polling" The `daikin` component integrates Daikin air conditioning systems into Home Assistant. -To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your 'configuration.yaml' file: +## {% linkable_title Supported hardware %} -

-Please note, the Daikin platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. -

+**Only** the european versions of Daikin ACs (models BRP069A41, 42, 43, 45). + +The model BRP069A42 does not support setting of fan speed or fan swing mode. + +Please note that some AC devices may report outside temperature only when they are turned on. + +## {% linkable_title Configuration %} To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your `configuration.yaml` file: @@ -52,7 +56,3 @@ monitored_conditions: description: The current temperature measured outside the house. {% endconfiguration %} -

-Please note that some AC devices may report outside temperature only when they are turned on. -

- diff --git a/source/_components/sensor.daikin.markdown b/source/_components/sensor.daikin.markdown index 250da44a727..5d9ba959592 100644 --- a/source/_components/sensor.daikin.markdown +++ b/source/_components/sensor.daikin.markdown @@ -16,12 +16,8 @@ ha_iot_class: "Local Polling" The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters: -- **inside temperature** -- **outside temperature** - -

-Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. -

+- Inside temperature +- Outside temperature ## {% linkable_title Configuration %} @@ -54,6 +50,3 @@ monitored_conditions: description: The current temperature measured outside the house. {% endconfiguration %} -

- Please note that some AC devices may report outside temperature only when they are turned on. -

From bec5ecc5ba39ee38031f64fd44def9e22fb5af36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Lov=C3=A9n?= Date: Tue, 4 Sep 2018 21:40:59 +0200 Subject: [PATCH 107/116] Clarify what components work with weather-card (#6195) * Clarify what components work with weather-card The weathe card only works with weather components, not weather sensors - a fact that seems to be causing a bit of confusion judging from the frequent questions on discord. I know it took me a while to figure out... I hope I used the correct nomenclature. * Minor fixes. --- source/_lovelace/weather-forecast.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/_lovelace/weather-forecast.markdown b/source/_lovelace/weather-forecast.markdown index b92588bd2c2..c636319db9a 100644 --- a/source/_lovelace/weather-forecast.markdown +++ b/source/_lovelace/weather-forecast.markdown @@ -34,3 +34,9 @@ entity: - type: weather-forecast entity: weather.demo_weather_north ``` + +

+ This card works only with platforms that define a `weather` entity. + + E.g., it works with [Dark Sky](https://www.home-assistant.io/components/weather.darksky/) but not [Dark Sky Sensor](https://www.home-assistant.io/components/sensor.darksky/) +

From bb68802e9b7cbebd37f5036035f5b4ed41d813d6 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 5 Sep 2018 06:50:50 +0100 Subject: [PATCH 108/116] Making title linkable (#6198) --- source/_docs/autostart/systemd.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index 17211e5ed9d..6b43b19c2e1 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -78,7 +78,7 @@ ExecStopPost=/usr/bin/docker rm -f home-assistant-%i WantedBy=multi-user.target ``` -### Next Steps +### {% linkable_title Next Steps %} You need to reload `systemd` to make the daemon aware of the new configuration. From 3530b131e2b0c28854bf4ada9e2ab66f1ac6179c Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 5 Sep 2018 06:51:21 +0100 Subject: [PATCH 109/116] Trying to direct people away from this (#6197) Given the pain that uninformed people run into with a non-venv install, trying to push people towards the venv installs. --- source/_docs/installation/python.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/_docs/installation/python.markdown b/source/_docs/installation/python.markdown index a7dda882e25..7f8c01ad421 100644 --- a/source/_docs/installation/python.markdown +++ b/source/_docs/installation/python.markdown @@ -10,6 +10,10 @@ footer: true redirect_from: /getting-started/installation-python/ --- +

+If you're running a Linux-based platform, we strongly recommend you follow the instructions for a [virtual environment](/docs/installation/virtualenv/) instead. If you're running on Windows then [see here](/docs/installation/windows/#installing-in-a-python-virtual-environment) instead. +

+ Once Python is installed, execute the following code in a console: ```bash @@ -22,12 +26,10 @@ Running these commands will: - Install Home Assistant - Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123) -If you're running a Linux-based platform, we suggest you follow the instructions for a [virtual environment](/docs/installation/virtualenv/) to avoid using `root`. - Video tutorials of this process for various operating systems are available here: - [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY) - [macOS](https://www.youtube.com/watch?v=hej6ipN86ls) - [Ubuntu 14.04](https://www.youtube.com/watch?v=SXaAG1lGNH0) -Keep in mind that the used operating systems and the shown software releases may be outdated. +Keep in mind that the operating systems used and the software releases shown may be outdated. From 426d08b5a992a5508391aa2c9069621c4119e329 Mon Sep 17 00:00:00 2001 From: Paul Annekov Date: Wed, 5 Sep 2018 12:12:15 +0300 Subject: [PATCH 110/116] Fixed branches definition in PR template (#6199) * fixed pull request template branches definition * Improve the change --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bfbe7bd2c02..9938ea6ddb2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,7 @@ ## Checklist: -- [ ] Branch: Fixes, changes and adjustments should be created against `current`. New documentation for platforms/components and features should go to `next`. +- [ ] Branch: `next` is for changes and new documentation that will go public with the next [home-assistant](https://github.com/home-assistant/home-assistant) release. Fixes, changes and adjustments for the current release should be created against `current`. - [ ] The documentation follow the [standards][standards]. [standards]: https://home-assistant.io/developers/documentation/standards/ From 825a067ec51ea3f80d0d4da559d0fba53993d898 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 5 Sep 2018 12:42:36 +0200 Subject: [PATCH 111/116] Update KNX docs --- source/_components/knx.markdown | 23 +++++++++++------------ source/_components/light.knx.markdown | 5 ++++- source/_components/notify.knx.markdown | 7 ++++++- source/_components/scene.knx.markdown | 9 ++++++--- source/_components/sensor.knx.markdown | 23 ++++++++++++++++++----- source/_components/switch.knx.markdown | 11 +++++++---- 6 files changed, 52 insertions(+), 26 deletions(-) diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 89e9a0c4129..802b288f4c2 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Notify](/components/notify.knx) - [Scene](/components/scene.knx) -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} To use your KNX in your installation, add the following lines to your `configuration.yaml` file: @@ -77,8 +77,8 @@ knx: ```yaml knx: - fire_event: True - fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] + fire_event: True + fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] ``` - **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus @@ -105,21 +105,20 @@ KNX component is able to expose time or sensor values to KNX bus. The component ```yaml # Example configuration.yaml entry knx: - expose: - - type: 'temperature' - entity_id: 'sensor.owm_temperature' - address: '0/0/2' - - type: 'time' - address: '0/0/1' - - type: 'datetime' - address: '0/0/23' + expose: + - type: 'temperature' + entity_id: 'sensor.owm_temperature' + address: '0/0/2' + - type: 'time' + address: '0/0/1' + - type: 'datetime' + address: '0/0/23' ``` * **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). * **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. * **address**: KNX group address. - ### {% linkable_title Known issues %} Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5. diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 4e0e7560801..4a229b62586 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -18,6 +18,8 @@ The `knx` light component is used as in interface to switching/light actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: ```yaml @@ -31,8 +33,8 @@ light: Configuration variables: +- **address** (*Required*): KNX group address for switching the light on and off. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address for switching the light on and off. - **brightness_address** (Optional): KNX group address for dimming light. - **state_address** (*Optional*): separate KNX group address for retrieving the switch state of the light. - **brightness_state_address** (*Optional*): separate KNX group address for retrieving the dimmed state of the light. @@ -41,3 +43,4 @@ Configuration variables: Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. + diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 78945fc3761..4e81f1e2362 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -17,6 +17,8 @@ The `knx` notify platform allows you to send notifications to [KNX](http://www.k The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file: ```yaml @@ -26,5 +28,8 @@ notify: address: '5/1/10' ``` +Configuration variables: + +* **address** (*Required*): KNX group address of the notification. * **name** (*Optional*): A name for this device used within Home Assistant. -* **address**: KNX group address of the notification + diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index e77b6571811..c9752de20c3 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -16,6 +16,10 @@ The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + +To use your KNX scence in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry scene: @@ -27,8 +31,7 @@ scene: Configuration variables: +- **address** (*Required*): KNX group address of the binary sensor. +- **scene_number** (*Required*): KNX scene number to be activated. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the binary sensor. -- **scene_number** KNX scene number to be activated. - diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index f7e78920229..6e0921c341a 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -17,8 +17,26 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file: +```yaml +# Example configuration.yaml entry +sensor: + - platform: knx + name: Heating.Valve1 + address: '2/0/0' +``` + + + +- **address** (*Required*): KNX group address of the sensor. +- **name** (*Optional*): A name for this device used within Home Assistant. +- **type** (*Optional*): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". + +## {% linkable_title Full example %} + ```yaml # Example configuration.yaml entry sensor: @@ -31,8 +49,3 @@ sensor: address: '6/2/1' type: 'temperature' ``` - -- **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the sensor. -- **type** (Optional): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". - diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index dbddf761518..92c04b6e4c2 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -18,6 +18,8 @@ The `knx` switch component is used as in interface to switching actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX switch in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -26,12 +28,13 @@ switch: name: Kitchen.Coffee address: '1/1/6' ``` + +Configuration variables: + +* **address** (*Required*): KNX group address for switching the switch on/off. * **name** (*Optional*): A name for this device used within Home Assistant. -* **address**: KNX group address for switching the switch on/off -* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state. +* **state_address** (*Optional*): separate KNX group address for retrieving the switch state. Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. - - From fdf1d1c9f7c6bc89703f5706bfd994976089c96a Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 5 Sep 2018 12:47:00 +0200 Subject: [PATCH 112/116] Remove exec permission --- source/_components/binary_sensor.bmw_connected_drive.markdown | 0 source/_components/cover.mqtt.markdown | 0 source/_components/light.template.markdown | 0 source/_components/lock.bmw_connected_drive.markdown | 0 source/_components/map.markdown | 0 source/_components/remote.harmony.markdown | 0 source/_components/remote.itach.markdown | 0 source/_components/remote.markdown | 0 source/_components/switch.digitalloggers.markdown | 0 9 files changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 source/_components/binary_sensor.bmw_connected_drive.markdown mode change 100755 => 100644 source/_components/cover.mqtt.markdown mode change 100755 => 100644 source/_components/light.template.markdown mode change 100755 => 100644 source/_components/lock.bmw_connected_drive.markdown mode change 100755 => 100644 source/_components/map.markdown mode change 100755 => 100644 source/_components/remote.harmony.markdown mode change 100755 => 100644 source/_components/remote.itach.markdown mode change 100755 => 100644 source/_components/remote.markdown mode change 100755 => 100644 source/_components/switch.digitalloggers.markdown diff --git a/source/_components/binary_sensor.bmw_connected_drive.markdown b/source/_components/binary_sensor.bmw_connected_drive.markdown old mode 100755 new mode 100644 diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown old mode 100755 new mode 100644 diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown old mode 100755 new mode 100644 diff --git a/source/_components/lock.bmw_connected_drive.markdown b/source/_components/lock.bmw_connected_drive.markdown old mode 100755 new mode 100644 diff --git a/source/_components/map.markdown b/source/_components/map.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.itach.markdown b/source/_components/remote.itach.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown old mode 100755 new mode 100644 diff --git a/source/_components/switch.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown old mode 100755 new mode 100644 From 2c1fdc2cd86e620e6109b5b14d8586cf3b240fad Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 5 Sep 2018 12:54:48 +0200 Subject: [PATCH 113/116] Add title --- source/_components/binary_sensor.knx.markdown | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index d51c9effbb4..6f5ff097906 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -15,26 +15,24 @@ ha_iot_class: "Local Polling" The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors. +## {% linkable_title Configuration %} + The `knx` component must be configured correctly, see [KNX Component](/components/knx). ```yaml # Example configuration.yaml entry binary_sensor: - platform: knx - name: "Entrance.Motion.Sensor" address: '6/0/2' - device_class: 'motion' - #significant_bit: 2 - #reset_after: 100 ``` Configuration variables: +- **address** (*Required*): KNX group address of the binary sensor. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the binary sensor. -- **device_class** (Optional): HASS device class e.g., "motion". -- **significant_bit** (Optional): Specify which significant bit of the KNX value should be used. Default is 1. -- **reset_after** (Optional): Reset back to OFF state after specified milliseconds. +- **device_class** (*Optional*): HASS device class e.g., "motion". +- **significant_bit** (*Optional*): Specify which significant bit of the KNX value should be used. Default is 1. +- **reset_after** (*Optional*): Reset back to OFF state after specified milliseconds. You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time. From 0192766d3bc08e9eec6d4e8391b5bbeb2c418772 Mon Sep 17 00:00:00 2001 From: Paul Annekov Date: Thu, 6 Sep 2018 08:06:02 +0300 Subject: [PATCH 114/116] Update Miflora documentation (#6163) * Update sensor.miflora.markdown * removed scan_interval from parameters list, added to note --- source/_components/sensor.miflora.markdown | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index 92d2a4ea4fd..0e82f9a6e32 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -70,13 +70,10 @@ sensor: - **name** (*Optional*): The name displayed in the frontend. - **force_update** (*Optional*): Sends update events even if the value hasn't changed. - **median** (*Optional*): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine. -- **timeout** (*Optional*): Define the timeout value in seconds when polling (defaults to 10 if not defined) -- **retries** (*Optional*): Define the number of retries when polling (defaults to 2 if not defined) -- **cache_value** (*Optional*): Define cache expiration value in seconds (defaults to 1200 if not defined) - **adapter** (*Optional*): Define the Bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters.

-By default the sensor is only polled once every 20 minutes. So, if you set `median: 3` it will take _at least_ 40 minutes before the sensor will report a value after a Home Assistant restart. Since the values usually change very slowly, this usually isn't a big problem. Keep in mind though that reducing polling intervals will have a negative effect on the battery life. +By default the sensor is only polled once every 20 minutes (`scan_interval` is 1200 seconds by default). On a Home Assistant restart sensor will report initial value. If you set `median: 3`, it will take _at least_ 40 minutes before the sensor will report an average value. Keep in mind though that reducing polling intervals will have a negative effect on the battery life.

A full configuration example could look like the one below: From 4ef8be77ce945f70dc1874f3239fa66bfce3273b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20H=C3=B8yer=20Iversen?= Date: Thu, 6 Sep 2018 11:17:31 +0200 Subject: [PATCH 115/116] Create switch.switchbot.markdown (#6186) * Create switch.switchbot.markdown * Add files via upload --- source/_components/switch.switchbot.markdown | 35 +++++++++++++++++++ source/images/supported_brands/switchbot.png | Bin 0 -> 28540 bytes 2 files changed, 35 insertions(+) create mode 100644 source/_components/switch.switchbot.markdown create mode 100644 source/images/supported_brands/switchbot.png diff --git a/source/_components/switch.switchbot.markdown b/source/_components/switch.switchbot.markdown new file mode 100644 index 00000000000..3eca50f1113 --- /dev/null +++ b/source/_components/switch.switchbot.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "Switchbot" +description: "Instructions on how to set up Switchmate switches." +date: 2018-09-03 22:41 +sidebar: true +comments: false +sharing: true +footer: true +logo: switchbot.png +ha_category: Switch +ha_release: 0.78 +ha_iot_class: "Local Polling" +--- + +This `Switchbot` switch platform allow you to control Switchbot [devices]( https://www.switch-bot.com/). + +To enable it, add the following lines to your `configuration.yaml`: + +```yaml +switch: + - platform: switchbot + mac: 'cb:25:0b......' +``` + +{% configuration %} +mac: + description: Device MAC address. + required: true + type: string +name: + description: The name used to display the switch in the frontend. + required: false + type: string +{% endconfiguration %} diff --git a/source/images/supported_brands/switchbot.png b/source/images/supported_brands/switchbot.png new file mode 100644 index 0000000000000000000000000000000000000000..da31c5feb002fbe93c134b29efcb889d067c4386 GIT binary patch literal 28540 zcmeFY_di?V|30qvR@A0ys}ieLt=OB`GnCr1_NGCNrfTn&SQUHk)lynijYbtk)ee;! zF=FJK_Vs?fzvGwhKk$i%2hKU}bME_ouIqYUCk14vMMcg^j)#XwrK7EGf`>;0!o$0z zNJ@-5^4nHt759VKNl!~15Bv8E)?bx{J3{tU+d2>r55V*H`&L+`atI!tAG?maidop= z?>A(9!KMrEP;zH0^ZHw#13w8fU<7rYi>o9ww%pTQpO3TCvCx?qJKv?};!N~m zdN~q_QbcuHthPp_xu7Hu))uy}u!F0|@_uXm+YS9^i(c3Bt;JFg332!SKcD~K6?h}z zv)Cr11V$vU#L55N+J7HdS~8)~%#;8Ai3j8?B}6ts3sU~y7ybEVrnI{E3&3=CdzmEk z&VMfla*E>yrM<9=Wj&$%e;&pSLIUnPa2guvilXBn{{NgxQpb;A-N?*@{O@Ck{kaFC zh5vV0ymWkghX4B{-u?e`67T;k!e8t7KbG*nivYrV;#GGsTJ^#v?{IYW7T$A()^_3I zdEw&d>*arr1Y^DpCpE+SWZ8oNQ}#0Ziwhb1aa$~={8^=`9Sl@=vbsKIwIqb~Zp+fW zQBzd!HEFMRb2yXy_rD-YQZqs!JZB!8#B2nmL@NjFqj>1<(o2?}+x6vSPG}JJ|OpLb0T!oE^25*0L;GkOPy)E`@9nB1->fNuzP?#SOB~V_0NPh z_IzI&IRHq99I7xq=&`a((CZ~QjF?5?i@lo)3j>^ABS&kO{yBJ%+;i#&lAbnQD!%KDTu8_&_)Mj`X>Lhk{^ZUXRO{me(IMX8 zB{M`V6_f~iey_uhD?YII-Y*is-M~Xn`oo#0;^w?nSoXa99kEgKox#SL z#Hd5;^#q`p_I<=F=v41_#E1l7%ZM$3fb#n>XU9tH@<;`Az9-CLeLJ}CTbF3j7+r(g9!eDU_d>s7@4(N#8_b zQC9}U^GZ*GRruq?-bDjHy}QX&;9Tc(D^9#wM^0Oxp0o^#p>-yYzx ze2~{{Et`J~9c_rt85aGpy8BDu=*yCr3VcBP?iL3j-rqIFXTWm`XPuWu+g2Ec9BwDn zeJSJh$Ssq~tv?(L&B+#m8~f1`Tft%$@`2Y3S(eOy+$6K-t<1;Q^*;e#rqJ;?S6{jX z^@GThYI82yX`ZwcfUhhTuhE%}(NUZg8pGQ9nokBR4ohN-@21m%iZtZ2KIszS{k<)O zTx@6dVP@4Zatal4_(V#s@NJ7cTXZ&L8kCh$ZK4-EkRJXHjN5m5e6$In&^-|L(%wd6 z#q{gq4;SMP#}{$X%^_}K%LkT_h}$oXQs>vj94T2k1oZ8FJXbMk+@M#4G(`V8>r|DDjsup11frRxU{?iN(qAEKlDzGER6vt!7%EH(*TO-<9jafMC^4F z`-(X<)aMrEPj(4*2?c#kX?%v;aJ=|?hG-RIRIq;$EAQ!&^tGXcN0d*u)JXyZ9>k^x zs93s6=&4GUQ;5vlBO|$(%dg`BrII6h?LI#TPMYK9g?&iqc^}2KykhSp`Wl3JQN%#( z5+%W&X7qPefH3@%UInVym8FqEV)xpZ2N28)Xz*?LGoTb7Xb?ezFU8dxWF;Y+XyQc6 zB;R9YeYT7{#SQv6w+1zpjcUFPiFkzHjyN-BexSrVM&ewis;q0Os8n6~(&(ye!2+;i zM2y?!f3q;U);p9Z=m8Jr0Kse!a@?L~ousdIWZlFt*iNN05zajy? z!G~Rok9y2L;jI~Jz*y8r3a})2uS5L7kJK!dZtoi<;bRa{%?a%{ zLgW_peVzA8zM2zmjGMoA=3(i!Nk{gcQyG5sN6%j4l7>I4GF6 z_k;#e9CTQcEj-Zn25$`;`C-I~kxzoM4M;V${r+fKlU9oqaVrNtm>xRJM$(3#Ev7lM zo>hTCmS=){Dxe}@c7e^f8!p?!ED8OOrYllZ=1gHC*Twk%cA@6RgevQbXO5!z{X3c9 z2jgq{#E$QXkW(+o5S!54Bq3-yBgZegk4xYvpz|&*paB$DyO8pQ-sfa^?QC!g%Z>{e zbI}bOzdQ)=%|#y_aIL0lXb~ds0S1y{FnH8Cad967)I>%F2F#{wOlr>_003D;3$AC! z2_=6ll(E5m= zXw&Ia|2}=q1EUOzTs(A38mRh_w24tqyg|Ww{Xw$>)EI zS{eCe<9_RotkPj~AC#lQcUPn3aS+fWFah= zd$@-m0n{voNf^!fyyO3 zN8RSC#O?+7bAFdm%30f2I6KxOH7lZRK@S*-mMWkjeAgmF;NL3ayUce4L@~AtStul_EB8)^B`nM>+ zXMiE`rS8zInlRiFxNK8|M3CV#5c_8WN+f%_K29?_#-7ir@{uBpFZ#^+@0seQTlgWf zPJ;0XJ;$cp^0SrqoeWpqw5;fAJW!di~DRE^7$?-f|D*JS%+O>+R)Rh0Xn&x>` zj!lY1ecy#&f3vN8-d7RzgDrP&%Or|wY-+kB!_tFz*Z{t?12r} zGoJyzu6C9w{u|QHrK+!v`li8dMWB6@z)-S{cAfP1yp0%S|*C|)~0Dq;$=hu}tGWq^0y15q%* zWw=0-d2vTmo7Fuh_&`H^v?Vbi@|yPzZpU#}Pa`@PovPnbBM8E-JDC#-Q9j0&J_%<+ z1>!2o&=mdG)z7S~Vh%1hV7T`iD-%vl}IDDge8t(gq>71%7^ghKB_3NrI!QWOlqf|PW(?g zGy}u#GWY+ed325tFSxCPwYMOMGm`v6#2jYb4neqxc!?uL@N;SK^8$z~_vC85lT!fv1&$^Gg0_u##P%>>+kg&Ee1^o6_RtcC?8sliJg9@od|8@0Ak})i zfL)Z)FEjME?=K-a=51-FG#QpEYsTtQa10dqoE;P2q_(vjuv1S48GlXo?{+ohh;FmV zftor*nm}K6NuJ7uDA;cI7a@~Yuk7eZGXN0e|K^Tp?Bd9vUEkt{o4!xrGzUN5s%XTL z7+yX-e2I+~F2MD72`}WH;G+ph5s*9ZQlk?-!yAENI>6U4$GDitqc}ir$RRD0R(F@) zZ_=jMytfDPrl?=vY9^E;L(IJ-MNH8Cr_wMBf7Wj@vf**w%6Vs1I4+2u={QJs#~w&b z-`gYmVPpz?wK&3aKYpq0_hZM~0Un=Nfo1rVW)3wjb4&{1_M)qmhjzRFN?v> zZ-(Gia#BQmD()V~ba1f!)Q3GNaMFNoMZ`y8c0Jg$^UJAC%QIi=vPA#QbqQ$>t7e48 zpu&f)UY8;7xO@;(5b6NtDlb1dY!v5|jIikhId?)Sn8-0~ZKfp87BCl|Dcy=mn z9Bb)ybk`%q-TK^bcvY(G=H}1T%8BA_xZjVGKvzD{9GY}KxB|LY5EPxX*^}sHQ#%_8 zPDO169yZbX%T|x-wo?+-yy|%o_M`K84fea35U3=FauEWjWk*l;i2kl{XwaD2*EUgp z3A{#ahiHa;dd<9IY{&VZ7%%%y=}Q-IZgpbb6D+3^@vT?(P~PJwBUXMma{(!7o|gSN zg^8Y+FvjT*9LlmZ$-Wb0GG8jTvx5=|#QQoKda!Y6(QMG;lh%g%p~n^)fO5G$3%%@z z4kY%tzG+lsHMld56g}f4gcJs(A#6_ebi{?Sx@Y*sHEzCypoVGr){q_xwc$UiMk`|2 z1B19hrVajJvahc52*2OOU$Ocr&+UY{o1b09u9XJw;`<&J1_$5dK9MxO8jI2v-&#sITT)LMxYuh1a-9;psB}s5JO&5#*l_b>P*` zT(H5FL3MD6a>Q>VvaHuVmD2aahm2cS7-!DvZTk{6>^=&9-MyT#XrCpl$yB-)Ht;f# z_;NBRnf57*rtACc2mmm^9o!OK|3S~rjtd&(v4*|SFfqL(z3>ao8=OGdSS^hlaqns_ zedjQqdSEL>2Pa{ngAW*9)cqz!WbeHWigwF>K1XF2^&_wGssCHMudCX`TdQ_gQW(I1 z;@!;H8yIwNb5PD&*MEQi*EJy5H2D5ki421=W~l+&?;}~Ggh*=*vZ0*_gN!Kybu*hs zR=N}j8gnpAGaB4K0%*d)@iZtJywBVF>s6-GsjA#pnDt=P%Y;>_Q}JDr6%q8)BJ}&p zS7+n{j26^)qId|*m9ub#D=vi35h7DHi9FTj?k-!_YtA2M^N?kAv`OGe6^O-}OPHn^ z+ommEUy7(tCIdOnrBgO~s->$J&qR(`Yf3f+2$=F-uhH`Vy3~%9d$XAM!v{f?QW{1p zvb#9Nllg&SHgF^1K>5=eB;1vFkiP{fYErT^Kc}=Z62tAg?VaHvm6?-Fab$NBWi@6! zgBj@i=oZmI2cHR4$o%6yI5AS?eCu2~$7Nw`$XgzJu*V(k7wq5gX{SA?yVzaer3M6( zjSKgN8F6ArVZ+Xej%htF$Dti2V;*Znx;VY~&hX|EWvydiBgr zCrH+)<)K%6a!koye)%IrF<7QE@N- z@zGP*r_U|CGnPi50EOMlB3nq*Yg38R4nMj9`x&jx4~s5~$u66L3>T;lucI@}RH*xc zStcpjJi?7~f7&&&Z*cN-+NUMaS-^Y#7Ya~mKu3&*j)yKbq)Jf)xcch;T9C&^2OxKqu3qtM^SGjQMMTz7mbzoubNJ?Q*N zd5S(2MF%~y$IvH0BzmkEHO`IP&(IdRP8VOtM<;1e3?)Q*s-YDgQl^GFb&F-!?c z=$CzrpEGdD1V^{s5r21+2BB8 z75Nbw)6(rZLnoDKrdJ!UJpOVyh~G9V@}hMV^NNXgsUkh=nlBGppJHzWm6|@m5N1Uo_VvJh!OerTPzbwlicffI4R{ zXRKlw2Ao5SYW;F+O{ps}?wEDRn%xR_ShA|)zkV6X%NC-eMnTO;p{astnz-`~EAW-S76C&2_7nxqU zc zg%1O$25l>VIa4FNm(BY+-7C}>nuWNlu)M>BPgg!|%tD}$57q|uq$NV_57t99YrWMd z(0yz(*R0scC18tW^a<kfh?=3R~;Pd?d{v_&$1uFDM6 zH0!NBna_Le(_M#XEP5!GL6)R@Wn&aWF(A5?9+8@wN!(q^8D`~UP+w^`e6Qm`0+Ez( zxdSi5P|f8vd{=*&Bc(GYbYQ;3u_t#%rDNNb$8i59;H2*rTXy9e`zo>pdnESk!kXO7 zqgRrO3=wF{zE5YUJNO9WCqU^iJO=l{3iD~`PH37(&t@Kden?4%m|~`dYq3Q78DzzO zA?Jt;`Y!Mh%093$lc!#Yy!7hhjy|sNeo*ofc^7NgVzR9r&S|dswr1e5k{aJq%YdkT zhPY}ajf2`h!1YLU?g14A;=$Z*#x*~vipkj0Vkzm?=fP~|`!%i=#byUCj{`V6$DY(M zdLGahz!kp<%01x!0o9Vaye=mjK~Wj1pWRo1HF*AcoM|r^F}!hf79eZt`-?~8?S)Uy zYQUlANlboS(?cKro7l{FpyF~mP*LG3=DyP}$s@xTOzkxRROsmN8alCIqIo}>=-Kf^ zOvO_U8h{=Q85(!;;MV&NKS&Rps zOfv}sq#ld7fZf`kAT{pGB>V>_!P4`PMmTf&6L7ZB+-lQ6GFQnS?fQ(P zCh^ZxGW=k^_~_ZUE`S#gAQ2VK%}H2=u{fZ?_o0SR{BsF*tiILNZq<$K%B>R^B7sv! z$Ptv$z0%@YrBCfNZi5+VGRC!G7>2J^dh8#PN-o}% zdB$kAJhhH*x&Qk1rATx=c_BQ^`m&R*ZByc^nP=6L~vHL zx@IhRjS?X*C+OhDiI>)+gf(f3&1}3S zd$XJv66vC7bOOD3;M#mn`Y$54wUQ6k`$Hl^6hONK5Y`sO{-(Z~4=M)d1)VQQC;IUs zdDCem!%)wqyH%;X#)He4mY0fhWoPEvnUxW`@YUR&VP#EDexGs4~WoDwdjKux3imAK{CN_)dWw8L`*Gtr483t!qkA zA4bYt080NlE@Joa&F#ZQK%oV2fc6 zVu8>eY9u}pMlQ*tgdHaZqNKJk zto`M|Wd%`!z@-?pGi%_xvR>eskTF8hgO5Op6k&jf{4rk;K8o_*!W|grGFFnjic1(7Q+YK8|L{GjtV2>p**NYR!z@mNO|h9tpti2Ed-)Vj4niyaGVYOr4`J+Lf{39;kV&ytTEpLKXH)LUC|%T zT%i8+iySUUPq9r`G%QWh=xcF#WQDp$Logtf0zm|2gp;8a&de!%sR+&zvD5-g;rVX5 zvFuw!w(yZUl|{1Y16j4fT51cFc%UtYq~gPLtXCTk4twJIa)KtmIQ)K!m0QqHwAMC( z-$GB%N|^FwwW;WPQPr2Fx$7u)ez7FxVud7?g*;mqC)e+Hmvn8j!^05yq}REFt;P`6 zn1NMaSqI~+ASuV5wkc}&uq@!*wS{IDIz1(<>5)MwNC25tW4{%}(iWKiaH<{&HDui} zjTN+phti}g7(~o}+q{|DTc&HkZV^|GvGb83(!p}&87+*5t4rKb~RkS$oHy`9WnZ0H;#n(%T2Uer>%BlW-u_+3aLXaJM@o zLJen7P)SC(<4_D9Jz7RlKJD`NNIyA0-!!90c#>LcJcjspMAD1KjT7?F=hP1WhvZxiA-Sg&esui2U413laUD7hzNf03)J>h1a?m;O-3ke*tKJ1H`}^V2prpjbM{L7Eu0C=Qo!$Tub;*Mkubnv*0ypa#d+WHI2uL5B}>F#Kv3{ zXxmYThKS7T;JxQdz3JZtvaK{rX??64w}mOw>a<1pl?89K?^<)sw6A`9w`S}X(o$(g zhPc3G?mxY+Yh&_$2<##w1`tX3QYTtk6DYaLqV0Ps&UL?kDS!H^N{BQaJ(y6*lT-oy z&YpjtN=);LZ2rgmMX{U_q=u$9tAoRWq7y6Dkw2XtZ;~e>bosFK?mk_>JvtH%msaRc z=@Kdrjk21(XgyBRKQ|92)NoDGziA_+A~%f>tl(DxkCBhh9?sd9wCuw53;Nq@2)+we z8#GQBGkQXfKt#j=r3SCkQHq7;MZBM|C3(D=L#;{;hFKiDAlMh4c2ivL_!_)wkq&%g zh?$CEfPV~r0HSYsbJcM)NFB!SBniPlUJ@Z&ll8K)ZrCaYC;NCadTx4|>EUO{l<7^FFls(*{G+RXt%B0mVAu%X-eb|jXW6==ozCC};^TT|~zqAqFr$`V3 zF$|h(2W@6ciD(xZP&PRfMr7%JR;SE@`XD^o!>?WmSn?hVM-3)v1h`t*-uFzK$~o!V zE$Ozb$~wOn>ipnzLX&uF?P(#wW^d}N%|Q+cQUs2;FcA3d$o4yLOu^?u;Xu?!CKCd* zWw7?abYp_`y?S_;36;X<$>8jn{k+E_ zCB8`Pr#xWdWxn82fM)RY7j=z<#F8-I*XBj)SjJqSH>hD`UdP7*7_U3@#^^gh|!!@1Xe56nP;#qid@(F z!#lxesL!DcucKK)i1)4hEB2iQF^o~o^m+#wX)XzF&-2hvu&N&_#HH+8Lo+hAggfU5! zl7M*N;nIiNkfV_E;+yP?Zb>?LsbW+v%1^f@oUP$F?SzXR>}qdA4<8s@tiTmW&Ya{! zGIL|UD-7s$L$A7Nhyv}WHajKnz&W*Gg|P!6bMwMaAQ&G;z-PO?dyxYcAMj&Um%oP3 zl^Xw`84>*uTeeew<@vh9w4}o)?Cq;v^c%8&mVQ!5#!|7~%up2N!Gb0+XKMG2)*ECs zyPzZQ%t0KiZNDiV(G5qOayIO|Q;b@ji%`@Sder1okXc-tcx4ycHLA5CA8hvkfrIxf zh}s=geyD5O)x`%TCb-Z1rv7&cj5+^r4l;zKs;%2SP^bp1a0;j>tp$m=GgVw2a}s$p zP`~{qB|rU+KWnr~^dq<|0=d(wd!v0-EdVS^~DYKnzeHC zrz0m%$k`tyu(ry7T4aw6%P>7$%(MO zpGN($P{m@kRyKp;?23VD$UwUFbw%} zi5kLo{#=vON{aN>Y{TIdmTJhhtXHH>tURMPi z)WGgd$3JJY6D}nNyzMyADj58l*OjVFsX16d^9*TB>Sw+NDN+&%f9s3-3!zOHMpEfw zII+E-S0+^BSo2YD?k$bKu3O=el95!*<})zS3FC_CZPp(YruHlV{R%`;6MF90MkgNE zGmJm;Zu9SYQPQNySIMoau<-uUy>F~Sxou_=;JRDsoJ>+n^qOP{MO?e(((bbj49G#(9Ftc{rh9j4;S@(@yII>2j$SjB|pUA6LTJg%FkQ?Hy002z%%3FWydxqSBUNYcL> zJ%elZ{tE_HS#YjEUzK)rm#5U+=-j)I!HOQZ3lyQf-(WTS*v({YORi_3>KSqigLO7rgIO#X1i!jK;7@A@q|;QM$_k0F?5Z3(BPDe5}U71qBt_ECJP;Ya|% zwZR>{!61sR^OE`ms?Foks@RT3e+<@kh7>cbm8_C5rtK*1KNKMQCzQvOCl@+sl+ ziVlolrdN8!m0_zv^G7Y@bK1t@$-}2If}mlkp0{jc%PwpQDTm||w1SaktczF`CeCbc z9qe*0ipwHdpw{OU98>z!c>PH8Os8`kqSsobJ>8=)jOH)JhS!fd$J*atKeVQOCaSqQ zfkkbeD1MuaR96zM&Idv-H3rW^j=p2xaQ~K!+P1JZw_%)I|3v_xHgn;rgRXNEB2l#P z=LvZ#0$pLT2tULNc2iB|$Vb+?7`SQyA!6`?d~9AGodV(YQ!nT_t(>yWJv5 zc|I7+I7g$;e7;k^i20t2` zJ)<9QjxUI+s2RlnEU*$th`fkaF8mO znSAhah9%7?ag_2d<$qMHye?%JpBCkM?ZZ=7g08^_)eq}BlyVoom8M#nXv|Jz8k;^^ zW-TZ7Jx;mpZWe{lG=Sa9+(ew-!pnG8Xg8$8OYnl`O>NIwl1oD{AF_Kst|yMnrE(9havL6p#nwpcW>xzYke-5^c+|~1 zo*D_2M#GX_mSbOyTDuuzSzBg@Ac;mc}rM?w2oesQyX;(G#a#WylYT>UK z0|%-sB8Tz(U(_^Pj6CvMyNuB3jy>tkIaPgS@ha9lE}8WAQJiHoR7d8sGdQ5d=Wc(2eyd01b@v5vH;a0 z>e_(=vvO3a9d*WwMSMsh*7xm%21b-VH7hAHCr**{LnTakecAZg!oYolti2~Z+F+6pHJ$fqMj zj^a9yNiP`T#wBR3;1U^1!@Hh0lN*I5?_F%KLLjM>it*fFuz;lQDT>4EsdHp7xYF}B|ZGVAgb)6-n zs6g0Lh88}-lCisn;mmf4CHWW3%?v7#I$xwEp4EAR5n@f}ud)T0g(MnptOJtT?|JKnV*sS@YKl`fZUldm1TqEi*%rK^#n2X=!P) zK`dtg9o!TSvDvZG!Nw}Bqb2~1`r5Le_PQIZMb`3IBL$w1v{{1d*hTF(WtGVmu4PyX zi*{Pbd)44I^6rfegRBE7B(I>&?DXqt%XEaGKUUnDYozHY35| zAnauK=Bewj%`Cq~$5GPZ>|u|c&Zy6A#&T(y7ByEJYkB8??uHl0Ek)<1*K=Nf_|)4O|BH!Tz??l`i#=q#m2+Zrk_A@L~VEQv39box};eEx0jOut7x zv1c;)Hr(rrWf|~|0rjg^ULStvUss1=dOjrsS@A$yl@>rfIRfj-!;qfJ*l@NoIQrJm&J0NYilpKtloC(BZ`-WL&QHF!w>Y*wux_kXRwJ zaHFB}n|(D%gi6xy=47ZAg>PCq**XpAJNJZ-69y!H7Jhn<9050yT?Da(rN|ql;0K47 z7Z`==Iw-w1XMy5$Et@zEFPXW~qxn!TGf#Jab62=H9_}K-niMbg#T7SOzwD2>H#o=DFy2%w(S!WQk6b=o~e9NN^KbFb-6W?2`tJ! zFKV1)b4g}6th)(+Mu?QBg>NC3F+>gEEb6@RKX9UO$?O?fE>#oXmUF0ST2I0l}*Y66wD@T_zAeMwrpZsyaQ zV-zwy?ZbONGlIiR_*?HmGK6Ktik~N==ZUbLxvHl2c>{^F`Q^hk8ycPd$G9Ft6)tq$ zPb5T^L|t!j3kc${JsGh8{7FkPXfHIp1{HnQ9X~@5dbKTc^hlv{q!lBnCeJf;9j0?gD?$FOi7dUzKH(kofR2;xB zQ^jpSy6`I`a%u@aOvx|wXh%`0Fqw+s;UNXVeoiG7R5)cCM9^sPmA}upSGcAl^>mMm z_GYSNZfUr%?c)_+o7Q=;QFp##QiPWjI?~=5*C|3ZS@x8p8Io1+AxW}5a zg%WwfWO)*Eq>Pm$ZVepFL|@vtwe?K#yv(tV_}_p8>`|X1=tVp4wN^5PS1n!82uHBN z3(qeI>SN5~;AF~spBRV4C_!h!Vb2~}H)YfOKBSMO zzFJ$=9x0d}(y3xbx-#+ID$1PCxX!r}ljMf+b}N)9+Z@*%Yz?>#k6`-gkvQsp6I#sl zUw^&lGF?V2TAF<62{@>K%ZC>;hY=PO3aA#_CARiuV}qnNgmLxbK{ zrs`O7IQZ(XKD&>5cl=;V_0j=$Fjz+Dc^)29v<20~oc>|IGIMdGDg<8VibEb59Heza z0o5=}-6U=+CR_Jgvw_RGln9x{@S#6W`*Qs+1A;AaW2zzIHs@f@zkvK-)5qNb<~g&~dHlMbI3o3h4x-3x6j+Z3VO{(JeX*J= zc8ijrvED=iF#Pj6i^wHmIgZhKJHSejc(_8i#FUaF2E1=Dq*$ z{`$b2#4DQK^8_fk;`6LdK*{y}8f7I%@4D*Hx85s0%9X_e%9>Y|8E5`#=wYwCWs=%6 z^obB;SeNZuQ48{@^|NIiDMI-_y)0ZT3lhK|E}=0Bdv7!4Oe(QIVaw3Pnrt{I_-ihSEtMToH&+HzA?gHh69H=sCWjwy08t&Azz&tf*E>F%U>02^q+S*ru1mZKq)-^ zqji|ln6tMebHS<_WFy8rwu{G%@QA$Wc;bVU3fABHFaEvB@eD`Y*mZgY(q@{=*$Gjq zH)OG@X?SnW#~pmjtVkV{o~R@p=AbC7OH$b$R5$T#z6yFzFrrg^S+i8m=<>nvj&N$R zagyyEu10jk>x;`M%(H>LViX4DiO>4+i3r^h0iDTM*nWwPQIGw2iyofGLJOxy;$;wx zf6_Fa+AAIG6+j@4!4ioO2a zSzExQ=vN(jQp6BZjl)LF>@;;j31cvx=)Xc>dWt((og@7u{r&zk3%cO>u7@hGd>AE! zm28JT$Wjha>k5wi;M5d;J1EO09IO(@bqY6E>QM`~!a5U26jn)=o%UDyKxl*ZvLy{A8YziU z(zBh_t2j%XKs^k%HG)lpi%fWUfjtLKymd?KX9D1TjvunjY2 z%%9hLG*#I5Vz@t-0|;U55MFiJ0J9!U(vN4}*M&tb=L4g8NpK2>Kcdn{3WR#9URDmhod3>r}=4;cWeoQ|U3YV^~jp)&cPSa@@X}{~kpwRO( zWg)DsN7)WUj2s8pi}QjU04lJ9$KFFd?NN;x_?L&c?#lf?_hbk?y&xF*CuNVZ637xw z{1IJZob+rkhv>ULp|07`8XckM*XAwS#LgwOd@{ciHJDc0^m}cy)C-Quw z0e9f2haD7adoG-U#Q&kvi?pfG5391?ci0zn3K|c?ermFuZ1qTq7qWBMWCGDc-r(Rj zSKDdibctCt4Y?~4oWxL+h~u915d=uYTXD@fnH{U@!XAgt0jF60Gl_9(|t=r0lJpFJ&feSr1csp#O=-H$)I5&ADw&-B@dcy^$1uegpg8jE0%$85H!dV;QBmiN4TN z<16Pci^r=95(J5Ga5JoEDU;9s&?ZLW&wgRtqFO*{}O#M=G&sm)1D+mV8T5m%(*tFK809Chas*#I0&9~UK@o;NH$ z!v2n{bm~)-KKnXv-rMMgYmD~18`c?0*thjwi(Q{Cyry(HP59nc=d(_V==3%y2JF#) z?+vpTZSNSdP77^0SIlAWTec!gx)v68RbM(!6Xz~Khn|NEB-K~1j);O@`X`&2dJL3i zgk}$DR^ez&WzV`ndG>#8um8~Q7@lD%%CofkbVZ|oXguGYR zOcRfV&cgL%6Lj`U$onjZgJZvp^l6Y@Y0uXA>BCk`;(&@H+PMyD2N%IO z3nF1Id_8cNdQJ$l;m3m?3|^qNJ4KUDjreGY{At5Iz6AfBSK}?K7O3|uc0WAyVRs*E z!xDv;qswoGh7|p4q1H=aZ_xVtZt&F#?v+=M1q!Q~{0k_qaGS?@L@(PO>U17;ANTGg zjzn$AgJT|7lQ>U5K|ijJoxqcxr!3ND9OzAW|5(tvDaBb%(e@plfm?R}=DUWSpk)z? z?1(k_3$NIGAvxodHDj%vStcTd633?lY0a$g&g^^64dOw`xuUzxnltpclJZREph>+Aait?P!b!@S~REIx8ex!FKCV*zG`jGx@+n3W7T?ztF_>{(!bYZ@peK}SX&+` zJ9SZeCet9_>lJ6Icx186=}cttIfq?W{UrOI1z^lw#TwB22ba|C{2HMfQF&7Ly>8eN z+*kEUn1&BTqY7&Xf6fI#N>a}YtH2WLK2qtzCw>^Fj_r=WeupDeWQ^zE4fThsf6IhT zXnah1`J;qu{cs&8){{KQbIo|eZ9!PWS+eh;Q4HU9hPp$(jjNcTJUTh^BIUEqdOm-W zm-`VIo842+SR7q4cNrSb0!K|6!|qD$@Fo6FOwEBiqR$@<+g?ORl_l#qA^06c!`Xr} zNcg~+A&=@=d8gKXy^0ff<)Z&?2o+MD{Po9#7B4Bnhzo@6l?wk!RP!Tp@5OXy(9q#A zV2d+5D|QZIAIbcnu{n?y7-D?5s&!D5l@%5 zCArVpkkQxgg`cZtLojgMlMiq~SQ*U>C3*j^_P#5uiLmQd0VyJ=phP+%y$jNNl~7D* zp@S$$@6x-4j&u+Z2#C^)^p1jbB$Nb@7Lgu>&;ta>8TJ4Ei*s`>&&_v}Co`F6o_A*U zyzkn3ueE}zcbIKX#j7L`OFVd>!IFvf$mY8bJ@BDkUI{>6&ZmuB*~GR zMfF$M9&r_#1y0Y?Y~MWCiw!1-+<9wWlq@by*E#HX<*H#vZKwu7q1utnEfP&OZ|IMV zbh^J5(6wdI_eH?zbJ!G6T_0l&C?Lcq<6ZRg(hpm&DMjlb=>-RGDr9vqEU@zVjOb)ZVyarL@<$(^cLO{4B^d#MEn zC|#uT_suJmhPggFfvi`1JdVE>F|kiQhnI5Qq`dRJ^X>XkNS9CWq5#BWyHHUYh_iFu zFX!X6oUA4p5AM!YZEU3^E6Jm0yg`e!4>e3N0$!gaof2x93 z>UAv7PgDyQr^?>gaHPBcG5}V?6%%=SfxUn<1TQAdodiw{t=X6Fk7)FZOARj3s}+h+5k>i9eN7RUB^ zZMo27&tYN97Xyt@+>R{4UJ(ib4Tacjo+Un?C`rG*~xQBf`jGho+7Fo&@g)k{At*)nA-xBijPYS)%;

^@tVWk0P0d;X_w(6A|J}9 zZNzya%k{e~MYCS|u+RF|C}_9m!lS;FactxJPo7>p!ga=mfb!q-lY64{wT$ztac1kQ z^&yJwarTmF9yFmBTPZtwPFynovV!d*r;iSocC#z4hM7?tkG&ij_fIkHQxl_U%b>0V zGcpB>4-Z14UasMArhRs*%r9!)WKDhaf?QAl^=%+Ydle@jm->hTxoLPV#ZPot^y2l% zkw$I%0fJDcfNJ{edbVWwDQR4RC%9Oc1B^_06g3qB>zKwChO!FtS4*%#dk~$_^H961 z$StIw(;bIQ{EA18z!eOju(bPq__it$QLnAk{FPP}paX8RHt3=rG=1 zXx#27p>|SaDO-J-Q+su{{L6_zBy|Y|ZG9>wooG&(M9slSrG;Tw?#}$T5-nMiRN4a4 z#ZU@*NA=EW8g!{CkS!lXEuT$&7AHT)n%dc_m-|wfW|1+r2&=Z8nTei=rN%~H!Q88@ zF_@80f|l_KNQH9FTDiF<_h-tQd?bsIQP1sEu<_XSqJaTRy@h4Lycp|B2GU%iXDB(zK#n?OJ^h*J9nCpHv}r}gJU5u zzzaZS?b1_9nF8j~m?kY>ul$k=spzQI3xfH9Djg&|G5;=MeVHT94C__Wa4H{^H0*Oi z-$Q{#-nOlsGl0E0z1U}zmgBG>s1C_VsmWK90cgKV5BFHG80}M*tgs2;WMVf=#4CZK zv~o-=qVu8RXnX8IXY}bAg5mc|G*83(KAb$ZFlJ3^2|H)8c8%(N%2{E1tq2MqD5%OA zd4LU#3It6B-pOz09VGq7(o=<>9$TeSd{uielbr;fxgzB2`^h90TFGA^!^EnE(%2ZZ zlbf+raxyg=*^6EFX(+S+E^@0ecYI50VTd|xAros0r(aM+Z@oVvNBp)Qn!hOG`1XSM zT?7M1uT39G$Xh@MU6VB%0L9iQvcODLJ~6o#v(66fco%ac{mKoJ(E4O@g8UD%KZ^$y zQ}ut}$BZcw6y%|`Hwc_jm#XF+r%Z?HHnsQUo@v5aU>QoNhB}n*VlBSXGd;n0xQw)L zTs?kF@Ls^^Fux7$WZY-B3oApR_eHE?E#1@Q+aHCi*zC=)$}_W=m}d z9;AOYJZ!F4NOaeNBTBgj!E}}scMp~EeE8+!PRI6mR>T#^jh;)k%B5mPhZVyfVOEu- z-y5iB?_H}n63M2R-h%Jb4+`;%<&=M{W&B755b;yK*bCZj;)$IU-a%tOu&7T~u3RKB z8r4;#|3NJie8gT84*8YN(|LkX)+mFaX{5PYWrBK7@5(LzFvOWCr8DRZd%cZ(Oq66l zB@N6V2Gx#^Ht@PIr6cj8-^!KoBcC;`EM~|iM1pZ4GL?t)0C7QxdrP9P%n~G_a|}sq zyd&fcFCoD&5DP$6bCt{KN0+Q{scEU|4vllH!d&Oap6sW6MR{u}m0ZDmK|Utwai0LH zTS&LAQ0LN5d5X5XG8A1k$I2kQ);Z!Asv9=3iKLPi4CrMMgZ2c4I^M&Mj=8&*gIKgo z+QQM>UKBnSBElWLvJJZ_0Lvl@_4r|XArlb=4 zUd-Jw)pR@>Wl7aJ8-FG9@x7D1S#%Ne?H;dhgvV!QQR^3z0aG=`L_U7+x8Plq5W9Da z+ujO^0=}V>z3Dx5y%!l_FjMF zLgr@W-KzA-!u*V_xato&on>qt-6VGXR$N{5%7|4R1#zw$6Z0DyDAsUxK8*e|wyjwJ(!cIHLwAxng> zx}Jx-bYNxp!SXr$fL?2Mrp}OuSXNS&4+`F`f$<8<1{`p5#+47XYFbvOi1`YNoF4)GR5y>6=7vXLHv4 zlfI=uzN+5Ct2E^S{vMQ&BX4uEi1~1_P&A-GI7zJ0tx_i~+m50W^(FFX!{!e%<)L@E zL<1~b?L(gOKTSleO_6eqQXS%}U6tUcBMpoI;HzHafZE^q;sE9m*Gj?}F=|VwQR55? zxf!^B+XQnP&kJ|*y;yMXC8P-;-S|GGo9(pSSI&SKKCaqXZGQGE9N@5yZutcNtecxw z{l`~J%2cwnf^F_IjY+h|^SM_lRR5l2yBFa3`b!V7Os>OLC0Vv*z4{EzQPx$Yf-`rc zpe+6Ya5e1EZJ~lNr`Y38E^{cDr%^F*qQN5V0W_s(Bt{s7}35x(t3@!(7QFgm_j8Wuyo6$ zcW~v^kk(+xk3VhBj{|woIX&0le6T2B9=8#*7%*`NkV6#XeH)*@6xOlTL|7`ai0Wmp^{)DI&}FT z1wlYN(0!hY>&$sOw#E*Mq#CHqmPtN}y*iXD!ZyqH-ql5!$J**k#7a?_VoOp%kifN3 zVM%1-t6!%J9$SDU5OmO@M74WY&|x zWV&Xraa0{II^n1Q;g#@}P>f*l_5rzc@*Ah+Kv;BK!LkMqaQoSYtYX zvy{^;{q}}OA?ChmL#dgR$%iLEK6@CbE?PX|0?~iDZ%(D#*X<|O$_8X@KWY?4cgDyx zzsLWPV|-!A)Ntigy*QO_?X!Jr}mJ2lx>2Ou|-E0CV>!!q%xNF*L2p>?@Ir6;j3UJ>-uLA?UgWEv|P(sQ~)7J*ss>3c5*yctGDGqf@~GMTZOk-Ht)H(n2{94^MovF5#9*I0b54(OY6! zHR%Let*YJa6M}?^Eaevf@z_%#KVQS<{xVX8MJiEYH|#9`;9rFdA9NK722iN%BSQS` zw=$b-CvjPUES(VEY70O8O6y2D-R8yX2PZ_>CDk4Ljd^j%xV$Yu^IgpXO z#NM>}T-tvRjkQ`PE{T+>;F{El*Myr%s}(IoEZGa@36#|ij*2`03#-B-?Fmx~@8GZO zzq%95<#kAcT=>z}Z@iMgg_@=hfPtILmkx zZ5lY86ZhsCNtv5)egoc|1H*_&z@|O}6fC3eKQ4WdbX^kGgF7XA*4_p9AjhH79l!FP z#@h#iCM|`Y4VE7{#&t@~b9)aHkx`m;bP22Cnc<=k?crEM9I`RQKg5UTt6888>)&w> z@O!(sf`rAIxBWlkpO}g#v@-ETDevLq?U|yE7Vahzw-izw^!AAfb$`9M7I*0LKH_A8 z6kDJ|;>5u}^}DC@!F-gYw(ifo731!&3-%U^ia)+Xmhw8LdY{u%80KyTJsaF&4Bdtd zjogS`oMx4P)=8bsJFA3ctD@!9?Lf8ab5>m#d}r@44{`b!2q@ahXq6wd&ulCkl(}jz zu}i$x$rxtwcrrEB^w57KRWD6S-YnEmt2xOnQcB=p`V*2;CO5&C6v zxRzt^v1MGVUoQ=(y|2UI3VREwP(>|zg-Y@U;0{rI`3_5SwQbgo&~217xnan;VuF%* z%i}#iQ)DBQwXSN>Mp3!YH$?aRtt-(QK-X(JBz&FPbx9em0zXs22`7!ehE zByi$p&^I*PH?f?btHpu`NO3Q3nd@UJB<`$deRn$}18JMg^ro@tov(ZHW~F~MuP)7F zb$J5LvT1<=PZ$ZvGa2iC-H&#kuCSo2jsA zz*wf+gxIsv84NYks3m%7=yGj9mTSH)2h%CDyzU*+!aBTxL$gD*x9hrP9|wY(GLI|P z1fdNB(&?ue9~71YmA6z%b@3mwi#hFi`{INE5*3uQb3j9v#rc)QE}5o~vuEgy!z-Z{ zA*QT{SC;&wibnqP4BjYF6}w+hM9d!CU?r?;qr#g+vx+Hb9mBq@`|KJ&ot6tuBr6(G zT04XoaE(dc5whOZmm3rfc7F{%{YXI@*9j`2*s3wjr$C0an20ByKB34eiEC*d{2XHV zoH0mmchQP^(`lm7MkP!iOuNnoMF^S0x#Y^7hj2LpO99_>;au&%&VmSzJ%UT= z%XNL6)xv~{Xi70S4QdgVHzt2Qw0t zP_)r)^mjf``=7%yh07!QcT8T3LTIZ3?#$=9y2x4|vv9A;lj{?MS*^wW0ejoskVARr zJ}kdHyx1YjzM@s+B)UMt5?21C09#GJiyY5Bf#kuPzH-AI__Tc!_H6Hobw@T2p_ zS2VOs^inFFlhL0PoV!xC>)1)kF65h7;jbz9WiwSQ*nc_=6asU#{qwNjb*I#E)bDbc zJ_qr1R^dto@z1IqwXAE5Sr4uRM&K-&*k1p^NJ_~>hb$x*#;&eB!^INO7f!HWP+$LV zJwF^}-SZ0F4gW`W!y%xH#5XM>tkcYW#jY(H*TLmVYnc~U4oVQ4j7%% zY}mBpbUB==uzAN>tv$U_<@My~B1J1BH4l9P3j5R0dfIqJIxwidt^De=kv%BiaM$_H z>E=Vrk%7zlf6Lsrc14*p5cxpSBLOmUQLZ!p@UV2!D5DsY9fj_hb_^bW`=Gs{-*{dT1@T{qOL+C_7yd5Lci>p zx#HAMO4@zz{j#MDHq{I$O+)m$SiGQuyE6Qvfd8=~Yx-ECp&8)&OVwJ|TI7PinE*tsfQ3cY?&{ zy}JJNPp3ZJC`EL=4>v56stFU4|arR+DaPZxwd4?oh7AP zS~u{eB`-DK4D4q?nuS5ncb8xJJ-OE(v;74|;?&(ichO!>UgLOWpa7`Fwu^W=C{K4{ zh$;(eQ@G9Muj680S>Lna59S0d_26`e@_at2*Efq-{#0p57M1h|YYkOo)$Zu`N-J$p zo+$_R!-9joME`J<{yJ|I`JBkr3}&R4I*A}RQc)`=Y4X2+QVP*QhHq_TW_mp!Uu-1y zoY@dHTadJ=IlV3|_pF2sxQ?a$J^7DoGt^s+uM_(@RA+z=E;D&drG;Etl8+>d;LO2< z@9v7Lic@epFVsg?hui#ui?5#9GM}l#EqQL4W>%zrSx$&LskiFbQrz^5db_95qD{Y? zwr`Qk@ZnagHZm_jE`KRhQOeep-qP?I_SLF|1^xM>Wg1%MdhPPwjU7bwkO5r6^zBZ_ zKAI-)Ls`PfY>Of{%@euU(mlD(#b<=ygbu~na5L@G;^ud{==ggEp-neW79fxr)B~&J zkv^~w8WQLG{$zJacGA}WcD3VBn-A;FUZd}u1*wV(e+<36u9d4A0wse`2z7($a zx6v(guup*=h0B0pa_c`CK(cLbIT@Hx{ihtu4^~?N{kEu(RUBy|_q4EruT;m{y=Fp3)`p0e?{YF z+$v8cyotnH5sS}b8{@ul^lT5l!=G6L3tLWfYSyalaZu2P_i+3mQ675T)@EN}vkT(6 zO9A5NvbB3-Qf;0$Sx2MA9x~MHBb4VhE-4w`{_7`x{U!+1HY1Z}pm)CN!8+uz06JD3 z6@pS0Q}ryxZ!>=!_lcalksl2xGHsRR(sV5e- zdN+y0ZQ6^&AYB6u9ch*=roOMw+Sut!zE$;#>7Oohoph-9-wf=ueUx|CyuOQ9^u(K8 zvndIOa@va@rE9Q$hmyVVbl_EQ<msW@GB)IrXhq zvG@VAF3V{yYy_2^&iuxYz}xZ)yM$3Dh8QVz8w&3`sIW)3A=$mP`P56>{agNo{;Wa0wS5)^EDvXHk}* z(Dd6uLc!GJ;=4tPqpbF=hP3^IFxHt}UG;g|0ROmD6Kw4_+BN>2hBzMO4stYuy8Z$(C{|Qbm2V8w$#?t z*uKp6jvR;Lx)-Q_81As(;2bL87D?vwd9L?WL39ZyL{J~&Lv3q*Yi4a}WjdLCc6?%m zduWCpJUFv!3gJFcwX>KPJYO58PfzfNVVD0MhJD^JEIe``JZvCnln}4I$`ILT+1VTPyy$n3c!B&w(xt559uWZ#`u)@$5hghZ zeZ_}@GU>sFz0tEN*3&7ZrjtivsmQg^n@?Op_%hr0xz+Q7U{X8!V8;?}4%J;cX&z)3 znQzL4RHZuuGg2m7P)qFE;FF;@DM>U{)9-b)I(--jX}NFwv?-$NKK!19?Fm&k1Qze; z{B;$6tX_{o9=&O0P-~P;zLV}!V`uwg&nC-onpM!<5 z2wgmE9LMsWql;-z!OWdqXGLdiLE4Rdrzu;FChsU_+`=3im}&FSW~pdr<(nwhWWNEc z2@SI0wvVPcECsXAg-u1~p^Z2pL2Szs_3V@do=YyjK`w7FR`?R?boG2%1C12ca~4Z_ zf3m3kZH;OY+_=+b>B1KEF7o0?#57Ij?gw`To{&1~G-KM@1Nn zsKQA}J)zTSG2=++{9UV+`9N4#_U|We8?5`d|H4_38?n|^VE$vzBaG&kERy$njh}DK zm0yChpF8Rv=J!bB(tE&JMn+r0a}J1c8nkK*E%Z|OZ<~>{bRSgE(|oD1t|i~l>h~<` z9n1Zo)+`T*EklLhBJ=)?-_0JqHg?e-w}O=<8ro+ z(v!Ai$uC{{-LW6OOEE+C2XOrTpAg_9{9mE%Kbx9=%Pjxd`tOhby+i+E;lGja-$?lX z83}2CeO?@)`7P$B&k2XjwQZh%g8}9*1%R_nHOR_IeEUDUF5Q~^s9Qd`-Y(SW`Kj{s z|2iB<4o@M4xc@!)?+LQeqmTo-dA Date: Thu, 6 Sep 2018 13:53:53 +0100 Subject: [PATCH 116/116] Update sensor.twitch.markdown (#6201) * Update sensor.twitch.markdown * Add setup instructions --- source/_components/sensor.twitch.markdown | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index d1265c1b1d5..660488a7675 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -16,6 +16,10 @@ ha_iot_class: "Cloud Polling" The `twitch` platform will allow you to monitor [Twitch](http://www.twitch.tv/) channel status from within Home Assistant and setup automation based on the information. +## {% linkable_title Setup %} + +Create a new app at "Register Your Application" in the [Twitch developer portal](https://glass.twitch.tv/console/apps). Then get the **Client ID** for the new app. + ## {% linkable_title Configuration %} To use Twitch with your installation, add the following to your `configuration.yaml` file: @@ -24,12 +28,17 @@ To use Twitch with your installation, add the following to your `configuration.y # Example configuration.yaml entry sensor: platform: twitch + client_id: YOUR_TWITCH_CLIENT_ID channels: - channel1 - channel2 ``` {% configuration %} +clientid: + description: Your Twitch client ID. + required: true + type: string channels: description: List of channels. required: true