Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for HomeMatic #7750

Merged
merged 6 commits into from
Dec 10, 2018
Merged

Update documentation for HomeMatic #7750

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
17a8a9e
Update documentation for HomeMatic
danielperna84 Dec 5, 2018
0293ba5
Update source/_components/homematic.markdown
klaasnicolaas Dec 6, 2018
ad00767
Update source/_components/homematic.markdown
klaasnicolaas Dec 6, 2018
790aa4a
Update source/_components/homematic.markdown
klaasnicolaas Dec 6, 2018
3c1bbb0
Update source/_components/homematic.markdown
klaasnicolaas Dec 6, 2018
011200e
Update source/_components/homematic.markdown
klaasnicolaas Dec 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions source/_components/homematic.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.
danielperna84 marked this conversation as resolved.
Show resolved Hide resolved
required: false
type: integer
ssl:
danielperna84 marked this conversation as resolved.
Show resolved Hide resolved
description: Set to `true` if SSL support is enabled on the CCU3.
required: false
type: bool
danielperna84 marked this conversation as resolved.
Show resolved Hide resolved
verify_ssl:
danielperna84 marked this conversation as resolved.
Show resolved Hide resolved
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
danielperna84 marked this conversation as resolved.
Show resolved Hide resolved
callback_ip:
description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
required: false
Expand All @@ -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:
Expand Down