Smart-Home-Garage – Leitfaden
action.devices.types.GARAGE
: Garagentore können geöffnet, geschlossen und ein geöffneter Zustand erkannt werden. Sie können auch anzeigen, ob ein Objekt den Weg der Tür beim Schließen versperrt hat oder ob die Tür verriegelt ist und daher nicht gesteuert werden kann.
Dieser Typ gibt an, dass das Gerät das Garagensymbol und einige zugehörige Synonyme und Aliasse erhält.
Gerätefunktionen
In der entsprechenden Dokumentation zu Merkmalen finden Sie Implementierungsdetails wie Attribute und Status, die Ihr Dienst unterstützen sollte, sowie Informationen zum Erstellen von EXECUTE- und QUERY-Antworten.
Erforderliche Merkmale
Diese Merkmale und Befehle sind erforderlich, sofern sie für Ihr Gerät gelten. Wenn Ihr Gerät diese Eigenschaften nicht unterstützt, geben Sie den Fehlercode functionNotSupported
in einer QUERY- oder EXECUTE-Antwort ein. Weitere Informationen finden Sie unter Fehler und Ausnahmen.
Empfohlene Merkmale
Diese Eigenschaften werden empfohlen, sofern sie für Ihr Gerät gelten. Sie können jedoch alle verfügbaren Merkmale kombinieren, um sie bestmöglich an Ihre vorhandenen Produktfunktionen anzupassen.
Qualitätsanforderungen
- Latenz:muss kleiner als oder gleich 2.000 ms sein.
- Zuverlässigkeit:muss mindestens 97% betragen.
Beispielgerät: Einfache Garage
Dieser Abschnitt enthält Beispiel-Intent-Nutzlasten für eine gängige „Garage“ basierend auf dem Gerätetyp und den oben genannten Merkmalen. Wenn Sie in Ihrer Implementierung Merkmale hinzufügen oder entfernen, ändern Sie Ihre Antworten entsprechend, um diese Änderungen widerzuspiegeln.
Beispiel für eine SYNC-Antwort
{ "requestId": "6894439706274654512", "inputs": [ { "intent": "action.devices.SYNC" } ] }
{ "requestId": "6894439706274654512", "payload": { "agentUserId": "user123", "devices": [ { "id": "123", "type": "action.devices.types.GARAGE", "traits": [ "action.devices.traits.OpenClose", "action.devices.traits.LockUnlock" ], "name": { "name": "Simple garage" }, "willReportState": true, "deviceInfo": { "manufacturer": "smart-home-inc", "model": "hs1234", "hwVersion": "3.2", "swVersion": "11.4" } } ] } }
Beispiel für eine QUERY-Antwort
{ "requestId": "6894439706274654514", "inputs": [ { "intent": "action.devices.QUERY", "payload": { "devices": [ { "id": "123" } ] } } ] }
{ "requestId": "6894439706274654514", "payload": { "devices": { "123": { "status": "SUCCESS", "online": true, "openPercent": 50, "isLocked": false, "isJammed": false } } } }
Beispielbefehle für EXECUTE
OpenClose
Weitere Informationen zu den Befehlsparametern finden Sie in der
action.devices.traits.OpenClose
-Referenz.
{ "requestId": "6894439706274654518", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.OpenClose", "params": { "openPercent": 100 } } ] } ] } } ] }
{ "requestId": "6894439706274654518", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "openPercent": 100 } } ] } }
LockUnlock
Weitere Informationen zu den Befehlsparametern finden Sie in der
action.devices.traits.LockUnlock
-Referenz.
{ "requestId": "6894439706274654516", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.LockUnlock", "params": { "lock": true } } ] } ] } } ] }
{ "requestId": "6894439706274654516", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "isLocked": true, "isJammed": false } } ] } }
GERÄTEFEHLER
Eine vollständige Liste der Fehler und AusnahmenobstructionDetected
– Der Nutzer hat versucht, das Garagentor zu schließen, aber ein Objekt blockierte das Tor.lockedState
– Der Nutzer hat versucht, das Garagentor zu öffnen, es ist jedoch verriegelt und lässt sich nicht bewegen.