From c5886f0e7fcf8fa781dbff0a2475a4199f1e90db Mon Sep 17 00:00:00 2001 From: Daniel Hyles Date: Tue, 29 Dec 2020 01:16:56 +1100 Subject: [PATCH 1/7] Add doco on new feature (#16028) Co-authored-by: Franck Nijhof --- source/_integrations/monoprice.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/monoprice.markdown b/source/_integrations/monoprice.markdown index f2387377fcf..a2f86bfdca2 100644 --- a/source/_integrations/monoprice.markdown +++ b/source/_integrations/monoprice.markdown @@ -21,6 +21,8 @@ Menu: **Configuration** -> **Integrations**. Click on the `+` sign to add an integration and click on **Monoprice**. Select the serial port to which Monoprice amplifier is connected, and name the six sources (leave sources you're not using empty). +If you are using an IP232 module instead of a direct serial connection, then use `socket://:` in the port setting. + Sources can also be later edited from the integration options (gear icon in the top right when selecting the integration). Note that editing sources will remove the snapshot you may have saved. ## Zone Management From 6d016d52c3d039f064cca58b313b16bcd88542fb Mon Sep 17 00:00:00 2001 From: Deez73 <46578629+Deez73@users.noreply.github.com> Date: Mon, 28 Dec 2020 16:07:28 +0100 Subject: [PATCH 2/7] Port change for Unifi OS upgraded Cloud Key G2+ (#16022) --- source/_integrations/unifi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown index 87fd9cfdd98..1099a178190 100644 --- a/source/_integrations/unifi.markdown +++ b/source/_integrations/unifi.markdown @@ -39,7 +39,7 @@ The UniFi controller allows you to create multiple users on it besides the main ### UniFi OS -For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro needs the port to be 443. +For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443. ### Conflicts with MQTT From b9e54d8a5c3c46bfcd386a8b52d7594b23161ed1 Mon Sep 17 00:00:00 2001 From: Kasper Malfroid Date: Mon, 28 Dec 2020 18:25:42 +0100 Subject: [PATCH 3/7] Add more configuration.yaml guidance (#15989) --- source/_integrations/zha.markdown | 86 +++++++++++++++++++------------ 1 file changed, 52 insertions(+), 34 deletions(-) diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index eb597b72007..406f5179f40 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -139,6 +139,10 @@ If you are use ZiGate or Sonoff ZBBridge you have to use some special usb_path c - Wifi Zigate : `socket://[IP]:[PORT]` for example `socket://192.168.1.10:9999` - Sonoff ZBBridge : `socket://[IP]:[PORT]` for example `socket://192.168.1.11:8888` +## Configuration - YAML + +For more advanced configuration, you can modify `configuration.yaml` and restart Home Assistant + {% configuration %} database_path: description: _Full_ path to the database which will keep persistent network data. @@ -151,13 +155,60 @@ enable_quirks: default: true {% endconfiguration %} -To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset. +### OTA firmware updates +ZHA component does have the ability to automatically download and perform OTA (Over-The-Air) firmware updates of Zigbee devices if the OTA firmware provider source URL for updates is available. OTA firmware updating is set to disabled (`false`) in the configuration by default. + +Currently, OTA providers for firmware updates are only available for IKEA and LEDVANCE devices. OTA updates for device of other manufactures could possible also be supported by ZHA dependencies in the future, if these manufacturers publish their firmware publicly. + +To enable OTA firmware updates for the ZHA integration you need to add the following configuration to your `configuration.yaml` and restart Home Assistant: + +```yaml +zha: + zigpy_config: + ota: + ikea_provider: true # Auto update Trådfri devices + ledvance_provider: true # Auto update LEDVANCE devices + #otau_directory: /path/to/your/ota/folder # Utilize .ota files to update everything else +``` + +You can choose if the IKEA or LEDVANCE provider should be set to enabled (`true`) or disabled (`false`) individually. After the OTA firmware upgrades are finished, you can set these to `false` again if you do not want ZHA to automatically download and perform OTA firmware upgrades in the future. + +Note that the `otau_directory` setting is optional and can be used for any firmware files you have downloaded yourself. + +### Defining Zigbee channel to use + +```yaml +zha: + zigpy_config: + network: + channel: 15 # What channel the radio should try to use. + channels: [15, 20, 25] # Channel mask +``` + +This is a good reference for channel selection [Zigbee and Wifi Coexistance](https://support.metageek.com/hc/en-us/articles/203845040-ZigBee-and-WiFi-Coexistence) + +### Modifying the device type + +As not all device manufacturers follow the Zigbee standard, at times a device can be incorrectly classified. For example, a switch could be classified as a light. + +To correct the device type, also called domain, add the following to your `configuration.yaml` and restart Home Assistant: + +```yaml +zha: + device_config: + 84:71:27:ff:fe:93:17:24-1: # format: {ieee}-{endpoint_id} + type: 'switch' # corrected device type +``` + +`{ieee}` is the device hardware address which can be read from the Home Assistant UI when looking at *Device info*. From device info, you can find the `{endpoint_id}` by viewing the *Zigbee device signature*. ## Services ### Service `zha.permit` +To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset. + This service opens network for joining new devices. | Data | Optional | Description | @@ -192,39 +243,6 @@ This service remove an existing device from the network. | ---- | ---- | ----------- | | `ieee` | no | IEEE address of the device to remove -### OTA firmware updates - -ZHA component does have the ability to automatically download and perform OTA (Over-The-Air) firmware updates of Zigbee devices if the OTA firmware provider source URL for updates is available. OTA firmware updating is set to disabled (`false`) in the configuration by default. - -Currently, OTA providers for firmware updates are only available for IKEA and LEDVANCE devices. OTA updates for device of other manufactures could possible also be supported by ZHA dependencies in the future, if these manufacturers publish their firmware publicly. - -To enable OTA firmware updates for the ZHA integration you need to add the following configuration to your `configuration.yaml` and restart Home Assistant: - -```yaml -zha: - zigpy_config: - ota: - ikea_provider: true # Auto update Trådfri devices - ledvance_provider: true # Auto update LEDVANCE devices - #otau_directory: /path/to/your/ota/folder # Utilize .ota files to update everything else -``` - -You can choose if the IKEA or LEDVANCE provider should be set to enabled (`true`) or disabled (`false`) individually. After the OTA firmware upgrades are finished, you can set these to `false` again if you do not want ZHA to automatically download and perform OTA firmware upgrades in the future. - -Note that the `otau_directory` setting is optional and can be used for any firmware files you have downloaded yourself. - -### Defining Zigbee channel to use - -```yaml -zha: - zigpy_config: - network: - channel: 15 # What channel the radio should try to use. - channels: [15, 20, 25] # Channel mask -``` - -This is a good reference for channel selection [Zigbee and Wifi Coexistance](https://support.metageek.com/hc/en-us/articles/203845040-ZigBee-and-WiFi-Coexistence) - ## Adding devices To add a new device: From 319bcba4510749c3960f529ed8bf22bbd3afcf43 Mon Sep 17 00:00:00 2001 From: Teemu R Date: Mon, 28 Dec 2020 19:47:22 +0100 Subject: [PATCH 4/7] Example on notification to open the shopping list (#15983) --- source/_integrations/shopping_list.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/_integrations/shopping_list.markdown b/source/_integrations/shopping_list.markdown index 2e852ab46db..be4bee97dc0 100644 --- a/source/_integrations/shopping_list.markdown +++ b/source/_integrations/shopping_list.markdown @@ -43,3 +43,21 @@ You can add or remove items from your shopping list by using the following servi | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| | `name` | no | Name of the item to mark as completed. Example: "Milk" | + +## Using in Automations + +The simplest way use shopping list with automations (e.g., when entering a zone with shops) is to create a notification that can be clicked to open the shopping list. +This is tested to work with the Android companion app. + +{% raw %} + +```yaml +service: notify.notify +title: "Time to shop?" +message: 'Click to open the shopping list' +data: + clickAction: '/shopping-list' + url: '/shopping-list' +``` + +{% endraw %} From 1c83db3c1a06fd121519001e81dcec86e114b828 Mon Sep 17 00:00:00 2001 From: treylok Date: Mon, 28 Dec 2020 12:49:06 -0600 Subject: [PATCH 5/7] Add description for target humidity (#15958) --- source/_integrations/ecobee.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index 8340c368d0d..fa1683d61be 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -112,6 +112,8 @@ When in _away preset_, the target temperature is permanently overridden by the t The _HVAC mode_ of the device is the currently active operational modes that the ecobee thermostat provides: heat, auxHeatOnly, cool, auto, and off. +The _target humidity_ is the humidity set point of the thermostat when a humidifier is connected and in manual control or "On" mode. + ## Attributes The ecobee climate entity has some extra attributes to represent the state of the thermostat. From bc4e1307c705a8c0615a12b92fee204f782336d3 Mon Sep 17 00:00:00 2001 From: Federico Granata <3602209+Edo78@users.noreply.github.com> Date: Mon, 28 Dec 2020 19:50:42 +0100 Subject: [PATCH 6/7] Add a prerequisite (#16019) Co-authored-by: Franck Nijhof --- source/_integrations/rpi_gpio.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_integrations/rpi_gpio.markdown b/source/_integrations/rpi_gpio.markdown index 193021f2dd0..c67c26a6f1a 100644 --- a/source/_integrations/rpi_gpio.markdown +++ b/source/_integrations/rpi_gpio.markdown @@ -13,6 +13,10 @@ ha_domain: rpi_gpio The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. +## Prerequisites + +When you are running the Home Assistant Operating System, the 32-bits version of the OS is required in order to use this integration. + ## Binary Sensor The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). From 816af711ad48a0a0e11b9c025cb738368f37ccd9 Mon Sep 17 00:00:00 2001 From: Fredrik <944065+fohlsso2@users.noreply.github.com> Date: Mon, 28 Dec 2020 19:56:58 +0100 Subject: [PATCH 7/7] example added for nesting automations (#16032) Co-authored-by: Franck Nijhof --- .../splitting_configuration.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index 9dbc5abe9a7..8fec8bb86dc 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -477,4 +477,22 @@ front_yard: - camera.front_porch ``` +### Example: Combine `!include_dir_merge_list` with `automations.yaml` + +You want to go the advanced route and split your automations, but still want to be able to create automations in the UI? +In a chapter above we write about nesting `!includes`. Here is how we can do that for automations. + +Using labels like `manual` or `ui` allows for using multiple keys in the config: + +`configuration.yaml` + +```yaml + +# My own handmade automations +automation manual: !include_dir_merge_list automations/ + +# Automations I create in the UI +automation ui: !include automations.yaml +``` + [discord]: https://discord.gg/c5DvZ4e