From 298eca2cbf448fbddd80874c07afc07d6e112b6f Mon Sep 17 00:00:00 2001 From: cogneato Date: Thu, 4 Jan 2018 12:42:22 -0700 Subject: [PATCH 01/24] small grammar fix (#4338) --- source/_addons/duckdns.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index f54e69f0da0..ed65a626c76 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -42,7 +42,7 @@ http: ssl_key: /ssl/privkey.pem ``` -If you use a other port as `8123` or a SSL proxy, change the port number. +If you use a port other than `8123` or an SSL proxy, change the port number accordingly. ## {% linkable_title Router configuration %} From 100e6832b42c5d6fc8c1b4b8a51480b9660cfb2c Mon Sep 17 00:00:00 2001 From: cogneato Date: Thu, 4 Jan 2018 12:47:24 -0700 Subject: [PATCH 02/24] Small changes to step 1 and 4 (#4337) Attempting to make it more clear to users (particularly hass.io users) that the gactions cli can be run from any pc. Replaced "install" with "download" and a few other changes. --- source/_components/google_assistant.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 95aee7b7974..5c0463589d6 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -91,7 +91,7 @@ Entity Customization Keys: ### {% linkable_title Setup %} -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`) +1. Download the [gactions CLI](https://developers.google.com/actions/tools/gactions-cli) (you'll use this later) - you can download and run this anywhere and on any machine, just remember where you put it for later (and don't forget to run `chmod +x gactions`to make it executable on mac or linux) 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. @@ -120,16 +120,16 @@ Entity Customization Keys: 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 (you'll need to put `./` before `gactions` so that it reads `./gactions` if you're running on Linux). 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 in a console from the same directory you saved `project.json` in (you'll need to put `./` before `gactions` so that it reads `./gactions` if you're running it on Linux or Windows). 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` 2. Client ID: The `client_id` from your Home Assistant configuration above 3. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth` 4. Configure your client. Add scopes for `email` and `name` - 5. Testing instructions: doesn't matter since you won't submit this app -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. If you haven't already added the configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have. + 5. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. +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. If you haven't already added the component configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have. 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: From e8a6451155656c9e97feb4c0a2ef7eb64be7f6a5 Mon Sep 17 00:00:00 2001 From: yeah Date: Thu, 4 Jan 2018 23:47:33 +0100 Subject: [PATCH 03/24] Fix typo (#4342) --- source/_addons/homematic.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_addons/homematic.markdown b/source/_addons/homematic.markdown index 1f91fe3dc79..aa1137abd0b 100644 --- a/source/_addons/homematic.markdown +++ b/source/_addons/homematic.markdown @@ -56,7 +56,7 @@ Use the following configuration in Home Assistant to use it: ```yaml homematic: - interfaces + interfaces: BidCoS-RF: host: core-homematic port: 2001 From 7eef2470bb03c2104143e357f73c30a21096f60b Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Thu, 4 Jan 2018 20:48:48 -0800 Subject: [PATCH 04/24] Add note about not using customize to checklist --- .../developers/code_review_component.markdown | 11 +++--- .../developers/code_review_platform.markdown | 36 +++++++++---------- 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/source/developers/code_review_component.markdown b/source/developers/code_review_component.markdown index 4d708290c54..9b7bdff4601 100644 --- a/source/developers/code_review_component.markdown +++ b/source/developers/code_review_component.markdown @@ -15,21 +15,22 @@ A checklist of things to do when you're adding a new component. Not all existing platforms follow the requirements in this checklist. This cannot be used as a reason to not follow them!

-### {% linkable_title Requirements %} +### {% linkable_title 1. Requirements %} 1. Requirement version pinned: `REQUIREMENTS = ['phue==0.8.1']` 2. We no longer want requirements hosted on GitHub. Please upload to PyPi. 3. Requirements should only be imported inside functions. This is necessary because requirements are installed on the fly. -### {% linkable_title Configuration %} +### {% linkable_title 2. Configuration %} 1. Voluptuous schema present for config validation 2. Default parameters specified in voluptuous schema, not in `setup(…)` 3. Schema using as many generic config keys as possible from `homeassistant.const` - 4. If having platforms, have a `PLATFORM_SCHEMA`, otherwise `CONFIG_SCHEMA`. - 5. If `PLATFORM_SCHEMA`, import base from `homeassistant.helpers.config_validation` + 4. If your component has platforms, define a `PLATFORM_SCHEMA` instead of a `CONFIG_SCHEMA`. + 5. If using a `PLATFORM_SCHEMA` to be used with `EntityComponent`, import base from `homeassistant.helpers.config_validation` + 6. Never depend on users adding things to `customize` to configure behavior inside your component. -### {% linkable_title Component/platform communication %} +### {% linkable_title 3. Component/platform communication %} 1. If you need to share global data with platforms, use the dictionary `hass.data`. `hass.data[DATA_XY]` while `XY` is the component is preferred over `hass.data[DOMAIN]`. 2. If the component fetches data that causes it's related platform entities to update, you can notify them using the dispatcher code in `homeassistant.helpers.dispatcher`. diff --git a/source/developers/code_review_platform.markdown b/source/developers/code_review_platform.markdown index 1475234123b..96f78c60a0c 100644 --- a/source/developers/code_review_platform.markdown +++ b/source/developers/code_review_platform.markdown @@ -27,28 +27,28 @@ Not all existing platforms follow the requirements in this checklist. This canno ### {% linkable_title 3. Configuration %} - 1. Volutpuous schema present for config validation + 1. Voluptuous schema present for config validation 2. Voluptuous schema extends schema from component
(e.g. `light.hue.PLATFORM_SCHEMA` extends `light.PLATFORM_SCHEMA`) 3. Default parameters specified in voluptuous schema, not in `setup_platform(…)` - 4. Schema using as many generic config keys as possible from `homeassistant.const` + 4. Your `PLATFORM_SCHEMA` should use as many generic config keys as possible from `homeassistant.const` + ```python + import voluptuous as vol -```python -import voluptuous as vol + from homeassistant.const import CONF_FILENAME, CONF_HOST + from homeassistant.components.light import PLATFORM_SCHEMA + import homeassistant.helpers.config_validation as cv -from homeassistant.const import CONF_FILENAME, CONF_HOST -from homeassistant.components.light import PLATFORM_SCHEMA -import homeassistant.helpers.config_validation as cv + CONF_ALLOW_UNREACHABLE = 'allow_unreachable' + DEFAULT_UNREACHABLE = False -CONF_ALLOW_UNREACHABLE = 'allow_unreachable' -DEFAULT_UNREACHABLE = False - -PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - vol.Required(CONF_HOST): cv.string, - vol.Optional(CONF_ALLOW_UNREACHABLE, - default=DEFAULT_UNREACHABLE): cv.boolean, - vol.Optional(CONF_FILENAME): cv.string, -}) -``` + PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ + vol.Required(CONF_HOST): cv.string, + vol.Optional(CONF_ALLOW_UNREACHABLE, + default=DEFAULT_UNREACHABLE): cv.boolean, + vol.Optional(CONF_FILENAME): cv.string, + }) + ``` + 5. Never depend on users adding things to `customize` to configure behavior inside your platform. ### {% linkable_title 4. Setup Platform %} @@ -66,7 +66,7 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ ### {% linkable_title 6. Communication with devices/services %} 1. All API specific code has to be part of a third party library hosted on PyPi. Home Assistant should only interact with objects and not make direct calls to the API. - + ```python # bad status = requests.get(url('/status')) From c624d5fc00a6b19a7cd10fd534d3cef2b8e94918 Mon Sep 17 00:00:00 2001 From: Carlo Costanzo Date: Fri, 5 Jan 2018 05:45:39 -0500 Subject: [PATCH 05/24] added instructions for configuration panel. (#4344) * added instructions for configuration panel. try searching for configuration.. it's fruitless. * Minor change --- source/_components/cloud.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/_components/cloud.markdown b/source/_components/cloud.markdown index 675f5fd5ffe..68becfd3283 100644 --- a/source/_components/cloud.markdown +++ b/source/_components/cloud.markdown @@ -22,6 +22,12 @@ cloud: Once activated, go to the configuration panel in Home Assistant and create an account and log in. There is no need to configure your router or expose your instance to the internet in any other way. +If you are not seeing the **Configuration** panel, make sure you have the following option enabled in your configuration.yaml` file. + +```yaml +config: +``` + ### {% linkable_title Amazon Alexa %} The Alexa integration allows users to control the entities via the [Home Assistant Smart Home skill for Alexa][alexa skill]. This means that you can say things like "Alexa, turn on the kitchen light" to control your local instance. From 5b873e2380fdab549c93d9249ebee799b9f42230 Mon Sep 17 00:00:00 2001 From: cdce8p <30130371+cdce8p@users.noreply.github.com> Date: Fri, 5 Jan 2018 11:53:52 +0100 Subject: [PATCH 06/24] Added Restore state info + Updated config style (#4343) * Updated input_boolean * new Configuration style * Linkable title Automation Examples * Updated input_select * new Configuration style * Services as table * Rearaged scenes * small improvments * Updated input_number * linkformat * Updated input_text * New configuration style * Update input_datetime * New configuration style * Updated recorder * New configuration style * Added Restore State Info --- source/_components/input_boolean.markdown | 32 +++++++-- source/_components/input_datetime.markdown | 51 +++++++++---- source/_components/input_number.markdown | 6 +- source/_components/input_select.markdown | 84 ++++++++++++++-------- source/_components/input_text.markdown | 41 +++++++++-- source/_components/recorder.markdown | 69 ++++++++++++++---- 6 files changed, 214 insertions(+), 69 deletions(-) diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 61e82ff846c..7608e0c7973 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -24,16 +24,34 @@ input_boolean: icon: mdi:car ``` -Configuration variables: +{% configuration %} + input_boolean: + description: Alias for the input. Multiple entries are allowed. + required: true + type: map + keys: + name: + description: Friendly name of the input. + required: false + type: String + initial: + description: Initial value whe Home Assistant starts. + required: false + type: boolean + default: false + icon: + description: Icon to display for the component. Refer to the [Customizing devices](/docs/configuration/customizing-devices/#possible-values) page for possible values. + required: false + type: icon +{% endconfiguration %} -- **[alias]** (*Required*): Alias for the input. - - **name** (*Optional*): Friendly name of the input. - - **initial** (*Optional*): Initial value when Home Assistant starts. Defaults to `False`. - - **icon** (*Optional*): Icon for entry. +### {% linkable_title Restore State %} -Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. +This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). -Here's an example of an automation using the above input_boolean. This action will only occur if the switch is on. +## {% linkable_title Automation Examples %} + +Here's an example of an automation using the above `input_boolean`. This action will only occur if the switch is on. ```yaml automation: diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 588154ca277..d056e935342 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -33,18 +33,45 @@ input_datetime: has_time: true ``` -Configuration variables: +{% configuration %} + input_datetime: + description: Alias for the datetime input. Multiple entries are allowed. + required: true + type: map + keys: + name: + description: Friendly name of the datetime input. + required: false + type: String + has_time: + description: Set to `true` if the input should have a time. At least one `has_time` or `has_date` must be defined. + required: false + type: Boolean + default: false + has_date: + description: Set to `true` if the input should have a date. At least one `has_time` or `has_date` must be defined. + required: false + type: Boolean + default: false + initial: + description: Set the initial value of this input, depending on `has_time` and `has_date`. + required: false + type: datetime | time | date + default: 1970-01-01 00:00 | 1970-01-01 | 00:00 +{% endconfiguration %} -- **[alias]** (*Required*): Alias for the datetime input. Multiple entries are allowed. - - **name** (*Optional*): Friendly name of the datetime input. - - **has_time** (*Optional*): Set to `true` if this input should have time. Defaults to `false`. - - **has_date** (*Optional*): Set to `true` if this input should have a date. Defaults to `false`. - - **initial** (*Optional*): Set the initial value of this input. Defaults to '1970-01-01 00:00'. If has_time is `false` this must be just a date (e.g.: '1970-01-01'). If has_date is `false` this must be just a time (e.g.: '15:16'). +### {% linkable_title Attributes %} -A datetime input entity's state exports several attributes that can be useful in automations and templates: +A datetime input entity's state exports several attributes that can be useful in automations and templates. -- **has_time**: `true` if this entity has time. -- **has_date**: `true` if this entity has a date. -- **year**, **month**, **day** (Only available if *has_date* is true): The year, month and day of the date. -- **hour**, **minute**, **second** (Only available if *has_time* is true): The hour, minute and second of the time. -- **timestamp**: A timestamp representing the time held in the input. If *has_date* is true, this is the UNIX timestamp of the date / time held by the input. Otherwise (i.e., if only *has_time* is true) the number of seconds since midnight representing the time held by the input. +| Attribute | Description | +| --------- | ----------- | +| `has_time` | `true` if this entity has a time. +| `has_date` | `true` if this entity has a date. +| `year`
`month`
`day` | The year, month and day of the date.
(only availabel if `has_date: true`) +| `hour`
`minute`
`second` | The hour, minute and second of the time.
(only available if `has_time: true`) +| `timestamp` | A timestamp representing the time held in the input.
If `has_date: true`, this is the UNIX timestamp of the date / time held by the input. Otherwise if only `has_time: true`, this is the number of seconds since midnight representing the time held by the input. + +### {% linkable_title Restore State %} + +This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index ecb9824772c..f3b2a0fda14 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -78,11 +78,15 @@ input_number: required: false type: string icon: - description: Icon to display in front of the box/slider in the frontend. Refer to the [Customizing devices](https://home-assistant.io/docs/configuration/customizing-devices/#possible-values) page for possible values. + description: Icon to display in front of the box/slider in the frontend. Refer to the [Customizing devices](/docs/configuration/customizing-devices/#possible-values) page for possible values. required: false type: icon {% endconfiguration %} +### {% linkable_title Restore State %} + +This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). + ## {% linkable_title Automation Examples %} Here's an example of `input_number` being used as a trigger in an automation. diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index e8cf94f94d1..a1b98fab34f 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -33,27 +33,64 @@ input_select: - Home Alone ``` -Configuration variables: - -- **[alias]** array (*Required*): Alias for the input. Multiple entries are allowed.. - - **name** (*Optional*): Friendly name of the input. - - **options** array (*Required*): List of options to choose from. - - **initial** (*Optional*): Initial value when Home Assistant starts. - - **icon** (*Optional*): Icon for entry. - -Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. +{% configuration %} + input_select: + description: Alias for the input. Multiple entries are allowed. + required: true + type: map + keys: + name: + description: Friendly name of the input. + required: false + type: String + options: + description: List of options to choose from. + required: true + type: Array + initial: + description: Initial value when Home Assistant starts. + required: false + type: Element of options + default: First element of options + icon: + description: Icon to display for the component. Refer to the [Customizing devices](/docs/configuration/customizing-devices/#possible-values) page for possible values. + required: false + type: icon +{% endconfiguration %}

Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, any variations of 'On', 'Yes', 'Y', 'Off', 'No', or 'N' (regardless of case) used as option names will be replaced by True and False unless they are defined in quotation marks.

