]> git.basschouten.com Git - openhab-addons.git/commitdiff
[velux] Improvements to documentation (#12604)
authorAndrew Fiddian-Green <software@whitebear.ch>
Mon, 18 Apr 2022 17:43:14 +0000 (18:43 +0100)
committerGitHub <noreply@github.com>
Mon, 18 Apr 2022 17:43:14 +0000 (19:43 +0200)
* [velux] update readme per #12601; delete dead web links
* [velux] improve readability

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
bundles/org.openhab.binding.velux/README.md
bundles/org.openhab.binding.velux/doc/conf/things/velux-001.things [deleted file]
bundles/org.openhab.binding.velux/doc/conf/things/velux-bridge.things [deleted file]
bundles/org.openhab.binding.velux/doc/conf/things/velux.things [new file with mode: 0644]
bundles/org.openhab.binding.velux/doc/conf/things/velux.things.disabled [deleted file]

index 5550350b96a3253f712dbfb7c74c546103ca1726..7aa4290dda46674f1c1f896f79e3b6560c316f7e 100644 (file)
@@ -90,9 +90,14 @@ In addition there are some optional Configuration Parameters.
 
 Notes:
 
-1. To enable a complete inversion of all parameter values (i.e. for Velux windows), use the property `inverted` or add a trailing star to the eight-byte serial number. For an example, see below at item `Velux DG Window Bathroom`.
+1. To enable a complete inversion of all parameter values (i.e. for Velux windows), use the property `inverted` or add a trailing star to the eight-byte serial number.
+For an example, see the Thing definition for 'Bathroom_Roof_Window' below.
 
-2. Somfy devices do not provide a valid serial number to the Velux KLF200 gateway. In this case you should enter the default `serial` number 00:00:00:00:00:00:00:00, and in addition enter the `name` parameter; this is the name that you gave to the actuator when you first registered it in the KLF200 Bridge. For an example, see below at item `Velux OG Somfy Shutter`.
+2. Somfy devices do not provide a valid serial number to the Velux KLF200 Bridge.
+For such devices you have to enter the special all-zero serial number 00:00:00:00:00:00:00:00 in the `serial` parameter.
+This special serial number complies with the serial number validation checks, but also makes the binding use the `name` parameter value instead of the `serial` parameter value when it communicates with the KLF Bridge.
+The `name` parameter must therefore contain the name that you gave to the actuator when you first registered it in the KLF200 Bridge.
+For an example, see the Thing definition for 'Living_Room_Awning' below.
 
 ### Thing Configuration for "scene"
 
@@ -222,11 +227,15 @@ The bridge Thing provides the following properties.
 
 ```
 Bridge velux:klf200:g24 "Velux KLF200 Hub" @ "Under Stairs" [ipAddress="192.168.1.xxx", password="secret"] {
-    Thing window w56-36-13-5A-11-2A-05-70 "Bathroom Roof Window" @ "Bathroom" [serial="56:36:13:5A:11:2A:05:70", inverted=true]
+       // Velux (standard) window (with serial number)
+    Thing window Bathroom_Roof_Window "Bathroom Roof Window" @ "Bathroom" [serial="56:36:13:5A:11:2A:05:70", inverted=true]
+
+       // Somfy (non-standard) rollershutter (without serial number)
+    Thing rollershutter Living_Room_Awning "Living Room Awning" @ "Living Room" [serial="00:00:00:00:00:00:00:00", name="Living Room Awning"]
 }
 ```
 
-[=> download sample things file for textual configuration](./doc/conf/things/velux.things)
+See [velux.things](doc/conf/things/velux.things) for more examples.
 
 ### Items
 
@@ -234,7 +243,7 @@ Bridge velux:klf200:g24 "Velux KLF200 Hub" @ "Under Stairs" [ipAddress="192.168.
 Rollershutter Bathroom_Roof_Window_Position "Bathroom Roof Window Position [%.0f %%]" {channel="velux:window:g24:w56-36-13-5A-11-2A-05-70:position"}
 ```
 
-[=> download sample items file for textual configuration](./doc/conf/items/velux.items)
+See [velux.items](doc/conf/items/velux.items) for more examples.
 
 ### Sitemap
 
@@ -244,7 +253,7 @@ Frame label="Velux Windows" {
 }
 ```
 
-[=> download sample sitemaps file for textual configuration](./doc/conf/sitemaps/velux.sitemap)
+See [velux.sitemap](doc/conf/sitemaps/velux.sitemap) for more examples.
 
 ### Rule for closing windows after a period of time
 
@@ -282,7 +291,7 @@ then
 end
 ```
 
-[=> download sample rules file for textual configuration](./doc/conf/rules/velux.rules)
+See [velux.rules](doc/conf/rules/velux.rules) for more examples.
 
 ### Rule for rebooting the Bridge
 
@@ -449,7 +458,6 @@ The next-generation firmware version two is not backward compatible, and does no
 Notes:
 
 - Velux bridges cannot be returned to version one of the firmware after being upgraded to version two.
-- Firmware updates are currently provided at [Velux download area](https://updates2.velux.com/).
 
 ## Is it possible to run the both communication methods in parallel?
 
diff --git a/bundles/org.openhab.binding.velux/doc/conf/things/velux-001.things b/bundles/org.openhab.binding.velux/doc/conf/things/velux-001.things
deleted file mode 100644 (file)
index 2d65824..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-/**
- *
- * Copyright (c) 2010-2022 Contributors to the openHAB project
- *
- * See the NOTICE file(s) distributed with this work for additional
- * information.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0
- */
-
-/**
- * OpenHAB thing definition for velux binding:
- *  define a Velux device behind the bridge
- *
- * @author Guenther Schreiner - Initial contribution
- */
-
-//
-// Definition of a Velux window behind bridge velux:klf200:gs28
-//
-
-Thing velux:window:gs28:window001      (velux:klf200:gs28)     [ serial="53:09:40:5A:0C:2A:05:64"  ]
-
-//
-// vim: syntax=Xtend vim: noai:ts=4:sw=4
-//
-// end-of-things/velux-bridge.things
-//
diff --git a/bundles/org.openhab.binding.velux/doc/conf/things/velux-bridge.things b/bundles/org.openhab.binding.velux/doc/conf/things/velux-bridge.things
deleted file mode 100644 (file)
index 7f2cfec..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-/**
- *
- * Copyright (c) 2010-2022 Contributors to the openHAB project
- *
- * See the NOTICE file(s) distributed with this work for additional
- * information.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0
- */
-
-/**
- * OpenHAB thing definition for velux binding:
- *  define basic Velux bridge parameters
- *
- * @author Guenther Schreiner - Initial contribution
- */
-
-//
-// Definition of Velux bridge velux:klf200:home
-//
-
-Bridge velux:klf200:gs28    [ ipAddress="192.168.45.1", tcpPort=51200, password="secret", isProtocolTraceEnabled=true ] 
-
-//
-// vim: syntax=Xtend vim: noai:ts=4:sw=4
-//
-// end-of-things/velux-bridge.things
-//
diff --git a/bundles/org.openhab.binding.velux/doc/conf/things/velux.things b/bundles/org.openhab.binding.velux/doc/conf/things/velux.things
new file mode 100644 (file)
index 0000000..d6f4717
--- /dev/null
@@ -0,0 +1,62 @@
+/**
+ *
+ * Copyright (c) 2010-2022 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ */
+
+/**
+ * OpenHAB thing definition for velux binding:
+ *  define basic Velux bridge parameters
+ *
+ * This is a definition which corresponds to the output of th Bridge
+ * during startup, i.e.
+ *
+ * [INFO ] [x.internal.handler.VeluxBridgeHandler] - Found velux actuators:
+ *     Product "#0" / SLIDER_SHUTTER (bridgeIndex=0,serial=56:32:14:5A:12:1C:05:5F,position=0000)
+ *     Product "#1" / SLIDER_SHUTTER (bridgeIndex=1,serial=53:09:40:5A:0C:23:0A:6E,position=0000)
+ *     Product "DG-M-Window" / SLIDER_WINDOW (bridgeIndex=3,serial=56:23:3E:26:0C:1B:00:10,position=C800)
+ *     Product "#2" / SLIDER_SHUTTER (bridgeIndex=2,serial=53:09:40:5A:0C:2A:05:64,position=0000)
+ *     Product "#4" / SWITCH (bridgeIndex=4,serial=Somfy-Switch,position=C800) 
+ *     Product "#5" / SWITCH (bridgeIndex=5,serial=Somfy-Switch,position=C800) 
+ *
+ * @author Guenther Schreiner - Initial contribution
+ */
+
+//
+// Definition of Velux bridge velux:klf200:home
+//
+
+Bridge velux:klf200:home    [ ipAddress="192.168.45.9", tcpPort=51200, password="verySecret" ] {
+
+// Velux scenes
+
+    Thing   scene   windowClosed    [ sceneName="V_DG_Window_Mitte_000" ]
+    Thing   scene   windowUnlocked  [ sceneName="V_DG_Window_Mitte_005" ]
+    Thing   scene   windowOpened    [ sceneName="V_DG_Window_Mitte_100" ]
+    Thing   scene   unknownScene    [ sceneName="ThisIsADummySceneName" ]
+
+// Velux IO-homecontrol devices
+
+    Thing   window             V_DG_M_W    [ serial="56:23:3E:26:0C:1B:00:10" ]
+    Thing   rollershutter      V_DG_M_S    [ serial="56:23:3E:26:0C:1B:00:10" ]
+    Thing   rollershutter      V_DG_W_S    [ serial="53:09:40:5A:0C:2A:05:64" ]
+    Thing   rollershuffer      V_DG_O_S    [ serial="53:09:40:5A:0C:23:0A:6E" ]
+    Thing   actuator           V_SWITCH1   [ name="#4" ]
+    Thing   actuator           V_SWITCH2   [ name="#5" ]
+
+// Virtual rollershutter
+
+    Thing   vshutter           V_WINDOW    [ sceneLevels="0,V_DG_Window_Mitte_000#5,V_DG_Window_Mitte_005#100,V_DG_Window_Mitte_100" ]
+}
+
+//
+// vim: syntax=Xtend vim: noai:ts=4:sw=4
+//
+// end-of-things/velux.things
+//
diff --git a/bundles/org.openhab.binding.velux/doc/conf/things/velux.things.disabled b/bundles/org.openhab.binding.velux/doc/conf/things/velux.things.disabled
deleted file mode 100644 (file)
index d6f4717..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-/**
- *
- * Copyright (c) 2010-2022 Contributors to the openHAB project
- *
- * See the NOTICE file(s) distributed with this work for additional
- * information.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License 2.0 which is available at
- * http://www.eclipse.org/legal/epl-2.0
- */
-
-/**
- * OpenHAB thing definition for velux binding:
- *  define basic Velux bridge parameters
- *
- * This is a definition which corresponds to the output of th Bridge
- * during startup, i.e.
- *
- * [INFO ] [x.internal.handler.VeluxBridgeHandler] - Found velux actuators:
- *     Product "#0" / SLIDER_SHUTTER (bridgeIndex=0,serial=56:32:14:5A:12:1C:05:5F,position=0000)
- *     Product "#1" / SLIDER_SHUTTER (bridgeIndex=1,serial=53:09:40:5A:0C:23:0A:6E,position=0000)
- *     Product "DG-M-Window" / SLIDER_WINDOW (bridgeIndex=3,serial=56:23:3E:26:0C:1B:00:10,position=C800)
- *     Product "#2" / SLIDER_SHUTTER (bridgeIndex=2,serial=53:09:40:5A:0C:2A:05:64,position=0000)
- *     Product "#4" / SWITCH (bridgeIndex=4,serial=Somfy-Switch,position=C800) 
- *     Product "#5" / SWITCH (bridgeIndex=5,serial=Somfy-Switch,position=C800) 
- *
- * @author Guenther Schreiner - Initial contribution
- */
-
-//
-// Definition of Velux bridge velux:klf200:home
-//
-
-Bridge velux:klf200:home    [ ipAddress="192.168.45.9", tcpPort=51200, password="verySecret" ] {
-
-// Velux scenes
-
-    Thing   scene   windowClosed    [ sceneName="V_DG_Window_Mitte_000" ]
-    Thing   scene   windowUnlocked  [ sceneName="V_DG_Window_Mitte_005" ]
-    Thing   scene   windowOpened    [ sceneName="V_DG_Window_Mitte_100" ]
-    Thing   scene   unknownScene    [ sceneName="ThisIsADummySceneName" ]
-
-// Velux IO-homecontrol devices
-
-    Thing   window             V_DG_M_W    [ serial="56:23:3E:26:0C:1B:00:10" ]
-    Thing   rollershutter      V_DG_M_S    [ serial="56:23:3E:26:0C:1B:00:10" ]
-    Thing   rollershutter      V_DG_W_S    [ serial="53:09:40:5A:0C:2A:05:64" ]
-    Thing   rollershuffer      V_DG_O_S    [ serial="53:09:40:5A:0C:23:0A:6E" ]
-    Thing   actuator           V_SWITCH1   [ name="#4" ]
-    Thing   actuator           V_SWITCH2   [ name="#5" ]
-
-// Virtual rollershutter
-
-    Thing   vshutter           V_WINDOW    [ sceneLevels="0,V_DG_Window_Mitte_000#5,V_DG_Window_Mitte_005#100,V_DG_Window_Mitte_100" ]
-}
-
-//
-// vim: syntax=Xtend vim: noai:ts=4:sw=4
-//
-// end-of-things/velux.things
-//