2017-11-27 23:16:08 -08:00

3.3 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page KNX Instructions on how to integrate KNX components with Home Assistant. 2016-06-08 12:00 true false true true knx.png Hub 0.24 Local Polling

The KNX integration for Home Assistant allows you to connect to a KNX/IP devices.

The component requires a local KNX/IP interface like the Weinzierl 730. Through this, it will send and receive commands to and from other devices to the KNX bus.

Please note, the `knx` platform does not support Windows and needs at least python version 3.5.

There is currently support for the following device types within Home Assistant:

{% linkable_title Configuration %}

To use your KNX in your installation, add the following lines to your configuration.yaml file:

knx:

Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside of Home Assistant:

knx:
  config_file: '/path/to/xknx.yaml'
  • config_file (Optional): The path for XKNX configuration file.

If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:

knx:
  tunneling:
    host: '192.168.2.23'
    port: 3671
    local_ip: '192.168.2.109'
  • host: Host of the KNX/IP tunneling device.
  • port: Port of the KNX/IP tunneling device.
  • local_ip: IP of the local interface.

Explicit connection to a KNX/IP routing device:

knx:
  config_file: '/path/to/xknx.yaml'
  routing:
     local_ip: '192.168.2.109'
  • local_ip: The local IP address of interface (which should be used for multicasting).
knx:
    fire_event: True
    fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
  • fire_event (Optional): If set to True, platform will write all received KNX messages to event bus
  • fire_event_filter (Optional): If fire_event is set fire_event_filter has to be specified. fire_event_filter defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
  • state_updater (Optional): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
  • time_address (Optional): Broadcast current local time to KNX bus with configured group address.

{% linkable_title Services %}

In order to directly interact with the KNX bus, you can now use the following service:

Domain: knx
Service: send 
Service Data: {"address": "1/0/15", "payload": 0}
  • address: KNX group address
  • payload: Payload, either an integer or an array of integers

{% linkable_title Known issues %}

Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5.