Adjust documentation for knx (#29092)

* Adjust documentation for knx

* Switch to colon

* Not allowed to use : in description
This commit is contained in:
Joakim Plate 2023-10-03 19:47:52 +02:00 committed by GitHub
parent a4f76128df
commit 01a1141210
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -823,6 +823,8 @@ The KNX cover platform is used as an interface to KNX covers.
Unlike most KNX devices, Home Assistant defines 0% as closed and 100% as fully open in regards to covers. The corresponding value inversion is done internally by the KNX integration.
Home Assistant will, by default, `close` a cover by moving it in the `DOWN` direction in the KNX nomenclature, and `open` a cover by moving it in the `UP` direction.
</div>
To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`:
@ -852,7 +854,7 @@ move_long_address:
required: false
type: [string, list]
move_short_address:
description: KNX group address for moving the cover stepwise up or down. Used by some covers also as the means to stop the cover, if no dedicated `stop_address` exists on the actuator. *DPT 1*
description: KNX group address for moving the cover stepwise up or down. Used by some covers also as the means to stop the cover. Stepwise moves are only mapped to tilt angle functions in Home Assistant, as no stepwise move of cover position is generally supported by the architecture. If tilt angle is not supported, prefer the use of a `stop_address`. *DPT 1*
required: false
type: [string, list]
stop_address:
@ -886,12 +888,12 @@ travelling_time_up:
default: 25
type: integer
invert_updown:
description: Set this to `true` to invert the binary up/down commands from/to your KNX actuator. Default is 0 for UP; 1 for DOWN.
description: Set this to `true` to invert the up/down commands from/to your KNX actuator. Default is to consider `UP` (0) as opening of a cover and `DOWN` (1) as closing of a cover.
required: false
default: false
type: boolean
invert_position:
description: Set this to `true` if your actuator reports fully closed position as 0% in KNX.
description: Set this to `true` if your actuator reports fully down position as 0% in KNX.
required: false
default: false
type: boolean