home-assistant.io/source/_components/climate.knx.markdown
Marvin Wichmann fca6611ebd Updated docs of knx climate device (#7937)
* Updated docs of knx climate device

* Updated docs to reflect changes in HA.

* Updated docs to mention the internal mapping
2019-01-09 15:30:51 -08:00

158 lines
5.0 KiB
Markdown

---
layout: page
title: "KNX Climate"
description: "Instructions on how to integrate KNX thermostats with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: knx.png
ha_category: Climate
ha_release: 0.25
ha_iot_class: "Local Polling"
---
The `knx` climate platform is used as in interface with KNX thermostats.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
climate:
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_address: '5/1/4'
operation_mode_address: '5/1/5'
```
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
```yaml
# Example configuration.yaml entry
climate:
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '5/1/1'
setpoint_shift_address: '5/1/2'
setpoint_shift_state_address: '5/1/3'
target_temperature_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_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified.
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 increasing the temperature in the frontend.
The following values are valid for the `operation_modes` attribute:
- Comfort (maps internally to STATE_HEAT within Home Assistant)
- Standby (maps internally to STATE_ECO within Home Assistant)
- Night (maps internally to STATE_IDLE within Home Assistant)
- Frost Protection (maps internally to STATE_MANUAL within Home Assistant)
- Fan only (maps internally to STATE_FAN_ONLY within Home Assistant)
- Dehumidification (maps internally to STATE_DRY 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.
required: true
type: string
target_temperature_address:
description: KNX group address for reading current target temperature from KNX bus.
required: true
type: string
setpoint_shift_address:
description: KNX address for setpoint_shift.
required: false
type: string
setpoint_shift_state_address:
description: Explicit KNX address for reading setpoint_shift.
required: false
type: string
setpoint_shift_step:
description: Defines for step size in Kelvin for each step of setpoint_shift.
required: false
default: 0.5
type: float
setpoint_shift_min:
description: Minimum value of setpoint shift.
required: false
default: -6
type: integer
setpoint_shift_max:
description: Maximum value of setpoint shift.
required: false
default: 6
type: integer
operation_mode_address:
description: KNX address for operation mode (Frost protection/night/comfort).
required: false
type: string
operation_mode_state_address:
description: Explicit KNX address for reading operation mode.
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: Explicit KNX address for reading HVAC controller status.
required: false
type: string
controller_mode_address:
description: KNX address for handling controller modes.
required: false
type: string
controller_mode_state_address:
description: Explicit KNX address for reading HVAC Control Mode.
required: false
type: string
operation_mode_frost_protection_address:
description: KNX address for switching on/off frost/heat protection mode.
required: false
type: string
operation_mode_night_address:
description: KNX address for switching on/off night mode.
required: false
type: string
operation_mode_comfort_address:
description: KNX address for switching on/off comfort mode.
required: false
type: string
operation_modes:
description: Overrides the supported operation modes.
required: false
type: array
on_off_address:
description: KNX address for switching the climate device on/off.
required: false
type: string
on_off_state_address:
description: KNX address for gathering the current state (on/off) of the climate device.
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 %}