home-assistant.io/knx.markdown at c6db7065fb034f9bc53b054e593a78f3bb3886df

mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-23 03:16:49 +00:00

Marvin Wichmann 9099d7d10a

Co-authored-by: Matthias Alphart <farmio@alphart.net>

2020-11-19 07:54:38 +01:00

49 KiB

Raw Blame History

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain, ha_quality_scale

title

description

ha_category

ha_release

ha_iot_class

ha_codeowners

ha_domain

ha_quality_scale

KNX

Instructions on how to integrate KNX components with Home Assistant.

Hub

Binary Sensor

Climate

Cover

Light

Notifications

Scene

Sensor

Switch

Weather

0.24

Local Push

@Julius2342

@farmio

@marvin-w

knx

silver

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

The integration requires a local KNX/IP interface or router. Through this, it will establish a connection between Home Assistant and your KNX bus.

Please note, the knx platform does not support KNX Secure.

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

Binary Sensor
Climate
Cover
Light
Notify
Scene
Sensor
Switch
Weather

Basic Configuration

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

knx:

In order to make use of the various platforms KNX offers you will need to have the following configuration inside configuration.yaml depending on what platforms you intend to use:

knx:
  binary_sensor: !include knx_binary_sensor.yaml
  switch: !include knx_switch.yaml
  sensor: !include knx_sensor.yaml
  cover: !include knx_cover.yaml
  light: !include knx_light.yaml
  notify: !include knx_notify.yaml
  scene: !include knx_scene.yaml

Please check the dedicated platform documentation about how to configure them correctly.

Optional, 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. See xknx.io for details required: false type: string rate_limit: description: Defines the maximum number of telegrams to be sent to the bus per second (range 1-100). required: false default: 20 type: integer individual_address: description: The KNX individual address that shall be used for routing or if a tunnelling server doesn't assign an IA at connection. required: false type: string default: "15.15.250" multicast_group: description: The multicast group to use for automatic interface discovery and routing communication. required: false type: string default: "224.0.23.12" multicast_port: description: The port for multicast communication. required: false type: integer default: 3671 {% endconfiguration %}

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

knx:
  tunneling:
    host: '192.168.2.23'
    port: 3671
    local_ip: '192.168.2.109'

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

Explicit connection to a KNX/IP routing device:

knx:
  routing:
     local_ip: '192.168.2.109'

{% configuration %} local_ip: description: The local IP address of the interface that shall be used to send multicast packets. type: string required: true {% 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 default: false 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 integration 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 %}

Services

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

Domain: knx
Service: send
Service Data: {"address": "1/0/15", "payload": 0, "type": "temperature"}

{% configuration %} address: description: KNX group address type: string payload: description: Payload to send to the bus. When type is not set, raw bytes are sent. Integers are then treated as DPT 1/2/3 payloads. For DPTs > 6 bits send a list. Each value represents 1 octet (0-255). Pad with 0 to DPT byte length. type: [integer, list] type: description: If set, the payload will not be sent as raw bytes, but encoded as given DPT. KNX sensor types are valid values - see table in KNX Sensor. type: [string, integer, float] {% endconfiguration %}

You can also use the homeassistant.update_entity service call to issue GroupValueRead requests for all *state_address of a device.

Exposing entity states, entity attributes or time to KNX bus

KNX integration is able to expose entity states or attributes to KNX bus. The integration will broadcast any change of the exposed value to the KNX bus and answer read requests to the specified group address. It is also possible to expose the current time.

# Example configuration.yaml entry
knx:
  expose:
    - type: 'temperature'
      entity_id: 'sensor.owm_temperature'
      address: '0/0/2'
    - type: 'string'
      address: '0/6/4'
      entity_id: "sensor.owm_weather"
    - type: 'binary'
      entity_id: 'binary_sensor.kitchen_window'
      address: '0/6/5'
    - type: 'binary'
      entity_id: 'light.office'
      address: '0/3/0'
      default: False
    - type: 'percentU8'
      entity_id: 'light.office'
      attribute: 'brightness'
      default: 0
      address: '0/3/1'
    - type: 'time'
      address: '0/0/1'
    - type: 'datetime'
      address: '0/0/23'

