Telegrammsyntax
Beschreibung
Die Kommunikation der Logikbausteine untereinander erfolgt mit Hilfe von Telegrammen, die einer URL-Syntax nachempfunden sind:
- request://{scene|group|node}{:id|/name}?param1=value1¶m2=value2#action
- response://{scene|group|node}{:id|/name}?param1=value1
- info://{scene|group|node}
Die Velux-Auftraggeber-Bausteine generieren "request://"-Telegramme, die an den Eingang des Velux Gateways gesendet werden. Dieses antwortet mit "response://"-Telegrammen, die es über seinen Ausgang an die Eingänge der Velux-Ausgabefilter-Bausteine sendet ("Broadcast").
scene, group oder node geben an, ob sich die nachfolgenden Parameter auf Szenen, Gruppen oder einzelne Geräte ("node") beziehen.
Die Szenen, Gruppen oder Geräte können entweder mit Hilfe ihrer internen Nummer (:id) oder anhand ihres Namens (/name) identifiziert werden (z.B. "request://scene/Aufwachen#start" oder "request://node:3?position=25").
Es schließt sich nun die optionale Parameterliste an. Sie beginnt mit dem Fragezeichen ("?") und dem ersten Schlüssel-Wert-Paar. Weitere Schlüssel-Wert-Paare werden durch kaufmännisches Unds ("&") angehängt.
Weiterhin besteht die Möglichkeit, Schnellbefehle zu definieren. Diese werden mit der Raute ("#aktion") eingeleitet. So werden beispielsweise Stop-Befehle (z.B. "request://node:2#stop") gesendet.
Die möglichen Schlüssel-Wert-Paare und Aktionen sind u.a. von der Art der Anfrage (Szene, Gruppe, Gerät) und derer Fähigkeiten (z.B. auf/ab/stop, ein/aus) ab. Gegenwärtig wird nur das Setzen des Standardparameters (target=)unterstützt.
Es gibt zusätzlich die Möglichkeit, die Liste alle Szenen, Gruppen und Geräte (Nummer und Name) ausgeben zu lassen. Dazu wird die Anfrage "info://" mit der entsprechenden Klasse ("scene", "group" oder "node") in der Simulation des Gira Projekt Assistenten an das Velux Gateway geschickt. Die angefragten Informationen werden in dem Fall über den Ausgang "Antworten" des Logikbausteins ausgegeben und haben das Format "0=Name1, 1=Name2, ..", wobei die Ziffer der internen Nummer des Geräts, der Gruppe oder Szene entspricht.
In der Regel ist das manuelle Zusammenstellen der Telegramme nicht erforderlich - jedoch können damit gegebenenfalls auch noch nicht offiziell getestete Geräte angebunden werden.
Eigenschaften
Protokoll
| Bezeichnung | Beschreibung |
|---|---|
| request:// |
Das Telegramm richtet sich an den Eingang des Velux Gateways. Es wird verwendet, um Eigenschaften in Geräten oder Gruppen zu setzen oder Szenen zu beginnen/beenden. |
| response:// |
Das Telegramm wird vom Ausgang des Velux Gateways versendet. Es zeigt Veränderungen der Eigenschaften von Geräten an. |
| info:// |
Das Telegramm richtet sich an den Eingang des Velux Gateways. Es wird verwendet, um die Liste der Geräte (Nodes), Gruppen oder Szenen abzurufen. Die Liste wird Ausgang "Antworten" des Gateway-Logikbausteins gesendet und ist für die erleichterte Einrichtung gedacht. |
Geltungsbereich
| Bezeichnung | Beschreibung |
|---|---|
| node |
Gibt an, dass die nachfolgenden Parameter für ein einzelnes Gerät (Node) gelten. |
| group |
Gibt an, dass die nachfolgenden Parameter für eine Gruppe an Geräten gelten. |
| scene |
Gibt an, dass die nachfolgenden Aktionen sich auf eine Szene beziehen. |
Bezeichner
| Bezeichnung | Protokolle | Geltungsbereiche | Beschreibung |
|---|---|---|---|
| :id | request response |
node group scene |
Der Bezeichner eines Geräts, einer Gruppe oder einer Szene wird in Form der innernen Stellennummer im Velux KLF-200 Gateway angegeben. Das Velux KLF-200 Gateway unterstützt die folgenden Nummernkreise: Geräte: 0..199, Gruppen: 0..99, Szenen: 0..31. |
| /name | request response |
node group scene |
Der Bezeichner eines Geräts, einer Gruppe oder einer Szene wird mit dem im Velux KLF-200 Gateway vergebenen Namen angesprochen (z.B. "Esszimmer"). Der Name darf max. 64 Buchstaben lang sein. |
Aktionen
| Bezeichnung | Protokolle | Geltungsbereiche | Beschreibung |
|---|---|---|---|
| #start | request | node group scene |
Setzt den Standardparameter (z.B. Position bei Rollläden) eines Geräts oder einer Gerätegruppe auf den Standardwert ("0xD300"). Dieser Wert ist nicht für allen Geräten definiert und wird gegebenenfalls ignoriert. Beginnt, eine Szene auszuführen. |
| #stop | request | node group scene |
Setzt den Standardparameter (z.B. Position bei Rollläden) eines Geräts oder einer Gerätegruppe auf den aktuellen Wert ("0xD200"). Damit werden laufende Aktionen eines Geräts oder einer Gruppe angehalten. Haben die Geräte oder Gerätegruppen ihre jeweiligen Zielwerte schon erreicht, wird das Telegramm ignoriert. Beendet eine laufende Szene. Ist die Szene bereits abgelaufen, wir das Telegramm ignoriert. |
| #min | request | node group |
Setzt den Standardparameter (z.B. Position bei Rollläden) eines Geräts oder einer Gerätegruppe auf den minimalen Wert ("0x000" = Auffahren bis zur Endposition bei Rollläden). Siehe Kapitel 14.1 der Velux KLF-200-Dokumentation. |
| #max | request | node group |
Setzt den Standardparameter (z.B. Position bei Rollläden) eines Geräts oder einer Gerätegruppe auf den maximalen Wert ("0xC800" = Abfahren bis zur Endposition bei Rollläden). Siehe Kapitel 14.1 der Velux KLF-200-Dokumentation. |
Parameter
| Bezeichnung | Protokolle | Geltungsbereiche | Aktionen | Beschreibung |
|---|---|---|---|---|
| source | request | node group scene |
min max start stop |
Definiert, wer das Telegramm initiiert hat:
Standardwert: User |
| priority | request | node group scene |
min max start stop |
Definiert, mit welcher Priorität das Telegramm behandelt werden soll:
Standardwert: UserLevel2, |
| velocity | request | node group scene |
min max start |
Definiert, mit welcher Geschwindigkeit die Geräte bzw. Gerätegruppen arbeiten sollen, sofern sie dies technisch unterstützen:
Standardwert: Default |
| target | request | node group |
(wird durch #start, #stop, #min und #max überschrieben) |
Der Zielwert kann auf unterschiedliche Weise festgelegt werden:
Absolute und relative Zielwerte müssen in Dezimalschreibweise angegeben werden. Siehe Kapitel 13 der Velux KLF-200-Dokumentation. |
| target | response | node | - |
Es wird der absolute Zielwert (0x000 .. 0xC800 bzw. 0..51200) für ein Gerät ausgegeben. Wurde ein relativer Zielwert (+/-%) gesetzt, liefert das Gateway den undefinierten Wert (0xF7FF = 63487). Werte werden immer in Dezimalschreibweise ausgegeben. Bei einem Rollladen entspricht dies der anzufahrenden Position. |
| current | response | node | - |
Es wird der absolute Wert (0x000 .. 0xC800 bzw. 0..51200) des Standardparameters eines Geräts ausgegeben. Werte werden immer in Dezimalschreibweise ausgegeben. Bei einem Rollladen entspricht dies der gegenwärtigen Position. |
| countdown | response | node | - |
Dieser Parameter informiert über die Zeit in Sekunden, die vom angegebenen Gerät benötigt wird, um den Zielwert des Standardparameters umzusetzen. Bei einem Rollladen entspricht dies der Fahrzeit von der aktuellen zur Zielposition. |
| state | response | node | - |
Definiert, wer das Telegramm initiiert hat:
Typische Werte sind: NotUsed, Executing und Done |
Anwendung
Die nachfolgenden Beispiele gehen von einem Rollladen mit dem Namen "Esszimmer" und der Gateway-internen Nummer von "1" aus:
request://node:1#min
Fährt den Rollladen aufwärts bis zur Endposition (intern verwendete Standardparameter: source=User, priority=UserLevel2, velocity=Default).
request://node:1?priority=UserLevel1#min
Fährt den Rollladen mit einer höhreren Priorisierung aufwärts bis zur Endposition (intern verwendete Standardparameter: source=User, velocity=Default).
request://node/Esszimmer?target=25600
Fährt den Rollladen auf 50% (50% von 51200 entsprechen 25600; intern verwendete Standardparameter: source=User, priority=UserLevel2, velocity=Default). Die Angabe des Zielwertes 50% beziehen sich auf die Fahrzeit, nicht auf die "technische" Höhe des Rollladens. Hier muss ein wenig experiementiert werden, um die für jeden Rollladen korrekten "50%" zu finden.