]> git.basschouten.com Git - openhab-addons.git/commitdiff
[knx] Improve config description for GAs (#14624)
authorHolger Friedrich <holgerfriedrich@users.noreply.github.com>
Fri, 7 Apr 2023 12:43:31 +0000 (14:43 +0200)
committerGitHub <noreply@github.com>
Fri, 7 Apr 2023 12:43:31 +0000 (14:43 +0200)
* [knx] Improve config description for GAs

Carryover from smarthomej/addons#257.

Also-by: Jan N. Klug <github@klug.nrw>
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
bundles/org.openhab.binding.knx/src/main/resources/OH-INF/config/channelConfig.xml
bundles/org.openhab.binding.knx/src/main/resources/OH-INF/i18n/knx.properties

index f4256cfce783ff45e7ff5ffa90b5078ca85f5e72..f6f21e6b3d212523d9b285ac27690fb6a19ac5a2 100644 (file)
@@ -9,34 +9,43 @@
        <config-description uri="channel-type:knx:dimmer">
                <parameter name="switch" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to toggle the dimmer on or off</description>
+                       <description>The group address (GA) to toggle the dimmer on or off. Additional listening (status) GAs can be added by
+                               concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA,
+                               separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "&lt;" (e.g. "&lt;5/1/125") are read from the bus on
+                               startup.
+                       </description>
                </parameter>
                <parameter name="position" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to set the absolute position of the dimmer</description>
+                       <description>The group address to set the absolute brightness (see format description above).</description>
                </parameter>
                <parameter name="increaseDecrease" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to increase or decrease the dimmer</description>
+                       <description>The group address to increase or decrease the dimmer (see format description above).</description>
                </parameter>
        </config-description>
        <config-description uri="channel-type:knx:dimmer-control">
                <parameter name="switch" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to toggle the dimmer on or off</description>
+                       <description>The group address (GA) to toggle the dimmer on or off. Additional listening (status) GAs can be added by
+                               concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA,
+                               separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "&lt;" (e.g. "&lt;5/1/125") are read from the bus on
+                               startup.
+                       </description>
                </parameter>
                <parameter name="position" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to set the absolute position of the dimmer</description>
+                       <description>The group address to set the brightness (see format description above).</description>
                </parameter>
                <parameter name="increaseDecrease" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to increase or decrease the dimmer</description>
+                       <description>The group address to increase or decrease the dimmer (see format description above).</description>
                </parameter>
                <parameter name="frequency" type="integer">
                        <label>Frequency</label>
                        <description>Increase/decrease send frequency if dimming should be handled by the binding (in ms) - set to 0 if the
-                               KNX device sends them repeatedly itself</description>
+                               KNX device sends them repeatedly itself.
+                       </description>
                        <default>0</default>
                </parameter>
        </config-description>
        <config-description uri="channel-type:knx:color">
                <parameter name="hsb" type="text" required="false">
                        <label>Color Value</label>
-                       <description>The group address(es) in Group Address Notation for the color value</description>
+                       <description>The group address (GA) to set the color value. Additional listening (status) GAs can be added by
+                               concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA,
+                               separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "&lt;" (e.g. "&lt;5/1/125") are read from the bus on
+                               startup.
+                       </description>
                </parameter>
                <parameter name="switch" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to toggle the color on or off</description>
+                       <description>The group address to toggle the color on or off (see format description above).</description>
                </parameter>
                <parameter name="position" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to set the absolute position of the color</description>
+                       <description>The group address to set the absolute brightness (see format description above).</description>
                </parameter>
                <parameter name="increaseDecrease" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to increase or decrease the color</description>
+                       <description>The group address to increase or decrease the brightness (see format description above).</description>
                </parameter>
        </config-description>
        <config-description uri="channel-type:knx:color-control">
                <parameter name="hsb" type="text" required="false">
                        <label>Color Value</label>
-                       <description>The group address(es) in Group Address Notation for the color value</description>
+                       <description>The group address (GA) to set the color value. Additional listening (status) GAs can be added by
+                               concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA,
+                               separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "&lt;" (e.g. "&lt;5/1/125") are read from the bus on
+                               startup.
+                       </description>
                </parameter>
                <parameter name="switch" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to toggle the color on or off</description>
+                       <description>The group address to toggle the color on or off (see format description above).</description>
                </parameter>
                <parameter name="position" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to set the absolute position of the color</description>
+                       <description>The group address to set the absolute brightness (see format description above).</description>
                </parameter>
                <parameter name="increaseDecrease" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to increase or decrease the color</description>
+                       <description>The group address to increase or decrease the brightness (see format description above).</description>
                </parameter>
                <parameter name="frequency" type="integer">
                        <label>Frequency</label>
                        <description>Increase/decrease send frequency if color should be handled by the binding (in ms) - set to 0 if the KNX
-                               device sends them repeatedly itself</description>
+                               device sends them repeatedly itself.
+                       </description>
                        <default>0</default>
                </parameter>
        </config-description>
        <config-description uri="channel-type:knx:rollershutter">
                <parameter name="upDown" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to move the shutter in the DOWN or UP direction</description>
+                       <description>The group address (GA) to set the moving direction (up/down). Additional listening (status) GAs can be
+                               added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first
+                               GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "&lt;" (e.g. "&lt;5/1/125") are read from the bus
+                               on startup.
+                       </description>
                </parameter>
                <parameter name="stopMove" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to start (MOVE) or STOP shutter movement</description>
+                       <description>The group address to start (MOVE) or STOP shutter movement (see format description above).</description>
                </parameter>
                <parameter name="position" type="text" required="false">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation to set the absolute position of the shutter, in %</description>
+                       <description>The group address to set the absolute position of the shutter, in % (see format description above).</description>
                </parameter>
        </config-description>
 
        <config-description uri="channel-type:knx:single">
                <parameter name="ga" type="text" required="true">
                        <label>Address</label>
-                       <description>The group address(es) in Group Address Notation</description>
+                       <description>The group address (GA) for this channel. Additional listening (status) GAs can be added by concatenating
+                               GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":"
+                               (e.g. "2.001:1/4/17"). GAs prepended with a "&lt;" (e.g. "&lt;5/1/125") are read from the bus on startup.
+                       </description>
                </parameter>
        </config-description>
 
index 241a3ba53014b9c1bff8b4f02441b57930476d29..4914cdc865aea2301ab45a461bc79c28e556a6a5 100644 (file)
@@ -3,6 +3,11 @@
 addon.knx.name = KNX Binding
 addon.knx.description = This binding supports connecting to a KNX bus
 
+# add-on config
+
+addon.config.knx.disableUoM.label = Disable UoM
+addon.config.knx.disableUoM.description = This disables Units of Measurement support for incoming values.
+
 # thing types
 
 thing-type.knx.device.label = KNX Device
@@ -107,45 +112,45 @@ channel-type.knx.switch.description = A channel to manage a generic Group Addres
 # channel types config
 
 channel-type.config.knx.color-control.frequency.label = Frequency
-channel-type.config.knx.color-control.frequency.description = Increase/decrease send frequency if color should be handled by the binding (in ms) - set to 0 if the KNX device sends them repeatedly itself
+channel-type.config.knx.color-control.frequency.description = Increase/decrease send frequency if color should be handled by the binding (in ms) - set to 0 if the KNX device sends them repeatedly itself.
 channel-type.config.knx.color-control.hsb.label = Color Value
-channel-type.config.knx.color-control.hsb.description = The group address(es) in Group Address Notation for the color value
+channel-type.config.knx.color-control.hsb.description = The group address (GA) to set the color value. Additional listening (status) GAs can be added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "<" (e.g. "<5/1/125") are read from the bus on startup.
 channel-type.config.knx.color-control.increaseDecrease.label = Address
-channel-type.config.knx.color-control.increaseDecrease.description = The group address(es) in Group Address Notation to increase or decrease the color
+channel-type.config.knx.color-control.increaseDecrease.description = The group address to increase or decrease the brightness (see format description above).
 channel-type.config.knx.color-control.position.label = Address
-channel-type.config.knx.color-control.position.description = The group address(es) in Group Address Notation to set the absolute position of the color
+channel-type.config.knx.color-control.position.description = The group address to set the absolute brightness (see format description above).
 channel-type.config.knx.color-control.switch.label = Address
-channel-type.config.knx.color-control.switch.description = The group address(es) in Group Address Notation to toggle the color on or off
+channel-type.config.knx.color-control.switch.description = The group address to toggle the color on or off (see format description above).
 channel-type.config.knx.color.hsb.label = Color Value
-channel-type.config.knx.color.hsb.description = The group address(es) in Group Address Notation for the color value
+channel-type.config.knx.color.hsb.description = The group address (GA) to set the color value. Additional listening (status) GAs can be added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "<" (e.g. "<5/1/125") are read from the bus on startup.
 channel-type.config.knx.color.increaseDecrease.label = Address
-channel-type.config.knx.color.increaseDecrease.description = The group address(es) in Group Address Notation to increase or decrease the color
+channel-type.config.knx.color.increaseDecrease.description = The group address to increase or decrease the brightness (see format description above).
 channel-type.config.knx.color.position.label = Address
-channel-type.config.knx.color.position.description = The group address(es) in Group Address Notation to set the absolute position of the color
+channel-type.config.knx.color.position.description = The group address to set the absolute brightness (see format description above).
 channel-type.config.knx.color.switch.label = Address
-channel-type.config.knx.color.switch.description = The group address(es) in Group Address Notation to toggle the color on or off
+channel-type.config.knx.color.switch.description = The group address to toggle the color on or off (see format description above).
 channel-type.config.knx.dimmer-control.frequency.label = Frequency
-channel-type.config.knx.dimmer-control.frequency.description = Increase/decrease send frequency if dimming should be handled by the binding (in ms) - set to 0 if the KNX device sends them repeatedly itself
+channel-type.config.knx.dimmer-control.frequency.description = Increase/decrease send frequency if dimming should be handled by the binding (in ms) - set to 0 if the KNX device sends them repeatedly itself.
 channel-type.config.knx.dimmer-control.increaseDecrease.label = Address
-channel-type.config.knx.dimmer-control.increaseDecrease.description = The group address(es) in Group Address Notation to increase or decrease the dimmer
+channel-type.config.knx.dimmer-control.increaseDecrease.description = The group address to increase or decrease the dimmer (see format description above).
 channel-type.config.knx.dimmer-control.position.label = Address
-channel-type.config.knx.dimmer-control.position.description = The group address(es) in Group Address Notation to set the absolute position of the dimmer
+channel-type.config.knx.dimmer-control.position.description = The group address to set the brightness (see format description above).
 channel-type.config.knx.dimmer-control.switch.label = Address
-channel-type.config.knx.dimmer-control.switch.description = The group address(es) in Group Address Notation to toggle the dimmer on or off
+channel-type.config.knx.dimmer-control.switch.description = The group address (GA) to toggle the dimmer on or off. Additional listening (status) GAs can be added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "<" (e.g. "<5/1/125") are read from the bus on startup.
 channel-type.config.knx.dimmer.increaseDecrease.label = Address
-channel-type.config.knx.dimmer.increaseDecrease.description = The group address(es) in Group Address Notation to increase or decrease the dimmer
+channel-type.config.knx.dimmer.increaseDecrease.description = The group address to increase or decrease the dimmer (see format description above).
 channel-type.config.knx.dimmer.position.label = Address
-channel-type.config.knx.dimmer.position.description = The group address(es) in Group Address Notation to set the absolute position of the dimmer
+channel-type.config.knx.dimmer.position.description = The group address to set the absolute brightness (see format description above).
 channel-type.config.knx.dimmer.switch.label = Address
-channel-type.config.knx.dimmer.switch.description = The group address(es) in Group Address Notation to toggle the dimmer on or off
+channel-type.config.knx.dimmer.switch.description = The group address (GA) to toggle the dimmer on or off. Additional listening (status) GAs can be added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "<" (e.g. "<5/1/125") are read from the bus on startup.
 channel-type.config.knx.rollershutter.position.label = Address
-channel-type.config.knx.rollershutter.position.description = The group address(es) in Group Address Notation to set the absolute position of the shutter, in %
+channel-type.config.knx.rollershutter.position.description = The group address to set the absolute position of the shutter, in % (see format description above).
 channel-type.config.knx.rollershutter.stopMove.label = Address
-channel-type.config.knx.rollershutter.stopMove.description = The group address(es) in Group Address Notation to start (MOVE) or STOP shutter movement
+channel-type.config.knx.rollershutter.stopMove.description = The group address to start (MOVE) or STOP shutter movement (see format description above).
 channel-type.config.knx.rollershutter.upDown.label = Address
-channel-type.config.knx.rollershutter.upDown.description = The group address(es) in Group Address Notation to move the shutter in the DOWN or UP direction
+channel-type.config.knx.rollershutter.upDown.description = The group address (GA) to set the moving direction (up/down). Additional listening (status) GAs can be added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "<" (e.g. "<5/1/125") are read from the bus on startup.
 channel-type.config.knx.single.ga.label = Address
-channel-type.config.knx.single.ga.description = The group address(es) in Group Address Notation
+channel-type.config.knx.single.ga.description = The group address (GA) for this channel. Additional listening (status) GAs can be added by concatenating GAs with a "+" (e.g. "1/7/18+2/9/15"). The DPT can be defined by prepending it to the first GA, separated by ":" (e.g. "2.001:1/4/17"). GAs prepended with a "<" (e.g. "<5/1/125") are read from the bus on startup.
 
 # thing types config