{% configuration %} type: description: Type of the exposed value. Either 'binary', 'time', 'date', 'datetime' or any supported type of KNX Sensor (e.g., "temperature" or "humidity"). type: string required: true entity_id: description: Entity id to be exposed. Not needed for types time, date and datetime. type: string required: false attribute: description: Attribute of the entity that shall be sent to the KNX bus. If not set (or None) the state will be sent. Eg. for a light the state is eigther "on" or "off" - with attribute you can expose its "brightness". type: string required: false default: description: Default value to send to the bus if the state or attribute value is None. Eg. a light with state "off" has no brightness attribute so a default value of 0 could be used. If not set (or None) no value would be sent to the bus and a GroupReadRequest to the address would return the last known value. type: [boolean, string, integer, float] default: None required: false address: description: KNX group address. type: string required: true {% endconfiguration %}

The knx sensor platform allows you to monitor KNX binary sensors.

Binary sensors are read-only. To write to the knx-bus configure an exposure KNX Integration - Expose.

Binary Sensor

To use your binary sensors please add the relevant configuration to your top level KNX Integration configuration key in configuration.yaml:

knx:
  binary_sensor:
    - name: sensor1
      state_address: '6/0/2'

{% configuration %} state_address: description: KNX group address of the binary sensor. DPT 1 required: true type: string name: description: A name for this device used within Home Assistant. required: false type: string sync_state: description: Actively read the value from the bus. If False no GroupValueRead telegrams will be sent to the bus. sync_state can be set to init to just initialize state on startup, expire <minutes> to read the state from the KNX bus when no telegram was received for <minutes> or every <minutes> to update it regularly every <minutes>. Maximum value for <minutes> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to True which is interpreted as "expire 60". required: false type: [boolean, string, integer] default: True device_class: description: Sets the class of the device, changing the device state and icon that is displayed on the frontend. required: false type: string reset_after: description: Reset back to OFF state after specified seconds. required: false type: float invert: description: Invert the telegrams payload before processing. This is applied before context_timeout or reset_after is evaluated. required: false type: boolean default: False ignore_internal_state: description: Specifies if telegrams should ignore the internal state and always trigger a Home Assistant state update. required: false type: boolean default: False context_timeout: description: The time in seconds between multiple identical telegram payloads would count towards the internal counter that is used for automations. Ex. You have automations in place that trigger your lights on button press and another set of lights if you click that button twice. This setting defines the time that a second button press would count toward, so if you set this 3.0 you can take up to 3 seconds in order to trigger the second button press. If set ignore_internal_state will be set to True internally. Maximum value is 10.0. required: false type: float default: None {% endconfiguration %}

Support for automations

You can use a built in event in order to trigger an automation (e.g. to switch on a light when a switch was pressed).

Let's pretend you have a binary sensor with the name Livingroom.Switch and you want to switch one light on when the button was pressed once and two other lights when the button was pressed twice.

# Example automation.yaml entry
automation:
  - trigger:
      platform: numeric_state
      entity_id: binary_sensor.Livingroom_Switch
      attribute: counter
      above: 0
      below: 2
    condition: 
      - condition: state
        entity_id: binary_sensor.cover_abstell
        state: 'on'
    action:
      - entity_id: light.hue_color_lamp_1
        service: light.turn_on
  - trigger:
      platform: numeric_state
      entity_id: binary_sensor.Livingroom_Switch
      attribute: counter
      above: 1
      below: 3
    condition:
      - condition: state
        entity_id: binary_sensor.cover_abstell
        state: 'on'
    action:
      - entity_id: light.hue_bloom_1
        service: homeassistant.turn_on
      - entity_id: light.hue_bloom_2
        service: homeassistant.turn_on

{% configuration %} name: description: A name for this device used within Home Assistant. required: false type: string counter: description: Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. required: false type: integer default: 1 hook: description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off". required: false type: string default: "on" action: description: Specify a list of actions analog to the automation rules. required: false type: list {% endconfiguration %}