+### {% linkable_title Restore State %} + +This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). + ### {% linkable_title Services %} -This components provide three services to modify the state of the `input_select`: +This components provide three services to modify the state of the `input_select`. -- `input_select.select_option`: This can be used to select a specific option. The option is passed as `option` attribute in the service data. -- `input_select.select_previous`: Select the previous option. -- `input_select.select_next`: Select the next option. +| Service | Data | Description | +| ------- | ---- | ----------- | +| `select_option` | `option` | This can be used to select a specific option. +| `set_options` | `options`
`entity_id(s)` | Set the options for specific `input_select` entities. +| `select_previous` | | Select the previous option. +| `select_next` | | Select the next option. + +### {% linkable_title Scenes %} + +To specify a target option in a [Scene](/components/scene/) you have to specify the target as `option` attribute: + +```yaml +# Example configuration.yaml entry +scene: + - name: Example1 + entities: + input_select.who_cooks: + option: Paulus +``` + +## {% linkable_title Automation Examples %} The following example shows the usage of the `input_select.select_option` service in an automation: @@ -87,23 +124,10 @@ automation: options: ["Item A", "Item B", "Item C"] ``` -### {% linkable_title Scenes %} - -To specify a target option in a [Scene](/components/scene/) you have to specify the target as `option` attribute: - -```yaml -# Example configuration.yaml entry -scene: - - name: Example1 - entities: - input_select.who_cooks: - option: Paulus -``` - Example of `input_select` being used in a bidirectional manner, both being set by and controlled by an MQTT action in an automation. -```yaml {% raw %} +```yaml # Example configuration.yaml entry using 'input_select' in an action in an automation # Define input_select @@ -129,7 +153,7 @@ input_select: service: input_select.select_option data_template: entity_id: input_select.thermostat_mode - option: '{{ trigger.payload }}' + option: "{{ trigger.payload }}" # This automation script runs when the thermostat mode selector is changed. # It publishes its value to the same MQTT topic it is also subscribed to. @@ -142,6 +166,6 @@ input_select: data_template: topic: "thermostatMode" retain: true - payload: '{{ states.input_select.thermostat_mode.state }}' -{% endraw %} + payload: "{{ states('input_select.thermostat_mode') }}" ``` +{% endraw %} diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 26ad4846a74..255ea31b00c 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -29,11 +29,38 @@ input_text: pattern: '[a-fA-F0-9]*' ``` -Configuration variables: +{% configuration %} + input_text: + description: Alias for the input. Multiple entries are allowed. + required: true + type: map + keys: + name: + description: Friendly name of the text input. + required: false + type: String + min: + description: Minimum length for the text value. + required: false + type: int + default: 0 + max: + description: Maximum length for the text value. + required: false + type: int + default: 100 + initial: + description: Initial value when Home Assistant starts. + required: false + type: String + default: empty + pattern: + description: Regex pattern for client side validation. + required: false + type: String + default: empty +{% endconfiguration %} -- **[alias]** (*Required*): Alias for the text input. -- **min** (*Optional*): Minimum length for the text value. Default is `0`. -- **max** (*Optional*): Maximum length for the text value. Default is `100`. -- **name** (*Optional*): Friendly name of the text input. -- **initial** (*Optional*): Initial value when Home Assistant starts. Default is empty string. -- **pattern** (*Optional*): Regex pattern for client side validation. Default is empty string, which is treated same as `.*`. +### {% linkable_title Restore State %} + +This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 86094eae18a..9a59fd8e8b3 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -25,18 +25,51 @@ To setup the `recorder` component in your installation, add the following to you recorder: ``` -Configuration variables: - -- **purge_interval** (*Optional*): (days) Enable scheduled purge of older events and states. The purge task runs every x days from when the `recorder component` is first enabled. If a scheduled purge is missed (e.g. if Home Assistant was not running) then the schedule will resume soon after Home Assistant restarts. You can use [service](#service-purge) call `recorder.purge` when required without impacting the purge schedule. -- **purge_keep_days** (*Required with `purge_interval`*): Specify number of history days to keep in recorder database after purge. -- **exclude** (*Optional*): Configure which components should be excluded from recordings. - - **entities** (*Optional*): The list of entity ids to be excluded from recordings. - - **domains** (*Optional*): The list of domains to be excluded from recordings. -- **include** (*Optional*): Configure which components should be included in recordings. If set, all other entities will not be recorded. - - **entities** (*Optional*): The list of entity ids to be included from recordings. - - **domains** (*Optional*): The list of domains to be included from recordings. -- **db_url** (*Optional*): The URL which point to your database. - +{% configuration %} + recorder: + description: Enables the recorder component. Only allowed once. + required: true + type: map + keys: + db_url: + description: The URL which points to your database. + required: false + type: URL + purge_interval: + description: Enable scheduled purge of older events and states. The purge task runs every `purge_interval` days from when the `recorder component` is first enabled. If a scheduled purge is missed (e.g if Home Assistant was not running), the schedule will resume soon after Home Assistant restarts. You can use the [service](#service-purge) call `purge` when required without impacting the purge schedule. If `purge_interval` is set, `purge_keep_days` needs to be set as well. + required: Inclusive + type: int + purge_keep_days: + description: Specify the number of history days to keep in recorder database after purge. If `purge_interval` is set, `purge_keep_days` needs to be set as well. + required: Inclusive + type: int + exclude: + description: Configure which components should be excluded + required: false + type: map + keys: + domains: + description: The list of domains to be excluded from recordings. + required: false + type: List + entities: + description: The list of entity ids to be excluded from recordings. + required: false + type: List + include: + description: Configure which components should be included in recordings. If set, all other entities will not be recorded. + required: false + type: map + keys: + domains: + description: The list of domains to be included in the recordings. + required: false + type: List + entities: + description: The list of entity ids to be included in the recordings. + required: false + type: List +{% endconfiguration %} Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like `weblink`) or rarely change (`updater` or `automation`). @@ -100,6 +133,18 @@ action: keep_days: 5 ``` +### {% linkable_title Restore State %} + +If the `recorder` component is activated, some components support `restore_state` which will restore the state of the entity after Home Assistant is started to to state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An uncomplete list of components that currently support `restore_state`: + +* [`input_boolean`](/components/input_boolean/#restore-state) +* [`input_number`](/components/input_number/#restore-state) +* [`input_select`](/components/input_select/#restore-state) +* [`input_datetime`](/components/input_datetime/#restore-state) +* [`input_text`](/components/input_text/#restore-state) +* ... + + ## Custom database engines | Database engine | `db_url` | From 137d6a4a040b497527667a91d208235882f13fd5 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 5 Jan 2018 13:19:18 +0100 Subject: [PATCH 07/24] Fix typos and change links --- source/_components/input_boolean.markdown | 4 ++-- source/_components/input_datetime.markdown | 2 +- source/_components/input_number.markdown | 2 +- source/_components/input_select.markdown | 2 +- source/_components/input_text.markdown | 2 +- source/_components/recorder.markdown | 5 ++--- 6 files changed, 8 insertions(+), 9 deletions(-) diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 7608e0c7973..ff2aa46ca85 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -35,7 +35,7 @@ input_boolean: required: false type: String initial: - description: Initial value whe Home Assistant starts. + description: Initial value when Home Assistant starts. required: false type: boolean default: false @@ -47,7 +47,7 @@ input_boolean: ### {% linkable_title Restore State %} -This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). +This component supports the `restore_state` function which restores the state after Home Assistant has started to the value it has been before Home Assistant stopped. To use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have a value set for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. ## {% linkable_title Automation Examples %} diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index d056e935342..4b9d9ae568a 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -74,4 +74,4 @@ A datetime input entity's state exports several attributes that can be useful in ### {% linkable_title Restore State %} -This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). +This component supports the `restore_state` function which restores the state after Home Assistant has started to the value it has been before Home Assistant stopped. To use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have a value set for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index f3b2a0fda14..32829baeff4 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -85,7 +85,7 @@ input_number: ### {% linkable_title Restore State %} -This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). +This component supports the `restore_state` function which restores the state after Home Assistant has started to the value it has been before Home Assistant stopped. To use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have a value set for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. ## {% linkable_title Automation Examples %} diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index a1b98fab34f..bf25b89d5f7 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -64,7 +64,7 @@ Because YAML defines [booleans](http://yaml.org/type/bool.html) as equivalent, a ### {% linkable_title Restore State %} -This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). +This component supports the `restore_state` function which restores the state after Home Assistant has started to the value it has been before Home Assistant stopped. To use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have a value set for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. ### {% linkable_title Services %} diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 255ea31b00c..2fa07711af3 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -63,4 +63,4 @@ input_text: ### {% linkable_title Restore State %} -This component supports the `restore_state` function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here [recorder/#restore-state](/components/recorder/#restore-state). +This component supports the `restore_state` function which restores the state after Home Assistant has started to the value it has been before Home Assistant stopped. To use this feature please make sure that the [`recorder`](/components/recorder/) component is enabled and your entity does not have a value set for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation. diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 9a59fd8e8b3..48ada639fde 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -135,17 +135,16 @@ action: ### {% linkable_title Restore State %} -If the `recorder` component is activated, some components support `restore_state` which will restore the state of the entity after Home Assistant is started to to state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An uncomplete list of components that currently support `restore_state`: +If the `recorder` component is activated then some components support `restore_state` which will restore the state of the entity after Home Assistant is started to the state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An incomplete list of components that currently support `restore_state`: * [`input_boolean`](/components/input_boolean/#restore-state) * [`input_number`](/components/input_number/#restore-state) * [`input_select`](/components/input_select/#restore-state) * [`input_datetime`](/components/input_datetime/#restore-state) * [`input_text`](/components/input_text/#restore-state) -* ... -## Custom database engines +## {% linkable_title Custom database engines %} | Database engine | `db_url` | | :---------------|:---------------------------------------------------------| From 1d7c8dce6325dba02418389c64e85e9c61eb3131 Mon Sep 17 00:00:00 2001 From: Marco Date: Fri, 5 Jan 2018 17:33:35 +0100 Subject: [PATCH 08/24] readability and notes (#4335) * Update media_player.yamaha_musiccast.markdown https://community.home-assistant.io/t/support-for-new-yamaha-receivers-and-musiccast-devices/17001/22 * moved section 'authentication' guide should be right below the 'scanning' guide. it's one workflow * easier searchable variable 'login_id' * added a hint to enable home sharing * fixed wrong syntax in config example * added note for use over https see https://github.com/home-assistant/home-assistant/issues/1258 --- source/_components/apple_tv.markdown | 43 ++++++++++--------- .../_components/device_tracker.luci.markdown | 4 ++ .../media_player.yamaha_musiccast.markdown | 4 +- source/_docs/configuration/devices.markdown | 8 ++-- 4 files changed, 33 insertions(+), 26 deletions(-) diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown index 5709958530d..bba7b7ac785 100644 --- a/source/_components/apple_tv.markdown +++ b/source/_components/apple_tv.markdown @@ -56,7 +56,9 @@ In order to connect to the device, you need a *login id*. The easiest way to obt ### {% linkable_title Scanning for devices %} -To scan for devices, press the icon in the upper left corner and select the leftmost icon according to the image: +Make sure Home Sharing is enabled on the Apple TV. + +To scan for devices and determine the `login_id`, press the icon in the upper left corner and select the leftmost icon according to the image: @@ -78,26 +80,7 @@ Found Apple TVs: Note: You must use 'pair' with devices that have home sharing disabled ``` -Just copy and paste the login id from the device you want to add. For more details about `atvremote`, see: [this page](http://pyatv.readthedocs.io/en/master/atvremote.html). - -### {% linkable_title My Apple TV turns on when I restart Home Assistant %} - -The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured. - -So, if your TV is randomly turning on, this is probably the reason. As stated, this is by design, and there is no real fix for it. There's also no known way to turn off the Apple TV via the protocol used for communication. You have the following options: - -- Do not use this platform -- Disable HDMI CEC on your Apple TV -- Use "fake standby" - -The first two points are quite obvious. Fake standby is a concept implemented in this platform that disables all requests to the device and makes it appear as being "off" in the web interface. This will make sure that the device is not woken up, but it will of course not show any information or allow you to control it. It is however easy to turn it on (or off) in the web interface or to use an automation with `turn_on`. To make it more useful, you can write automations that turn it on or off depending on some other device, like the input source on your receiver. - -To put a device into fake standby when starting Home Assistant, add `start_off: true` to your configuration. - -

-Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above. -

- +Just copy and paste the `login_id` from the device you want to add. For more details about `atvremote`, see: [this page](http://pyatv.readthedocs.io/en/master/atvremote.html). ### {% linkable_title Setting up device authentication %} @@ -129,6 +112,24 @@ apple_tv: Restart Home Assistant, and you should now be able to use `play_url` as before. +### {% linkable_title My Apple TV turns on when I restart Home Assistant %} + +The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured. + +So, if your TV is randomly turning on, this is probably the reason. As stated, this is by design, and there is no real fix for it. There's also no known way to turn off the Apple TV via the protocol used for communication. You have the following options: + +- Do not use this platform +- Disable HDMI CEC on your Apple TV +- Use "fake standby" + +The first two points are quite obvious. Fake standby is a concept implemented in this platform that disables all requests to the device and makes it appear as being "off" in the web interface. This will make sure that the device is not woken up, but it will of course not show any information or allow you to control it. It is however easy to turn it on (or off) in the web interface or to use an automation with `turn_on`. To make it more useful, you can write automations that turn it on or off depending on some other device, like the input source on your receiver. + +To put a device into fake standby when starting Home Assistant, add `start_off: true` to your configuration. + +

+Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above. +

+ ## {% linkable_title Services %} ### {% linkable_title Service `apple_tv_authenticate` %} diff --git a/source/_components/device_tracker.luci.markdown b/source/_components/device_tracker.luci.markdown index 937193752e5..32d0cde87b8 100644 --- a/source/_components/device_tracker.luci.markdown +++ b/source/_components/device_tracker.luci.markdown @@ -16,6 +16,10 @@ _This is one of the two ways we support OpenWRT. If you encounter problems, try This is a presence detection scanner for OpenWRT using [luci](http://wiki.openwrt.org/doc/techref/luci). +

+This component requires a [workaround](https://github.com/home-assistant/home-assistant/issues/1258#issuecomment-252469880) when using luci with HTTPS and a self-signed certificate. +

+ Before this scanner can be used you have to install the luci RPC package on OpenWRT: ```bash diff --git a/source/_components/media_player.yamaha_musiccast.markdown b/source/_components/media_player.yamaha_musiccast.markdown index 121687b9827..7d98e77102f 100644 --- a/source/_components/media_player.yamaha_musiccast.markdown +++ b/source/_components/media_player.yamaha_musiccast.markdown @@ -16,7 +16,7 @@ The `yamaha_musiccast` platform allows you to control [Yamaha MusicCast Receiver Supported devices are listed on their [German site](https://de.yamaha.com/de/products/contents/audio_visual/musiccast/products.html). -To add a Yamaha Network Receiver to your installation, add the following to your `configuration.yaml` file: +To add a Yamaha MusicCast Receiver to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -27,7 +27,7 @@ media_player: Configuration variables: - **host** (*Required*): IP address or hostname of the device -- **port** (*Optional*): UDP Port +- **port** (*Optional*): UDP source port. If multiple devices are present, specify a different port per device - **interval_seconds** (*Optional*): Polling interval (default: 480 seconds = 8 minutes) A few notes: diff --git a/source/_docs/configuration/devices.markdown b/source/_docs/configuration/devices.markdown index 7b8b1a1f78e..6fbee6a4330 100644 --- a/source/_docs/configuration/devices.markdown +++ b/source/_docs/configuration/devices.markdown @@ -60,10 +60,12 @@ Each group consists of a name and a list of entity IDs. Entity IDs can be retrie ```yaml # Example configuration.yaml entry showing two styles group: - living_room: light.table_lamp, switch.ac + living_room: + entities: light.table_lamp, switch.ac bedroom: - - light.bedroom - - media_player.nexus_player + entities: + - light.bedroom + - media_player.nexus_player ``` For more details please check the [Group](/components/group/) page. From 0b77723072254fa8376e2e638ee80a1907f09008 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Fri, 5 Jan 2018 18:28:13 +0100 Subject: [PATCH 09/24] Update zwave.markdown --- source/hassio/zwave.markdown | 6 ------ 1 file changed, 6 deletions(-) diff --git a/source/hassio/zwave.markdown b/source/hassio/zwave.markdown index 3ffe692ecf5..3be0947a5f0 100644 --- a/source/hassio/zwave.markdown +++ b/source/hassio/zwave.markdown @@ -24,12 +24,6 @@ If you need GPIO on Raspberry Pi 3 for your Z-Wave module, add the following lin dtoverlay=pi3-miniuart-bt ``` -For some devices the `/dev/ttyAMA0` device is not detected by udev and is therefore not mapped by Docker. To explicitly set this device for mapping to Home-Assistant, execute the following command using the ssh add-on: - -```bash -$ curl -d '{"devices": ["ttyAMA0"]}' http://hassio/homeassistant/options -``` - After that, you need to change `usb_path` to `/dev/ttyAMA0` in your `configuration.yaml`. ```yaml From 815772a59888168ee26f7ee76d66629a04271a14 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Fri, 5 Jan 2018 18:30:27 +0100 Subject: [PATCH 10/24] Update addon_config.markdown --- source/developers/hassio/addon_config.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/developers/hassio/addon_config.markdown b/source/developers/hassio/addon_config.markdown index 43cf11f7869..031dbabb3fc 100644 --- a/source/developers/hassio/addon_config.markdown +++ b/source/developers/hassio/addon_config.markdown @@ -120,7 +120,7 @@ The config for an add-on is stored in `config.json`. | auto_uart | no | Default False. Auto mapping all UART/Serial device from host into add-on. | hassio_api | no | This add-on can access to Hass.io REST API. It set the host alias `hassio`. | homeassistant_api | no | This add-on can access to Hass.io Home-Assistant REST API proxy. Use `http://hassio/homeassistant/api`. -| privileged | no | Privilege for access to hardware/system. Available access: `NET_ADMIN`, `SYS_ADMIN`, `SYS_RAWIO` +| privileged | no | Privilege for access to hardware/system. Available access: `NET_ADMIN`, `SYS_ADMIN`, `SYS_RAWIO`, `SYS_TIME`, `SYS_NICE` | map | no | List of maps for additional Hass.io folders. Possible values: `config`, `ssl`, `addons`, `backup`, `share`. Defaults to `ro`, which you can change by adding `:rw` to the end of the name. | environment | no | A dict of environment variable to run add-on. | 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. From d9a2c8c1be8b3a428b46672b7010bdb4ae66c8d1 Mon Sep 17 00:00:00 2001 From: Carlo Costanzo Date: Fri, 5 Jan 2018 16:49:11 -0500 Subject: [PATCH 11/24] Updated Domain List (#4347) Added in Script and input_boolean. Alphabetized them. Closes #11459 --- source/_components/cloud.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/_components/cloud.markdown b/source/_components/cloud.markdown index 68becfd3283..3710eeff24e 100644 --- a/source/_components/cloud.markdown +++ b/source/_components/cloud.markdown @@ -88,14 +88,16 @@ alexa: ### {% linkable_title Available domains %} Currently, the following domains are available to be used with Alexa: - alert -- automation +- automation (enables/disables) - cover -- light - fan (supports on/off and set speed) - group +- input_boolean +- light - lock (lock and unlock, but unlock is untested as Amazon has disabled unlock for now) - media_player (play, pause, stop, set volume, adjust volume, next track and previous track) - scene +- script (enables/disables) - switch [alexa skill]: https://alexa.amazon.com/spa/index.html#skills/dp/B0772J1QKB/?ref=skill_dsk_skb_sr_2 From a58944a86dfb3d6bc64eeb1eb8898927125f7ec9 Mon Sep 17 00:00:00 2001 From: sagilo Date: Sat, 6 Jan 2018 10:44:54 +0200 Subject: [PATCH 12/24] Update remote.harmony.markdown (#4351) --- source/_components/remote.harmony.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown index ec7057a5a80..c9a23a0f135 100755 --- a/source/_components/remote.harmony.markdown +++ b/source/_components/remote.harmony.markdown @@ -103,6 +103,7 @@ data: - home - 1 - 2 + device: 4576546 delay_secs: 0.6 ``` From d19596a16cae9f49ba59de5f7aaf492bfc806171 Mon Sep 17 00:00:00 2001 From: Alexandre Prates Dias Date: Sat, 6 Jan 2018 06:54:08 -0200 Subject: [PATCH 13/24] Update media_player.samsungtv.markdown (#4349) --- source/_components/media_player.samsungtv.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 471ae8c6af8..17fc9370b3e 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -38,6 +38,7 @@ Configuration variables: Currently known supported models: - C7700 +- D5500 - D6500 - D7000 - D8000 From 2f5a91d661a403e25aa48306f6bf48ad23d9b724 Mon Sep 17 00:00:00 2001 From: Hamid Elaosta Date: Sat, 6 Jan 2018 14:53:32 +0000 Subject: [PATCH 14/24] Fix the structure for component specific keys in Pushover --- source/_components/notify.pushover.markdown | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/source/_components/notify.pushover.markdown b/source/_components/notify.pushover.markdown index b9b2dce48a3..67e7db1098a 100644 --- a/source/_components/notify.pushover.markdown +++ b/source/_components/notify.pushover.markdown @@ -37,12 +37,15 @@ Configuration variables: Example Automation: ```yaml - service: notify.entity_id - data: + data: message: "This is the message" title: "Title of message" - sound: pianobar - priority: 0 + data: + url: "https://home-assistant.io/" + sound: pianobar + priority: 0 ``` +Component specific values in the nested `data` section are optional. This is a quote from the Pushover website regarding free/open source apps: @@ -54,7 +57,7 @@ When setting up the application you can use this [icon](https://home-assistant.i To use notifications, please see the [getting started with automation page](/getting-started/automation/). -When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api). +When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api). Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: @@ -67,8 +70,9 @@ alexa: service: notify.notify data_template: message: "The location of {% raw %}{{ User }}{% endraw %} has been queried via Alexa." + data: + title: "Home Assistant" data: - title: "Home Assistant" sound: falling device: pixel url: "https://home-assistant.io/" From 39c8b1eb26ba92b1593fa64d0d7c97161d1d244f Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sat, 6 Jan 2018 11:28:31 -0800 Subject: [PATCH 15/24] Release 0.60.1 --- _config.yml | 6 +-- source/_posts/2017-12-17-release-60.markdown | 55 +++++++++++++++++++- 2 files changed, 56 insertions(+), 5 deletions(-) diff --git a/_config.yml b/_config.yml index 868c6051c4d..413de4a3ab4 100644 --- a/_config.yml +++ b/_config.yml @@ -140,11 +140,11 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 60 -current_patch_version: 0 -date_released: 2017-12-17 +current_patch_version: 1 +date_released: 2018-01-06 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#" +patch_version_notes: "#release-0601---january-6" # Minor release (Example #release-0431---april-25): diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown index 42849c95152..1008b816ed5 100644 --- a/source/_posts/2017-12-17-release-60.markdown +++ b/source/_posts/2017-12-17-release-60.markdown @@ -15,13 +15,13 @@ og_image: /images/blog/2017-12-0.60/components.png The biggest change for 0.60 will be covered in a separate [blog post](/blog/2017/12/17/introducing-home-assistant-cloud/). Thus, we will keep it short here. Just one thing: This is the last release in 2017. We will be back to our bi-weekly release cycle in 2018. -A big "Thank you" to all people who supported us to make this release possible. +A big "Thank you" to all people who supported us to make this release possible. ## {% linkable_title TwinCAT %} With the brand-new [ADS (automation device specification)][ads docs] component by [@stlehmann] allows you to hook Home Assistant into this fieldbus independent interface which is often used between Beckhoff devices running with TwinCAT. ## {% linkable_title WebDav calendar %} -Thanks to [@maxlaverse] Home Assistant support now [WebDav calendars][calendar.caldav docs]. +Thanks to [@maxlaverse] Home Assistant support now [WebDav calendars][calendar.caldav docs]. ## {% linkable_title Tracking prices %} With the new [`gearbest` sensor][sensor.gearbest docs] there is now an additional sensor available to track the price of a product. @@ -44,6 +44,23 @@ Yahoo! has discontinued their financial service. To fill this gap we have now th - Add a caldav calendar component ([@maxlaverse] - [#10842]) ([calendar.caldav docs]) (new-platform) - Refactor hue to split bridge support from light platform ([@andreacampi] - [#10691]) ([hue docs]) ([light.hue docs]) (breaking change) (new-platform) +## {% linkable_title Relase 0.60.1 - January 6 %} + +- Fix async IO in Sesame lock component. ([@veleek] - [#11054]) ([lock.sesame docs]) +- Fix webdav calendar schema ([@maxlaverse] - [#11185]) ([calendar.caldav docs]) +- homematic: add username and password to interface config schema ([@jannau] - [#11214]) ([homematic docs]) +- Fix webostv select source ([@OddBloke] - [#11227]) ([media_player.webostv docs]) +- Fix detection of if a negative node is in use ([@OverloadUT] - [#11255]) ([binary_sensor.isy994 docs]) +- Bugfix homematic available modus ([@pvizeli] - [#11256]) ([homematic docs]) +- Support multiple Hue bridges with lights of the same id ([@andreacampi] - [#11259]) ([light.hue docs]) +- Fix inverted sensors on the concord232 binary sensor component ([@CTLS] - [#11261]) ([binary_sensor.concord232 docs]) +- Fix handling zero values for state_on/state_off ([@ziotibia81] - [#11264]) ([switch.modbus docs]) +- Fix allday events in custom_calendars ([@maxlaverse] - [#11272]) ([calendar.caldav docs]) +- Fix unpredictable entity names in concord232 binary_sensor ([@rwa] - [#11292]) ([binary_sensor.concord232 docs]) +- Fix leak sensors always showing Unknown until Wet ([@OverloadUT] - [#11313]) ([binary_sensor.isy994 docs]) +- Don't block on sevice call for alexa ([@pvizeli] - [#11358]) ([alexa.smart_home docs]) +- iOS 10 should be served javascript_version:es5 ([@mnoorenberghe] - [#11387]) + ## {% 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. @@ -355,3 +372,37 @@ Experiencing issues introduced by this release? Please report them in our [issue [vera docs]: https://home-assistant.io/components/vera/ [volvooncall docs]: https://home-assistant.io/components/volvooncall/ [xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/ +[#11054]: https://github.com/home-assistant/home-assistant/pull/11054 +[#11185]: https://github.com/home-assistant/home-assistant/pull/11185 +[#11214]: https://github.com/home-assistant/home-assistant/pull/11214 +[#11227]: https://github.com/home-assistant/home-assistant/pull/11227 +[#11255]: https://github.com/home-assistant/home-assistant/pull/11255 +[#11256]: https://github.com/home-assistant/home-assistant/pull/11256 +[#11259]: https://github.com/home-assistant/home-assistant/pull/11259 +[#11261]: https://github.com/home-assistant/home-assistant/pull/11261 +[#11264]: https://github.com/home-assistant/home-assistant/pull/11264 +[#11272]: https://github.com/home-assistant/home-assistant/pull/11272 +[#11292]: https://github.com/home-assistant/home-assistant/pull/11292 +[#11313]: https://github.com/home-assistant/home-assistant/pull/11313 +[#11358]: https://github.com/home-assistant/home-assistant/pull/11358 +[#11387]: https://github.com/home-assistant/home-assistant/pull/11387 +[@CTLS]: https://github.com/CTLS +[@OddBloke]: https://github.com/OddBloke +[@OverloadUT]: https://github.com/OverloadUT +[@andreacampi]: https://github.com/andreacampi +[@jannau]: https://github.com/jannau +[@maxlaverse]: https://github.com/maxlaverse +[@mnoorenberghe]: https://github.com/mnoorenberghe +[@pvizeli]: https://github.com/pvizeli +[@rwa]: https://github.com/rwa +[@veleek]: https://github.com/veleek +[@ziotibia81]: https://github.com/ziotibia81 +[alexa.smart_home docs]: https://home-assistant.io/components/alexa.smart_home/ +[binary_sensor.concord232 docs]: https://home-assistant.io/components/binary_sensor.concord232/ +[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/ +[calendar.caldav docs]: https://home-assistant.io/components/calendar.caldav/ +[homematic docs]: https://home-assistant.io/components/homematic/ +[light.hue docs]: https://home-assistant.io/components/light.hue/ +[lock.sesame docs]: https://home-assistant.io/components/lock.sesame/ +[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/ +[switch.modbus docs]: https://home-assistant.io/components/switch.modbus/ From 10a1ddffbd2f9683469af86f3b75dc7f7f01a7da Mon Sep 17 00:00:00 2001 From: Kalen Johnson Date: Sat, 6 Jan 2018 12:46:15 -0800 Subject: [PATCH 16/24] Fix typo (#4356) --- source/_components/camera.yi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index 98cc2b1f38b..8b12c67e9a4 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -26,7 +26,7 @@ To successfully implement this platform, the Home Assistant host should be capab ### {% linkable_title Installing Alternative Firmware %} -In order to integrate the camera with Home Assitant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3). +In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3). Once installed, please ensure that you have enabled FTP and Telnet on your device. From 7a7855cc8e2655090491e3e8a9cf407517169724 Mon Sep 17 00:00:00 2001 From: Amir Hanan Date: Sun, 7 Jan 2018 12:09:56 +0200 Subject: [PATCH 17/24] clarifying prerequisites for sesame integration (#4359) took me a while to figure out, hope it helps someone. --- source/_components/lock.sesame.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/lock.sesame.markdown b/source/_components/lock.sesame.markdown index 121d337cefb..01d9910fdac 100644 --- a/source/_components/lock.sesame.markdown +++ b/source/_components/lock.sesame.markdown @@ -17,7 +17,7 @@ The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/ Your Sesame needs to be paired with a mobile device running the app in *virtual station* mode, or a standalone [Wi-Fi Access Point](https://candyhouse.co/collections/frontpage/products/wi-fi-access-point). -Once you have remote access enabled, add the following to your `configuration.yaml` file: +Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry lock: From b0c3ff6a339f60511bafb24cad768aa67192666c Mon Sep 17 00:00:00 2001 From: travislreno Date: Sun, 7 Jan 2018 04:10:42 -0600 Subject: [PATCH 18/24] More tested components (#4358) Fixed bad link. Added new tested device (I have successfully tested this component with the 15A switch) --- source/_components/light.decora_wifi.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/light.decora_wifi.markdown b/source/_components/light.decora_wifi.markdown index 85dbcd0e575..48ce82aa3aa 100644 --- a/source/_components/light.decora_wifi.markdown +++ b/source/_components/light.decora_wifi.markdown @@ -17,7 +17,8 @@ Support for [Leviton Decora Wi-Fi](http://www.leviton.com/en/products/lighting-c Supported devices (tested): -- [DW6HD1-BZ](https://www.leviton.com/en/products/dw6hd) (Decora Smart Wi-Fi 600W Dimmer) +- [DW6HD1-BZ](https://www.leviton.com/en/products/dw6hd-1bz) (Decora Smart Wi-Fi 600W Dimmer) +- [DW15S-1BZ](https://www.leviton.com/en/products/dw15s-1bz) (Decora Smart Wi-Fi 15A Switch) To enable these lights, add the following lines to your `configuration.yaml` file: From 1bf360f38e64614dd503684926802f3259f7018f Mon Sep 17 00:00:00 2001 From: nau-mll <35155971+nau-mll@users.noreply.github.com> Date: Sun, 7 Jan 2018 11:11:25 +0100 Subject: [PATCH 19/24] Include Unitymedia device, german brand of UPC (#4357) --- source/_components/device_tracker.upc_connect.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/device_tracker.upc_connect.markdown b/source/_components/device_tracker.upc_connect.markdown index d58a1878e93..ca0a7e57b23 100644 --- a/source/_components/device_tracker.upc_connect.markdown +++ b/source/_components/device_tracker.upc_connect.markdown @@ -32,4 +32,5 @@ See the [device tracker component page](/components/device_tracker/) for instruc Also known to be working with the following devices: - Irish Virgin Media Super Hub 3.0 - Ziggo Connectbox NL + - Unitymedia Connect Box (DE) From 38b571562d8ade9f022ea2042da453e07eb34225 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Calder=C3=ADn=20Go=C3=B1i?= Date: Mon, 8 Jan 2018 00:09:39 +1100 Subject: [PATCH 20/24] Google assistant api password doc (#4360) * Add information about the api * Rewrite the sentence --- source/_components/google_assistant.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 5c0463589d6..1e27ce6cc33 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -125,8 +125,8 @@ Entity Customization Keys: 6. The final item on that page `Account linking` is required for your app to interact with Home Assistant. 1. Grant type: `Implicit` 2. Client ID: The `client_id` from your Home Assistant configuration above - 3. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth` - 4. Configure your client. Add scopes for `email` and `name` + 3. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth`. If you have set `api_password:` add this password to the URL `https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth?api_password=[YOUR API PASSWORD]`) + 4. Configure your client. Add scopes for `email` and `name`. 5. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. 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. If you haven't already added the component configuration to `configuration.yaml` and restarted Home Assistant, you'll be unable to continue until you have. From 81185518a3d39f77e86d12da2cf0e7448dc1f781 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 6 Jan 2018 09:51:23 +0100 Subject: [PATCH 21/24] Minor changes --- source/_components/remote.harmony.markdown | 34 +++++++++++----------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown index c9a23a0f135..cc2eba65ccd 100755 --- a/source/_components/remote.harmony.markdown +++ b/source/_components/remote.harmony.markdown @@ -23,37 +23,33 @@ Supported units: - Harmony Pro - Harmony Elite - The preferred way to setup the Harmony remote is by enabling the [discovery component](/components/discovery/). -However, if you want to manually configure the device, you will need to add its settings to your `configuration.yaml`. +However, if you want to manually configure the device, you will need to add its settings to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry remote: - platform: harmony name: Bedroom - host: 10.168.1.13 # The IP of your hub + host: 10.168.1.13 ``` -You can override some default configuration values on a discovered hub (e.g. the `port` or `activity`) by adding -a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will -discover the host IP automatically, but set the `name` in the config to match exactly the name you have -set for your Hub so the platform knows what Hub you are trying to configure. +You can override some default configuration values on a discovered hub (e.g. the `port` or `activity`) by adding a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will discover the host IP automatically, but set the `name` in the config to match exactly the name you have set for your Hub so the platform knows what Hub you are trying to configure. ```yaml # Example configuration.yaml entry with discovery - platform: harmony - name: Living Room # This name must match the name you have set on the Hub - activity: Watch TV # Overriding the 'activity' setting for this discovered hub + name: Living Room + activity: Watch TV ``` Configuration variables: -- **name** (*Required*): The hub's name to display in the frontend. +- **name** (*Required*): The hub's name to display in the frontend. This name must match the name you have set on the Hub. - **host** (*Optional*): The Harmony device's IP address. Leave empty for the IP to be discovered automatically. - **port** (*Optional*): The Harmony device's port. Defaults to 5222. -- **activity** (*Optional*): Activity to use when `turn_on` service is called without any data. +- **activity** (*Optional*): Activity to use when `turn_on` service is called without any data. Overrides the `activity` setting for this discovered hub. - **delay_secs** (*Optional*): Default duration in seconds between sending commands to a device. Configuration file: @@ -119,20 +115,23 @@ Synchronize the Harmony device with the Harmony web service if any changes are m Template sensors can be utilized to display current activity in the frontend. +{% raw %} ```yaml sensor: - platform: template sensors: family_room: - value_template: {% raw %}'{{ states.remote.family_room.attributes.current_activity }}'{% endraw %} + value_template: '{{ states.remote.family_room.attributes.current_activity }}' friendly_name: 'Family Room' bedroom: - value_template: {% raw %}'{{ states.remote.bedroom.attributes.current_activity }}'{% endraw %} + value_template: '{{ states.remote.bedroom.attributes.current_activity }}' friendly_name: 'bedroom' ``` +{% endraw %} -The example below shows how to control an `input_boolean` switch using the Harmony remote's current activity. The switch will turn on when the remote's state changes and the Kodi activity is started and off when the remote's state changes and the current activity is PowerOff. +The example below shows how to control an `input_boolean` switch using the Harmony remote's current activity. The switch will turn on when the remote's state changes and the Kodi activity is started and off when the remote's state changes and the current activity is "PowerOff". +{% raw %} ```yaml automation: - alias: "Watch TV started from harmony hub" @@ -141,7 +140,7 @@ automation: entity_id: remote.family_room condition: condition: template - value_template: {% raw %}'{{ trigger.to_state.attributes.current_activity == "Kodi" }}'{% endraw %} + value_template: '{{ trigger.to_state.attributes.current_activity == "Kodi" }}' action: service: input_boolean.turn_on entity_id: input_boolean.notify @@ -151,8 +150,9 @@ automation: entity_id: remote.family_room condition: condition: template - value_template: {% raw %}'{{ trigger.to_state.attributes.current_activity == "PowerOff" }}'{% endraw %} + value_template: '{{ trigger.to_state.attributes.current_activity == "PowerOff" }}' action: service: input_boolean.turn_off entity_id: input_boolean.notify -```` +``` +{% endraw %} From 04fbbee3cfea43e36abf492679d4de06eaa51cdc Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 6 Jan 2018 09:51:59 +0100 Subject: [PATCH 22/24] Update link --- .../alarm_control_panel.manual_mqtt.markdown | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/_components/alarm_control_panel.manual_mqtt.markdown b/source/_components/alarm_control_panel.manual_mqtt.markdown index 4f1f90995ce..95fd3e09ff2 100644 --- a/source/_components/alarm_control_panel.manual_mqtt.markdown +++ b/source/_components/alarm_control_panel.manual_mqtt.markdown @@ -32,6 +32,8 @@ When the state of the manual alarm changes, Home Assistant will publish one of t - 'pending' - 'triggered' +To use your panel in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry alarm_control_panel: @@ -56,7 +58,7 @@ The following configuration variables from the base manual alarm platform are av - **pending_time** (*Optional*): State specific setting for **pending_time** (all states except **disarmed**) - **trigger_time** (*Optional*): State specific setting for **trigger_time** (all states except **triggered**) -See the documentation for the [manual alarm platform](../alarm_control_panel.manual/) for a description. +See the documentation for the [manual alarm platform](/component/alarm_control_panel.manual/) for a description. Additionally, the following MQTT configuration variables are also available: @@ -68,13 +70,11 @@ Additionally, the following MQTT configuration variables are also available: - **payload_arm_away** (*Optional*): The payload to set armed-away mode on this Alarm Panel. Default is "ARM_AWAY". - **payload_arm_night** (*Optional*): The payload to set armed-night mode on this Alarm Panel. Default is "ARM_NIGHT". -In the config example below: +In the configuration example below: -- the disarmed state never triggers the alarm; - -- the armed_home state will leave no time to leave the building or disarm the alarm; - -- while other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back. +- The disarmed state never triggers the alarm. +- The armed_home state will leave no time to leave the building or disarm the alarm. +- While other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back. ```yaml # Example configuration.yaml entry From edcef968c4653a78e223dfea80231f377c5c44a6 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 7 Jan 2018 14:28:25 +0100 Subject: [PATCH 23/24] Fix typo --- source/_posts/2017-12-17-release-60.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown index 1008b816ed5..6f795df119c 100644 --- a/source/_posts/2017-12-17-release-60.markdown +++ b/source/_posts/2017-12-17-release-60.markdown @@ -44,7 +44,7 @@ Yahoo! has discontinued their financial service. To fill this gap we have now th - Add a caldav calendar component ([@maxlaverse] - [#10842]) ([calendar.caldav docs]) (new-platform) - Refactor hue to split bridge support from light platform ([@andreacampi] - [#10691]) ([hue docs]) ([light.hue docs]) (breaking change) (new-platform) -## {% linkable_title Relase 0.60.1 - January 6 %} +## {% linkable_title Release 0.60.1 - January 6 %} - Fix async IO in Sesame lock component. ([@veleek] - [#11054]) ([lock.sesame docs]) - Fix webdav calendar schema ([@maxlaverse] - [#11185]) ([calendar.caldav docs]) From e2ca90c068ea77f2f8425caf73910061337d4fff Mon Sep 17 00:00:00 2001 From: kaiomatico Date: Sun, 7 Jan 2018 18:17:01 +0100 Subject: [PATCH 24/24] Added J5500 to tested Models (#4364) I have tested a Samsung UE50J5550. After changing to Port 8001 the TV is discovered but the state is always on and it does not react to any actions like power off or mute. --- source/_components/media_player.samsungtv.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 17fc9370b3e..f64277c404e 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -65,6 +65,7 @@ Currently known supported models: Currently tested but not working models: - J5200 - Unable to see state and unable to control +- J5500 - State is always "on" and unable to control (but port 8001 *is* open) - JU7000 - Unable to see state and unable to control (but port 8001 *is* open) - JU7500 - Unable to see state and unable to control - JS9000 - State is always "on" and unable to control (but port 8001 *is* open)