Updated KNX documenation (#672)

* Updated KNX documentation

* Fixed minor formating issue
This commit is contained in:
Open Home Automation 2016-07-25 12:54:13 +02:00 committed by Fabian Affolter
parent ee7b42ca67
commit 451949a198
3 changed files with 54 additions and 13 deletions

View File

@ -17,9 +17,8 @@ ha_release: 0.24
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/binary_sensor.knx)
- [Switch](/components/switch.knx)
The local ZigBee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed.
- [Switch](/components/switch.knx)
- [Thermostat](/components/thermostat.knx)
A `knx` section must be present in the `configuration.yaml` file and contain the following options as required:
@ -31,4 +30,3 @@ knx:
- **host** (*Required*): The IP address of the KNX/IP interface to use. You can use "0.0.0.0" if your KNX/IP gateway supports discovery.
- **port** (*Optional*): The UDP port number. Defaults to `3671`.

View File

@ -1,19 +1,29 @@
---
layout: page
title: "KNX Switch"
description: "Instructions how to setup the KNX switches within Home Assistant."
date: 2016-07-13 07:00
title: "KNX Switches"
description: "Instructions on how to integrate KXN switches with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
comments: false
sharing: true
footer: true
<<<<<<< HEAD
logo: zknx.png
=======
logo: knx.png
>>>>>>> master
ha_category: Switch
ha_category: DIY
ha_release: 0.24
---
To get your KNX switches working with Home Assistant, follow the instructions for the [KNX component](/components/knx/).
The KNX switch component is used as in interface to switching actuators.
```yaml
switch:
platform: knx
name: KNX Switch
address: 0/0/1
state_address: 0/0/3
```
- **name** (*Optional*): A name for this devices used within Home assistant
- **address** (*Required*): The KNX group address that is used to turn on/off this actuator channel
- **state_address** (*Optional*): Some KNX devices can change their state internally without any messages on the KXN 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 wil 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 configrue the state address

View File

@ -0,0 +1,33 @@
---
layout: page
title: "KNX Thermostats"
description: "Instructions on how to integrate KXN thermostats with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: knx.png
ha_category: DIY
ha_release: 0.25
---
The KNX thermostat component 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).
```yaml
thermostat:
platform: knx
name: KNX Thermostat
temperature_address: 0/1/1
setpoint_address: 0/1/0
```
- **name** (*Optional*): A name for this devices used within Home assistant
- **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) (see 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.
With the current version of the module, no advanced KNX thermostat functionalities (e.g. HVAC mode) are supported.