Climate

The knx climate platform is used as an interface to KNX thermostats and room controllers.

To use your KNX thermostats in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

# Example configuration.yaml entry
knx:
  climate:
    - name: HASS-Kitchen.Temperature
      temperature_address: '5/1/1'
      setpoint_shift_address: '5/1/2'
      setpoint_shift_state_address: '5/1/3'
      target_temperature_state_address: '5/1/4'
      operation_mode_address: '5/1/5'
      operation_mode_state_address: '5/1/6'

Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:

# Example configuration.yaml entry
knx:
  climate:
    - name: HASS-Kitchen.Temperature
      temperature_address: '5/1/1'
      setpoint_shift_address: '5/1/2'
      setpoint_shift_state_address: '5/1/3'
      target_temperature_state_address: '5/1/4'
      operation_mode_frost_protection_address: '5/1/5'
      operation_mode_night_address: '5/1/6'
      operation_mode_comfort_address: '5/1/7'
      operation_mode_state_address: '5/1/8'

If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a setpoint_shift_address value) please set the min_temp and max_temp attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the target_temperature_address to the configuration in this case.:

# Example configuration.yaml entry
knx:
  climate:
    - name: HASS-Kitchen.Temperature
      temperature_address: '5/1/2'
      target_temperature_address: '5/1/4'
      target_temperature_state_address: '5/1/1'
      operation_mode_frost_protection_address: '5/1/5'
      operation_mode_night_address: '5/1/6'
      operation_mode_comfort_address: '5/1/7'
      operation_mode_state_address: '5/1/8'
      operation_mode_standby_address: '5/1/9'
      min_temp: 7.0
      max_temp: 32.0

setpoint_shift_mode allows the two following DPTs to be used:

DPT6002 (for 1 byte signed integer)
DPT9002 (for 2 byte float)

Example:

# Example configuration.yaml entry
knx:
  climate:
    - name: HASS-Kitchen.Temperature
      temperature_address: '5/1/1'
      setpoint_shift_address: '5/1/2'
      setpoint_shift_state_address: '5/1/3'
      setpoint_shift_mode: 'DPT9002'
      target_temperature_state_address: '5/1/4'
      operation_mode_address: '5/1/5'
      operation_mode_state_address: '5/1/6'

operation_mode_frost_protection_address / operation_mode_night_address / operation_mode_comfort_address / operation_mode_standby_address are not necessary if operation_mode_address is specified. If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading e.g., when starting Home Assistant.

The following values are valid for the heat_cool_address and the heat_cool_state_address:

0 (cooling)
1 (heating)

The following values are valid for the hvac_mode attribute:

Off (maps internally to HVAC_MODE_OFF within Home Assistant)
Auto (maps internally to HVAC_MODE_AUTO within Home Assistant)
Heat (maps internally to HVAC_MDOE_HEAT within Home Assistant)
Cool (maps internally to HVAC_MDOE_COOL within Home Assistant)
Fan only (maps internally to HVAC_MODE_FAN_ONLY within Home Assistant)
Dry (maps internally to HVAC_MODE_DRY within Home Assistant)

The following presets are valid for the preset_mode attribute:

Auto (maps internally to PRESET_NONE within Home Assistant)
Comfort (maps internally to PRESET_COMFORT within Home Assistant)
Standby (maps internally to PRESET_AWAY within Home Assistant)
Night (maps internally to PRESET_SLEEP within Home Assistant)
Frost Protection (maps internally to PRESET_ECO within Home Assistant)

