From 17a8a9e4d664a304afa79aaa4ebb119b3aed5c27 Mon Sep 17 00:00:00 2001 From: Daniel Perna Date: Wed, 5 Dec 2018 23:30:58 +0100 Subject: [PATCH 1/6] Update documentation for HomeMatic --- source/_components/homematic.markdown | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 86ff3df552e..77a06faab93 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -16,12 +16,12 @@ featured: false The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well. -Device support is available for most of the wired and wireless devices, as well as a few IP devices. If you have a setup with mixed protocols, you have to configure additional hosts with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. +Device support is available for most of the wired and wireless devices, as well as a lot of IP devices. If you have a setup with mixed protocols, you have to configure additional [interfaces](https://www.home-assistant.io/components/homematic#interfaces) with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. When using SSL on a CCU3, by default the same ports as usual with a prepended 4 are available. So 2001 becomes 42001, 2010 becomes 42010 etc.. If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute. We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default. -You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. +You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. With it you are also able to hide entities you don't want to see in the UI. The HomeMatic component is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI. To set up the component, add the following information to your `configuration.yaml` file: @@ -61,9 +61,17 @@ host: required: true type: string port: - description: "Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292." + description: Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292. With enabled SSL on the CCU3 usually a 4 is prepended to the Port. E.g. 2001 becomes 42001 with enabled SSL. required: false type: integer +ssl: + description: Set to `true` if SSL support is enabled on the CCU3. + required: false + type: bool +verify_ssl: + description: Set to `true` if a valid certificate is being used. The default is `false` as usually a self-signed certificate is configured. + required: false + type: bool callback_ip: description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). required: false @@ -78,7 +86,7 @@ resolvenames: type: string default: false jsonport: - description: Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker. + description: Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker or with enabled SSL. required: false type: integer username: From 0293ba50533e9b34a08b3b6656bb6846911d16e1 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 6 Dec 2018 11:52:25 +0100 Subject: [PATCH 2/6] Update source/_components/homematic.markdown Co-Authored-By: danielperna84 --- source/_components/homematic.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 77a06faab93..b79561a3563 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -61,7 +61,7 @@ host: required: true type: string port: - description: Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292. With enabled SSL on the CCU3 usually a 4 is prepended to the Port. E.g. 2001 becomes 42001 with enabled SSL. + description: "Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292. With enabled SSL on the CCU3 usually a 4 is prepended to the Port. e.g., 2001 becomes 42001 with enabled SSL." required: false type: integer ssl: From ad00767bf62df3ab1d9c4a6f46ae88f8396b3d67 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 6 Dec 2018 11:52:40 +0100 Subject: [PATCH 3/6] Update source/_components/homematic.markdown Co-Authored-By: danielperna84 --- source/_components/homematic.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index b79561a3563..11c575af68d 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -67,7 +67,7 @@ port: ssl: description: Set to `true` if SSL support is enabled on the CCU3. required: false - type: bool + type: boolean verify_ssl: description: Set to `true` if a valid certificate is being used. The default is `false` as usually a self-signed certificate is configured. required: false From 790aa4acb62adc8ea3d11096a77be2a8a0375b0d Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 6 Dec 2018 11:52:57 +0100 Subject: [PATCH 4/6] Update source/_components/homematic.markdown Co-Authored-By: danielperna84 --- source/_components/homematic.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 11c575af68d..07ac39c17bd 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -71,7 +71,7 @@ ssl: verify_ssl: description: Set to `true` if a valid certificate is being used. The default is `false` as usually a self-signed certificate is configured. required: false - type: bool + type: boolean callback_ip: description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). required: false From 3c1bbb0a7291b6e0eed29cc6e99af9881aae8765 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 6 Dec 2018 11:53:10 +0100 Subject: [PATCH 5/6] Update source/_components/homematic.markdown Co-Authored-By: danielperna84 --- source/_components/homematic.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 07ac39c17bd..3f9f186d405 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -65,6 +65,7 @@ port: required: false type: integer ssl: + default: false description: Set to `true` if SSL support is enabled on the CCU3. required: false type: boolean From 011200e28e5d94bae796414666f078ad49f6d7a2 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 6 Dec 2018 11:53:28 +0100 Subject: [PATCH 6/6] Update source/_components/homematic.markdown Co-Authored-By: danielperna84 --- source/_components/homematic.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 3f9f186d405..dede62718a4 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -70,6 +70,7 @@ ssl: required: false type: boolean verify_ssl: + default: false description: Set to `true` if a valid certificate is being used. The default is `false` as usually a self-signed certificate is configured. required: false type: boolean