From 40773d9845d292b5ad93c4b108e7e73c0aeb8cd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wr=C3=B3bel?= Date: Mon, 23 Oct 2017 05:07:14 -0400 Subject: [PATCH 01/48] Add instructions for multi-user configuration (#3721) --- source/_components/google_assistant.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 040c76c7821..8d54e38324f 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -102,3 +102,8 @@ homeassistant: 7. Back on the main app draft page. Click `Test Draft`. That will take you to the simulator (which won't work) so just close that window. 8. Open the Google Assistant app and go into `Settings > Home Control` 9. Click the `+` sign, and near the bottom, you should have `[test] your app name`. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices. +10. If you want to allow other houshold users to control the devices: + 1. Go to the developer console using address from point 4. + 2. Under the gear icon, click `Permissions` + 3. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role + 4. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 7. From 7efe57852345c3e1a70aef59ba14fc997b6ad8eb Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 12:02:03 +0200 Subject: [PATCH 02/48] Fix sentence (fixes #3713) (#3734) --- source/_docs/backend.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/backend.markdown b/source/_docs/backend.markdown index 23659871a0e..01b28b17a49 100644 --- a/source/_docs/backend.markdown +++ b/source/_docs/backend.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -The frontend of Home Assistant is running with [Python 3](https://www.python.org/). +The backend of Home Assistant is running with [Python 3](https://www.python.org/). The [Architecture page](/developers/architecture/) show the details about the elements running in the background of Home Assistant. From 33a6bd4e49770fe78d4dc239369b006329fa8095 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 12:20:42 +0200 Subject: [PATCH 03/48] Add details about bugfix releases --- source/developers/releasing.markdown | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/source/developers/releasing.markdown b/source/developers/releasing.markdown index 1963ea07f27..55ef646a995 100644 --- a/source/developers/releasing.markdown +++ b/source/developers/releasing.markdown @@ -60,6 +60,15 @@ Checkout the `master` branch and run `script/release` to publish the new release ### {% linkable_title Social media %} -1. Use [hootsuite] to publish a link to the release post on social media. +1. Use [hootsuite](https://hootsuite.com/dashboard) to publish a link to the release post on social media. -[hootsuite]: https://hootsuite.com/dashboard +## {% linkable_title Bugfix Release %} + +1. Checkout `master` and update it. `git checkout master && git pull --rebase` +2. Create a new release branch from `master`. `git checkout -b release-0-56-2` +3. Cherry-pick the PRs which were milestoned. +4. Update `homeassistant/const.py` with the correct version number (increment `PATCH_VERSION`) and push that commit to release branch. +5. Create a pull request from the release branch to `master` with the upcoming release number as the title. +6. Merge pull request (DO NOT SQUASH!). Use `Merge pull request`. +7. Go to [releases](https://github.com/home-assistant/home-assistant/releases), click `Draft a new release` and tag a new release on the `master` branch. "Tag version" and "Release title" are the version number (`O.x` for major version, `0.x.y` for minor and bug fix releases). Release description is the text from PR. Press "Publish release" to finish the process. +8. [Publish](/developers/releasing/#python-package-index) the new release on PyPI. From 33c982d7614296e72301fb2861e4acb11d4f64b9 Mon Sep 17 00:00:00 2001 From: Phill Price Date: Mon, 23 Oct 2017 11:24:58 +0100 Subject: [PATCH 04/48] remove ssl and port in configuration.yaml (#3691) * remove ssl and port in configuration.yaml Make clear to remove SSL and port in configuration.yaml to avoid 502 errors * Update nginx_proxy.markdown * Minor change --- source/_addons/nginx_proxy.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_addons/nginx_proxy.markdown b/source/_addons/nginx_proxy.markdown index 7f14e50bee6..318b9768d9c 100644 --- a/source/_addons/nginx_proxy.markdown +++ b/source/_addons/nginx_proxy.markdown @@ -9,7 +9,9 @@ sharing: true footer: true --- -Setup a SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generate certificate before you start this add-on. +Setup a SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on. + +In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid a HTTP 502 error. ```json From 1d8d68ddfc2da520fe61dc4e30a1456ae2504432 Mon Sep 17 00:00:00 2001 From: Nicholas Griffin Date: Mon, 23 Oct 2017 14:55:31 +0100 Subject: [PATCH 05/48] Update Arlo Control Panel with away mode variable (#3732) * Update Arlo Control Panel with away mode variable Just a simple change to add a description about adding an away mode to the Arlo Control Panel. * Remove blank line --- source/_components/alarm_control_panel.arlo.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/alarm_control_panel.arlo.markdown b/source/_components/alarm_control_panel.arlo.markdown index c58bb46d992..bc94d594a54 100644 --- a/source/_components/alarm_control_panel.arlo.markdown +++ b/source/_components/alarm_control_panel.arlo.markdown @@ -29,3 +29,4 @@ alarm_control_panel: Configuration variables: - **home_mode_name**: (*Optional*): Arlo base station does not have a built-in home mode. You can map one of your custom modes to home assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app. +- **away_mode_name**: (*Optional*): Like the home mode, the Arlo base station does not have a built-in away mode, however, you can map a custom mode from the Arlo app to Home Assistant with this variable, just make sure the name matches exactly what you have set up in the Arlo app. From 84ebf01d15cebf482a26f4b03ad85cb211833742 Mon Sep 17 00:00:00 2001 From: Erik-jan Riemers Date: Mon, 23 Oct 2017 16:00:42 +0200 Subject: [PATCH 06/48] Point to component used in recorder (#3712) * Update recorder.markdown * It's a platform and not a component --- source/_components/recorder.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index b96abb90a48..49117b4974e 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -52,8 +52,8 @@ recorder: - weblink - updater entities: - - sun.sun # Don't record sun data - - sensor.last_boot + - sun.sun # Don't record sun data + - sensor.last_boot # Comes from 'systemmonitor' sensor platform - sensor.date ``` From ec4f19a51aa95fa96ff0d9bfb42740b5cbcccff0 Mon Sep 17 00:00:00 2001 From: Hugo Gresse Date: Mon, 23 Oct 2017 16:08:09 +0200 Subject: [PATCH 07/48] Maybe fix SQL indentation in warning node (#3668) --- source/_components/sensor.onewire.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 19396863493..aaa616d8dab 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -37,12 +37,12 @@ When an interface adapter is used, sensors can be accessed on Linux hosts via [o This component has been modified to work with devices with multiple sensors which will cause a discontinuity in recorded values. Existing devices will receive a new ID and therefore show up as new devices. If you wish to maintain continuity it can be resolved in the database by renaming the old devices to the new names. -Connect to your database using the instructions from [home-assistant.io/docs/backend/database/](https://home-assistant.io/docs/backend/database/). Check the names of sensors: +Connect to your database using the instructions from [home-assistant.io/docs/backend/database/](https://home-assistant.io/docs/backend/database/). Check the names of sensors: ```sql SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10; ``` -Alter the names of sensors using the following examples: +Alter the names of sensors using the following examples: ```sql UPDATE states SET entity_id='sensor._temperature' WHERE entity_id LIKE 'sensor.%' AND attributes LIKE '%\u00b0C%'; From c18e26dd074ae878f615d883c4dd3a66b631f6b9 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 18:19:14 +0200 Subject: [PATCH 08/48] Update for 0.56.2 (#3736) --- _config.yml | 6 +++--- source/_posts/2017-10-21-release-56.markdown | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/_config.yml b/_config.yml index fb78ca7c0c5..60aeac7847b 100644 --- a/_config.yml +++ b/_config.yml @@ -140,11 +140,11 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 56 -current_patch_version: 1 -date_released: 2017-10-22 +current_patch_version: 2 +date_released: 2017-10-23 # 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-0561---october-22" +patch_version_notes: "#release-0562---october-23" # Minor release (Example #release-0431---april-25): diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown index 2f228c63872..593d4ef1f98 100644 --- a/source/_posts/2017-10-21-release-56.markdown +++ b/source/_posts/2017-10-21-release-56.markdown @@ -58,6 +58,13 @@ Why not observe your [Travis CI](https://travis-ci.org) jobs with Home Assistant - Fix device update / entity_id with names ([@pvizeli] - [#10029]) - fix temperature/humidity sensors valid values ([@bieniu] - [#10024]) ([sensor.xiaomi_aqara docs]) +## {% linkable_title 0.56.2 - October 23 %} + +- Fix gateway illumination sensor value ([@bieniu] - [#10045]) ([sensor.xiaomi_aqara docs]) +- Fix device update/`entity_id` with names ([@rytilahti] - [#10053]) ([switch.tplink docs]) +- Remove warning component / Update event trigger for UI created ([@pvizeli] - [#10060]) + + ## {% 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 ffc3c44c9dd951c75a997905e5bde1dbc3e06eb9 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 19:27:07 +0200 Subject: [PATCH 09/48] Fix link --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index 60aeac7847b..1c6a0ee81c4 100644 --- a/_config.yml +++ b/_config.yml @@ -146,5 +146,5 @@ date_released: 2017-10-23 # 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-0562---october-23" +patch_version_notes: "#0562---october-23" # Minor release (Example #release-0431---april-25): From 37d6cccfc5e8efa37e22cf74bb0471ee8be01b19 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Mon, 23 Oct 2017 19:04:07 +0100 Subject: [PATCH 10/48] updated docs to add path details --- source/_components/google_assistant.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 8d54e38324f..4a2d6e8a0be 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -62,8 +62,8 @@ homeassistant: ### {% linkable_title Setup %} -1. Install the [gactions CLI](https://developers.google.com/actions/tools/gactions-cli) (you'll use this later) -2. Create a new file named `project.json` and replace the `[YOUR HOME ASSISTANT URL]` below with the URL you use to access Home Assistant. +1. Install the [gactions CLI](https://developers.google.com/actions/tools/gactions-cli) (you'll use this later) - you can download this anywhere, just remember where you put it for later (and don't forget to run `chmod +x gactions`) +2. Create a new file named `project.json` (in the same directory you downloaded `gactions` to) and replace the `[YOUR HOME ASSISTANT URL]` below with the URL you use to access Home Assistant. Note: This must be an HTTPS URL to work. ```json @@ -91,7 +91,7 @@ homeassistant: 2. Go to Build under the Actions SDK box 3. Copy the command that looks like: `gactions update --action_package PACKAGE_NAME --project doctest-2d0b8` -4. Replace `PACKAGE_NAME` with `project.json` and run that command from the same directory you saved `project.json` in. It should output a URL like `https://console.actions.google.com/project/doctest-2d0b8/overview` Go there. +4. Replace `PACKAGE_NAME` with `project.json` and run that command from the same directory you saved `project.json` in (you'll need to put `./` before `gactions` so that it reads `./gactions`). It should output a URL like `https://console.actions.google.com/project/doctest-2d0b8/overview` - go there. 5. You'll need to fill out most of the information on that page, but none of it really matters since you won't be addressing the App directly, only through the Smart Home functionality built into Google Assistant. 6. The final item on that page `Account linking` is required for your app to interact with Home Assistant. 1. Grant type: `Implicit` From 81d23248ec1ed8d35ed31e0657c63ecbb9ae8d99 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 21:49:46 +0200 Subject: [PATCH 11/48] Add PRs --- source/_posts/2017-10-21-release-56.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown index 593d4ef1f98..97699b6b47d 100644 --- a/source/_posts/2017-10-21-release-56.markdown +++ b/source/_posts/2017-10-21-release-56.markdown @@ -357,6 +357,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [#9959]: https://github.com/home-assistant/home-assistant/pull/9959 [#9963]: https://github.com/home-assistant/home-assistant/pull/9963 [#9997]: https://github.com/home-assistant/home-assistant/pull/9997 +[#10045]: https://github.com/home-assistant/home-assistant/pull/10045 +[#10053]: https://github.com/home-assistant/home-assistant/pull/10053 +[#10060]: https://github.com/home-assistant/home-assistant/pull/10060 [@Bahnburner]: https://github.com/Bahnburner [@Boltgolt]: https://github.com/Boltgolt [@ChristianKuehnel]: https://github.com/ChristianKuehnel From fbbaeecf6bddbb32501969fffdc9ab32ae022647 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 22:18:08 +0200 Subject: [PATCH 12/48] Add Android IP Webcam docs --- .../camera.android_ip_webcam.markdown | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 source/_components/camera.android_ip_webcam.markdown diff --git a/source/_components/camera.android_ip_webcam.markdown b/source/_components/camera.android_ip_webcam.markdown new file mode 100644 index 00000000000..04c6e41d8e8 --- /dev/null +++ b/source/_components/camera.android_ip_webcam.markdown @@ -0,0 +1,27 @@ +--- +layout: page +title: "Android IP Webcam Camera" +description: "Instructions how to integrate Android IP Webcam cameras within Home Assistant." +date: 2015-07-11 0:36 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Camera +logo: android_ip_webcam.png +ha_release: "0.40" +ha_iot_class: "Local Polling" +--- + + +The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used. + +To enable only the camera in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +camera: + - platform: mjpeg + mjpeg_url: http://IP_ADDRESS:8080/video +``` + From f4700243a11417cbca265f2fbe5ff2af8f4fd746 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 23 Oct 2017 22:43:49 +0200 Subject: [PATCH 13/48] Add example --- source/_components/android_ip_webcam.markdown | 37 ++++++++++++++++++- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index 2823143f968..5a62ccefdeb 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Local Polling" The `android_ip_webcam` component turns an Android phone into a network camera with multiple viewing options. -It's setup as an M-JPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list. +It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list. To set it up, download [the IP Webcam app][app], and add the following information to your `configuration.yaml` file: @@ -49,7 +49,7 @@ Sensors: - motion - pressure -Settings: +Settings (Switches): - exposure_lock - ffc @@ -61,4 +61,37 @@ Settings: - whitebalance_lock - video_recording +## {% linkable_title Full example %} + +```yaml +# Example configuration.yaml entry +android_ip_webcam: + - host: 192.168.1.202 + port: 8000 + sensors: + - audio_connections + - battery_level + - battery_temp + - battery_voltage + - light + - motion + - pressure + switches: + - exposure_lock + - ffc + - focus + - gps_active + - night_vision + - overlay + - torch + - whitebalance_lock + - video_recording + - host: 192.168.1.203 + port: 8000 + sensors: + - light + switches: + - torch +``` + [app]: https://play.google.com/store/apps/details?id=com.pas.webcam From 2cfea1e430e4c50b8f528c0a4da337bbe28b1ec2 Mon Sep 17 00:00:00 2001 From: Uli Date: Sun, 22 Oct 2017 10:40:42 +0200 Subject: [PATCH 14/48] fixed dead link to retrieving access token for xiaomi vacuum and switch (#3709) --- source/_components/switch.xiaomi_miio.markdown | 2 +- source/_components/vacuum.xiaomi_miio.markdown | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/switch.xiaomi_miio.markdown b/source/_components/switch.xiaomi_miio.markdown index e4375733237..f8d03291d0d 100644 --- a/source/_components/switch.xiaomi_miio.markdown +++ b/source/_components/switch.xiaomi_miio.markdown @@ -17,7 +17,7 @@ The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Currently, the supported features are `on`, `off`. If the device provides the current load, it will be reported. -Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. +Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. To add a plug to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 17f608a4e75..884d840339f 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -28,7 +28,7 @@ Currently supported features are: - `set_fanspeed` - remote control of your robot. -Please follow [Retrieving the Access Token](/components/vacuum.xiaomi/#retrieving-the-access-token) to retrieve the API token used in +Please follow [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to retrieve the API token used in `configuration.yaml`. ## {% linkable_title Configuring the Platform %} From 1e87488ae02d437e5cb511ed58e51ac763f8c39c Mon Sep 17 00:00:00 2001 From: Taylor Peet Date: Mon, 23 Oct 2017 23:44:52 -0700 Subject: [PATCH 15/48] Readability changes to min max sensor docs (#3749) --- source/_components/sensor.min_max.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index ec6907c1ca5..db4db382a48 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -14,9 +14,9 @@ ha_release: "0.31" --- -The `min_max` sensor platform is consuming the state from other sensors and determine the minimum, maximum, and the mean of the collected states. The sensor will always show you the highest/lowest value which was received from your all monitored sensors. If you have spikes in your values, it's recommended filter/equalize your values with a [statistics sensor](/components/sensor.statistics/) first. +The `min_max` sensor platform consumes the state from other sensors to determine the minimum, maximum, and the mean of the collected states. The sensor will always show you the lowest/highest value which was received from all monitored sensors. If you have spikes in your values, it's recommended to filter/equalize your values with a [statistics sensor](/components/sensor.statistics/) first. -It's an alternative to the [template sensor](/components/sensor.template/)'s `value_template:` to get the average of multiple sensors. +This sensor is an alternative to the [template sensor](/components/sensor.template/)'s `value_template:` to get the average of multiple sensors. ```yaml {% raw %}{{ ((float(states.sensor.kitchen_temperature.state) + @@ -25,9 +25,9 @@ It's an alternative to the [template sensor](/components/sensor.template/)'s `va }}{% 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 the unit of measurement is `ERR`. +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`. -To enable the minimum/maximum sensor, add the following lines to your `configuration.yaml`: +To enable the `min_max` sensor, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry From 342278294003508c5293de2a77bb8025a57ee2c3 Mon Sep 17 00:00:00 2001 From: Taylor Peet Date: Mon, 23 Oct 2017 23:59:26 -0700 Subject: [PATCH 16/48] Fix unintended typo in Bayesian Documentation (#3748) Got distracted and typed before/after instead of below/above --- source/_components/binary_sensor.bayesian.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index b5d20c509ff..d17b957b6f5 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -40,7 +40,7 @@ Configuration variables: - **entity_id** (*Required*): Name of the entity to monitor. - **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`. - **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`. - - **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations, requiring `before` and/or `after` instead of `to_state`. + - **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations, requiring `below` and/or `above` instead of `to_state`. - **to_state** (*Required*): The target state. - **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`. - **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary`. From 4f4ffe895776e13660761efd3bc7f7081f50ac09 Mon Sep 17 00:00:00 2001 From: Taylor Peet Date: Tue, 24 Oct 2017 00:00:18 -0700 Subject: [PATCH 17/48] Readability updates to statistics sensor docs (#3750) --- source/_components/sensor.statistics.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index d37adc192fa..01abb92ca24 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -14,7 +14,7 @@ ha_release: "0.30" --- -The `statistics` sensor platform is consuming the state from other sensors. Beside the maximal and the minimal value also the total, the mean, the median, the variance, and the standard deviation are as attributes available. If it's a binary sensor then only the state changes are counted. +The `statistics` sensor platform consumes the state from other sensors. Besides the maximum and the minimum values, the total, mean, median, variance and the standard deviation are also available as attributes. If it's a binary sensor then only state changes are counted. 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 recoder 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. From 10ec5092f935e0d405f1d1b4c0009798e1f40eef Mon Sep 17 00:00:00 2001 From: DubhAd Date: Tue, 24 Oct 2017 08:02:15 +0100 Subject: [PATCH 18/48] Updating Z-Wave links Updating the navigation links for Z-Wave --- source/_includes/asides/docs_navigation.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index cd1fb5c0601..98b5ef661c7 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -93,8 +93,10 @@
  • {% active_link /docs/z-wave/ Z-Wave %}
      +
    • {% active_link /docs/z-wave/adding/ Adding devices %}
      • +
    • {% active_link /docs/z-wave/control-panel/ The Z-Wave control panel %}
    • {% active_link /docs/z-wave/controllers/ Controllers %}
      • -
    • {% active_link /docs/z-wave/settings/ Modifying Settings %}
      • +
    • {% active_link /docs/z-wave/devices/ Devices %}
    • {% active_link /docs/z-wave/device-specific/ Device Specific %}
    • From 86a65e03e58f93bfb245a58cc13d89fbf4f105c5 Mon Sep 17 00:00:00 2001 From: jvimont Date: Tue, 24 Oct 2017 09:51:50 +0200 Subject: [PATCH 19/48] Add info in connection problem section --- source/_components/xiaomi_aqara.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 7ebc568b642..373d9c3d99b 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -178,3 +178,4 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - Try to set `discovery_retry: 10`. - Try to disable and then enable LAN access. - Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch. +- If you are using Home Assistant in Docker, use --net=host in your docker run. From 5d28e8266be3b0c44c2165d481e9021002cdb532 Mon Sep 17 00:00:00 2001 From: ntalekt Date: Tue, 24 Oct 2017 02:16:38 -0700 Subject: [PATCH 20/48] added note: type names differ from entity names (#3746) * added note: type names differ from entity names * Minor changes --- .../_components/sensor.systemmonitor.markdown | 54 +++++++++++-------- 1 file changed, 31 insertions(+), 23 deletions(-) diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 3ec9bbcb338..283e302217f 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -35,30 +35,38 @@ Configuration variables: The table contains types and their argument to use in your `configuration.yaml` file. -| Type (`type:`) | Argument (`arg:`) | +| Type (`type:`) | Argument (`arg:`) | +| :------------------ |:--------------------------| +| disk_use_percent | Path, eg. `/` | +| disk_use | Path, eg. `/` | +| disk_free | Path, eg. `/` | +| memory_use_percent | | +| memory_use | | +| memory_free | | +| swap_use_percent | | +| swap_use | | +| swap_free | | +| load_1m | | +| load_5m | | +| load_15m | | +| network_in | Interface, eg. `eth0` | +| network_out | Interface, eg. `eth0` | +| packets_in | Interface, eg. `eth0` | +| packets_out | Interface, eg. `eth0` | +| ipv4_address | Interface, eg. `eth0` | +| ipv6_address | Interface, eg. `eth0` | +| processor_use | | +| process | Binary, e.g. `octave-cli` | +| last_boot | | +| since_last_boot | | + +**Note**: Some `type:` names used in the `configuration.yaml` file differ from the entity names. + +| Sensor type | Entity ID | | :------------------ |:-------------------------| -| disk_use_percent | Path, eg. `/` | -| disk_use | Path, eg. `/` | -| disk_free | Path, eg. `/` | -| memory_use_percent | | -| memory_use | | -| memory_free | | -| swap_use_percent | | -| swap_use | | -| swap_free | | -| load_1m | | -| load_5m | | -| load_15m | | -| network_in | Interface, eg. `eth0` | -| network_out | Interface, eg. `eth0` | -| packets_in | Interface, eg. `eth0` | -| packets_out | Interface, eg. `eth0` | -| ipv4_address | Interface, eg. `eth0` | -| ipv6_address | Interface, eg. `eth0` | -| processor_use | | -| process | Binary, eg. `octave-cli` | -| last_boot | | -| since_last_boot | | +| memory_free | sensor.ram_available | +| memory_use_percent | sensor.ram_used | +| processor_use | sensor.cpu_used | ## {% linkable_title Linux specific %} From 4ffb7222c4eac7ff333a7fcdbfe80d00cdc94469 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 24 Oct 2017 11:17:27 +0200 Subject: [PATCH 21/48] Update toon docs (#3752) --- source/_components/climate.toon.markdown | 2 +- source/_components/sensor.toon.markdown | 2 +- source/_components/switch.toon.markdown | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/climate.toon.markdown b/source/_components/climate.toon.markdown index 78bd06be1ca..6822b9038c5 100644 --- a/source/_components/climate.toon.markdown +++ b/source/_components/climate.toon.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Toon" +title: "Toon Climate" description: "Instructions how to integrate Toon Climate devices within Home Assistant." date: 2017-10-21 12:00 sidebar: true diff --git a/source/_components/sensor.toon.markdown b/source/_components/sensor.toon.markdown index 54a069b0cc3..79e04e8202c 100644 --- a/source/_components/sensor.toon.markdown +++ b/source/_components/sensor.toon.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Toon" +title: "Toon Sensor" description: "Instructions how to integrate Toon Climate devices within Home Assistant." date: 2017-10-21 12:00 sidebar: true diff --git a/source/_components/switch.toon.markdown b/source/_components/switch.toon.markdown index 679ce3aa787..ffc63e22e2b 100644 --- a/source/_components/switch.toon.markdown +++ b/source/_components/switch.toon.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Toon" +title: "Toon Switch" description: "Instructions how to integrate Toon Climate devices within Home Assistant." date: 2017-10-21 12:00 sidebar: true From 21e16613456f475685130411b35579cd4d208ccf Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 24 Oct 2017 11:21:01 +0200 Subject: [PATCH 22/48] Add link to Docker docs --- source/_components/xiaomi_aqara.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 373d9c3d99b..0dc1b12dcc3 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -178,4 +178,4 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - Try to set `discovery_retry: 10`. - Try to disable and then enable LAN access. - Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch. -- If you are using Home Assistant in Docker, use --net=host in your docker run. +- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`. From a7ccbf18d4fdb7609f19231b6eb80f969b722ed0 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Tue, 24 Oct 2017 11:36:41 +0100 Subject: [PATCH 23/48] Fixing some tabs that snuck in --- source/_docs/z-wave/entities.markdown | 32 +++++++++++++-------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown index 0d48e989d66..79bcc03045d 100644 --- a/source/_docs/z-wave/entities.markdown +++ b/source/_docs/z-wave/entities.markdown @@ -29,11 +29,11 @@ Devices (usually sensors) that support the Alarm command class will create entit - **alarm_type**: Reports the type of the sensor - **0**: General purpose - - **1**: Smoke sensor - - **2**: Carbon Monoxide (CO) sensor - - **3**: Carbon Dioxide (CO2) sensor - - **4**: Heat sensor - - **5**: Water leak sensor + - **1**: Smoke sensor + - **2**: Carbon Monoxide (CO) sensor + - **3**: Carbon Dioxide (CO2) sensor + - **4**: Heat sensor + - **5**: Water leak sensor - **6**: Access control ### {% linkable_title Alarm Level %} @@ -114,10 +114,10 @@ The meaning of the `alarm_level` entity depends on the nature of the alarm senso ### {% linkable_title Access Control %} - **access_control**: These *may* vary between brands - - **22**: Open - - **23**: Closed - - **254**: Deep sleep - - **255**: Case open + - **22**: Open + - **23**: Closed + - **254**: Deep sleep + - **255**: Case open If your device has an `access_control` entity, but not a `binary_sensor` equivalent, you can use a [template binary sensor](omponents/binary_sensor.template/) to create one: @@ -140,13 +140,13 @@ sensor: - **burglar**: These *may* vary between brands - **0**: Not active - - **2**: Smoke (?) - - **3**: Tamper - - **8**: Motion - - **22**: Open - - **23**: Closed - - **254**: Deep sleep - - **255**: Case open + - **2**: Smoke (?) + - **3**: Tamper + - **8**: Motion + - **22**: Open + - **23**: Closed + - **254**: Deep sleep + - **255**: Case open If your device has an `burglar` entity, but not a `binary_sensor` equivalent, you can use a [template binary sensor](omponents/binary_sensor.template/) to create one: From 726029170f992665113c6ac19f13654325e0f5ae Mon Sep 17 00:00:00 2001 From: DubhAd Date: Tue, 24 Oct 2017 11:39:54 +0100 Subject: [PATCH 24/48] And some missing raw tags --- source/_docs/z-wave/entities.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown index 79bcc03045d..a8d7c5eea7b 100644 --- a/source/_docs/z-wave/entities.markdown +++ b/source/_docs/z-wave/entities.markdown @@ -129,11 +129,11 @@ sensor: sensor_class: opening friendly_name: "Friendly name here" value_template: >- - {%- if is_state('sensor.YOUR_SENSOR_access_control', '22') -%} + {% raw %}{%- if is_state('sensor.YOUR_SENSOR_access_control', '22') -%} open {%- else -%} closed - {%- endif -%} + {%- endif -%}{% endraw %} ``` ### {% linkable_title Burglar %} @@ -157,12 +157,12 @@ sensor: YOUR_SENSOR: sensor_class: motion friendly_name: "Friendly name here" - value_template: >- - {%- if is_state('sensor.YOUR_SENSOR_burglar', '8') -%} + value_template: >- + {% raw %}{%- if is_state('sensor.YOUR_SENSOR_burglar', '8') -%} on {%- else -%} off - {%- endif -%} + {%- endif -%}{% endraw %} ``` ### {% linkable_title Source Node ID %} From 7c4d71118f9d0e0e2e965514aaedf34dba678764 Mon Sep 17 00:00:00 2001 From: adamp237 Date: Tue, 24 Oct 2017 23:30:15 +1030 Subject: [PATCH 25/48] Change 'set_fanspeed' to 'set_fan_speed' (#3755) I tried creating a script using set_fanspeed. After much trial and error, it worked when I used set_fan_speed. Suggest this page is updated. --- source/_components/vacuum.xiaomi_miio.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 884d840339f..b702071e60a 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -25,7 +25,7 @@ Currently supported features are: - `turn_off` (stop all activity and return to dock) - `locate` - `clean_spot` -- `set_fanspeed` +- `set_fan_speed` - remote control of your robot. Please follow [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to retrieve the API token used in @@ -52,7 +52,7 @@ Configuration variables: In addition to [all of the services provided by the `vacuum` component] ]) (`turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_home`, `locate`, -`set_fanspeed` and `send_command`), the `xiaomi` platform introduces specific +`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` From 5efe58ec85b7cf7776aebd4950b0f65ec0312e70 Mon Sep 17 00:00:00 2001 From: Phil Hawthorne Date: Wed, 25 Oct 2017 06:10:35 +1100 Subject: [PATCH 26/48] Update the RFLink Docs to read better (#3758) Makes some slight adjustments to the RFLink component documentation to remove some grammer and spelling mistakes. Alos changes the domain which the docs point to, as the domain name mentioned has been moved. --- source/_components/rflink.markdown | 34 ++++++++++++++++-------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown index 3df73deaf35..26515b5f8c3 100644 --- a/source/_components/rflink.markdown +++ b/source/_components/rflink.markdown @@ -12,17 +12,17 @@ ha_category: Hub ha_release: 0.38 --- -The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). +The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors. -RFLink Gateway supports a number of RF frequencies, using a wide range of low-cost hardware. Their website provides details for various RF transmitter, receiver and transceiver modules for 433MHz, 868MHz and 2.4 GHz [here.](http://www.nemcon.nl/blog2/wiring) +RFLink Gateway supports a number of RF frequencies, using a wide range of low-cost hardware. [Their website](http://www.rflink.nl/blog2/) provides details for various RF transmitters, receivers and transceiver modules for 433MHz, 868MHz and 2.4 GHz.

    - Note: Versions later than R44 adds support for Ikea Ansluta, Philips Living Colors Gen1, MySensors devices. + Note: Versions later than R44 add support for Ikea Ansluta, Philips Living Colors Gen1 and MySensors devices.

    -A complete list of devices supported by RFLink can be found [here](http://www.nemcon.nl/blog2/devlist) +A complete list of devices supported by RFLink can be found [here](http://www.rflink.nl/blog2/devlist). This component is tested with the following hardware/software: @@ -41,7 +41,7 @@ Configuration variables: - **port** (*Required*): The path to RFLink USB/serial device or TCP port in TCP mode. - **host** (*Optional*): Switches to TCP mode, connects to host instead of to USB/serial. - **wait_for_ack** (*Optional*): Wait for RFLink to acknowledge commands sent before sending new command (slower but more reliable). Defaults to `True` -- **ignore_devices** (*Optional*): List of devices id's to ignore. Supports wildcards (*) at the end. +- **ignore_devices** (*Optional*): List of device id's to ignore. Supports wildcards (*) at the end. - **reconnect_interval** (*Optional*): Time in seconds between reconnect attempts. Complete example: @@ -58,7 +58,7 @@ rflink: ### {% linkable_title TCP mode %} -TCP mode allows connect to a RFLink device over TCP/IP network. This is for example useful if placing the RFLink device next to the HA server is not optimal or desired (eg: bad reception). +TCP mode allows you to connect to an RFLink device over a TCP/IP network. This is useful if placing the RFLink device next to the HA server is not optimal or desired (eg: bad reception). To expose the USB/serial interface over TCP on a different host (Linux) the following command can be used: @@ -71,7 +71,7 @@ Other methods of exposing the serial interface over TCP are possible (eg: ESP826 Tested with Wifi serial bridge [esp-link V2.2.3](https://github.com/jeelabs/esp-link/releases/tag/v2.2.3) running on a NodeMCU (ESP8266 Wifi module) with ESP8266 TXD0 (pin D10) and RXD0 (pin D9) connected to Arduino MEGA 2560 RX (Pin 2) and TX (Pin 3) respectively.

    -Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for Ikea Ansluta and Living Colors) +Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for Ikea Ansluta and Philips Living Colors)

    @@ -87,7 +87,7 @@ rflink: ### {% linkable_title Adding devices Automatically %} -In order to have your devices being detected and added automatically, you need to add the following to the configuration. +In order to have your devices discovered automatically, you need to add the following to the configuration. When pressing the button on the physical remote, RFLink detects the signal and the device should be added automatically to Home Assistant. ```yaml @@ -104,7 +104,7 @@ sensor: ### {% linkable_title Ignoring devices %} -RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology. +The RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology. For example: @@ -121,7 +121,9 @@ rflink: This configuration will ignore the button `1` of the `newkaku` device with ID `000001`, all devices of the `digitech` protocol and all switches of the `kaku` protocol device with codewheel ID `1`. -Wildcards only work at the end of the ID, not in the middle of front! +

    +Wildcards only work at the end of the ID, not in the middle or front! +

    ### {% linkable_title Device support %} @@ -129,16 +131,16 @@ Even though a lot of devices are supported by RFLink, not all have been tested/i ### {% linkable_title Device Incorrectly Identified %} -If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFLink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.nemcon.nl/blog2/faq#RFFind) +If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFLink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.rflink.nl/blog2/faq#RFFind) -### {% linkable_title Technical overview %} +### {% linkable_title Technical Overview %} -- The`rflink` Python module a asyncio transport/protocol is setup that fires an callback for every (valid/supported) packet received by the RFLink gateway. -- This component uses this callback to distribute 'rflink packet events' over Home Assistant's bus which can be subscribed to by entities/platform implementations. -- The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet id's. +- The`rflink` Python module is a asyncio transport/protocol which is setup to fire a callback for every (valid/supported) packet received by the RFLink gateway. +- This component uses this callback to distribute 'rflink packet events' over [Home Assistant's event bus](https://home-assistant.io/docs/configuration/events/) which can be subscribed to by entities/platform implementations. +- The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet ID's. - Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component. -### {% linkable_title Debug logging %} +### {% linkable_title Debug Logging %} For debugging purposes or context when investigating issues you can enable debug logging for Rflink with the following config snippet: From 86a281bfb00a5ff9011750ed7c5ea98d7c795be9 Mon Sep 17 00:00:00 2001 From: Phil Hawthorne Date: Wed, 25 Oct 2017 06:12:33 +1100 Subject: [PATCH 27/48] Update MQTT docs for consistency (#3759) Makes some updates to the MQTT docs pages for spelling and grammar, and also consistency. --- source/_components/climate.mqtt.markdown | 2 +- source/_components/cover.mqtt.markdown | 2 +- source/_components/fan.mqtt.markdown | 6 +++--- source/_components/light.mqtt.markdown | 10 +++++----- source/_components/lock.mqtt.markdown | 8 ++++---- source/_components/notify.mqtt.markdown | 2 +- source/_components/switch.mqtt.markdown | 12 ++++++------ source/_components/vacuum.mqtt.markdown | 2 +- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 162acec8257..bde12c97ccd 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -13,7 +13,7 @@ ha_release: 0.55 ha_iot_class: "Local Polling" --- -The `mqtt` climate platform let you control your MQTT enabled HVAC devices. +The `mqtt` climate platform lets you control your MQTT enabled HVAC devices. The platform currently works in optimistic mode, which means it does not obtain states from MQTT topics, but it sends and remembers control commands. diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index fb501ea9bae..e466514cadd 100755 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -65,7 +65,7 @@ Configuration variables: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this platform. +In this section you will find some real life examples of how to use this platform. ### {% linkable_title Full configuration without tilt %} diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 43e2da29363..82c5193ba30 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -13,9 +13,9 @@ ha_release: 0.27 ha_iot_class: depends --- -The `mqtt` fan platform let you control your MQTT enabled fans. +The `mqtt` fan platform lets you control your MQTT enabled fans. -In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the fan will be `false`. +In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`. When a `state_topic` is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from `state_topic`). @@ -56,7 +56,7 @@ Configuration variables: - **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `medium`, and `high`.

    -Make sure that your topic is an exact match. `some-topic/` and `some-topic` are different topics. +Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

    ## {% linkable_title Examples %} diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index b90de5ae569..26496730b0a 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -14,11 +14,11 @@ ha_iot_class: depends The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values. -In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off. +In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. -When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from device (message from `state_topic`). +When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`). -Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect light operation. +Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation. ```yaml # Example configuration.yml entry @@ -61,7 +61,7 @@ Configuration variables: - **xy_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the XY value.

    - Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics. + Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

    @@ -83,7 +83,7 @@ Configuration variables: ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you will find some real life examples of how to use this sensor. ### {% linkable_title Brightness and RGB support %} diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index d66c4c8c76b..6f91de7d133 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -13,9 +13,9 @@ ha_release: 0.15 ha_iot_class: depends --- -The `mqtt` lock platform let you control your MQTT enabled locks. +The `mqtt` lock platform lets you control your MQTT enabled locks. -In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with `RETAIN` flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be false/unlocked. +In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be `false` / unlocked. When a `state_topic` is not available, the lock will work in optimistic mode. In this mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the device (message from `state_topic`). @@ -43,12 +43,12 @@ Configuration variables: - **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.

    -Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics. +Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.

    ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this lock. +In this section you will find some real life examples of how to use this lock. ### {% linkable_title Full configuration %} diff --git a/source/_components/notify.mqtt.markdown b/source/_components/notify.mqtt.markdown index 34b4b8c0d7b..7aefb8743f0 100644 --- a/source/_components/notify.mqtt.markdown +++ b/source/_components/notify.mqtt.markdown @@ -12,7 +12,7 @@ ha_category: Notifications ha_iot_class: depends --- -The MQTT notification support is different than the other [notification](/components/notify/) platforms. It is a service. This means that you don't have to create a configuration entry but you need to provide more details while calling the service. +The MQTT notification support is different than the other [notification](/components/notify/) platforms. It is a service. This means that you don't have to create a configuration entry but you need to provide more details when calling the service. **Call Service** section from the **Developer Tools** allows you to send MQTT messages. Choose *mqtt/publish* from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index a32b94b0c2c..4ad0a6c1f87 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -13,13 +13,13 @@ ha_release: 0.7 ha_iot_class: depends --- -The `mqtt` switch platform let you control your MQTT enabled switch. +The `mqtt` switch platform lets you control your MQTT enabled switches. -In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with `RETAIN` flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off. +In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT switch will receive an instant state update after subscription, and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. -When a `state_topic` is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from device (message from `state_topic`). +When a `state_topic` is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from the device (message from `state_topic`). -Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect switch operation. +Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect switch operation. To enable this switch in your installation, add the following to your `configuration.yaml` file: @@ -46,12 +46,12 @@ Configuration variables: - **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.

    -Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics. +Make sure that your topic matches exactly. `some-topic/` and `some-topic` are different topics.

    ## {% linkable_title Examples %} -In this section you find some real life examples of how to use this sensor. +In this section you will find some real life examples of how to use this sensor. ### {% linkable_title Full configuration %} diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown index 34f98401703..df5a01a8cf8 100644 --- a/source/_components/vacuum.mqtt.markdown +++ b/source/_components/vacuum.mqtt.markdown @@ -12,7 +12,7 @@ ha_category: Vacuum ha_release: 0.54 --- -The `mqtt` component allows you to control your MQTT-enabled vacuum. +The `mqtt` vacuum component allows you to control your MQTT-enabled vacuum. To add your MQTT vacuum to your installation, add the following to your `configuration.yaml` file: From 025c6ab51d804db65ca98f723d37845e59fcc2d4 Mon Sep 17 00:00:00 2001 From: Ryan Bahm Date: Tue, 24 Oct 2017 22:25:24 -0700 Subject: [PATCH 28/48] Added some punctuation to the last paragraph (#3770) For greater clarity. --- source/developers/maintenance.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/developers/maintenance.markdown b/source/developers/maintenance.markdown index 0a509231e84..4f48326ceb3 100644 --- a/source/developers/maintenance.markdown +++ b/source/developers/maintenance.markdown @@ -36,7 +36,7 @@ If you update the requirements of a component/platform through the `REQUIREMENTS $ script/gen_requirements_all.py ``` -Start a test run of Home Assistant if that was successful include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description. +Start a test run of Home Assistant. If that was successful, include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description. From 2c7eedd97016c0a89b09c1109778237d6ffaccb8 Mon Sep 17 00:00:00 2001 From: Nicholas Griffin Date: Wed, 25 Oct 2017 06:34:22 +0100 Subject: [PATCH 29/48] Fixing Typo that was mentioned in #3764 (#3766) --- source/_data/glossary.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml index 1b18f1539de..f1c27b24443 100644 --- a/source/_data/glossary.yml +++ b/source/_data/glossary.yml @@ -5,7 +5,7 @@ - topic: Service description: "[Services](/docs/scripts/service-calls/) are called to perform actions." - topic: Event - description: When somethings happen. + description: When something happens. - topic: Entity description: An entity is the representation of a single device, unit or web service. - topic: Device From 0927f6b4bb32505b68a9ae39a405b0fe4fc6e141 Mon Sep 17 00:00:00 2001 From: Nicholas Griffin Date: Wed, 25 Oct 2017 07:50:22 +0100 Subject: [PATCH 30/48] Cleaning up some other things in glossary (#3768) * Fixing Typo that was mentioned in #3764 * Cleaning up some other things in glossary As I was making the other commit (#3766) I noticed some other things in the glossary that could be changed. One of the main things is that each example read differently so there was a lot of jumping between how examples were written, I've made them a bit more unified. I also added a bit more explanatory text and added some links as suggested in #3764. I made this a seperate pull because I figured it might be a bit more opinionated than the typo error. * Missed discovery. * Add quotes --- source/_data/glossary.yml | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml index f1c27b24443..d9e75f950af 100644 --- a/source/_data/glossary.yml +++ b/source/_data/glossary.yml @@ -1,42 +1,43 @@ - topic: Platform - description: A platform makes the connection to a specific software or hardware platform. The `pushbullet` platform works with the service from pushbullet.com. + description: "[Platforms](/docs/configuration/platform_options/) make the connection to a specific software or hardware platform. For example, the `pushbullet` platform works with the service pushbullet.com to send notifications." - topic: Component - description: "The components provide the core logic for the functionality in Home Assistant. Like `notify` provides sending notifications." + description: "[Components](/docs/configuration/platform_options/) provide the core logic for the functionality in Home Assistant. Like `notify` provides sending notifications." - topic: Service description: "[Services](/docs/scripts/service-calls/) are called to perform actions." - topic: Event + description: "An [event](/docs/configuration/events/) is when something happens." description: When something happens. - topic: Entity - description: An entity is the representation of a single device, unit or web service. + description: An [entity](/docs/configuration/platform_options/) is the representation of a single device, unit or web service. - topic: Device - description: "Usually this is a physical unit which can do or observe something." + description: "A device is usually a physical unit which can do or observe something." - topic: hass - description: "Often used abbreviation for Home Assistant." + description: "HASS or hass is often used as an abbreviation for Home Assistant." - topic: Discovery - description: The automatic setup of zeroconf/mDNS and uPnP devices after they are discovered. + description: Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered. - topic: Groups description: "Groups are a way to organize your entities into a single unit." - topic: Automation - description: "Capability to call a service based on a simple or complex trigger. Automation allows a condition such as sunset to cause an event, such as a light turning on." + description: "[Automations](/docs/automation/) offer the capability to call a service based on a simple or complex trigger. Automation allows a condition such as sunset to cause an event, such as a light turning on." - topic: Trigger - description: "Values or conditions of a platform that are defined to cause an automation to run." + description: "A [trigger](/docs/automation/trigger/) is a set of values or conditions of a platform that are defined to cause an automation to run." - topic: Template - description: "An automation definition can include variables for the service or data from the trigger values. This allows automations to generate dynamic actions." + description: "A [template](/docs/automation/templating/) is an automation definition that can include variables for the service or data from the trigger values. This allows automations to generate dynamic actions." - topic: Script - description: "A component that allows users to specify a sequence of actions to be executed by Home Assistant when turned on" + description: "[Scripts](/docs/scripts/) are components that allow users to specify a sequence of actions to be executed by Home Assistant when turned on" - topic: Scene - description: "You can create scenes that capture the states you want certain entities to be. For example a scene can specify that light A should be turned on and light B should be bright red." + description: "Scenes capture the states you want certain entities to be. For example a scene can specify that light A should be turned on and light B should be bright red." - topic: hassio - description: "An operating system to manage Home Assistant easily using various HASS.io add-ons" + description: see Hass.io - topic: HADashboard - description: "HADashboard is a modular, skinnable dashboard for Home Assistant that is intended to be wall mounted, and is optimized for distance viewing." + description: "[HADashboard](/docs/ecosystem/hadashboard/) is a modular, skinnable dashboard for Home Assistant that is intended to be wall mounted, and is optimized for distance viewing." - topic: Hass.io - description: "Hass.io is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration and can easily be extended" + description: "Hass.io is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration, and can easily be extended" - topic: Cookbook - description: "Home Assistant configuration examples of the community" + description: "The [Cookbook](/cookbook/) contains a set of configuration examples of Home Assistant from the community" - topic: Packages - description: "Packages allow to bundle different component configuations together." + description: "Packages allow you to bundle different component configuations together." - topic: Customizing - description: "Customization allows overwriting default parameter of the devices in the configuration." + description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameter of your devices in the configuration." - topic: Zones - description: "Area used for presence detection." + description: "Zones are areas that can be used for presence detection." From 9eeb6cefeb210d6f0e1809dbd740c7ca1fcf7af3 Mon Sep 17 00:00:00 2001 From: ntalekt Date: Tue, 24 Oct 2017 23:51:19 -0700 Subject: [PATCH 31/48] Updated: Added missing components (#3761) --- source/_components/discovery.markdown | 70 +++++++++++++++------------ 1 file changed, 38 insertions(+), 32 deletions(-) diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 726da20c46c..62f9c0c1b34 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -14,25 +14,29 @@ ha_category: Other Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect: - * Google Chromecast - * Belkin WeMo switches - * Philips Hue - * Netgear routers - * Plex media server - * Panasonic Viera - * Roku media player - * Sonos Speakers - * Yamaha media player - * Logitech media server (Squeezebox) - * DirecTV - * Apple TV - * Yeelight Sunflower Bulb - * Linn / Openhome - * Denon Network Receivers - * Bose Soundtouch speakers - * Axis Communications security devices - * IKEA Trådfri (Tradfri) - * Harmony Hub + * [Apple TV](https://home-assistant.io/components/apple_tv/) + * [Axis Communications security devices](https://home-assistant.io/components/axis/) + * [Belkin WeMo switches](https://home-assistant.io/components/wemo/) + * [Bluesound speakers](https://home-assistant.io/components/media_player.bluesound/) + * [Bose Soundtouch speakers](https://home-assistant.io/components/media_player.soundtouch/) + * [Denon network receivers](https://home-assistant.io/components/media_player.denonavr/) + * [DirecTV receivers](https://home-assistant.io/components/media_player.directv/) + * [Frontier Silicon internet radios](https://home-assistant.io/components/media_player.frontier_silicon/) + * [Google Cast](https://home-assistant.io/components/media_player.cast/) + * [IKEA Trådfri (Tradfri)](https://home-assistant.io/components/tradfri/) + * [Linn / Openhome](https://home-assistant.io/components/media_player.openhome/) + * [Logitech Harmony Hub](https://home-assistant.io/components/remote.harmony/) + * [Logitech media server (Squeezebox)](https://home-assistant.io/components/media_player.squeezebox/) + * [Netgear routers](https://home-assistant.io/components/device_tracker.netgear/) + * [Panasonic Viera](https://home-assistant.io/components/media_player.panasonic_viera/) + * [Philips Hue](https://home-assistant.io/components/light.hue/) + * [Plex media server](https://home-assistant.io/components/media_player.plex/) + * [Roku media player](https://home-assistant.io/components/media_player.roku/) + * [SABnzbd downloader](https://home-assistant.io/components/sensor.sabnzbd/) + * [Samsung TVs](https://home-assistant.io/components/media_player.samsungtv/) + * [Sonos speakers](https://home-assistant.io/components/media_player.sonos/) + * [Yamaha media player](https://home-assistant.io/components/media_player.yamaha/) + * [Yeelight Sunflower bulb](https://home-assistant.io/components/light.yeelightsunflower/) It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user. @@ -54,25 +58,27 @@ Valid values for ignore are: * `apple_tv`: Apple TV * `axis`: Axis Communications security devices - * `bluesound` + * `belkin_wemo`: Belkin WeMo switches + * `bluesound`: Bluesound speakers * `bose_soundtouch`: Bose Soundtouch speakers - * `denonavr`: Denon Network Receivers - * `directv`: DirecTV - * `frontier_silicon` - * `google_cast`: Google Chromecast - * `harmony`: Harmony Hub - * `ikea_tradfri`: IKEA Trådfri - * `logitech_mediaserver`: Logitech media server - Squeezebox player - * `openhome`: Linn/Openhome + * `denonavr`: Denon network receivers + * `directv`: DirecTV receivers + * `frontier_silicon`: Frontier Silicon internet radios + * `google_cast`: Google Cast + * `harmony`: Logitech Harmony Hub + * `ikea_tradfri`: IKEA Trådfri (Tradfri) + * `logitech_mediaserver`: Logitech media server (Squeezebox) + * `netgear_router`: Netgear routers + * `openhome`: Linn / Openhome * `panasonic_viera`: Panasonic Viera * `philips_hue`: Philips Hue * `plex_mediaserver`: Plex media server * `roku`: Roku media player - * `sabnzbd` - * `samsung_tv`: Samsung TV - * `sonos`: Sonos Speakers + * `sabnzbd`: SABnzbd downloader + * `samsung_tv`: Samsung TVs + * `sonos`: Sonos speakers * `yamaha`: Yamaha media player - * `yeelight`: Yeelight Sunflower Bulb + * `yeelight`: Yeelight Sunflower bulb

    Home Assistant must be on the same network as the devices for uPnP discovery to work. From 204b856e12a21fc0dff67f96f3b00c179a8b2556 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 25 Oct 2017 10:53:12 +0100 Subject: [PATCH 32/48] Added setup link for Z-Wave --- source/_includes/asides/docs_navigation.html | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 98b5ef661c7..b6c07f6f979 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -93,6 +93,7 @@

  • {% active_link /docs/z-wave/ Z-Wave %}
      +
    • {% active_link /docs/z-wave/installation/ Configuring the Z-Wave component %}
    • {% active_link /docs/z-wave/adding/ Adding devices %}
    • {% active_link /docs/z-wave/control-panel/ The Z-Wave control panel %}
    • {% active_link /docs/z-wave/controllers/ Controllers %}
      • From 37c527e446af65e02c3bafc8fc06db3a6a9f1066 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 25 Oct 2017 10:54:08 +0100 Subject: [PATCH 33/48] Removed outdated info Removed info about versions before 0.4x --- source/_docs/z-wave/installation.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 1bb9c9236f1..17b948a0051 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -10,8 +10,6 @@ footer: true redirect_from: /getting-started/z-wave-installation/ --- -As of version 0.45, Home Assistant automatically installs python-openzwave from PyPI as needed. This also introduced the integrated Z-Wave control panel, removing the need for the OpenZWave control panel. - There is one dependency you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems): ```bash From cc614c75fce09ca0d481db213216100aa9a076ac Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Wed, 25 Oct 2017 12:17:52 +0200 Subject: [PATCH 34/48] Update addon_config.markdown --- source/developers/hassio/addon_config.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/developers/hassio/addon_config.markdown b/source/developers/hassio/addon_config.markdown index 7ce40cd18bd..9ec5bae332f 100644 --- a/source/developers/hassio/addon_config.markdown +++ b/source/developers/hassio/addon_config.markdown @@ -123,6 +123,7 @@ The config for an add-on is stored in `config.json`. | audio | no | Boolean. Mark this add-on to use internal an audio system. The available environment variables are `ALSA_INPUT` and `ALSA_OUTPUT` which provide internal information to access alsa. | gpio | no | Boolean. If this is set to True, `/sys/class/gpio` will map into add-on for access to GPIO interface from kernel. Some library need also `/dev/mem` and `SYS_RAWIO` for read/write access to this device. | stdin | no | Boolean. If that is enable, you can use the STDIN with Hass.io API. +| legacy | no | Boolean. If the docker image have no hass.io labels, you can enable the legacy mode to use the config data. | options | yes | Default options value of the add-on | schema | yes | Schema for options value of the add-on. It can be `False` to disable schema validation and use custom options. | image | no | For use with Docker Hub. From 67331387623528df0e04fa60fd5beb203c91db4b Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 25 Oct 2017 11:37:19 +0100 Subject: [PATCH 35/48] Update about Hass.io Added link to the Hass.io Z-Wave docs, and a note that the pre-reqs don't apply to it. --- source/_docs/z-wave/installation.markdown | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 17b948a0051..2c5cad179ca 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /getting-started/z-wave-installation/ --- -There is one dependency you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems): +On Linux platforms (other than Hass.io) there is one dependency you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems): ```bash $ sudo apt-get install libudev-dev @@ -104,6 +104,10 @@ device_config: ### {% linkable_title Finding the controller path on Linux %} +

      + To find the path of your Z-Wave USB stick or module, connect it to your system and run: ```bash From 74bccbbe3272e363e347da209ce32613aca7dbce Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 25 Oct 2017 19:41:56 +0100 Subject: [PATCH 36/48] Fixed sliders to numbers --- source/_cookbook/dim_and_brighten_lights.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_cookbook/dim_and_brighten_lights.markdown b/source/_cookbook/dim_and_brighten_lights.markdown index 83ea160c797..98222e719cf 100644 --- a/source/_cookbook/dim_and_brighten_lights.markdown +++ b/source/_cookbook/dim_and_brighten_lights.markdown @@ -124,7 +124,7 @@ script: {{ next }}{% endraw %} - service_template: > - {% raw %}{% if states.light.YOUR_LIGHT.attributes.brightness|default(0)|int < states('input_slider.light_maximum')|int %} + {% raw %}{% if states.light.YOUR_LIGHT.attributes.brightness|default(0)|int < states('input_number.light_maximum')|int %} script.turn_on {% else %} script.turn_off @@ -155,7 +155,7 @@ script: {{ next }}{% endraw %} - service_template: > - {% raw %}{% if states.light.YOUR_LIGHT.attributes.brightness|default(0)|int > states('input_slider.light_minimum')|int %} + {% raw %}{% if states.light.YOUR_LIGHT.attributes.brightness|default(0)|int > states('input_number.light_minimum')|int %} script.turn_on {% else %} script.turn_off From c17103c3c1d0572de0f84289a339887a4258583c Mon Sep 17 00:00:00 2001 From: Adam Mills Date: Wed, 25 Oct 2017 15:42:16 -0400 Subject: [PATCH 37/48] Better documentation for state attributes (#3772) * Better documentation for state attributes * Fix extra tick * Extra notes for new components --- source/developers/development_states.markdown | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/source/developers/development_states.markdown b/source/developers/development_states.markdown index 4a8d1b81a8f..369f87ea54b 100644 --- a/source/developers/development_states.markdown +++ b/source/developers/development_states.markdown @@ -124,13 +124,17 @@ After a start or a restart of Home Assistant the component will be visible in th

      -In order to expose attributes of your component, you will need to define a method called `state_attributes` which will return a dictionary of attributes: +In order to expose attributes for a platform, you will need to define a property called `device_state_attributes` on the entity class, which will return a dictionary of attributes: ``` @property -def state_attributes(self): - """Return the attributes of the entity.""" +def device_state_attributes(self): + """Return device specific state attributes.""" return self._attributes ``` +

      +Entities also have a similar property `state_attributes`, which normally doesn't need to be defined by new platforms. This property is used by base components to add standard sets of attributes to a state. Example: The light component uses `state_attributes` to add brightness to the state dictionary. If you are designing a new component, you should define `state_attributes` instead. +

      + To get your component included in the Home Assistant releases, follow the steps described in the [Submitting improvements](https://home-assistant.io/developers/#submitting-improvements) section. Basically you only need to move your component in the `homeassistant/component/` directory of your fork and create a Pull Request. From a6b848085e00fa67d2be86f2d7a8025845d373d3 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 25 Oct 2017 21:09:15 +0100 Subject: [PATCH 38/48] Corrected sensor to binary_sensor --- source/_docs/z-wave/entities.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown index a8d7c5eea7b..6949439b9b8 100644 --- a/source/_docs/z-wave/entities.markdown +++ b/source/_docs/z-wave/entities.markdown @@ -122,7 +122,7 @@ The meaning of the `alarm_level` entity depends on the nature of the alarm senso If your device has an `access_control` entity, but not a `binary_sensor` equivalent, you can use a [template binary sensor](omponents/binary_sensor.template/) to create one: ``` -sensor: +binary_sensor: - platform: template sensors: YOUR_SENSOR: @@ -151,7 +151,7 @@ sensor: If your device has an `burglar` entity, but not a `binary_sensor` equivalent, you can use a [template binary sensor](omponents/binary_sensor.template/) to create one: ``` -sensor: +binary_sensor: - platform: template sensors: YOUR_SENSOR: From 67193615a6b35b0a11790410cfede8d6d8f9a42d Mon Sep 17 00:00:00 2001 From: DubhAd Date: Wed, 25 Oct 2017 21:19:13 +0100 Subject: [PATCH 39/48] Other fixes Apparently I don't get to make up configuration variables. Removing it anyway since few other components have it as an option --- source/_docs/z-wave/entities.markdown | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown index 6949439b9b8..c95c539c5e4 100644 --- a/source/_docs/z-wave/entities.markdown +++ b/source/_docs/z-wave/entities.markdown @@ -126,13 +126,12 @@ binary_sensor: - platform: template sensors: YOUR_SENSOR: - sensor_class: opening friendly_name: "Friendly name here" value_template: >- {% raw %}{%- if is_state('sensor.YOUR_SENSOR_access_control', '22') -%} - open + on {%- else -%} - closed + off {%- endif -%}{% endraw %} ``` @@ -155,7 +154,6 @@ binary_sensor: - platform: template sensors: YOUR_SENSOR: - sensor_class: motion friendly_name: "Friendly name here" value_template: >- {% raw %}{%- if is_state('sensor.YOUR_SENSOR_burglar', '8') -%} From 5a73466d3b8b9e6203db0ec5506fbbabca78ed39 Mon Sep 17 00:00:00 2001 From: Peter Epley Date: Thu, 26 Oct 2017 02:33:59 -0400 Subject: [PATCH 40/48] Update development_environment.markdown (#3781) Updated based on https://community.home-assistant.io/t/starting-development-problem-with-tox/6381/3 and experience setting up environment --- source/developers/development_environment.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/developers/development_environment.markdown b/source/developers/development_environment.markdown index 56ee50a9485..21d7651f031 100644 --- a/source/developers/development_environment.markdown +++ b/source/developers/development_environment.markdown @@ -22,7 +22,7 @@ $ sudo apt-get install python3-pip python3-dev python3-venv In order to run `script/setup` below you will need some more dependencies. ```bash -$ sudo apt-get install libssl-dev libxml2-dev libxslt1-dev libjpeg-dev libffi-dev libudev-dev +$ sudo apt-get install libssl-dev libxml2-dev libxslt1-dev libjpeg-dev libffi-dev libudev-dev zlib1g-dev ```

      @@ -60,7 +60,7 @@ $ cd home-assistant $ git remote add upstream https://github.com/home-assistant/home-assistant.git ``` -### {% linkable_title Setting up virtual environment (optional) %} +### {% linkable_title Setting up virtual environment %} If you plan on providing isolation to your environment using [`venv`](https://docs.python.org/3.4/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment. From 455d41639cbfe9568a1dafcb6e6cfffc462a4a47 Mon Sep 17 00:00:00 2001 From: Derek Date: Thu, 26 Oct 2017 02:42:04 -0400 Subject: [PATCH 41/48] New entries, fixes, hyperlinks. (#3774) * New entries, fixes, hyperlinks. - Got rid of a second hass.io entry - Seems as though "hass" entry topic undercase is allowing it to bypass sorting? - Added hyperlinks to all entries - Added some new terms * Typo fix * Added frontend/themes --- source/_data/glossary.yml | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml index d9e75f950af..ba5c42f02c9 100644 --- a/source/_data/glossary.yml +++ b/source/_data/glossary.yml @@ -2,21 +2,24 @@ description: "[Platforms](/docs/configuration/platform_options/) make the connection to a specific software or hardware platform. For example, the `pushbullet` platform works with the service pushbullet.com to send notifications." - topic: Component description: "[Components](/docs/configuration/platform_options/) provide the core logic for the functionality in Home Assistant. Like `notify` provides sending notifications." +- topic: Condition + description: "[Conditions](/docs/scripts/conditions/) are an optional part of an automation that will prevent an action from firing if they are not met." - topic: Service description: "[Services](/docs/scripts/service-calls/) are called to perform actions." +- topic: Action + description: "[Actions](/docs/automation/action/) are events that fires once all triggers and conditions have been met." - topic: Event description: "An [event](/docs/configuration/events/) is when something happens." - description: When something happens. - topic: Entity - description: An [entity](/docs/configuration/platform_options/) is the representation of a single device, unit or web service. + description: "An [entity](/docs/configuration/platform_options/) is the representation of a single device, unit or web service." - topic: Device description: "A device is usually a physical unit which can do or observe something." - topic: hass - description: "HASS or hass is often used as an abbreviation for Home Assistant." + description: "HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home Assistant as well the command line tool." - topic: Discovery - description: Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered. -- topic: Groups - description: "Groups are a way to organize your entities into a single unit." + description: "[Discovery](/components/discovery/) is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered." +- topic: Group + description: "[Groups](/components/group/) are a way to organize your entities into a single unit." - topic: Automation description: "[Automations](/docs/automation/) offer the capability to call a service based on a simple or complex trigger. Automation allows a condition such as sunset to cause an event, such as a light turning on." - topic: Trigger @@ -26,18 +29,20 @@ - topic: Script description: "[Scripts](/docs/scripts/) are components that allow users to specify a sequence of actions to be executed by Home Assistant when turned on" - topic: Scene - description: "Scenes capture the states you want certain entities to be. For example a scene can specify that light A should be turned on and light B should be bright red." -- topic: hassio - description: see Hass.io + description: "[Scenes](/components/scene/) capture the states you want certain entities to be. For example a scene can specify that light A should be turned on and light B should be bright red." - topic: HADashboard description: "[HADashboard](/docs/ecosystem/hadashboard/) is a modular, skinnable dashboard for Home Assistant that is intended to be wall mounted, and is optimized for distance viewing." +- topic: hass + description: "HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home Assistant. It is aslo the comand line tool for accessing" - topic: Hass.io - description: "Hass.io is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration, and can easily be extended" + description: "[Hass.io](/hassio/) is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration, and can easily be extended" - topic: Cookbook description: "The [Cookbook](/cookbook/) contains a set of configuration examples of Home Assistant from the community" - topic: Packages - description: "Packages allow you to bundle different component configuations together." -- topic: Customizing + description: "[Packages](/docs/configuration/packages/) allow you to bundle different component configuations together." +- topic: Customize description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameter of your devices in the configuration." -- topic: Zones - description: "Zones are areas that can be used for presence detection." +- topic: Zone + description: "[Zones](/components/zone/) are areas that can be used for presence detection." +- topic: Frontend + description: "The [frontend](/components/frontend/) is a necessary component for the UI, it is also where you can define your themes." From 87cd795a858efd304e3ab8313f523df91e6c55a1 Mon Sep 17 00:00:00 2001 From: Peter Epley Date: Thu, 26 Oct 2017 03:58:56 -0400 Subject: [PATCH 42/48] Update development_submitting.markdown (#3782) * Update development_submitting.markdown Added notes helpful for comparing and requesting a pull (ex. to avoid proposing merge of dev and master accidentally). * Update format --- source/developers/development_submitting.markdown | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/developers/development_submitting.markdown b/source/developers/development_submitting.markdown index 5e3fea51afa..919e20706b9 100644 --- a/source/developers/development_submitting.markdown +++ b/source/developers/development_submitting.markdown @@ -36,5 +36,12 @@ Submit your improvements, fixes, and new features to Home Assistant one at a tim 6. Follow [these steps](https://help.github.com/articles/creating-a-pull-request/) to create your pull request. + * On GitHub, navigate to the main page of the Home Assistant repository. + * In the "Branch" menu, choose the branch that contains your commits (from your fork). + * To the right of the Branch menu, click **New pull request**. + * Use the base branch dropdown menu to select the branch you'd like to merge your changes into, then use the compare branch drop-down menu to choose the topic branch you made your changes in. Make sure the Home Assistant branch matches with your forked branch (`dev`) else you will propose ALL committs between branches. + * Type a title and complete the provided description for your pull request. + * Click **Create pull request**. + 7. Check for comments and suggestions on your pull request and keep an eye on the [CI output](https://travis-ci.org/home-assistant/home-assistant/). From 5dfdb98b9b5c1fc0bf6116d8fef4c202ea78dd0a Mon Sep 17 00:00:00 2001 From: UiGuy Date: Thu, 26 Oct 2017 08:59:22 +0100 Subject: [PATCH 43/48] {"error":"Invalid key"} (#3780) * {"error":"Invalid key"} resolution to {"error":"Invalid key"} issue when trying to control the gateway lights via Home Assistant UI. * Minor changes --- source/_components/xiaomi_aqara.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 0dc1b12dcc3..11a2191635c 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -179,3 +179,4 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - Try to disable and then enable LAN access. - Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch. - If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`. +- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternativly an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application. From 48468bf32b8290b2db1cfefb8ac37ae3d0bd02d7 Mon Sep 17 00:00:00 2001 From: boltgolt Date: Thu, 26 Oct 2017 10:27:08 +0200 Subject: [PATCH 44/48] Update Toon docs (#3771) * Updates to Toon docs * Fixed typo * Implemented suggested fixes --- source/_components/climate.toon.markdown | 19 ++++++++++++++----- source/_components/sensor.toon.markdown | 6 +++--- source/_components/switch.toon.markdown | 8 ++++---- source/_components/toon.markdown | 5 ++--- 4 files changed, 23 insertions(+), 15 deletions(-) diff --git a/source/_components/climate.toon.markdown b/source/_components/climate.toon.markdown index 6822b9038c5..57d8708aa38 100644 --- a/source/_components/climate.toon.markdown +++ b/source/_components/climate.toon.markdown @@ -1,8 +1,8 @@ --- layout: page -title: "Toon Climate" -description: "Instructions how to integrate Toon Climate devices within Home Assistant." -date: 2017-10-21 12:00 +title: "Toon Thermostat" +description: "Instructions how to integrate Toon thermostats within Home Assistant." +date: 2017-10-22 12:00 sidebar: true comments: false sharing: true @@ -13,6 +13,15 @@ logo: toon.png ha_iot_class: "Cloud Polling" --- -The `toon` climate platform allows you to interact with your Toon device. +The `toon` climate platform allows you to interact with your Toon thermostat. For compatibility reasons, the states in Home Assistant are different from the states displayed on your Toon device and are mapped as follows: -The requirement is that you have setup the [`toon`](/components/toon/) component. + +| Home Assistant | Toon | +|:---------------|:--------| +| Performance | Comfort | +| Heat | Thuis | +| Eco | Weg | +| Cool | Slapen | + + +Please refer to the [hub component](/components/toon/) for setup instructions. diff --git a/source/_components/sensor.toon.markdown b/source/_components/sensor.toon.markdown index 79e04e8202c..fabf565aeb4 100644 --- a/source/_components/sensor.toon.markdown +++ b/source/_components/sensor.toon.markdown @@ -1,8 +1,8 @@ --- layout: page title: "Toon Sensor" -description: "Instructions how to integrate Toon Climate devices within Home Assistant." -date: 2017-10-21 12:00 +description: "Instructions how to integrate Toon climate devices within Home Assistant." +date: 2017-10-22 12:00 sidebar: true comments: false sharing: true @@ -13,6 +13,6 @@ logo: toon.png ha_iot_class: "Cloud Polling" --- -The `toon` sensor platform allows you to observe your Toon device. +The `toon` sensor platform allows you to observe the power flow in your house through your Toon. If available, gas flow, solar output, smart plug status and connected smoke detector data can also be accessed in Toon. The requirement is that you have setup the [`toon`](/components/toon/) component. diff --git a/source/_components/switch.toon.markdown b/source/_components/switch.toon.markdown index ffc63e22e2b..af4e1978501 100644 --- a/source/_components/switch.toon.markdown +++ b/source/_components/switch.toon.markdown @@ -1,8 +1,8 @@ --- layout: page -title: "Toon Switch" -description: "Instructions how to integrate Toon Climate devices within Home Assistant." -date: 2017-10-21 12:00 +title: "Toon Smart Plugs" +description: "Instructions how to integrate Toon smart plugs within Home Assistant." +date: 2017-10-22 12:00 sidebar: true comments: false sharing: true @@ -13,6 +13,6 @@ logo: toon.png ha_iot_class: "Cloud Polling" --- -The `toon` switch platform allows you to control your Toon device. +The `toon` switch platform allows you to control your smart plugs if they are connected to Toon. The requirement is that you have setup the [`toon`](/components/toon/) component. diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index fdd392e91e9..08c38f9acea 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -2,7 +2,7 @@ layout: page title: "Toon" description: "Instructions how to integrate Toon within Home Assistant." -date: 2017-10-21 12:00 +date: 2017-10-22 12:00 sidebar: true comments: false sharing: true @@ -31,7 +31,6 @@ Configuration variables: - **username** (*Required*): Username for Mijn Eneco. - **password** (*Required*): Password for Mijn Eneco. -Toon is a smart thermostat delivered by the Eneco power company in The Netherlands. It can measure energy consumption (power and gas), but also the amount of energy generated in case solar panels are connected to it. Toon also acts as a z-wave hub for supported Fibaro devices like the wall plug and the smoke detector. This component uses the [toonlib library](https://github.com/costastf/toonlib) by Costas Tyfoxylos that connects to the unofficial API on [https://toonopafstand.eneco.nl](https://toonopafstand.eneco.nl). +Toon is a smart thermostat delivered by the Eneco power company in The Netherlands. It can measure energy consumption (power and gas), but also the amount of energy generated in case solar panels are connected to it. Toon also acts as a z-wave hub for supported devices like the wall plug and the smoke detector. This component uses the [toonlib library](https://github.com/costastf/toonlib) by Costas Tyfoxylos that connects to the unofficial API on [https://toonopafstand.eneco.nl](https://toonopafstand.eneco.nl). The current version of this component supports setting any of the four built-in programs and setting the temperature manually. It polls the Toon API at 30 second intervals so the status is relatively fresh without overloading the API. - From 5884dc8df306d46b8d96c2202ec7753279fd85fc Mon Sep 17 00:00:00 2001 From: David Grant Date: Thu, 26 Oct 2017 12:17:11 -0400 Subject: [PATCH 45/48] Fixed command for installing all test requirements (#3787) previous command was giving me: (venv) dgrant@16elford:~/home-assistant$ bash pip3 install -r requirements_test_all.txt import: unable to open X server `' @ error/import.c/ImportImageCommand/364. import: unable to open X server `' @ error/import.c/ImportImageCommand/364. from: can't read /var/mail/pip /home/dgrant/home-assistant/venv/bin/pip3: pip3: line 10: syntax error near unexpected token `(' /home/dgrant/home-assistant/venv/bin/pip3: pip3: line 10: ` sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])' --- source/developers/development_testing.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/developers/development_testing.markdown b/source/developers/development_testing.markdown index a3b9f152501..b1bc38d0c29 100644 --- a/source/developers/development_testing.markdown +++ b/source/developers/development_testing.markdown @@ -42,7 +42,7 @@ $ tox -e py36 -- tests/test_core.py --duration=10 Running tox will invoke the full test suite. Even if you specify which tox target to run, you still run all tests inside that target. That's not very convenient to quickly iterate on your code! To be able to run the specific test suites without Tox, you'll need to install the test dependencies into your Python environment: ```bash -$ bash pip3 install -r requirements_test_all.txt +$ pip3 install -r requirements_test_all.txt ``` Now that you have all test dependencies installed, you can run tests on individual files: From 4b33e71440a741ba47992bd9c3b90e7b8d0588c9 Mon Sep 17 00:00:00 2001 From: misterbenj34 Date: Thu, 26 Oct 2017 18:17:49 +0200 Subject: [PATCH 46/48] Correction of line 448 (#3786) add "sudo" and remove the space before "s" --- source/_docs/ecosystem/certificates/lets_encrypt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index ad7963fae69..edc5fe6b2b3 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -445,7 +445,7 @@ To set a cron job to run the script at regular intervals: * Change to your Home Assistant user (command similar to): ```bash -$ su - s /bin/bash hass +$ sudo su -s /bin/bash hass ``` * Open the crontab: From 00844141bb30e24a6331f21100746d1ddaf5a5cc Mon Sep 17 00:00:00 2001 From: DubhAd Date: Thu, 26 Oct 2017 19:20:19 +0100 Subject: [PATCH 47/48] Added note on port forwarding --- source/_addons/duckdns.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index 9667c91e725..f54e69f0da0 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -43,3 +43,7 @@ http: ``` If you use a other port as `8123` or a SSL proxy, change the port number. + +## {% linkable_title Router configuration %} + +You'll need to forward the port you listed in your configuration (8123 in the example above) on your router to your Home Assistant system. You can find guides on how to do this on [Port Forward](https://portforward.com/) - noting that you'll only need to forward the TCP port. From 687ce971bdcbe9e4fd32671c53d51f0ff4da99fb Mon Sep 17 00:00:00 2001 From: ntalekt Date: Thu, 26 Oct 2017 15:07:54 -0700 Subject: [PATCH 48/48] Update: Config example by ntalekt (#3790) --- source/_cookbook/configuration_yaml_by_ntalekt | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 source/_cookbook/configuration_yaml_by_ntalekt diff --git a/source/_cookbook/configuration_yaml_by_ntalekt b/source/_cookbook/configuration_yaml_by_ntalekt new file mode 100644 index 00000000000..657e33b001e --- /dev/null +++ b/source/_cookbook/configuration_yaml_by_ntalekt @@ -0,0 +1,12 @@ +--- +layout: page +title: "Configuration.yaml by ntalekt" +description: "" +date: 2017-10-26 13:08 -0700 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Example configuration.yaml +ha_external_link: https://github.com/ntalekt/homeassistant +---