{% configuration %} name: description: A name for this device used within Home Assistant. required: false default: KNX Climate type: string temperature_address: description: KNX group address for reading current room temperature from KNX bus. DPT 9.001 required: true type: string temperature_step: description: Defines the step size in Kelvin for each step of setpoint_shift. required: false type: float default: 0.1 target_temperature_address: description: KNX group address for setting target temperature. DPT 9.001 required: false type: string target_temperature_state_address: description: KNX group address for reading current target temperature from KNX bus. DPT 9.001 required: true type: string setpoint_shift_address: description: KNX address for setpoint_shift. DPT 6.010 or 9.001 based on setpoint_shift_mode required: false type: string setpoint_shift_state_address: description: KNX address for reading setpoint_shift. DPT 6.010 or 9.001 based on setpoint_shift_mode required: false type: string setpoint_shift_mode: description: Defines the internal device DPT used. required: false default: 0.5 type: string default: DPT6010 setpoint_shift_min: description: Minimum value of setpoint shift. required: false default: -6 type: float setpoint_shift_max: description: Maximum value of setpoint shift. required: false default: 6 type: float operation_mode_address: description: KNX address for setting operation mode (Frost protection/night/comfort). DPT 20.102 required: false type: string operation_mode_state_address: description: KNX address for reading operation mode. DPT 20.102 required: false type: string controller_status_address: description: KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3). required: false type: string controller_status_state_address: description: KNX address for reading HVAC controller status. required: false type: string controller_mode_address: description: KNX address for setting HVAC controller modes. DPT 20.105 required: false type: string controller_mode_state_address: description: KNX address for reading HVAC Control Mode. DPT 20.105 required: false type: string heat_cool_address: description: KNX address for switching between heat/cool mode. DPT 1.100 required: false type: string heat_cool_state_address: description: KNX address for reading heat/cool mode. DPT 1.100 required: false type: string operation_mode_frost_protection_address: description: KNX address for switching on/off frost/heat protection mode. DPT 1 required: false type: string operation_mode_night_address: description: KNX address for switching on/off night mode. DPT 1 required: false type: string operation_mode_comfort_address: description: KNX address for switching on/off comfort mode. DPT 1 required: false type: string operation_mode_standby_address: description: KNX address for switching on/off standby mode. DPT 1 required: false type: string
operation_modes: description: Overrides the supported operation modes. Provide the supported preset_mode values for your device. required: false type: list controller_modes: description: Overrides the supported controller modes. Provide the supported hvac_mode values for your device. required: false type: list on_off_address: description: KNX address for switching the climate device on/off. DPT 1 required: false type: string on_off_invert: description: Value for switching the climate device on/off is inverted. required: false default: false type: boolean on_off_state_address: description: KNX address for gathering the current state (on/off) of the climate device. DPT 1 required: false type: string min_temp: description: Override the minimum temperature. required: false type: float max_temp: description: Override the maximum temperature. required: false type: float {% endconfiguration %}

Cover

The knx cover platform is used as an interface to KNX covers.

To use your KNX covers in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

# Example configuration.yaml entry
knx:
  cover:
    - name: "Kitchen.Shutter"
      move_long_address: '3/0/0'
      move_short_address: '3/0/1'
      stop_address: '3/0/4'
      position_address: '3/0/3'
      position_state_address: '3/0/2'
      travelling_time_down: 51
      travelling_time_up: 61

{% configuration %} name: description: A name for this device used within Home Assistant. required: false default: KNX Cover type: string move_long_address: description: KNX group address for moving the cover full up or down. DPT 1 required: false type: string move_short_address: description: KNX group address for moving the cover short time up or down. DPT 1 required: false type: string stop_address: description: KNX group address for stopping the current movement from the cover. DPT 1 required: false type: string position_address: description: KNX group address for moving the cover to the dedicated position. DPT 5.001 required: false type: string position_state_address: description: Separate KNX group address for requesting the current position of the cover. DPT 5.001 required: false type: string angle_address: description: KNX group address for moving the cover to the dedicated angle. DPT 5.001 required: false type: string angle_state_address: description: Separate KNX group address for requesting the current angle of cover. DPT 5.001 required: false type: string travelling_time_down: description: Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. required: false default: 25 type: integer travelling_time_up: description: Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. required: false default: 25 type: integer invert_position: description: Set this to true if your actuator report fully closed as 0% in KNX. required: false default: false type: boolean invert_angle: description: Set this to true if your actuator reports tilt fully closed as 0% in KNX. required: false default: false type: boolean {% endconfiguration %}

Light

The knx light integration is used as an interface to control KNX actuators for lighting applications such as:

