From bc314cca4f2335294aed77a1a5be778fd17a74d0 Mon Sep 17 00:00:00 2001 From: Thom Stricklin Date: Thu, 28 Mar 2019 16:43:30 -0700 Subject: [PATCH 01/37] Add UPnP sensor troubleshooting (#9060) * Add UPnP sensor troubleshooting * Minor changes --- source/_components/upnp.markdown | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown index c2c6e667aaa..d26f55aace7 100644 --- a/source/_components/upnp.markdown +++ b/source/_components/upnp.markdown @@ -64,3 +64,14 @@ ports: type: map default: Open same port on external router as that HASS runs locally and forwards it. {% endconfiguration %} + +## {% linkable_title Troubleshooting %} + +If Home Assistant is not able to discover UPnP sensors, it may be because the local IP address was not auto-detected correctly. To prevent this, you may add the `local_ip` option to your UPnP configuration: + +```yaml +# Example configuration.yaml with UPnP sensors enabled and local_ip set +upnp: + sensors: true + local_ip: 192.168.1.2 +``` From 10db76700bc1ab2877971e656e22e3b11e9e56d9 Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Sat, 30 Mar 2019 01:20:56 -0600 Subject: [PATCH 02/37] Fixed mispelling in SmartThings docs (#9074) --- source/_components/smartthings.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/smartthings.markdown b/source/_components/smartthings.markdown index 273324bccb7..7bef6a5c581 100644 --- a/source/_components/smartthings.markdown +++ b/source/_components/smartthings.markdown @@ -62,7 +62,7 @@ The SmartThings integration utilizes a webhook to receive push updates from the ### {% linkable_title Cloudhook via Nabu Casa %} -If you are using Home Assistant Cloud (Nabu Casa) the integraiton will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the component prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.** +If you are using Home Assistant Cloud (Nabu Casa) the integration will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the component prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.** 1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions). 2. Home Assistant Cloud is configured and logged-in with a non-expired subscription. From e15c9a82191880ead46f3d5d19036f757c6188a5 Mon Sep 17 00:00:00 2001 From: emontnemery Date: Sat, 30 Mar 2019 08:21:44 +0100 Subject: [PATCH 03/37] Clarify default value for mqtt.switch state_on / state_off (#9070) * Update switch.mqtt.markdown * Update switch.mqtt.markdown * Update switch.mqtt.markdown * Update switch.mqtt.markdown * Update switch.mqtt.markdown * Update switch.mqtt.markdown --- source/_components/switch.mqtt.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index ca62ceb039d..252d8f9de5d 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -54,12 +54,12 @@ state_on: description: The payload that represents the on state. required: false type: string - default: "ON" + default: "`payload_on` if defined, else ON" state_off: description: The payload that represents the off state. required: false type: string - default: "OFF" + default: "`payload_off` if defined, else OFF" availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false From 17abb801ef07d65737d20edbba9673e2614a470c Mon Sep 17 00:00:00 2001 From: David Beitey Date: Sat, 30 Mar 2019 17:35:40 +1000 Subject: [PATCH 04/37] Fix grammar and formatting from #8615 (#9066) Improves on the wording of my previous PR for readability --- source/_components/http.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 8cab4fa7ed9..dc970733727 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -41,7 +41,7 @@ server_port: type: integer default: 8123 base_url: - description: "The URL that Home Assistant is available on the internet. For example: `https://hass-example.duckdns.org:8123`. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app. Note that setting may contain protocol, hostname and port; using a path is not currently supported." + description: "The URL that Home Assistant is available on the internet. For example: `https://hass-example.duckdns.org:8123`. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app. Note that this setting may only contain a protocol, hostname and port; using a path is *not* currently supported." required: false type: string default: Your local IP address From 706ff615b62f47129ae7876a680282d849431d1c Mon Sep 17 00:00:00 2001 From: Patrik Hermansson Date: Sat, 30 Mar 2019 12:30:36 +0100 Subject: [PATCH 05/37] Better explanation of how to use sources (#9065) --- source/_components/media_player.spotify.markdown | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/source/_components/media_player.spotify.markdown b/source/_components/media_player.spotify.markdown index 982730bd33b..3140745e0fe 100644 --- a/source/_components/media_player.spotify.markdown +++ b/source/_components/media_player.spotify.markdown @@ -98,7 +98,19 @@ authorization, discard the download. It is not needed. The sources are based on if you have streamed to these devices before in Spotify. If you don't have any sources, then simply stream from your phone to another device in your house: Bluetooth, echo, etc. Once you do, the sources will -show up in the developer console as a device to cast/stream to. The devices won't show up in the dev-console as sources unless they are powered on as well. +show up in the Spotify developer console as a device to cast/stream to. +Go to https://developer.spotify.com and login. Click on "Console" in top menu and then "Player" in the left menu. Select "/v1/me/player/devices" in the list. Then click "Get token", accept the terms and click "Try it". Your active Spotify devices will then be listed in the right panel, beneath the curl-line (for example, "name": "Web Player (Chrome)"). +These names can then be used in for example an input selector: + +```yaml + spotify_source: + name: 'Source:' + options: + - Spotifyd@rock64 + - Web Player (Chrome) +``` + +The devices won't show up in the dev-console as sources unless they are powered on as well. ## {% linkable_title URI Links For Playlists/Etc. %} You can send playlists to spotify via the `"media_content_type": "playlist"` and something like (depending on your content ID) From bc398c9de85e0e8bc3c311af458e6c1b609e51e4 Mon Sep 17 00:00:00 2001 From: kgalilio <48642035+kgalilio@users.noreply.github.com> Date: Sat, 30 Mar 2019 15:18:53 +0300 Subject: [PATCH 06/37] Update switch.broadlink.markdown (#9069) * Update switch.broadlink.markdown Added Node red method for obtaining and transmitting IR codes. * Minor changes --- source/_components/switch.broadlink.markdown | 71 +++++++++++++++++++- 1 file changed, 68 insertions(+), 3 deletions(-) diff --git a/source/_components/switch.broadlink.markdown b/source/_components/switch.broadlink.markdown index 7e0c4d82a42..e6d796d62c2 100644 --- a/source/_components/switch.broadlink.markdown +++ b/source/_components/switch.broadlink.markdown @@ -196,7 +196,7 @@ script: - "JgBGAJSTFDUUNhM2ExITEhMSExITEhM2EzYTNhQRFBEUERQRFBEUNRQ2ExITNhMSExITNhMSExITEhM2ExITNhQ1FBEUNhMADQUAAA==" ``` -## {% linkable_title Using E-Control Remotes %} +## {% linkable_title Using E-Control remotes %} If you already have your remotes learned on E-Control app you can use this method to "copy" them to Home Assistant. @@ -244,7 +244,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 8. Convert the HEX codes to base64. Use [this](http://tomeko.net/online_tools/hex_to_base64.php?lang=en1) tool to convert the hex codes to base64 for use with Home Assistant. -## {% linkable_title Using iOS and Windows to Obtain Codes %} +## {% linkable_title Using iOS and Windows to obtain codes %} 1. Use the E-Control app to learn the codes from all of your suitable remotes. Depending on the remote, try to add useful names for the buttons and/or the remotes. This will mean that you should only have to run this process once and will help with getting them quickly into Home Assistant. Dump the files in the app by navigating to the hamburger icon, select `share and select`, then choose `Share to other phones on WLAN`. @@ -292,9 +292,74 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your config.yaml file (or wherever you have your switches). -## {% linkable_title Using Windows to Obtain Codes with Broadlink Manager %} +## {% linkable_title Using Windows to obtain codes with Broadlink Manager %} 1. Install Broadlink Manager from this SourceForge link [here](https://sourceforge.net/projects/broadlink-manager/). 2. Open the application and hit "scan" to activate your broadlink device. 3. Hit "Learn New Command" and follow instructions on screen. 4. The "OnRawData Base64" is the value to be used with Home Assistant. + + +## {% linkable_title Using Node-RED to obtain codes %} + +1. Install the Broadlink Control palette in Node-RED (click the Hamburger menu at top right corner> Settings> Palette> Install and type Broadlink. Click install on the node-red-contrib-broadlink-control. +2. Once installed, verify that the new palette titled broadlink is available in the nodes menu. +3. Drag the RM node to an empty flow and double click to configure the node. + ```bash + a. give your RM device a name for easy identification + b. click on the pencil to edit the device information + c. enter the MAC address of the Broadlink RM PRO or RM Mini + d. enter the IP address of the Broadlink RM PRO or RM mini + e. leave the Catalog field empty. + ``` +4. Click Update, and the device field should show the MAC address of the newly added device. If not, just select it. +5. In the Action field, select Learn, then click Done. +6. Drag an Inject node to the left of the RM node and link them. The type of inject doesn't matter. Leave it to the defaults. +7. Drag a Template node on the Flow to the right of the RM node and link it to the RM node. +8. Double click the Template node to edit it, select: + ```bash + Property: msg.payload + Format: Mustache template + Template field: enter '{{payload.data}}'. + Output as: Plain text + ``` +9. Drag a Debug node to the right of the Template node and link them. +10. Show the debug messages, deploy the flow and click on the inject button. +11. A message will show in the debug window: + ```bash + 3/23/2019, 9:56:53 AMnode: RM_Mini1 + msg : string[47] + "Please tap the remote button within 30 seconds." + ``` +12. Point the IR remote control at the RM device and click the desired button for about 2 seconds. An array of numbers will show in the debug window. For example: + ```bash + '38,0,132,3,19,18,19,18,19,18,19,17,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,20,17,19,18,19,18,19,18,19,17,20,17,20,54,20,17,20,54,19,55,19,54,20,54,20,54,19,55,19,0,6,6,150,146,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,17,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,19,18,19,55,19,54,20,54,20,54,20,54,19,55,19,0,6,6,150,146,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,54,19,55,19,54,20,17,20,17,20,17,20,17,20,17,19,18,19,55,19,17,20,17,20,17,20,17,20,17,19,18,19,55,19,18,19,54,20,54,20,54,19,55,19,54,20,54,20,0,6,5,150,146,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,17,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,19,18,19,55,19,54,20,54,20,54,19,55,19,54,20,0,6,6,149,147,20,54,19,55,19,54,20,17,20,17,20,17,20,17,20,17,19,55,19,54,20,54,20,17,20,17,20,17,19,18,19,18,19,18,19,54,20,17,20,17,20,17,20,17,19,18,19,18,19,54,20,17,20,54,20,54,20,54,19,...' + ``` +This is the code we need to transmit again to replicate the same remote function. + +## {% linkable_title Using Node red to Transmit Codes %} + +1. Drag another RM node on the same flow we created earlier. The RM node should be configured to the RM device created earlier by default. +2. In the Action field, select - Set from msg.payload -. +3. Drag an Inject node and give it a meaningful name relevant to the remote control button function, like "TV On" or "TV Source". +4. Drag a template node and double click it to configure: + ```bash + Property: msg.payload + Format: Mustache template + Template: enter the following: + '{ + "action" : "send", + "data" : [ 38, 0, 34, 1, 40, 15, 40, 15 ] // Here you must enter the entire code from point 12 above, without the trailing "." + }' + In the Output as field, "select Parsed JSON". + ``` +5. Click Done. +6. Drag a debug node and connect it to the output of the RM node. +7. Connect the Inject node to the Template node, and the template node to the RM node. +8. Click Deploy to activate the flow, and then click the inject button. The debug window should show a debug message. For example: + ```bash + {"action":"send","data": [38,0,152,0,0,1,39,148,19,18,18,19,18,55,19,18,18,19,18,19,18,19,18,55,18,56,18,19,18,55,18,19,18,56,18,18,19,55,18,19,18,19,18,18,18,56,18,19,18,18,19,55,18,56,18,18,19,18,18,19,18,19,18,55,19,18,18,19,18,19,18,19,18,18,18,19,18,19,18,55,19,55,18,19,18,19,18,18,19,18,18,56,18,19,18,18,19,55,18,56,18,18,19,18,18,19,18,19,18,19,18,18,19,18,18,56,18,55,18,19,18,19,18,19,18,18,19,55,18,19,18,55,19,18,18,56,18,19,18,18,19,18,18,19,18,19,18,19,18,18,18,56,18,0,13,5],"status":"OK"} + ``` +The "status" : "OK" at the end is a feedback that the Broadlink RM device is connected and has transmitted the payload. + +Now you can add as many template nodes, each having a specific code, and add any type of input nodes to activate the template and transmit the code. From 945021c714efe71fdade4b536ccac817ad030cb0 Mon Sep 17 00:00:00 2001 From: Andreas Setterlind Date: Sat, 30 Mar 2019 13:39:26 +0100 Subject: [PATCH 07/37] Update zha.markdown to further explain function of ZHA Device Handlers (#9067) Update zha.markdown to further explain the function of custom ZHA Device Handlers for Home Assistant. --- source/_components/zha.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 0e70bd5d966..dcdf41bde2b 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -37,7 +37,9 @@ There is currently support for the following device types within Home Assistant: ZHA exception and deviation handling: -Zigbee devices that deviate from or do not fully conform to the standard specification set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant. +Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. + +The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Shepherd Converters as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms. Known working Zigbee radio modules: From 71d82e9a0faaf4df14cec94ca2beec0ea426220d Mon Sep 17 00:00:00 2001 From: mastakebob <47671816+mastakebob@users.noreply.github.com> Date: Sat, 30 Mar 2019 09:07:12 -0400 Subject: [PATCH 08/37] Update device-specific.markdown (#9058) * Update device-specific.markdown Fixed formatting ("*" causing italics) * :pencil2: Tweak * :pencil2: Adds proper escaping --- source/_docs/z-wave/device-specific.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 288eb1d57e0..50eb7ef7a05 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -300,7 +300,7 @@ Press circle and plus simultaneously to wake up the device. -Once you've added the NanoMote to your z-wave network, you'll need to update your zwcfg*.xml file with the below xml data. Stop Home Assistant and open your zwcfg*.xml file (located in your config folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below xml data. Save the file and restart Home Assistant. +Once you've added the NanoMote to your z-wave network, you'll need to update your zwcfg_\*.xml file with the below xml data. Stop Home Assistant and open your zwcfg_\*.xml file (located in your config folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below xml data. Save the file and restart Home Assistant. ```xml From 9b29fb4a915c8c9e8a3c2039a0adeeb02ef3f03f Mon Sep 17 00:00:00 2001 From: Anders Melchiorsen Date: Sat, 30 Mar 2019 14:11:09 +0100 Subject: [PATCH 09/37] Revert Sonos service call reformatting (#9048) --- source/_components/sonos.markdown | 130 +++++++++--------------------- 1 file changed, 36 insertions(+), 94 deletions(-) diff --git a/source/_components/sonos.markdown b/source/_components/sonos.markdown index 3c9d4e4c688..776d6fb7d73 100644 --- a/source/_components/sonos.markdown +++ b/source/_components/sonos.markdown @@ -31,16 +31,11 @@ Take a snapshot of what is currently playing on one or more speakers. This servi The queue is not snapshotted and must be left untouched until the restore. Using `media_player.play_media` is safe and can be used to play a notification sound, including [TTS](/components/tts/) announcements.

-{% configuration %} -entity_id: - description: The speakers to snapshot. - required: false - type: entity_id -with_group: - description: Should we also snapshot the group layout and the state of other speakers in the group. - required: false - type: boolean -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | The speakers to snapshot. +| `with_group` | yes | Should we also snapshot the group layout and the state of other speakers in the group. + ### {% linkable_title Service `media_player.sonos_restore` %} @@ -54,99 +49,55 @@ The playing queue is not snapshotted. Using `media_player.sonos_restore` on a sp A cloud queue cannot be restarted. This includes queues started from within Spotify and queues controlled by Amazon Alexa.

-{% configuration %} -entity_id: - description: The speakers that should have their snapshot restored. - required: false - type: entity_id -with_group: - description: Should we also restore the group layout and the state of other speakers in the group. - required: false - type: boolean -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of `entity_id`s that should have their snapshot restored. +| `with_group` | yes | Should we also restore the group layout and the state of other speakers in the group. ### {% linkable_title Service `media_player.sonos_join` %} Group players together under a single coordinator. This will make a new group or join to an existing group. - -{% configuration %} -master: - description: A single `entity_id` that will become/stay the coordinator speaker. - required: true - type: entity_id -entity_id: - description: The speakers to join to the master. - required: false - type: entity_id -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `master` | no | A single `entity_id` that will become/stay the coordinator speaker. +| `entity_id` | no | String or list of `entity_id`s to join to the master. ### {% linkable_title Service `media_player.sonos_unjoin` %} Remove one or more speakers from their group of speakers. If no `entity_id` is provided, all speakers are unjoined. - -{% configuration %} -entity_id: - description: The speakers to separate from their coordinator speaker. - required: false - type: entity_id -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of `entity_id`s to separate from their coordinator speaker. ### {% linkable_title Service `media_player.sonos_set_sleep_timer` %} Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down. -{% configuration %} -entity_id: - description: The speakers that will have their timers set. - required: true - type: entity_id -sleep_time: - description: Number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day). - required: true - type: integer -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of `entity_id`s that will have their timers set. +| `sleep_time` | no | Integer number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day). ### {% linkable_title Service `media_player.sonos_clear_sleep_timer` %} Clear the sleep timer on a speaker, if one is set. -{% configuration %} -entity_id: - description: The speakers that will have their timers cleared. - required: true - type: entity_id -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker. ### {% linkable_title Service `media_player.sonos_update_alarm` %} Update an existing Sonos alarm. -{% configuration %} -entity_id: - description: The speaker that will have its alarm updated. - required: true - type: entity_id -alarm_id: - description: Integer that is used in Sonos to refer to your alarm. - required: true - type: integer -time: - description: Time to set the alarm. - required: no - type: time -volume: - description: Float for volume level (0.0-1.0). - required: no - type: float -enabled: - description: Boolean for whether or not to enable this alarm. - required: no - type: boolean -include_linked_zones: - description: Boolean that defines if the alarm also plays on grouped players. - required: no - type: boolean -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker. +| `alarm_id` | no | Integer that is used in Sonos to refer to your alarm. +| `time` | yes | Time to set the alarm. +| `volume` | yes | Float for volume level. +| `enabled` | yes | Boolean for whether or not to enable this alarm. +| `include_linked_zones` | yes | Boolean that defines if the alarm also plays on grouped players. ### {% linkable_title Service `media_player.sonos_set_option` %} @@ -154,20 +105,11 @@ Set Sonos speaker options. Night Sound and Speech Enhancement modes are only supported when playing from the TV source of products like Sonos Playbar and Sonos Beam. Other speaker types will ignore these options. -{% configuration %} -entity_id: - description: The speakers that will have their options set. - required: true - type: entity_id -night_sound: - description: Boolean to control Night Sound mode. - required: no - type: boolean -speech_enhance: - description: Boolean to control Speech Enhancement mode. - required: no - type: boolean -{% endconfiguration %} +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | String or list of `entity_id`s that will have their options set. +| `night_sound` | yes | Boolean to control Night Sound mode. +| `speech_enhance` | yes | Boolean to control Speech Enhancement mode. ## {% linkable_title Advanced use %} From aea87d4ee044657109468e5e681fe4de336020c4 Mon Sep 17 00:00:00 2001 From: dnguyen800 <25126347+dnguyen800@users.noreply.github.com> Date: Sat, 30 Mar 2019 06:17:33 -0700 Subject: [PATCH 10/37] Update documentation of 'Z-Wave Devices - Adding and Removing' section (#9026) * Update adding.markdown * :pencil2: Fixes Markdown numbering * :pencil2: Again... --- source/_docs/z-wave/adding.markdown | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/source/_docs/z-wave/adding.markdown b/source/_docs/z-wave/adding.markdown index e40a86276e6..a5275d6f9c1 100644 --- a/source/_docs/z-wave/adding.markdown +++ b/source/_docs/z-wave/adding.markdown @@ -87,11 +87,17 @@ If your device isn't responding to this process, possibly because you've factory 1. Go to the *States* menu under *Developer tools* in the Home Assistant frontend 2. Click on the name of the `zwave.` entity you want to remove -3. At the top, edit the JSON attributes to replace `false` with `true` for `"is_failed": false,` so that it reads `"is_failed": true,` -4. Click **Set State** -5. Go to the Z-Wave control panel in the Home Assistant frontend -6. Click the **Remove Failed Node** button in the *Z-Wave Network Management* card -7. The device will now be removed, but that won't show until you restart Home Assistant +3. Make note of the entity's "node_id" value as you will need to re-add the "node_id" attribute and value in step 4. +4. At the top, edit the JSON attributes to replace `false` with `true` for `"is_failed": false,` so that it reads `"is_failed": true.` Also add the "node_id" value to the number listed in the entity's attribute. The JSON attributes should look something like below: + + ```yaml + {"node_id":6, "is_failed":true} + ``` + +5. Click **Set State** +6. Go to the Z-Wave control panel in the Home Assistant frontend +7. Click the **Remove Failed Node** button in the *Z-Wave Node Management* card +8. The device will now be removed, but that won't show until you restart Home Assistant ## {% linkable_title Troubleshooting %} From 04a4ec89400ee4dbd51ba318b19f24afea148101 Mon Sep 17 00:00:00 2001 From: gremblin Date: Sat, 30 Mar 2019 10:30:42 -0400 Subject: [PATCH 11/37] Grammar update (#8979) * Grammar update I attempted to make it a bit more readable. I'm trying to follow the logic. Maybe these hypothetical tests will clear things up. Example 1: Let's say for example I have a bluetooth beacon and GPS and I leave home. If I forget my bluetooth beacon at home, but have my phone with me then I will be considered 'home' since both devices will be updating and the stationary tracker has priority. Correct? Example 2: Let's say I have a router tracker and GPS and I arrive home. Let's also say that for some reason my WIFI is disabled on my phone. The router tracker hasn't updated in a long time (>1 hour), but my GPS just updated. According the the explained logic... I would be considered 'not_home' since the stationary tracker has priority, correct? Or is the state of 'home' the priority? Since I have a recently updated tracker reporting me as 'home,' then I am considered home? I'd like to add similar examples to the person description to clear up the understanding of the logic after receiving feedback, or if you prefer, add examples yourself. * :pencil2: Tweaks * :pencil2: Markdown tweaks --- source/_components/person.markdown | 31 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/source/_components/person.markdown b/source/_components/person.markdown index db5bf96bbb9..ef3e0a54ffa 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -13,29 +13,27 @@ ha_qa_scale: internal ha_release: 0.88 --- -The person component allows connecting device tracker entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers used, the state of person will be determined next way: +The person component allows connecting [device tracker](https://www.home-assistant.io/components/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order: -1. If there are stationary sources (which type is not 'gps') presenting status 'home', the latest of these sources will be taken. -2. If there are sources of type 'gps', then the latest of these sources will be taken. -3. Otherwise will be taken the latest source with status 'not_home'. +1. If there are stationary trackers (non-GPS trackers, i.e., a router or Bluetooth 'device_trackers') presenting the status 'home', the tracker most recently updated will be used. +2. If there are trackers of type 'gps', then the most recently updated tracker will be used. +3. Otherwise, the latest tracker with status 'not_home' will be used. Let's say, for example, that you have 3 trackers: 'tracker_gps', 'tracker_router' and 'tracker_ble'. -1. You're at home, all 3 devices show status 'home' - status of your Person entity will be 'home' with source 'tracker_router' or 'tracker_ble', whatever was latest. -2. You're going out. 'tracker_gps' shows status 'not_home', but the other two trackers show status 'home' according to their setting 'consider_home'. You are still considered to be at home. -3. After some time both stationary trackers show status 'not_home'. Now your Person entity has status 'not_home' with source 'tracker_gps'. -4. While you are outside your home, your Home Assistant was suddenly restarted. Until 'tracker_gps' receives an update, your status will be determined by stationary tracker, which gets the latest update after a restart. Obviously, the status will be 'not_home'. -5. Then you're going into the area marked as 'zone1', 'tracker_gps' is getting an update, and now your status is 'zone1' with source 'tracker_gps'. -6. You've returned home and your mobile device has connected to the router, but GPS update yet didn't occur. Your status will be 'home' with source 'tracker_router'. -7. After the GPS update occurs, your status will still be 'home' with source 'tracker_router' or 'tracker_ble', whatever updates latest. +1. You're at home, all 3 devices show status 'home' - status of your Person entity will be 'home' with source 'tracker_router' or 'tracker_ble', whichever was most recently updated. +2. You just left home. 'tracker_gps' shows status 'not_home', but the other two trackers show status 'home' (they may not have yet updated due to their 'consider_home' setting see [device_tracker](https://www.home-assistant.io/components/device_tracker/#configuring-a-device_tracker-platform)). Since the stationary trackers have priority, you are considered 'home'. +3. After some time, both stationary trackers show status 'not_home'. Now your Person entity has status 'not_home' with source 'tracker_gps'. +4. While you are away from home, your Home Assistant is restarted. Until 'tracker_gps' receives an update, your status will be determined by the stationary trackers, since they will have the most recent update after a restart. Obviously, the status will be 'not_home'. +5. Then you're going into a zone you have defined as 'zone1', 'tracker_gps' sends an update, and now your status is 'zone1' with source 'tracker_gps'. +6. You've returned home and your mobile device has connected to the router, but 'tracker_gps' hasn't updated yet. Your status will be 'home' with source 'tracker_router'. +7. After the 'tracker_gps' update occurs, your status will still be 'home' with source 'tracker_router' or 'tracker_ble', whichever has the most recent update. -TL;DR: When you're at home, your position is determined firstly by stationary trackers (if any) and then by GPS. When you're outside your home, your position is determined firstly by GPS and then by stationary trackers. +TL;DR: When you're at home, your position is determined first by stationary trackers (if any) and then by GPS. When you're outside your home, your position is determined firstly by GPS and then by stationary trackers. +**Hint**: When you use multiple device trackers together, especially stationary and GPS trackers, it's advisable to set `consider_home` for stationary trackers as low as possible see [device_tracker](https://www.home-assistant.io/components/device_tracker/#configuring-a-device_tracker-platform)). -**Hint**: When you use multiple device trackers together, especially stationary and GPS trackers, it's advisable to set `consider_home` for stationary trackers as low as possible. - - -You can manage persons via the UI from the person page inside the configuration panel or via `YAML`. +You can manage persons via the UI from the person page inside the configuration panel or via `YAML` in your `configuration.yaml` file. ## {% linkable_title Configuring the `person` component via the Home Assistant configuration panel %} @@ -77,7 +75,6 @@ person: type: list, string {% endconfiguration %} - An extended example would look like the following sample: ```yaml From f209cfaa9dda871cd8cc5d717459ab0e6f8c68e8 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 30 Mar 2019 16:33:12 +0100 Subject: [PATCH 12/37] Updates scan interval notice of Toon component (#8975) --- source/_components/toon.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index 4effbc315f8..3a72312b636 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -80,4 +80,4 @@ The `toon` climate platform allows you to interact with your Toon thermostat. Fo It also supports setting the temperature manually. -The Toon API is polled at a 30-second interval, so the status is relatively fresh without overloading the API. +The Toon API is polled at a 300-second interval, so the status is relatively fresh without overloading the API. From 35f4985c97af7e6ef22a20d65bd05b352f9eccf6 Mon Sep 17 00:00:00 2001 From: Daniel Shokouhi Date: Sat, 30 Mar 2019 08:55:21 -0700 Subject: [PATCH 13/37] Add some clarifications for the new service call (#8850) --- source/_components/neato.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 63b20cbde64..6fe4639c023 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -84,9 +84,9 @@ Some information about the capabilities might be found on the [Neato Developer P | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | Only act on a specific robot | | `mode` | yes | Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set. | -| `navigation` | yes | Set the navigation mode: 1 for normal, 2 for extra care, 3 for deep. Defaults to normal if not set. | +| `navigation` | yes | Set the navigation mode: 1 for normal, 2 for extra care, 3 for deep. Defaults to normal if not set. Deep cleaning is only supported on the Botvac D7. | | `category` | yes | Whether to use a persistent map or not for cleaning (i.e. No go lines): 2 for no map, 4 for map. Default to using map if not set (and fallback to no map if no map is found). | -| `zone` | yes | Only supported on the Botvac D7. Name of the zone to clean. Defaults to no zone i.e. complete house cleanup. | +| `zone` | yes | Only supported on the Botvac D7. Name of the zone to clean from the Neato app. Use unique names for the zones to avoid the wrong zone from running. Defaults to no zone i.e. complete house cleanup. | ## {% linkable_title Camera %} From 27731f908aad89be40653ea6f753203620d6a066 Mon Sep 17 00:00:00 2001 From: David Thulke Date: Sat, 30 Mar 2019 17:01:26 +0100 Subject: [PATCH 14/37] clarify expose_by_default and exposed_domains in google_assistant config (#9008) --- 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 3da070904ba..32a35d90c19 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -139,12 +139,12 @@ api_key: required: false type: string expose_by_default: - description: "Expose devices in all supported domains by default. If set to false, you need to either expose domains or add the expose configuration option to each entity in `entity_config` and set it to true." + description: "Expose devices in all supported domains by default. If `exposed_domains` domains is set, only these domains are exposed by default. If `expose_by_default` is set to false, devices have to be manually exposed in `entity_config`." required: false default: true type: boolean exposed_domains: - description: List of entity domains to expose to Google Assistant. + description: List of entity domains to expose to Google Assistant if `expose_by_default` is set to true. This has no effect if `expose_by_default` is set to false. required: false type: list entity_config: From 1a0f35f1bcee4858e69ccf5f635fafe1fc118c72 Mon Sep 17 00:00:00 2001 From: Nicholas Hawkes Date: Sun, 31 Mar 2019 03:24:08 -0400 Subject: [PATCH 15/37] Update installation.markdown (#9081) It is not possible to run the command `add-apt-repository universe` without installing `apt-get software-properties-common` first --- source/hassio/installation.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 7fc36d64ee2..70bfda9db86 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -95,11 +95,13 @@ To perform the Hass.io installation, run the following commands: ```bash sudo -i +apt-get software-properties-common + add-apt-repository universe apt-get update -apt-get install -y apparmor-utils apt-transport-https avahi-daemon ca-certificates curl dbus jq network-manager socat software-properties-common +apt-get install -y apparmor-utils apt-transport-https avahi-daemon ca-certificates curl dbus jq network-manager socat curl -fsSL get.docker.com | sh From bde67b6cc3f09d2d23139fc7ba21653a0c98cba1 Mon Sep 17 00:00:00 2001 From: Chris Helming Date: Sun, 31 Mar 2019 03:26:05 -0400 Subject: [PATCH 16/37] Update notify.html5.markdown (#9080) Added a note on having to delete `html5_push_registrations.conf` when switching from GCM. --- source/_components/notify.html5.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown index d741c065209..525cf8c54e0 100644 --- a/source/_components/notify.html5.markdown +++ b/source/_components/notify.html5.markdown @@ -19,7 +19,7 @@ HTML5 push notifications **do not** work on iOS.

-The GCM configuration option is deprecated and will stop working in April 2019, see [https://developers.google.com/cloud-messaging/faq](https://developers.google.com/cloud-messaging/faq). If you are installing this platform for the first time, follow the VAPID configuration steps. To migrate your current installation from GCM to VAPID configuration, follow the instructions below. You can skip the first 3 steps and continue in step 4 with your existing project. You will also need to [re-enable the notifications in your browser](#setting-up-your-browser). +The GCM configuration option is deprecated and will stop working in April 2019, see [https://developers.google.com/cloud-messaging/faq](https://developers.google.com/cloud-messaging/faq). If you are installing this platform for the first time, follow the VAPID configuration steps. To migrate your current installation from GCM to VAPID configuration, follow the instructions below. You can skip the first 3 steps and continue in step 4 with your existing project. You will also need to delete `html5_push_registrations.conf` and [re-enable the notifications in your browser](#setting-up-your-browser).

## {% linkable_title Configuration %} From 1d2eb9f4127cc12dc8a338ec2ce0b7a2680ce15f Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 31 Mar 2019 11:41:21 +0100 Subject: [PATCH 17/37] Adding upgrade details (#8643) * Adding upgrade details Adding details here on how to upgrade and run specific versions, rather than leaving them as incomplete generic steps in the Updating page * :pencil2: Tweaks --- .../_docs/installation/raspberry-pi.markdown | 38 ++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index 136c1ae2bb5..2e412cf0756 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -106,7 +106,43 @@ $ source /srv/homeassistant/bin/activate $ pip3 install --upgrade homeassistant ``` -Once the last command executes restart the Home Assistant service to apply the latest updates. Please keep in mind that some updates may take longer to boot up than others. If Home Assistant fails to start make sure you check the **Breaking Changes** from the [Release Notes](https://github.com/home-assistant/home-assistant/releases). +Once the last command executes, restart the Home Assistant service to apply the latest updates. Please keep in mind that some updates may take longer to start up than others. If Home Assistant fails to start, make sure you check the **Breaking Changes** from the [Release Notes](https://github.com/home-assistant/home-assistant/releases). + +### {% linkable_title Run a specific version %} + +In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release. For example: + +```bash +$ sudo -u homeassistant -H -s +$ source /srv/homeassistant/bin/activate +$ pip3 install homeassistant==0.XX.X +``` + +### {% linkable_title Run the beta version %} + +If you would like to test next release before anyone else, you can install the beta version released every two weeks, for example: + +```bash +$ sudo -u homeassistant -H -s +$ source /srv/homeassistant/bin/activate +$ pip3 install --pre --upgrade homeassistant +``` + +### {% linkable_title Run the development version %} + +If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`. + +

+ The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption. +

+ +For example: + +```bash +$ sudo -u homeassistant -H -s +$ source /srv/homeassistant/bin/activate +$ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev +``` ### {% linkable_title Activating the virtual environment %} From abb3edbbcf23286c6624de00ca448b91463b0f32 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 31 Mar 2019 11:43:30 +0100 Subject: [PATCH 18/37] Adding details here on running version (#8644) Instead of missing this out here, pulling the details from the Hassbian scripts docs --- .../hassbian/installation.markdown | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/source/_docs/installation/hassbian/installation.markdown b/source/_docs/installation/hassbian/installation.markdown index 26d1f729441..7b5017e7eb7 100644 --- a/source/_docs/installation/hassbian/installation.markdown +++ b/source/_docs/installation/hassbian/installation.markdown @@ -98,3 +98,33 @@ SSH to your system as the user `pi` and run: ```bash $ sudo hassbian-config upgrade hassbian ``` + +## {% linkable_title Run a specific version %} + +In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release. For example: + +```bash +$ sudo hassbian-config upgrade homeassistant=0.XX.X +``` + +#### {% linkable_title Run the beta version %} + +If you would like to test next release before anyone else, you can install the beta version released every two weeks, for example: + +```bash +$ sudo hassbian-config upgrade homeassistant --beta +``` + +## {% linkable_title Run the development version %} + +If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`. + +

+ The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption. +

+ +For example: + +```bash +$ sudo hassbian-config upgrade homeassistant --dev +``` From b802eb693798afb5e860a332866dd956e3181838 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 31 Mar 2019 11:45:30 +0100 Subject: [PATCH 19/37] Adding update and version details (#8645) Adding details here on how to update, install specific versions, and join the beta releases. --- source/hassio/installation.markdown | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 70bfda9db86..e7db56bc8ef 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -65,6 +65,33 @@ Now you can [configure][configure] your install. If you copy over your existing Home Assistant configuration, make sure to enable the Hass.io panel by adding either `discovery:` or `hassio:` to your configuration. +## {% linkable_title Updating a Hass.io installation %} + +Best practice for updating a Hass.io installation: + +1. Backup your installation, using the snapshot functionality Hass.io offers. +2. Check the release notes for breaking changes on [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**. +3. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on. +4. If the check passes, you can safely update. If not, update your configuration accordingly. +5. Select _Dashboard_ from the _Hass.io_ menu, and then select _Update_. + +## {% linkable_title Run a specific version on Hass.io %} + +SSH to your Hass.io system, or connect to the console, and run: + +``` +hassio ha update --version=0.XX.X +``` + +## {% linkable_title Run the beta version on Hass.io %} + +If you would like to test next release before anyone else, you can install the beta version released every two weeks: + +1. Backup your installation, using the snapshot functionality Hass.io offers. +2. Check the RC release notes for breaking changes on [Home Assistant release notes](https://rc--home-assistant-docs.netlify.com/latest-release-notes/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**. +3. Select _System_ from the _Hass.io_ menu, then select _Join Beta Channel_ under _Hass.io supervisor_, then select _Reload_. +4. Select _Dashboard_ from the _Hass.io_ menu, and then select _Update_. + ## {% linkable_title Alternative: install on generic Linux server %} For advanced users, it is also possible to try Hass.io on your [Linux server or inside a virtual machine][linux]. From 5ed9c98da774bd35e32136a0f9fc04e6d6f590de Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 31 Mar 2019 11:46:15 +0100 Subject: [PATCH 20/37] Adding details on upgrade, beta, and versions (#8646) Rather than incomplete instructions in the upgrade page, adding the details here --- source/_docs/installation/virtualenv.markdown | 51 +++++++++++++++---- 1 file changed, 40 insertions(+), 11 deletions(-) diff --git a/source/_docs/installation/virtualenv.markdown b/source/_docs/installation/virtualenv.markdown index 548c776ce22..3b4c5914c42 100644 --- a/source/_docs/installation/virtualenv.markdown +++ b/source/_docs/installation/virtualenv.markdown @@ -48,26 +48,55 @@ It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/) $ hass --open-ui ``` 8. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take up to 20 minutes before the web interface is available - ### {% linkable_title Upgrade %} 1. Stop Home Assistant - 2. Open the directory where the virtual environment is located: - ``` + 2. Open the directory where the virtual environment is located, activate the virtual environment, then upgrade Home Assistant: + ```bash $ cd homeassistant - ``` - 3. Activate the virtual environment: - ``` $ source bin/activate - ``` - 4. Upgrade Home Assistant: - ``` $ python3 -m pip install --upgrade homeassistant ``` - 5. Start Home Assistant - 6. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take up to 20 minutes before the web interface is available + 3. Start Home Assistant + 4. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take up to 20 minutes before the web interface is available + +### {% linkable_title Run a specific version %} + +In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release. For example: + +```bash +$ cd homeassistant +$ source bin/activate +$ pip3 install homeassistant==0.XX.X +``` + +#### {% linkable_title Run the beta version %} + +If you would like to test next release before anyone else, you can install the beta version released every two weeks, for example: + +```bash +$ cd homeassistant +$ source bin/activate +$ pip3 install --pre --upgrade homeassistant +``` + +#### {% linkable_title Run the development version %} + +If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`. + +

+ The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption. +

+ +For example: + +```bash +$ cd homeassistant +$ source bin/activate +$ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev +``` ### {% linkable_title Notes %} From 91f2dd7657fdab911907a52bd9e5e006d8bf552f Mon Sep 17 00:00:00 2001 From: Dominik Palo Date: Sun, 31 Mar 2019 13:03:50 +0200 Subject: [PATCH 21/37] Update the docs for the Xiaomi Gateway component (#8890) * Update the docs * Fix typos * Fix typos * Remove the unnecessary last step --- source/_components/xiaomi_aqara.markdown | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index b1b6f112e47..d56e3464fc0 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -277,3 +277,14 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances, there is an issue with keys being generated using the iOS application. - You need to make sure to have multicast support on your network. If you are running Home Assistant in a virtual machine (like Proxmox), try `echo 0 >/sys/class/net/vmbr0/bridge/multicast_snooping` on the host and restart the service or reboot the host. - If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`). +- If your gateway's MAC address starts with `04:CF:8C`, there is a good chance that the required port `9898` is closed on your gateway (you can check it with the Nmap utility, using the command `sudo nmap - sU {gateway_ip} -p 9898`). To fix that issue, you need to do these steps: + - Find a specific screw bit (like a fork) to open the gateway case. + - Find a USB-UART cable/module and connect it to your computer. + - Solder 3 wires - RX, TX and GND like [here](http://cs5-3.4pda.to/14176168/IMG_20181020_201150.jpg). + - Turn on the gateway (220V). + - Open a serial terminal application (e.g. PuTTY) and connect to the serial port assigned to the USB-UART module (baudrate: 115200). + - Wait until the gateway is booted up, connect the RX, TX and GND wires to the UART module (don't connect the Vcc (power) wire!). + - You will see all the messages from the gateway. + - Send the command `psm-set network.open_pf 3` (the command has to end with a `CR` newline character). + - Check your settings executing the command `psm-get network.open_pf` to be sure it's OK. + - Restart the gateway. From 19cc1c6eb9e0268a80cbdaa1da5b3753ee67bff4 Mon Sep 17 00:00:00 2001 From: Gary Barclay Date: Sun, 31 Mar 2019 12:19:25 +0100 Subject: [PATCH 22/37] Add warning re hub version. (#8999) * Add warning re hub version. Make clarification on hub API access status as it really was not clear. * :pencil2: Tweaks * :pencil2: Tweaks --- source/_components/xiaomi_aqara.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index d56e3464fc0..ee8729d4b9e 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -16,6 +16,8 @@ redirect_from: /components/xiaomi/ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/en/) Aqara-compatible devices into Home Assistant. +Please note, there are two versions of the hub: v1 and v2. v1 can be used with Home Assistant without any problems, however, v2 might be less straight forward when it comes to enabling the local API, and might even require you to open up your device in order to do so. Xiaomi has suggested this is in the pipeline. + ## {% linkable_title Supported Devices %} - Aqara Air Conditioning Companion (lumi.acpartner.v3) From e63fcdd6b75865aa4dbe13739d5435fc195e7865 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 1 Apr 2019 15:32:30 +0200 Subject: [PATCH 23/37] Fix snippet formatting (#9089) --- source/_components/sensor.rmvtransport.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.rmvtransport.markdown b/source/_components/sensor.rmvtransport.markdown index 5bcde6f84dc..20976e3844b 100644 --- a/source/_components/sensor.rmvtransport.markdown +++ b/source/_components/sensor.rmvtransport.markdown @@ -111,6 +111,6 @@ sensor: The first sensor will return S-Bahn, bus, RB and RE trains departures from Frankfurt Hauptbahnhof to Frankfurt Airport or Stadium that are at least 5 minutes away. -The second sensor returns bus departures from Wiesbaden Hauptbahnhof going to Dernsches Gelände and Mainz Hauptbahnhof. To retrieve the time of the second departure, you would use states.sensor.ENTITY_NAME.attributes.departures[1].time. +The second sensor returns bus departures from Wiesbaden Hauptbahnhof going to Dernsches Gelände and Mainz Hauptbahnhof. To retrieve the time of the second departure, you would use `states.sensor.ENTITY_NAME.attributes.departures[1].time`. The third sensor returns all S-Bahn trains from Mainz Hauptbahnhof for line S8. From 3d1ae6500050e946b07f192c805108a8aaf0face Mon Sep 17 00:00:00 2001 From: Bram Mittendorff Date: Mon, 1 Apr 2019 22:32:26 +0200 Subject: [PATCH 24/37] Update installation.markdown (#9092) Changed `apt-get software-properties-common` because this will not work. You need to use `apt-get install software-properties-common` --- source/hassio/installation.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index e7db56bc8ef..7fed6d468f1 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -122,7 +122,7 @@ To perform the Hass.io installation, run the following commands: ```bash sudo -i -apt-get software-properties-common +apt-get install software-properties-common add-apt-repository universe From e31c0281fe331cf71a0935adb21cee0812198066 Mon Sep 17 00:00:00 2001 From: Robbie Trencheny Date: Mon, 1 Apr 2019 14:17:24 -0700 Subject: [PATCH 25/37] Android --- source/_posts/2019-04-01-android.markdown | 52 +++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 source/_posts/2019-04-01-android.markdown diff --git a/source/_posts/2019-04-01-android.markdown b/source/_posts/2019-04-01-android.markdown new file mode 100644 index 00000000000..5eaec15929a --- /dev/null +++ b/source/_posts/2019-04-01-android.markdown @@ -0,0 +1,52 @@ +--- +layout: post +title: "When will there be an official Home Assistant for Android app???" +description: "Announcing Home Assistant Companion for Android" +date: 2019-04-01 00:01:00 +date_formatted: "April 1, 2019" +author: Robbie Trencheny +author_twitter: robbie +comments: true +categories: Announcements +--- + +1 year, 11 months and 17 days ago or 716 days ago, [I announced Home Assistant Companion for iOS on this blog](https://www.home-assistant.io/blog/2017/04/15/ios/). +Ever since then, at least once a week, sometimes far more often, I am asked a question that I haven't been able to truly answer until today. +It's a question that has gotten on my nerves almost every time I've seen it. I could understand why people were wanting an official Android app to mirror the functionality of the iOS app. +But I never thought of myself as the person to best deliver on that idea. + +Recently, these requests have reached a ear shattering volume and I had enough. It had been almost 2 years and no official app had materialized. It was time for me to act. +So I bought a Pixel 3 and re-immersed myself in Android, not having used it for more than a few minutes since my Nexus 5. It's changed a lot, for the better in my mind, since that time. +I knew I could do this. I did it once before. It will require learning a new language, Kotlin, but I learned Swift to build the iOS app and that worked out well. + +So here I am, announcing to you, that the official Home Assistant Companion for Android will soon be under development. + +I'm going to try to duplicate the timeline of the iOS app as much as possible, although with less time between releases to start. The 1.0 will feature three core features: + +1. A location engine to rival the iOS app. This means location updates while out and about as well as region monitoring. +2. Push notifications that aim to be just as powerful as iOS. Actions and sounds will be added to start and eventually I hope to add embedded content like camera streams and maps. No more need for HTML5 notifications. +3. A full screen view for the beautiful web UI that Paulus and co have built. That's right, no native UI, at least for now. + +Long term, I hope to provide a similar feature set on Android as on iOS. That means Android Wear support, sensors and widgets. + +If you're an iOS user reading this, don't fret. Here's the current timeline I'm working on: + +- April 1, 2019: Announce the Android app +- No later than April 31st, 2019: Release iOS 2.0 to the App Store +- Early to mid summer, 2019: Release first beta of the Android app +- Mid to late summer, 2019: Release 1.0 of the Android app to the Play Store +- Late summer to mid fall, 2019: Adopt new features in iOS 13 into the iOS app, version 2.5. + +I've already laid the groundwork in Home Assistant itself by implementing the utterly fantastic `mobile_app` component which provides a very secure and featureful integration system for mobile apps. + +Now, i'd like to take a moment to address the elephant in the room: What about the other Android apps that have cropped up to fill the void left without having an official app for so long? The answer is, nothing. +The authors of those apps are absolutely welcome to continue to build their apps as they see fit, we at Home Assistant will of course do nothing to stop them or hinder their progress. + +You might be wondering why we are choosing to do this now, other than the previously mentioned constant questions. Recently, we've seen a worrying uptick in the number of apps making poor integration choices or outright horrifying security choices. +Furthermore, Home Assistant will always remain free and your privacy is a key part of our mission. Because of that key ideal, we don't like seeing ads in Home Assistant mobile apps as they have been previously shown to not care about your privacy and in some cases be downright dangerous. +We wanted to provide a full featured solution that was open source and cared about your privacy. + +So that's it. The app that 74.15 % of you have been waiting for. Coming soon to a Play Store near you. You'll be hearing and seeing progress on it very soon via this blog, Twitter, Facebook, Discord, and more. + +Finally, I'm going to make a public plug for my [Patreon](https://patreon.com/robbiet480) which will hopefully soon enable me to spend 100% of my time on Home Assistant for the rest of 2019. +That means full time on iOS, Android and more fun. Thanks in advance for your ongoing support. From 2aeba10c7e862e71c608557735d0066f180fe6b9 Mon Sep 17 00:00:00 2001 From: Robbie Trencheny Date: Mon, 1 Apr 2019 14:25:26 -0700 Subject: [PATCH 26/37] Minor niceness tweak --- source/_posts/2019-04-01-android.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_posts/2019-04-01-android.markdown b/source/_posts/2019-04-01-android.markdown index 5eaec15929a..b5496d5343a 100644 --- a/source/_posts/2019-04-01-android.markdown +++ b/source/_posts/2019-04-01-android.markdown @@ -40,7 +40,8 @@ If you're an iOS user reading this, don't fret. Here's the current timeline I'm I've already laid the groundwork in Home Assistant itself by implementing the utterly fantastic `mobile_app` component which provides a very secure and featureful integration system for mobile apps. Now, i'd like to take a moment to address the elephant in the room: What about the other Android apps that have cropped up to fill the void left without having an official app for so long? The answer is, nothing. -The authors of those apps are absolutely welcome to continue to build their apps as they see fit, we at Home Assistant will of course do nothing to stop them or hinder their progress. +Authors of third party apps can continue to build their app and provide innovative features that blend phone and Home Assistant. They will be able to leverage the foundation that was put in place for them: the mobile app component. +These apps are part of our ecosystem and we don't intend to push them out, but embrace them. The better apps they can offer, the more choice our users have and the better it is for the Home Assistant ecosystem. You might be wondering why we are choosing to do this now, other than the previously mentioned constant questions. Recently, we've seen a worrying uptick in the number of apps making poor integration choices or outright horrifying security choices. Furthermore, Home Assistant will always remain free and your privacy is a key part of our mission. Because of that key ideal, we don't like seeing ads in Home Assistant mobile apps as they have been previously shown to not care about your privacy and in some cases be downright dangerous. From a7cd9d8794190aa4f0ac092ce4cf4cc41c59022b Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 1 Apr 2019 15:11:46 -0700 Subject: [PATCH 27/37] Add remote ui ref --- source/_docs/configuration/remote.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_docs/configuration/remote.markdown b/source/_docs/configuration/remote.markdown index 13637d41147..89fef2c9e1b 100644 --- a/source/_docs/configuration/remote.markdown +++ b/source/_docs/configuration/remote.markdown @@ -9,6 +9,8 @@ sharing: true footer: true --- +

Users of Home Assistant Cloud can use the Remote UI without requiring any configuration.

+ If you're interested in logging in to Home Assistant while away, you'll have to make your instance remotely accessible.

From 17707ae65b38c5e98b9aa307d11c9290b111d192 Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 2 Apr 2019 09:49:29 +0200 Subject: [PATCH 28/37] Updated with confirmed AU models working (#9100) --- source/_components/daikin.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index addd13452d7..f7dcd4d9de9 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -27,7 +27,9 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Supported hardware %} -**Only** the European versions of Daikin AC (models BRP069A41, 42, 43, 45). +The European versions of Daikin AC (models BRP069A41, 42, 43, 45). + +The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [DAIKIN Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) Some models do not support setting of fan speed or fan swing mode. From 60e73110869242ff0154122c133562d10a6e5dbf Mon Sep 17 00:00:00 2001 From: Jason White Date: Tue, 2 Apr 2019 03:02:19 -0500 Subject: [PATCH 29/37] Update device-specific.markdown (#9099) * Update device-specific.markdown Expand Aeotec Z-Stick section to provide alternative "pipe to cu" syntax for enabling/disabling "disco lights" on systems where redirection to serial devices doesn't work because the baud rate on the serial device reverts to 9600 when haas isn't running. * :pencil2: Tweaks --- source/_docs/z-wave/device-specific.markdown | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 50eb7ef7a05..845dc0fa1d9 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -45,7 +45,13 @@ Turn on "Disco lights": $ echo -e -n "\x01\x08\x00\xF2\x51\x01\x01\x05\x01\x50" > /dev/serial/by-id/usb-0658_0200-if00 ``` -If the above two commands give errors about not having that device, you should try replacing the `/dev/serial/by-id/usb-0658_0200-if00` with `/dev/ttyACM0` or `/dev/ttyACM1` (depending on which tty your aeotec stick is addressed to). +If the above two commands give errors about not having that device, you should try replacing the `/dev/serial/by-id/usb-0658_0200-if00` with `/dev/ttyACM0` or `/dev/ttyACM1` (depending on which tty your Aeotec stick is addressed to). + +On some systems, such as macOS, you need to pipe the output of the `echo` command, rather than redirecting to the serial device, to something like `cu` (replacing `/dev/zstick` acccordingly) to properly set the baud rate to 115200 bps: + +```bash +echo -e -n "...turn on/off string from examples above..." | cu -l /dev/zstick -s 115200 +``` ### {% linkable_title Razberry Board %} From 042a0d2688f631c98072e79c35c184e03fe0ba27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaros=C5=82aw=20Salwa?= Date: Tue, 2 Apr 2019 10:05:15 +0200 Subject: [PATCH 30/37] Update vacuum.markdown with return_to_base service (#9094) Fix documentation and replace wrong service (return_to_home) with a proper one (return_to_base). --- source/_components/vacuum.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index ffdf18dabf9..2a5da6f3263 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -26,7 +26,7 @@ vacuum: ### {% linkable_title Component services %} -Available services: `turn_on`, `turn_off`, `start_pause`, `start`, `pause`, `stop`, `return_to_home`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`. +Available services: `turn_on`, `turn_off`, `start_pause`, `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean_spot`, `set_fanspeed` and `send_command`. Before calling one of these services, make sure your vacuum platform supports it. @@ -78,7 +78,7 @@ Stop the current activity of the vacuum. |---------------------------|----------|-------------------------------------------------------| | `entity_id` | yes | Only act on specific vacuum. Else targets all. | -#### {% linkable_title Service `vacuum.return_to_home` %} +#### {% linkable_title Service `vacuum.return_to_base` %} Tell the vacuum to return home. From 33618cf29d7c6c53d4a59ab7d96b3912a267366e Mon Sep 17 00:00:00 2001 From: Adam <22942687+SilvrrGIT@users.noreply.github.com> Date: Tue, 2 Apr 2019 03:39:57 -0500 Subject: [PATCH 31/37] Cleanup of Cookbook examples Round 2 (#9091) * Delete configuration_yaml_by_silvrr.markdown Repo no longer available * Delete configuration_yaml_by_daniel_hoyer_iversen.markdown Latest substantial change 8 months ago. * Delete configuration_yaml_by_lancehaynie.markdown Broken link. * Delete configuration_yaml_by_skalavala.markdown "Repository unavailable due to DMCA takedown." * Delete configuration_yaml_by_gstevenson.markdown No activity for a least 11 months. --- ...nfiguration_yaml_by_daniel_hoyer_iversen.markdown | 12 ------------ .../configuration_yaml_by_gstevenson.markdown | 12 ------------ .../configuration_yaml_by_lancehaynie.markdown | 12 ------------ .../_cookbook/configuration_yaml_by_silvrr.markdown | 12 ------------ .../configuration_yaml_by_skalavala.markdown | 12 ------------ 5 files changed, 60 deletions(-) delete mode 100644 source/_cookbook/configuration_yaml_by_daniel_hoyer_iversen.markdown delete mode 100644 source/_cookbook/configuration_yaml_by_gstevenson.markdown delete mode 100644 source/_cookbook/configuration_yaml_by_lancehaynie.markdown delete mode 100644 source/_cookbook/configuration_yaml_by_silvrr.markdown delete mode 100644 source/_cookbook/configuration_yaml_by_skalavala.markdown diff --git a/source/_cookbook/configuration_yaml_by_daniel_hoyer_iversen.markdown b/source/_cookbook/configuration_yaml_by_daniel_hoyer_iversen.markdown deleted file mode 100644 index 5fe391eb75b..00000000000 --- a/source/_cookbook/configuration_yaml_by_daniel_hoyer_iversen.markdown +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: page -title: "Configuration.yaml by Daniel Høyer Iversen" -description: "" -date: 2016-10-11 11:45 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Example configuration.yaml -ha_external_link: https://github.com/Danielhiversen/home-assistant_config ---- diff --git a/source/_cookbook/configuration_yaml_by_gstevenson.markdown b/source/_cookbook/configuration_yaml_by_gstevenson.markdown deleted file mode 100644 index eadfbfe2c02..00000000000 --- a/source/_cookbook/configuration_yaml_by_gstevenson.markdown +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: page -title: "Configuration.yaml by gstevenson" -description: "" -date: 2016-07-13 21:58 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Example configuration.yaml -ha_external_link: https://github.com/gstevenson/ha-config ---- diff --git a/source/_cookbook/configuration_yaml_by_lancehaynie.markdown b/source/_cookbook/configuration_yaml_by_lancehaynie.markdown deleted file mode 100644 index d4c6d0e0598..00000000000 --- a/source/_cookbook/configuration_yaml_by_lancehaynie.markdown +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: page -title: "Configuration.yaml by Lance Haynie" -description: "" -date: 2017-08-18 18:33 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Example configuration.yaml -ha_external_link: https://git.haynienetworks.com/projects/HRDPUBLIC/repos/jarvis/browse ---- diff --git a/source/_cookbook/configuration_yaml_by_silvrr.markdown b/source/_cookbook/configuration_yaml_by_silvrr.markdown deleted file mode 100644 index 847b4bf1c07..00000000000 --- a/source/_cookbook/configuration_yaml_by_silvrr.markdown +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: page -title: "Configuration.yaml by silvrr" -description: "" -date: 2018-1-18 13:08 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Example configuration.yaml -ha_external_link: https://github.com/SilvrrGIT/HomeAssistant ---- diff --git a/source/_cookbook/configuration_yaml_by_skalavala.markdown b/source/_cookbook/configuration_yaml_by_skalavala.markdown deleted file mode 100644 index 28550e1d7d6..00000000000 --- a/source/_cookbook/configuration_yaml_by_skalavala.markdown +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: page -title: "Configuration.yaml by Mahasri Kalavala" -description: "" -date: 2017-04-19 12:00 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Example configuration.yaml -ha_external_link: https://github.com/skalavala/smarthome ---- From 79ea274a2f634513d8febf539552a1e335aaaf20 Mon Sep 17 00:00:00 2001 From: ErikS Date: Tue, 2 Apr 2019 13:19:59 +0300 Subject: [PATCH 32/37] added boot partition CONFIG directory option (#9093) i was confused myself, while trying to configure wifi, added option that finally helped me. --- source/hassio/installation.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 7fed6d468f1..b791391b54c 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -39,7 +39,10 @@ The following will take you through the steps required to install Hass.io. - Flash the downloaded image to an SD card using [balenaEtcher][balenaEtcher]. If using a Pi we recommend at least a 32 GB SD card to avoid running out of space. On Virtual machine platforms, provide at least 32 GB of disk space for the VM. - Load the appliance image into your virtual machine software. Choose 64-bit Linux and UEFI boot. -3. Optional - set up the WiFi or static IP: On a USB stick, create the `network/my-network` file and follow the [HassOS howto][hassos-network]. +3. Optional - set up the WiFi or static IP. There are two possible places for that: +- On a blank USB stick with Fat32 partition (partition label: "CONFIG"), while in / directory, create `network/my-network` file +- or on Hassio SD card first, bootable partition (might not be auto mounted in Linux) create `CONFIG/network/my-network` file +For the content of this file follow the [HassOS howto][hassos-network]. 4. For image-based installs insert the SD card (and optional USB stick) into the device. From 641b08e5057942ac5e0abe5449e66144e6cfb74f Mon Sep 17 00:00:00 2001 From: Patrik Hermansson Date: Tue, 2 Apr 2019 14:56:48 +0200 Subject: [PATCH 33/37] Adjusted rgb-color section, added example Added a note about needed square brackets for rgb values. Also added an example how this is done. --- source/_components/light.markdown | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/source/_components/light.markdown b/source/_components/light.markdown index 191109246b0..45c0bd022b9 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -35,7 +35,7 @@ Most lights do not support all attributes. You can check the platform documentat | `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color and a brightness. If a profile is given and a brightness then the profile brightness will be overwritten. | `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. | `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. You can find a great chart here: [Hue Color Chart](https://developers.meethue.com/documentation/core-concepts#color_gets_more_complicated). -| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB. Note that the specified RGB value will not change the light brightness, only the color. +| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets. Note that the specified RGB value will not change the light brightness, only the color. | `white_value` | yes | Integer between 0 and 255 for how bright a dedicated white LED should be. | `color_temp` | yes | An integer in mireds representing the color temperature you want the light to be. | `kelvin` | yes | Alternatively, you can specify the color temperature in Kelvin. @@ -65,6 +65,20 @@ automation: brightness: 255 kelvin: 2700 ``` +```yaml +# Ledlist morning on, red +- id: llmor + alias: Stair morning on + trigger: + - at: '05:00' + platform: time + action: + - service: light.turn_on + data: + entity_id: light.ledliststair + brightness: 130 + rgb_color: [255,0,0] +``` ### {% linkable_title Service `light.turn_off` %} From a85d738aa6d76743f5666247bfb8f57e7c370670 Mon Sep 17 00:00:00 2001 From: seanvictory Date: Tue, 2 Apr 2019 11:31:22 -0700 Subject: [PATCH 34/37] Updated Automation 2 (#9105) Fixed title heading --- source/getting-started/automation-2.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started/automation-2.markdown b/source/getting-started/automation-2.markdown index fd645b6ac7d..a7cb8201c32 100644 --- a/source/getting-started/automation-2.markdown +++ b/source/getting-started/automation-2.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Your second Automation" +title: "Your Second Automation" description: "Step by step guiding through making your second automation." date: 2016-04-24 08:30 +0100 sidebar: true From 5d970c1cd818fc91a1b10400a721bfce6d09df47 Mon Sep 17 00:00:00 2001 From: seanvictory Date: Tue, 2 Apr 2019 11:31:49 -0700 Subject: [PATCH 35/37] Update Index (#9104) Fixed spacing for consistency --- source/getting-started/index.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index 756aacaf8ef..eade77a5557 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -44,7 +44,7 @@ We will need a few things to get started with installing Home Assistant. For bes - Create a folder named `network` in the root of the newly formatted USB-stick. - Within that folder create a file named `my-network` without extension. - Copy one of [the examples] to the `my-network` file. - - Plug the USB-stick into the RaspberryPi 3. + - Plug the USB-stick into the Raspberry Pi 3. 1. Unmount the SD card and remove it from your SD card reader. 1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too. 1. Connect your Raspberry Pi to the power supply, so it turns on. From 72ca63441020b67c14a31c9a1d6850f92861371c Mon Sep 17 00:00:00 2001 From: a-r-j-a-n Date: Wed, 3 Apr 2019 08:47:24 +0200 Subject: [PATCH 36/37] Update media_player.markdown Fixed typo --- source/_components/media_player.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 5bfb1c3fd08..e11273a4750 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -42,7 +42,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | `entity_id` | yes | Target a specific media player. Defaults to all. | | `seek_position` | no | Position to seek to. The format is platform dependent. | -#### {% linkable_title Service `media_player.play_media` %} +#### {% linkable_title Service `media_player.media_play` %} | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | From 41c122f9fb24e3e14c64ae00d27a4c3dd861ca88 Mon Sep 17 00:00:00 2001 From: rasmuoy <45128715+rasmuoy@users.noreply.github.com> Date: Wed, 3 Apr 2019 15:27:30 +0200 Subject: [PATCH 37/37] Update sensor.hp_ilo.markdown (#9110) https://pythonhosted.org/python-hpilo/ is dead -> http://seveas.github.io/python-hpilo/ is new location --- source/_components/sensor.hp_ilo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.hp_ilo.markdown b/source/_components/sensor.hp_ilo.markdown index e3a70e36d60..235e67b939b 100644 --- a/source/_components/sensor.hp_ilo.markdown +++ b/source/_components/sensor.hp_ilo.markdown @@ -17,7 +17,7 @@ The `hp_ilo` platform allows you to do an API call to the HP ILO (Integrated Lig If the ILO or specified jsonpath query returns only a single value (e.g., a temperature or state), it will be put in the state field. If a data structure is returned, it will be placed in the `ilo_data` attribute. -Some more details about what can be retrieved from these sensors is available in the [python-hpilo documentation](http://pythonhosted.org/python-hpilo/). +Some more details about what can be retrieved from these sensors is available in the [python-hpilo documentation](http://seveas.github.io/python-hpilo/).