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

26
source/_components/light.knx.markdown
View file

@ -16,18 +16,28 @@ ha_iot_class: "Local Polling"
The `knx` light component is used as in interface to switching/light actuators.
To use your KNX light in your installation, add the following to your `configuration.yaml` file:
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX light in your installation, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: knx
name: KNX light
address: 0/0/1
name: Kitchen-Light-1
address: '1/0/9'
brightness_address: '1/0/11'
- platform: knx
name: Kitchen-Light-2
address: '1/0/12'
brightness_address: '1/0/14'
```
- **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 will overwrite the state of the switch object.
For switching/light 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.
* **name** (*Optional*): A name for this device used within Home Assistant.
* **address**: KNX group address for switching the light on and off
* **brightness_address**: (Optional) KNX group address for dimming light.
* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state of the light.
* **brightness_state_address**: (*Optional*) separate KNX group address for retrieving the dimmed state of the light.
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 will overwrite the state of the switch object.
For switching/light 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.