switching actuators
dimming actuators
LED controllers
DALI gateways

Configuration

To use your KNX light in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

# Example configuration.yaml entry
knx:
  light:
    - name: 'kitchen'
      address: '1/0/9'

{% configuration %} address: description: KNX group address for switching the light on and off. DPT 1.001 required: true type: string state_address: description: KNX group address for retrieving the switch state of the light. DPT 1.001 required: false type: string name: description: A name for this device used within Home Assistant. required: false type: string brightness_address: description: KNX group address for setting the brightness of the light in percent (absolute dimming). DPT 5.001 required: false type: string brightness_state_address: description: KNX group address for retrieving the brightness of the light in percent. DPT 5.001 required: false type: string color_address: description: KNX group address for setting the RGB color of the light. DPT 232.600 required: false type: string color_state_address: description: KNX group address for retrieving the RGB color of the light. DPT 232.600 required: false type: string rgbw_address: description: KNX group address for setting the RGBW color of the light. DPT 251.600 required: false type: string rgbw_state_address: description: KNX group address for retrieving the RGBW color of the light. DPT 251.600 required: false type: string color_temperature_address: description: KNX group address for setting the color temperature of the light. DPT 5.001 or 7.600 based on color_temperature_mode required: false type: string color_temperature_state_address: description: KNX group address for retrieving the color temperature of the light. DPT 5.001 or 7.600 based on color_temperature_mode required: false type: string color_temperature_mode: description: Color temperature group address data type. absolute color temperature in Kelvin. color_temperature_address -> DPT 7.600. relative color temperature in percent cold white (0% warmest; 100% coldest). color_temperature_address -> DPT 5.001 required: false type: string default: absolute min_kelvin: description: Warmest possible color temperature in Kelvin. (Used in combination with color_temperature_address) required: false type: integer default: 2700 max_kelvin: description: Coldest possible color temperature in Kelvin. (Used in combination with color_temperature_address) required: false type: integer default: 6000 {% endconfiguration %}

Many KNX devices can change their state internally without a message to the switch address on the KNX bus, e.g., if you configure a scene or a timer on a channel. The optional state_address can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state_address (in most cases from the light actuator), it will overwrite the state of the switch object.

For switching/light actuators that are only controlled by a single group address and don't have dedicated state communication objects you can set state_address to the same value as address.

Note on tunable white: Home Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home Assistant may not align with ones of KNX visualizations. This is the expected behavior.

Extended configuration example

knx:
  light:
    # dimmable light
    - name: Bedroom-Light-1
      address: '1/0/9'
      state_address: '1/1/9'
      brightness_address: '1/2/9'
      brightness_state_address: '1/3/9'
    #
    # RGB light
    - name: Bathroom-Light-1
      address: '1/0/9'
      state_address: '1/1/9'
      brightness_address: '1/2/9'
      brightness_state_address: '1/3/9'
      color_address: '1/4/9'
      color_state_address: '1/5/9'
    #
    # tunable white light
    - name: Office-Light-1
      address: '1/0/21'
      state_address: '1/1/21'
      brightness_address: '1/2/21'
      brightness_state_address: '1/3/21'
      color_temperature_address: '1/4/21'
      color_temperature_state_address: '1/5/21'
      color_temperature_mode: absolute
      min_kelvin: 2550
      max_kelvin: 6200
    #
    # actuator without dedicated state communication object
    - name: Cellar-Light-1
      address: '1/0/5'
      state_address: '1/0/5'

Notify

The knx notify platform allows you to send notifications to KNX devices.

Configuration

To use your KNX switch in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

knx:
  notify:
    - name: Alarm
      address: '5/1/10'

{% configuration %} address: description: KNX group address of the notification. DPT 16.000 required: true type: string name: description: A name for this device used within Home Assistant. required: false type: string {% endconfiguration %} The knx scenes platform allows you to trigger KNX scenes.

Scene

Configuration

To use your KNX scene in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

# Example configuration.yaml entry
knx:
  scene:
    - name: Romantic
      address: 8/8/8
      scene_number: 23

