- adapted for 2.3.0

- adapted for year 2018 - more sophisticated examples - minor doc changes - fixed: lowercase/uppercase typos - comments of @htreu incorporated (still TBD: properties-instead-of-channels) - on our way resolving all issues mentioned by @htreu Signed-off-by: Guenther Schreiner <guenther.schreiner@smile.de> (github: gs4711)
openhab · Feb 14, 2018 · 647c42c · 647c42c
1 parent 7b40545
commit 647c42c
Show file tree

Hide file tree

Showing 53 changed files with 684 additions and 794 deletions.
diff --git a/addons/binding/org.openhab.binding.velux/ESH-INF/binding/binding.xml b/addons/binding/org.openhab.binding.velux/ESH-INF/binding/binding.xml
@@ -1,21 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Copyright 2016-2017 (c) Guenther Schreiner <guenther.schreiner@smile.de>
- *
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- -->
-<binding:binding id="velux"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xmlns:binding="http://eclipse.org/smarthome/schemas/binding/v1.0.0"
+<binding:binding id="velux" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:binding="http://eclipse.org/smarthome/schemas/binding/v1.0.0"
 	xsi:schemaLocation="http://eclipse.org/smarthome/schemas/binding/v1.0.0 http://eclipse.org/smarthome/schemas/binding-1.0.0.xsd">
-
 	<name>Velux Binding</name>
 	<description>The Velux Binding interacts via a Velux Bridge with the different Velux devices
-                like controlling window openers, shutters and others. For example a KLF200 can act as interface between the HomeAutomation and the VELUX INTEGRA products with wireless connectivity based on the io-homecontrol standard.</description>
+like controlling window openers, shutters and others. For example a KLF200 can act as interface between the HomeAutomation and the VELUX INTEGRA products with wireless connectivity based on the io-homecontrol standard.</description>
 	<author>Guenther Schreiner</author>
-
 </binding:binding>
diff --git a/addons/binding/org.openhab.binding.velux/ESH-INF/i18n/velux_de.properties b/addons/binding/org.openhab.binding.velux/ESH-INF/i18n/velux_de.properties
@@ -1,55 +1,55 @@
 
 # binding
 binding.velux.name = Velux Binding
-binding.velux.description = Das Velux Binding kommuniziert ueber ein Velux Kopplungselement mit den unterschiedlichen Veluxgeraeten zur Steuerung von Fenstern, Rollaeden und anderen Geraeten. Beispielsweise kann ein KLF 200 als Schnittstelle zwischen Hausleitsystemen und VELUX INTEGRA Produkten mit Funkanbindung basierend auf dem io-homecontrol-Standard eingesetzt werden.
+binding.velux.description = Das Velux Binding kommuniziert über ein Velux Kopplungselement mit den unterschiedlichen Velux-Geräten zur Steuerung von Fenstern, Rolläden und anderen Geräten. Beispielsweise kann ein KLF 200 als Schnittstelle zwischen Hausleitsystemen und VELUX INTEGRA Produkten mit Funkanbindung basierend auf dem io-homecontrol-Standard eingesetzt werden.
 
 # thing types
 thing-type.velux.klf200.label = Velux KLF200
-thing-type.velux.klf200.description = Kopplungselement zur Interaktion mit unterschiedlichen Veluxgeraeten.
-thing-type.config.velux.klf200.bridgeURL.label = URL des Kopplungselements
-thing-type.config.velux.klf200.bridgeURL.description = Basis-URL zum Zugriff auf das Velux KLF200 Kopplungselement.
+thing-type.velux.klf200.description = Kopplungselement zur Interaktion mit unterschiedlichen Velux-Geräten.
+thing-type.config.velux.klf200.bridgeIPAddress.label = Adresse des Kopplungselements
+thing-type.config.velux.klf200.bridgeIPAddress.description = Name oder IP-Adresse zum Zugriff auf das Velux KLF200 Kopplungselement.
+thing-type.config.velux.klf200.bridgeTCPPort.label = Port des Kopplungselements
+thing-type.config.velux.klf200.bridgeTCPPort.description = TCP Portnummer zum HTTP-Zugriff auf das Velux KLF200 Kopplungselement.
 thing-type.config.velux.klf200.bridgePassword.label = Passwort
 thing-type.config.velux.klf200.bridgePassword.description = Password zur Anmeldung an dem Velux KLF200 Kopplungselement.
