home-assistant.io/source/_components/cover.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

87 lines
2.5 KiB
Markdown

---
layout: page
title: "KNX Cover"
description: "Instructions on how to integrate KNX covers with Home Assistant."
date: 2017-06-18 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: knx.png
ha_category: Cover
ha_release: 0.48
ha_iot_class: "Local Polling"
---
The `knx` cover platform is used as in interface with KNX covers.
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
To use your KNX covers in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
cover:
- platform: knx
name: "Kitchen.Shutter"
move_long_address: '3/0/0'
move_short_address: '3/0/1'
position_address: '3/0/3'
position_state_address: '3/0/2'
travelling_time_down: 51
travelling_time_up: 61
```
{% configuration %}
name:
description: A name for this device used within Home Assistant.
required: false
default: KNX Cover
type: string
move_long_address:
description: KNX group address for moving the cover full up or down.
required: false
type: string
move_short_address:
description: KNX group address for moving the cover short time up or down. If the KNX device has a stop group address you can use that here.
required: false
type: string
position_address:
description: KNX group address for moving the cover to the dedicated position.
required: false
type: string
position_state_address:
description: Separate KNX group address for requesting the current position of the cover.
required: false
type: string
angle_address:
description: KNX group address for moving the cover to the dedicated angle.
required: false
type: string
angle_state_address:
description: Separate KNX group address for requesting the current angle of cover.
required: false
type: string
travelling_time_down:
description: Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling.
required: false
default: 25
type: integer
travelling_time_up:
description: Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling.
required: false
default: 25
type: integer
invert_position:
description: Set this to true if your actuator report fully closed as 100%.
required: false
default: false
type: boolean
invert_angle:
description: Set this to true if your actuator reports tilt fully closed as 100%.
required: false
default: false
type: boolean
{% endconfiguration %}