{% configuration %} address: description: KNX group address for the scene. DPT 17.001 required: true type: string scene_number: description: KNX scene number to be activated. ( 1 ... 64 ) required: true type: integer name: description: A name for this device used within Home Assistant. required: false type: string {% endconfiguration %}

Sensor

The knx sensor platform allows you to monitor KNX sensors.

Sensors are read-only. To write to the knx-bus configure an exposure KNX Integration - Expose.

Configuration

To use your KNX sensor in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

# Example configuration.yaml entry
knx:
  sensor:
    - name: Heating.Valve1
      state_address: '2/0/0'

In order to actively read the sensor data from the bus all 30 seconds you can add the following lines to your configuration.yaml:

# Example configuration.yaml entry
knx:
  sensor:
    - name: Heating.Valve1
      state_address: '2/0/0'
      sync_state: expire 30

{% configuration %} state_address: description: KNX group address of the sensor. required: true type: string name: description: A name for this device used within Home Assistant. required: false type: string sync_state: description: Actively read the value from the bus. If False no GroupValueRead telegrams will be sent to the bus. sync_state can be set to init to just initialize state on startup, expire <minutes> to read the state from the KNX bus when no telegram was received for <minutes> or every <minutes> to update it regularly every <minutes>. Maximum value for <minutes> is 1440. If just a number is configured "expire"-behaviour is used. Defaults to True which is interpreted as "expire 60". required: false type: [boolean, string, integer] default: True type: description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly. required: true type: string always_callback: description: Defines if telegrams with equal payload as the previously received telegram should trigger a state update within Home Assistant. required: false type: boolean default: False {% endconfiguration %}