-thing-type.config.velux.klf200.timeoutMsecs.label = Antwortwartezeit
+thing-type.config.velux.klf200.timeoutMsecs.label = Zeitüberschreitung
 thing-type.config.velux.klf200.timeoutMsecs.description = Zeit in Millisekunden.
 thing-type.config.velux.klf200.retries.label = Wiederholungsversuche
-thing-type.config.velux.klf200.retries.description = Anzahl der Verbindungswiederholungen fuer den Binary Exponential Backoff (BEB) Algorithmus.
+thing-type.config.velux.klf200.retries.description = Anzahl der Verbindungswiederholungen für den Binary Exponential Backoff (BEB) Algorithmus.
 
 thing-type.velux.scene.label = Velux Szene
-thing-type.velux.scene.description = Szene als Sammlung von Geraetezustaenden, welche aktiviert werden koennen.
+thing-type.velux.scene.description = Szene als Sammlung von Gerätezuständen, welche aktiviert werden können.
 thing-type.config.velux.scene.sceneName.label = Szenenname
 thing-type.config.velux.scene.sceneName.description = Name der Szene, welche hier behandelt wird.
-thing-type.config.velux.scene.TTL.label = Lebenszeit
-thing-type.config.velux.scene.TTL.description = Lebenszeit dieses Objekts in Sekunden (-1 bedeutet unendlich).
 
 # channel types
-channel-type.velux.STATUS.label = Status
-channel-type.velux.STATUS.description = Status des Kopplungselements.
-channel-type.velux.FIRMWARE.label = Firmware
-channel-type.velux.FIRMWARE.description = Softwareversion des Kopplungselements.
-channel-type.velux.IPADDRESS.label = IP-Adresse
-channel-type.velux.IPADDRESS.description = IP-Adresse des Kopplungselements.
-channel-type.velux.SUBNETMASK.label = Subnetzmaske
-channel-type.velux.SUBNETMASK.description = IP-Subnetzmaske des Kopplungselements.
-channel-type.velux.DEFAULTGW.label = Gateway-IP-Adresse
-channel-type.velux.DEFAULTGW.description = IP-Adresse des Gateways.
+channel-type.velux.status.label = Status
+channel-type.velux.status.description = Status des Kopplungselements.
+channel-type.velux.firmware.label = Firmware
+channel-type.velux.firmware.description = Softwareversion des Kopplungselements.
+channel-type.velux.ipAddress.label = IP-Adresse
+channel-type.velux.ipAddress.description = IP-Adresse des Kopplungselements.
+channel-type.velux.subnetMask.label = Subnetzmaske
+channel-type.velux.subnetMask.description = IP-Subnetzmaske des Kopplungselements.
+channel-type.velux.defaultGW.label = Gateway-IP-Adresse
+channel-type.velux.defaultGW.description = IP-Adresse des Gateways.
 channel-type.velux.DHCP.label = DHCP-Aktivierung
 channel-type.velux.DHCP.description = Aktivierung der automatischen IP-Konfiguration mittels DHCP.
 channel-type.velux.WLANSSID.label = WLAN-SSID
 channel-type.velux.WLANSSID.description = Netzwerkkennung des Wireless-Netzwerks.
-channel-type.velux.WLANPASSWORD.label = WLAN-Passwort
-channel-type.velux.WLANPASSWORD.description = Passwort zum Zugriff auf das Wireless-Netzwerk.
-channel-type.velux.SCENES.label = Identifizierte Szenen
-channel-type.velux.SCENES.description = Szenen welche auf dem Kopplungselement definiert sind.
-channel-type.velux.PRODUCTS.label = Identifizierte Produkte
-channel-type.velux.PRODUCTS.description = Produkte welche auf dem Kopplungselement im Rahmen von Szenen definiert sind.
-channel-type.velux.DETECTION.label = Produkterkennung
-channel-type.velux.DETECTION.description = Schalter zum Start der Produkterkennung.
+channel-type.velux.WLANPassword.label = WLAN-Passwort
+channel-type.velux.WLANPassword.description = Passwort zum Zugriff auf das Wireless-Netzwerk.
+channel-type.velux.scenes.label = Identifizierte Szenen
+channel-type.velux.scenes.description = Szenen welche auf dem Kopplungselement definiert sind.
+channel-type.velux.products.label = Identifizierte Produkte
+channel-type.velux.products.description = Produkte welche auf dem Kopplungselement im Rahmen von Szenen definiert sind.
+channel-type.velux.doDetection.label = Produkterkennung
+channel-type.velux.doDetection.description = Schalter zum Start der Produkterkennung.
 
-channel-type.velux.ACTION.label = Szenenstart
-channel-type.velux.ACTION.description = Schalter zum Start dieser Szene
-channel-type.velux.SILENTMODE.label = Stillmodus
-channel-type.velux.SILENTMODE.description = Aktiviert den Leise-Modus auf einer definierten Szene.
+channel-type.velux.action.label = Szenenstart
+channel-type.velux.action.description = Schalter zum Start dieser Szene
+channel-type.velux.silentMode.label = Stillmodus
+channel-type.velux.silentMode.description = Aktiviert den Leise-Modus auf einer definierten Szene.
 
 # end-of-ESH-INF/i18n/velux_de.properties
 
diff --git a/addons/binding/org.openhab.binding.velux/ESH-INF/thing/bridge.xml b/addons/binding/org.openhab.binding.velux/ESH-INF/thing/bridge.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Copyright 2016-2017 (c) Guenther Schreiner <guenther.schreiner@smile.de>
+ * Copyright 2016-2018 (c) Guenther Schreiner <guenther.schreiner@smile.de>
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
@@ -18,35 +18,41 @@
 		<label>Velux KLF200 Bridge</label>
 		<description>The Velux KLF200 represents a gateway to all Velux devices.</description>
 
-                <channels>
-                        <channel id="STATUS" typeId="STATUS" />
-                        <channel id="FIRMWARE" typeId="FIRMWARE" />
-                        <channel id="IPADDRESS" typeId="IPADDRESS" />
-                        <channel id="SUBNETMASK" typeId="SUBNETMASK" />
-                        <channel id="DEFAULTGW" typeId="DEFAULTGW" />
-                        <channel id="DHCP" typeId="DHCP" />
-                        <channel id="WLANSSID" typeId="WLANSSID" />
-                        <channel id="WLANPASSWORD" typeId="WLANPASSWORD" />
-                        <channel id="SCENES" typeId="SCENES" />
-                        <channel id="PRODUCTS" typeId="PRODUCTS" />
-                        <channel id="DETECTION" typeId="DETECTION" />
-                </channels>
+		<channels>
+			<channel id="status" typeId="status" />
+			<channel id="firmware" typeId="firmware" />
+			<channel id="ipAddress" typeId="ipAddress" />
+			<channel id="subnetMask" typeId="subnetMask" />
+			<channel id="defaultGW" typeId="defaultGW" />
+			<channel id="DHCP" typeId="DHCP" />
+			<channel id="WLANSSID" typeId="WLANSSID" />
+			<channel id="WLANPassword" typeId="WLANPassword" />
+			<channel id="scenes" typeId="scenes" />
+			<channel id="products" typeId="products" />
+			<channel id="doDetection" typeId="doDetection" />
+		</channels>
 
 		<properties>
 			<property name="vendor">Velux</property>
 		</properties>
 
 		<config-description>
-			<parameter name="bridgeURL" type="text">
-				<label>Bridge URL</label>
-				<description>Basic bridge URL for accessing the Velux Bridge.</description>
+			<parameter name="bridgeIPAddress" type="text">
+				<label>Bridge IP Address</label>
+				<description>The IP address of the Velux Bridge.</description>
 				<required>true</required>
-				<default>http://velux.bridge:80</default>
+			</parameter>
+			<parameter name="bridgeTCPPort" type="integer" required="false" min="1" max="65335">
+				<label>Bridge Port</label>
+				<description>TCP port of the Velux gateway</description>
+				<default>80</default>
+				<advanced>true</advanced>
 			</parameter>
 			<parameter name="bridgePassword" type="text">
 				<label>Bridge Password</label>
 				<description>Password for authentication against the Velux Bridge.</description>
 				<required>true</required>
+				<!-- Velux Bridge factory default -->
 				<default>velux123</default>
 			</parameter>
 			<parameter name="timeoutMsecs" type="integer" min="1" step="1">
@@ -57,7 +63,7 @@
 				<advanced>true</advanced>
 			</parameter>
 			<parameter name="retries" type="integer" min="1" step="1">
-				<label>Timeout</label>
+				<label>Connection retries</label>
 				<description>Number of retries with timing along the Binary Exponential Backoff (BEB) Algorithm.</description>
 				<required>false</required>
 				<default>6</default>