home-assistant.io/source/_components/light.knx.markdown
Klaas Schoute 6577daf37f Update KNX component configuration variable (#6602)
* Update KNX component configuration variable

Update style of KNX component (all the 7 files) documentation to follow new configuration variables description.
Related to #6385.

* Update binary_sensor.knx.markdown

* 🚑 Syntax fix

* 🚑 Tweak after source check

* 🚑 Tweak after suggestion
2018-10-11 20:59:34 +02:00

65 lines
2.1 KiB
Markdown

---
layout: page
title: "KNX Light"
description: "Instructions on how to integrate KNX lights with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: knx.png
ha_category: Light
ha_release: 0.44
ha_iot_class: "Local Polling"
---
The `knx` light component is used as in interface to switching/light actuators.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
## {% linkable_title Configuration %}
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
address: '1/0/9'
```
{% configuration %}
address:
description: KNX group address for switching the light on and off.
required: true
type: string
name:
description: A name for this device used within Home Assistant.
required: false
type: string
brightness_address:
description: KNX group address for dimming light.
required: false
type: string
state_address:
description: separate KNX group address for retrieving the switch state of the light.
required: false
type: string
brightness_state_address:
description: separate KNX group address for retrieving the dimmed state of the light.
required: false
type: string
color_address:
description: separate KNX group address for setting the color of the light.
required: false
type: string
color_state_address:
description: separate KNX group address for retrieving the color of the light.
required: false
type: string
{% 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/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.