KNX DPT	type	size in byte	range	unit
5.001	percent	1	0 ... 100	%
5.003	angle	1	0 ... 360	°
5.004	percentU8	1	0 ... 255	%
5.010	pulse	1	0 ... 255
5.010	1byte_unsigned	1	0 ... 255
6.001	percentV8	1	-128 ... 127	%
6.010	counter_pulses	1	-128 ... 127	counter pulses
7.001	2byte_unsigned	2	0 ... 65535	pulses
7.002	time_period_msec	2	0 ... 65535	ms
7.003	time_period_10msec	2	0 ... 65535	ms
7.004	time_period_100msec	2	0 ... 65535	ms
7.005	time_period_sec	2	0 ... 65535	s
7.006	time_period_min	2	0 ... 65535	min
7.007	time_period_hrs	2	0 ... 65535	h
7.011	length_mm	2	0 ... 65535	mm
7.012	current	2	0 ... 65535	mA
7.013	brightness	2	0 ... 65535	lx
7.600	color_temperature	2	0 ... 65535	K
8.001	2byte_signed	2	-32768 ... 32767	pulses
8.002	delta_time_ms	2	-32768 ... 32767	ms
8.005	delta_time_sec	2	-32768 ... 32767	s
8.006	delta_time_min	2	-32768 ... 32767	min
8.007	delta_time_hrs	2	-32768 ... 32767	h
8.010	percentV16	2	-32768 ... 32767	%
8.011	rotation_angle	2	-32768 ... 32767	°
9.*	enthalpy	2	-671088.64 ... 670760.96	H
9.001	temperature	2	-273 ... 670760	°C
9.002	temperature_difference_2byte	2	-670760 ... 670760	K
9.003	temperature_a	2	-670760 ... 670760	K/h
9.004	illuminance	2	0 ... 670760	lx
9.005	wind_speed_ms	2	0 ... 670760	m/s
9.006	pressure_2byte	2	0 ... 670760	Pa
9.007	humidity	2	0 ... 670760	%
9.008	ppm	2	-671088.64 ... 670760.96	ppm
9.010	time_1	2	-670760 ... 670760	s
9.011	time_2	2	-670760 ... 670760	ms
9.020	voltage	2	-671088.64 ... 670760.96	mV
9.022	power_density	2	-671088.64 ... 670760.96	W/m²
9.023	kelvin_per_percent	2	-671088.64 ... 670760.96	K/%
9.024	power_2byte	2	-671088.64 ... 670760.96	kW
9.025	volume_flow	2	-671088.64 ... 670760.96	l/h
9.026	rain_amount	2	-671088.64 ... 670760.96	l/m²
9.027	temperature_f	2	-459.6 ... 670760	°F
9.028	wind_speed_kmh	2	0 ... 670760	km/h
12.***	4byte_unsigned	4	0 ... 4294967295
13.***	4byte_signed	4	-2147483648 ... 2147483647
13.002	flow_rate_m3h	4	-2147483648 ... 2147483647	m³/h
13.010	active_energy	4	-2147483648 ... 2147483647	Wh
13.011	apparant_energy	4	-2147483648 ... 2147483647	VAh
13.012	reactive_energy	4	-2147483648 ... 2147483647	VARh
13.013	active_energy_kwh	4	-2147483648 ... 2147483647	kWh
13.014	apparant_energy_kvah	4	-2147483648 ... 2147483647	kVAh
13.015	reactive_energy_kvarh	4	-2147483648 ... 2147483647	kVARh
13.100	long_delta_timesec	4	-2147483648 ... 2147483647	s
14.000	acceleration	4		m/s²
14.***	4byte_float	4
14.001	acceleration_angular	4		rad/s²
14.002	activation_energy	4		J/mol
14.003	activity	4		s⁻¹
14.004	mol	4		mol
14.005	amplitude	4
14.006	angle_rad	4		rad
14.007	angle_deg	4		°
14.008	angular_momentum	4		J s
14.009	angular_velocity	4		rad/s
14.010	area	4		m²
14.011	capacitance	4		F
14.012	charge_density_surface	4		C/m²
14.013	charge_density_volume	4		C/m³
14.014	compressibility	4		m²/N
14.015	conductance	4		S
14.016	electrical_conductivity	4		S/m
14.017	density	4		kg/m³
14.018	electric_charge	4		C
14.019	electric_current	4		A
14.020	electric_current_density	4		A/m²
14.021	electric_dipole_moment	4		C m
14.022	electric_displacement	4		C/m²
14.023	electric_field_strength	4		V/m
14.024	electric_flux	4		c
14.025	electric_flux_density	4		C/m²
14.026	electric_polarization	4		C/m²
14.027	electric_potential	4		V
14.028	electric_potential_difference	4		V
14.029	electromagnetic_moment	4		A m²
14.030	electromotive_force	4		V
14.031	energy	4		J
14.032	force	4		N
14.033	frequency	4		Hz
14.034	angular_frequency	4		rad/s
14.035	heatcapacity	4		J/K
14.036	heatflowrate	4		W
14.037	heat_quantity	4		J
14.038	impedance	4		Ω
14.039	length	4		m
14.040	light_quantity	4		lm s
14.041	luminance	4		cd/m²
14.042	luminous_flux	4		lm
14.043	luminous_intensity	4		cd
14.044	magnetic_field_strength	4		A/m
14.045	magnetic_flux	4		Wb
14.046	magnetic_flux_density	4		T
14.047	magnetic_moment	4		A m²
14.048	magnetic_polarization	4		T
14.049	magnetization	4		A/m
14.050	magnetomotive_force	4		A
14.051	mass	4		kg
14.052	mass_flux	4		kg/s
14.053	momentum	4		N/s
14.054	phaseanglerad	4		rad
14.055	phaseangledeg	4		°
14.056	power	4		W
14.057	powerfactor	4		cosΦ
14.058	pressure	4		Pa
14.059	reactance	4		Ω
14.060	resistance	4		Ω
14.061	resistivity	4		Ω m
14.062	self_inductance	4		H
14.063	solid_angle	4		sr
14.064	sound_intensity	4		W/m²
14.065	speed	4		m/s
14.066	stress	4		Pa
14.067	surface_tension	4		N/m
14.068	common_temperature	4		°C
14.069	absolute_temperature	4		K
14.070	temperature_difference	4		K
14.071	thermal_capacity	4		J/K
14.072	thermal_conductivity	4		W/mK
14.073	thermoelectric_power	4		V/K
14.074	time_seconds	4		s
14.075	torque	4		N m
14.076	volume	4		m³
14.077	volume_flux	4		m³/s
14.078	weight	4		N
14.079	work	4		J
16.000	string	14
17.001	scene_number	1	1 ... 64

