Documentation for KNX component (#3298)
* documentation for knx component * documentation of knx component * fixed typo * updated documentation for new HVAC controller status * fixed spelling
This commit is contained in:
parent
b12dce2779
commit
c3736c2fd9
8 changed files with 256 additions and 69 deletions
|
@ -16,22 +16,32 @@ 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
|
||||
updown_address: 9/0/0
|
||||
stop_address: 9/0/1
|
||||
- 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
|
||||
```
|
||||
|
||||
- **name** (*Optional*): A name for this devices used within Home Assistant.
|
||||
- **updown_address** (*Required*): The KNX group address that is used to move the cover up and down.
|
||||
- **stop_address** (*Required*): The group address that is used to stop the cover.
|
||||
- **setposition_address** (*Optional*): The group address that is used to set the position.
|
||||
- **getposition_address** (*Optional*): The group address that is used to read the position.
|
||||
- **setangle_address** (*Optional*): The group address that is used to set the tilt angle.
|
||||
- **getangle_address** (*Optional*): The group address that is used to read the tilt angle.
|
||||
- **invert_position** (*Optional*): Set this to true if your actuator report fully closed as 100%
|
||||
- **invert_angle** (*Optional*): Set this to true if your actuator reports tilt fully closed as 100%
|
||||
- **name** (*Optional*): A name for this device used within Home Assistant.
|
||||
- **move_long_address**: KNX group address for moving the cover full up or down.
|
||||
- **move_short_address**: (*Optional*) KNX group address for moving the cover short time up or down.
|
||||
- **position_address**: (*Optional*) KNX group address for moving the cover to the dedicated position.
|
||||
- **position_state_address**: (*Optional*) Separate KNX group address for requesting the current position of the cover.
|
||||
- **angle_address**: (*Optional*) KNX group address for moving the cover to the dedicated angle.
|
||||
- **angle_state_address**: (*Optional*) Separate KNX group address for requesting the current angle of cover.
|
||||
- **travelling_time_down**: (*Optional*) Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
|
||||
- **travelling_time_up**: (*Optional*) Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
|
||||
- **invert_position**: (*Optional*) Set this to true if your actuator report fully closed as 100%
|
||||
- **invert_angle**: (*Optional*) Set this to true if your actuator reports tilt fully closed as 100%
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue