Home Assistant

Homematic

The Homematic 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 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.

If you want to see if a specific device you have is supported, head over to the pyhomematic 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 feature. With it you are also able to hide entities you don’t want to see in the UI.

To set up the component, add the following information to your configuration.yaml file:

homematic:
  interfaces:
    wireless:
      host: 127.0.0.1

Configuration variables (global):

  • interfaces (Required): Configuration for each XML-RPC interface to integrate into Home Assistant.
  • hosts (Optional): Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant.
  • local_ip (Optional): IP of device running Home Assistant. Override auto-detected value for exotic network setups.
  • local_port (Optional): Port for connection with Home Assistant. By default it is randomly assigned.

Configuration variables (interface):

  • host (Required): IP address or Hostname of CCU/Homegear device or Hass.io add-on.
  • port (Optional): Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292.
  • callback_ip (Optional): Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
  • callback_port (Optional): Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.).
  • resolvenames (Optional): [metadata, json, xml] Try to fetch device names. Defaults to false if not specified.
  • username (Optional): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
  • password (Optional): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
  • path (Optional): Set to /groups when using port 9292.

Configuration variables (host):

  • host (Required): IP address of CCU/Homegear device.
  • username (Optional): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
  • password (Optional): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.

Example configuration with multiple protocols and some other options set:

homematic:
  interfaces:
    rf:
      host: 127.0.0.1
      resolvenames: json
      username: Admin
      password: secret
      primary: true
      variables: true
    wired:
      host: 127.0.0.1
      port: 2000
      resolvenames: json
      username: Admin
      password: secret
    ip:
      host: 127.0.0.1
      port: 2010
    groups:
      host: 127.0.0.1
      port: 9292
      resolvenames: json
      username: Admin
      password: secret
      path: /groups
  hosts:
    ccu2:
      host: 127.0.0.1
      username: Admin
      password: secret

The resolvenames option

We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won’t include non-ASCII characters in entity-names.

  1. json: The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work you need to add valid credentials to your component-configuration. Guest-access is sufficient to query for device names.
  2. xml: If you use a CCU, there is an add-on called the “XML-API”. With it installed, you are able to fetch all kinds of information from you CCU using XML-RPC. We can leverage this and fetch the names of devices set within the CCU. We don’t support authentication with this method.
  3. metadata: Homegear provides device-names through the metadata devices internally have. When using an HM-CFG-LAN interface, you typically use a configuration software (“HomeMatic-Komponenten konfigurieren” is the name of the shortcut on your desktop by default) to pair and configure your devices. If you have paired devices, you’ll see them listed in a table. The leftmost column (Name) is prefilled with default names. You can click such a name and enter whatever you like.

Resolving names can take some time. So when you start Home Assistant you won’t see you devices at first. For a setup with 20+ devices it can take up to a minute until all devices show up in the UI.

Multiple hosts

In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters. Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host. This does not affect the entities in Home Assistant. They all use their own connection and work as expected.

Reading attributes of entities

Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the template sensor component. Here’s an example of a template sensor that exposes the valve state of a thermostat.

sensor:
- platform: template
  sensors:
    bedroom_valve:
      value_template: '{{ states.climate.leq123456.attributes.Valve }}'
      entity_id: climate.leq123456
      friendly_name: 'Bedroom valve'

Variables

It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables. The states of the variables are available through the attributes of your hub entity (e.g. homematic.ccu2). Use templates (as mentioned above) to make your variables available to automations or as entities. The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed.

Events

When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available:

  • homematic.keypress: For devices with buttons, see information below
  • homematic.impulse: For impulse sensors

Devices with buttons

Devices with buttons (e.g. HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don’t serve any value here and all they do is trigger events. As an example: The HM-Sen-MDIR-WM55 motion detector will be displayed as 2 entities. A motion sensor and a brightness sensor. On top of that we have 2 sets (one set per button) of 4 events: PRESS_SHORT, PRESS_LONG, PRESS_CONT, PRESS_LONG_RELEASE. Be aware, that there are devices which don’t provide all of these events. But in general: if you can press it, it usually at least has PRESS_SHORT.

Here’s an example of how to use these events for automations:

automation:
   trigger:
     platform: event
     event_type: homematic.keypress
     event_data:
       name: Kitchen Switch
       channel: 1
       param: PRESS_SHORT
   action:
     service: switch.turn_on
     entity_id: switch.Kitchen_Ambience

The channel parameter is equal to the channel of the button you are configuring the automation for. You can view the available channels in the UI you use to pair your devices. The name depends on if you chose to resolve names or not. If not, it will be the device ID (e.g. LEQ1234657). If you chose to resolve names (and that is successful), it will be the name you have set in your CCU or in the metadata (e.g. “Kitchen Switch”).

You can test whether your button works within Home Assistant if you look at the terminal output. When pressing a button, lines similar to those should appear:

2018-01-27 11:51:32 INFO (Thread-12) [pyhomematic.devicetypes.generic] HMGeneric.event: address=MEQ1234567:6, interface_id=homeassistant-CCU2, key=PRESS_SHORT, value=True
2018-01-27 11:51:32 INFO (MainThread) [homeassistant.core] Bus:Handling <Event homematic.keypress[L]: param=PRESS_SHORT, name=your_nice_name, channel=6>
2018-01-27 11:51:32 INFO (Thread-12) [pyhomematic.devicetypes.generic] HMGeneric.event: address=MEQ1234567:6, interface_id=homeassistant-CCU2, key=INSTALL_TEST, value=True

It may happen that “your_nice_name” is not resolved correctly; the according message (#2 in the above example) will be missing. This might be due to secure communication between your HM interface and the HM device. You can change the communication from “secure” to “standard” within your HM-interface to solve that issue (in “Einstellungen” - “Geräte” find your device and change “Übertragungsmodus” from secure to standard) - not recommended for devices that should have secure communication.

Services

  • homematic.virtualkey: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys.
  • homematic.reconnect: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted)
  • homematic.set_variable_value: Set the value of a system variable.
  • homematic.set_device_value: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC.

Examples

Simulate a button being pressed

...
action:
  service: homematic.virtualkey
  data:
    address: BidCoS-RF
    channel: 1
    param: PRESS_LONG

Open KeyMatic

...
action:
  service: homematic.virtualkey
  data:
    address: LEQ1234567
    channel: 1
    param: OPEN

Set boolean variable to true

...
action:
  service: homematic.set_variable_value
  data:
    entity_id: homematic.ccu2
    name: Variablename
    value: true

Advanced examples

If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented. Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above rf, wired and ip would be valid values.

Manually turn on a switch actor

...
action:
  service: homematic.set_device_value
  data:
    address: LEQ1234567
    channel: 1
    param: STATE
    value: true

Manually set temperature on thermostat

...
action:
  service: homematic.set_device_value
  data:
    address: LEQ1234567
    channel: 4
    param: SET_TEMPERATURE
    value: 23.0

Manually set lock on KeyMatic devices

...
action:
  service: lock.lock
  entity_id: lock.leq1234567

Manually set unlock on KeyMatic devices

...
action:
  service: lock.unlock
  entity_id: lock.leq1234567