home-assistant.io/source/_components/knx.markdown

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:

• Binary Sensor
• Cover
• Sensor
• Switch
• Light
• Thermostat
• Notify
• Scene

{% 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'

{% configuration %} config_file: description: The path for XKNX configuration file. required: false type: string {% endconfiguration %}

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'

{% configuration %} host: description: Host of the KNX/IP tunneling device. type: string port: description: Port of the KNX/IP tunneling device. type: integer local_ip: description: IP of the local interface. type: string {% endconfiguration %}

Explicit connection to a KNX/IP routing device:

knx:
  config_file: '/path/to/xknx.yaml'
  routing:
     local_ip: '192.168.2.109'

{% configuration %} local_ip: description: The local IP address of interface (which should be used for multicasting). type: string {% endconfiguration %}

knx:
  fire_event: true
  fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]

{% configuration %} fire_event: description: If set to True, platform will write all received KNX messages to event bus required: inclusive type: boolean fire_event_filter: description: 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. required: inclusive type: [list, string] state_updater: description: 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 behavior. required: false default: true type: boolean {% endconfiguration %}

{% 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}

{% configuration %} address: description: KNX group address type: string payload: description: Payload, either an integer or an array of integers type: [integer, list] {% endconfiguration %}

{% linkable_title Exposing sensor values or time to knx bus %}

KNX component is able to expose time or sensor values to KNX bus. The component will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address:

# Example configuration.yaml entry
knx:
  expose:
    - type: 'temperature'
      entity_id: 'sensor.owm_temperature'
      address: '0/0/2'
    - type: 'time'
      address: '0/0/1'
    - type: 'datetime'
      address: '0/0/23'

{% configuration %} type: description: Type of the exposed value. Either time or datetime or any supported type of KNX Sensor (e.g., "temperature" or "humidity"). type: string entity_id: description: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. type: string address: description: KNX group address. type: string {% endconfiguration %}

{% linkable_title Known issues %}

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