Full example

# Example configuration.yaml entry
knx:
  sensor:
    - name: Heating.Valve1
      state_address: '2/0/0'
      sync_state: init
      type: 'percent'
    - name: Kitchen.Temperature
      state_address: '6/2/1'
      sync_state: every 60
      type: 'temperature'

Switch

The knx switch platform is used as an interface to switching actuators.

Configuration

To use your KNX switch in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

knx:
  switch:
    - name: Kitchen.Coffee
      address: '1/1/6'

{% configuration %} address: description: KNX group address for switching the switch on/off. DPT 1 required: true type: string name: description: A name for this device used within Home Assistant. required: false default: KNX Switch type: string state_address: description: Separate KNX group address for retrieving the switch state. DPT 1 required: false type: string invert: description: Invert the telegrams payload before processing or sending. This is applied before reset_after is evaluated so the reset will send "1" to the bus. required: false type: boolean default: False reset_after: description: Reset the switch back to OFF after specified seconds. required: false type: float {% endconfiguration %}

Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional state_address can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address.

Weather

The knx weather platform is used as an interface to KNX weather stations.

To use your KNX weather station in your installation, add the following lines to your top level KNX Integration configuration key in configuration.yaml:

# Example configuration.yaml entry
knx:
  weather:
    - name: "home"
      address_temperature: "7/0/0"
      address_brightness_south: "7/0/1"
      address_brightness_west: "7/0/2"
      address_brightness_east: "7/0/3"
      address_brightness_north: "7/0/11"
      address_wind_speed: "7/0/4"
      address_rain_alarm: "7/0/5"
      address_frost_alarm: "7/0/6"
      address_wind_alarm: "7/0/7"
      address_day_night: "7/0/8"
      address_air_pressure: "7/0/9"
      address_humidity: "7/0/10"
      expose_sensors: False
      sync_state: True

{% configuration %} name: description: A name for this device used within Home Assistant. required: false default: KNX Weather type: string address_temperature: description: KNX group address for reading current outside temperature from KNX bus. DPT 9.001 required: true type: string address_brightness_south: description: KNX group address for reading current brightness to south coordinate from KNX bus. DPT 9.004 required: false type: string address_brightness_west: description: KNX group address for reading current brightness to west coordinate from KNX bus. DPT 9.004 required: false type: string address_brightness_east: description: KNX group address for reading current brightness to east coordinate from KNX bus. DPT 9.004 required: false type: string address_brightness_north: description: KNX group address for reading current brightness to north coordinate from KNX bus. DPT 9.004 required: false type: string address_wind_speed: description: KNX group address for reading current wind speed from KNX bus. DPT 9.005 required: false type: string address_rain_alarm: description: KNX group address for reading if rain alarm is on/off. required: false type: string address_frost_alarm: description: KNX group address for reading if frost alarm is on/off. required: false type: string address_wind_alarm: description: KNX group address for reading if wind alarm is on/off. required: false type: string address_day_night: description: KNX group address for reading if it's day/night. required: false type: string address_air_pressure: description: KNX address reading current air pressure. DPT 9.006 required: false type: string address_humidity: description: KNX address for reading current humidity. DPT 9.007 required: false type: string expose_sensors: description: If true, exposes all sensor values as dedicated sensors to HA. required: false type: boolean default: False sync_state: description: Actively read the value from the bus. If False no GroupValueRead telegrams will be sent to the bus. required: false type: boolean default: True {% endconfiguration %}

49 KiB Raw Blame History

Basic Configuration

Services

Exposing entity states, entity attributes or time to KNX bus

Binary Sensor

Support for automations

Climate

Cover

Light

Configuration

Extended configuration example

Notify

Configuration

Scene

Configuration

Sensor

Configuration

Full example

Switch

Configuration

Weather

49 KiB

Raw Blame History