From 256bc81feb9357d947f2378cb9c05b051fdec1ea Mon Sep 17 00:00:00 2001 From: Michael Geramb Date: Fri, 30 Dec 2022 19:46:58 +0100 Subject: [PATCH] [knx] add color channel to knx binding docu (#14114) add color channel to knx binding docu --- bundles/org.openhab.binding.knx/README.md | 37 ++++++++++++++++++----- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/bundles/org.openhab.binding.knx/README.md b/bundles/org.openhab.binding.knx/README.md index 6ac60a148..db9a7a671 100644 --- a/bundles/org.openhab.binding.knx/README.md +++ b/bundles/org.openhab.binding.knx/README.md @@ -1,4 +1,3 @@ - # KNX Binding The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations. @@ -102,6 +101,15 @@ Note: After changing the DPT of already existing Channels, openHAB needs to be r | position | Group address of the absolute position | 5.001 | | increaseDecrease | Group address for relative movement | 3.007 | +##### Channel Type "color" + +| Parameter | Description | Default DPT | +|------------------|----------------------------------------|-------------| +| hsb | Group address for color | 232.600 | +| switch | Group address for the binary switch | 1.001 | +| position | Group address of the absolute position | 5.001 | +| increaseDecrease | Group address for relative movement | 3.007 | + ##### Channel Type "rollershutter" | Parameter | Description | Default DPT | @@ -158,6 +166,15 @@ If from the KNX bus a `GroupValueRead` telegram is sent to a *-control Channel, | increaseDecrease | Group address for relative movement | 3.007 | | frequency | Increase/Decrease frequency in milliseconds in case the binding should handle that (0 if the KNX device sends the commands repeatedly itself) | 0 | +##### Channel Type "color-control" + +| Parameter | Description | Default DPT | +|------------------|----------------------------------------|-------------| +| hsb | Group address for color | 232.600 | +| switch | Group address for the binary switch | 1.001 | +| position | Group address of the absolute position | 5.001 | +| increaseDecrease | Group address for relative movement | 3.007 | + ##### Channel Type "rollershutter-control" | Parameter | Description | Default DPT | @@ -294,6 +311,7 @@ Bridge knx:ip:bridge [ readInterval=3600 ] { Type switch : demoSwitch "Light" [ ga="3/0/4+<3/0/5" ] + Type color : demoColorLight "Color" [ hsb="6/0/10+<6/0/11", switch="6/0/12+<6/0/13", position="6/0/14+<6/0/15", increaseDecrease="6/0/16+<6/0/17" ] Type rollershutter : demoRollershutter "Shade" [ upDown="4/3/50+4/3/51", stopMove="4/3/52+4/3/53", position="4/3/54+<4/3/55" ] Type contact : demoContact "Door" [ ga="1.019:<5/1/2" ] Type number : demoTemperature "Temperature" [ ga="9.001:<5/0/0" ] @@ -321,6 +339,7 @@ knx.items: ```java Switch demoSwitch "Light [%s]" { channel="knx:device:bridge:generic:demoSwitch" } +Color demoColorLight "Color [%s]" { channel="knx:device:bridge:generic:demoColorLight" } Dimmer demoDimmer "Dimmer [%d %%]" { channel="knx:device:bridge:generic:demoDimmer" } Rollershutter demoRollershutter "Shade [%d %%]" { channel="knx:device:bridge:generic:demoRollershutter" } Contact demoContact "Front Door [%s]" { channel="knx:device:bridge:generic:demoContact" } @@ -334,13 +353,14 @@ knx.sitemap: ```perl sitemap knx label="KNX Demo Sitemap" { Frame label="Demo Elements" { - Switch item=demoSwitch - Switch item=demoRollershutter - Text item=demoContact - Text item=demoTemperature - Slider item=demoDimmer - Text item=demoString - Text item=demoDatetime + Switch item=demoSwitch + Slider item=demoDimmer + Colorpicker item=demoColorLight + Default item=demoRollershutter + Text item=demoContact + Text item=demoTemperature + Text item=demoString + Text item=demoDatetime } } @@ -361,6 +381,7 @@ Bridge knx:serial:bridge [ Thing device generic { Type switch-control : controlSwitch "Control Switch" [ ga="3/3/10+<3/3/11" ] // '<' signs are allowed but will be ignored for control Channels Type dimmer-control : controlDimmer "Control Dimmer" [ switch="3/3/50+3/3/48", position="3/3/46", increaseDecrease="3/3/49", frequency=300 ] + Type color : controlColorLight "Color" [ hsb="6/0/10", switch="6/0/12", position="6/0/14", Type rollershutter-control : controlRollershutter "Control Rollershutter" [ upDown="3/4/1+3/4/2", stopMove="3/4/3", position="3/4/4" ] Type number-control : controlNumber "Control Number" [ ga="1/2/2" ] Type string-control : controlString "Control String" [ ga="1/4/2" ]