Telegrammsyntax
Beschreibung
Die Kommunikation der Logikbausteine untereinander erfolgt mit Hilfe von Telegrammen, die einer URL-Syntax nachempfunden sind:
- request://<device-id><:device-type>/{lock|unlock|unlatch|info}
- response://<device-id><:device-type>/{lock|unlock|unlatch|info}?param1=value1
Die Nuki Auftraggeber-Bausteine generieren "request://"-Telegramme, die an den Eingang der Nuki Bridge gesendet werden. Diese antwortet mit "response://"-Telegrammen, die es über seinen Ausgang an die Eingänge der Nuki Antwortfilter-Bausteine sendet ("Broadcast").
Jedes Telegramm definiert die Nuki-ID (device-id), den Nuki-Gerättyp (device-type) und eine Aktion (z.B. lock, info).
Bei Antworten 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.
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 der Nuki Bridge. Es wird verwendet, um Eigenschaften in Geräten abzufragen oder Aktionen auszulösen. |
| response:// |
Das Telegramm wird vom Ausgang der Nuki Bridge versendet. Es zeigt Veränderungen der Eigenschaften von Geräten an. |
Bezeichner
| Bezeichnung | Protokolle | Beschreibung |
|---|---|---|
| device-id | request response |
Der eindeutige Bezeichner eines Geräts ("nukiID"). Die Bezeichner aller mit einer Bridge gekoppelten Geräte können mit Hilfe des /list-Befehls ermittelt werden. |
| device-type | request response |
Der Typ eines Geräts ("deviceType"). Die Bezeichner aller mit einer Bridge gekoppelten Geräte können mit Hilfe des /list-Befehls ermittelt werden. |
Aktionen
| Bezeichnung | Protokolle | Beschreibung |
|---|---|---|
| /lock | request response |
Fordert das angegebene Nuki Gerät auf, die Aktion "2" (= "lock", siehe Lock Actions) durchzuführen. Eine Antwort meldet die erfolgreiche bzw. erfolgreiche Ausführung der Aktion. |
| /unlock | request response |
Fordert das angegebene Nuki Gerät auf, die Aktion "1" (= "unlock", siehe Lock Actions) durchzuführen. Eine Antwort meldet die erfolgreiche bzw. erfolgreiche Ausführung der Aktion. |
| /unlatch | request response |
Fordert das angegebene Nuki Gerät auf, die Aktion "3" (= "unlatch", siehe Lock Actions) durchzuführen. Eine Antwort meldet die erfolgreiche bzw. erfolgreiche Ausführung der Aktion. |
| /info | request response |
Fordert das angegebene Nuki Gerät auf, den Status des Geräts und ggf des Türsensors und der Batterie zu melden. Eine Antwort meldet den Status des Geräts, Türsensors und der Batterie. |
Parameter
| Bezeichnung | Protokolle | Beschreibung |
|---|---|---|
| success | response |
Definiert, ob eine Aktion erfolgreich war:
|
| lock | response |
Liefert den Status des Geräts (typischerweise ein Smart Lock):
Siehe auch: Liste aller Nuki Lock States |
| door | response |
Liefert den Status des Türsensors:
Siehe auch: Liste aller Nuki Door Sensor States |
| battery | response |
Prozentualer Ladezustand der Batterie bzw. des Akkus des Nuki Geräts. |
Anwendung
Die nachfolgenden Beispiele gehen von einem Nuki Smartlock der zweiten Generation (device-type=0) mit dem Bezeichner "13579" (device-id=13579) aus:
request://13579:0/lock
Schließt die Tür ab.
response://13579:0/lock?success=true
Bestätigt, dass die Tür abgeschlossen wurde.
request://13579:0/info
Fordert den aktuellen Gerätestatus an.
response://13579:0/info?lock=3&door=2&battery=50
Teilt mit, dass die Tür unverschlossen (lock=3), jedoch auch nicht geöffnet (door=2) ist und dass noch 50% Kapazität in der Batterie bzw. dem Akku vorhanden sind.