jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Documentation for KNX component (#3298)

Browse source 
* documentation for knx component

* documentation of knx component

* fixed typo

* updated documentation for new HVAC controller status

* fixed spelling
This commit is contained in:
Julius Mittenzwei 2017-09-07 09:41:38 +02:00 • committed by Franck Nijhof
parent b12dce2779
commit c3736c2fd9
8 changed files with 256 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

53
source/_components/climate.knx.markdown
View file

@ -1,6 +1,6 @@
---
layout: page
title: "KNX Thermostat"
title: "KNX Climate"
description: "Instructions on how to integrate KXN thermostats with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
@ -16,22 +16,49 @@ ha_iot_class: "Local Polling"
The `knx` climate platform is used as in interface with KNX thermostats.
KNX thermostats use at least 2 group addresses: one for the current temperature and one for the target temperature (named set-point in KNX terms).
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX thermostats in your installation, add the following to your `configuration.yaml` file:
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
address : KNX_ADDRESS
temperature_address: 0/1/1
setpoint_address: 0/1/0
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '6/2/1'
setpoint_address: '5/1/2'
target_temperature_address: '5/1/1'
operation_mode_address: '5/1/3'
```
- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel.
- **temperature_address** (*Required*): The group address that is used to communicate the current temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value), check [details](http://www.knx.org/fileadmin/template/documents/downloads_support_menu/KNX_tutor_seminar_page/Advanced_documentation/05_Interworking_E1209.pdf).
- **setpoint_address** (*Required*): The group address that is used to set/read the target temperature. Data format must be datapoint type 9.001 DPT_Value_Temp (2-Octet float value). Make sure, you set the read-flag for the thermostat to allow Home Assistant to read the target temperature.
- **name** (*Optional*): A name for this devices used within Home Assistant.
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
```yaml
climate:
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '6/2/1'
setpoint_address: '5/1/2'
target_temperature_address: '5/1/1'
operation_mode_frost_protection_address: '5/1/3'
operation_mode_night_address: '5/1/4'
operation_mode_comfort_address: '5/1/5'
```
* **name** (*Optional*): A name for this device used within Home Assistant.
* **temperature_address**: KNX group address for reading current room temperature from KNX bus.
* **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
* **setpoint_address**: KNX group address for basis setpoint
* **operation_mode_address** (*Optional*) KNX address for operation mode (Frost protection/night/comfort).
* **operation_mode_state_address** (*Optional*) Explicit KNX address for reading operation mode
* **controller_status_address** (*Optional*) KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
* **controller_status_state_address** (*Optional*) Explicit KNX address for reading HVAC controller status
* **operation_mode_frost_protection_address** (*Optional*) KNX address for switching on/off frost/heat protection mode.
* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night nmode.
* **operation_mode_comfort_address** (*Optional*) KNX address for switching on/off comfort mode.
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified.
With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported.