Leitfaden für Smart-Home-Wasserhähne
action.devices.types.FAUCET: Wasserhähne können Flüssigkeiten in verschiedenen Mengen und mit Voreinstellungen ausgeben. Wasserhähne können verschiedene Modi haben und jeder Modus hat seine eigenen zugehörigen Einstellungen. Diese beziehen sich speziell auf den Wasserhahn und werden in allgemeiner Form interpretiert.
Dieser Typ gibt an, dass das Gerät das Wasserhahnsymbol und einige verwandte Synonyme und Aliasse erhält.
Gerätefunktionen
Informationen zur Implementierung finden Sie in der entsprechenden Trait-Dokumentation, z. B. zu Attributen und Statusangaben, die Ihr Dienst unterstützen sollte, und zum Erstellen von EXECUTE- und QUERY-Antworten.
Empfohlene Eigenschaften
Diese Traits werden empfohlen, sofern für Ihr Gerät zutreffend. Sie können jedoch alle verfügbaren Merkmale beliebig kombinieren, um der vorhandenen Produktfunktionalität am besten zu entsprechen.
-
action.devices.traits.Dispense -
action.devices.traits.StartStop -
action.devices.traits.TemperatureControl
Qualitätsanforderungen
- Latenz:muss kleiner oder gleich 800 ms sein.
- Zuverlässigkeit: muss größer oder gleich 97% sein.
Beispielgerät: Einfacher Wasserhahn
Dieser Abschnitt enthält Beispiel-Intent-Nutzlasten, die einen gemeinsamen „Faucet“ basierend auf dem oben genannten Gerätetyp und den obigen Traits darstellen. Wenn Sie in Ihrer Implementierung Traits hinzufügen oder entfernen, passen Sie Ihre Antworten entsprechend an.
Beispiel für SYNC-Antwort
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.FAUCET",
"traits": [
"action.devices.traits.Dispense",
"action.devices.traits.TemperatureControl",
"action.devices.traits.OnOff"
],
"name": {
"name": "Simple faucet"
},
"willReportState": true,
"attributes": {
"supportedDispenseItems": [
{
"item_name": "water_key",
"item_name_synonyms": [
{
"lang": "en",
"synonyms": [
"Water"
]
},
{
"lang": "es",
"synonyms": [
"Agua"
]
},
{
"lang": "fr",
"synonyms": [
"Eau"
]
}
],
"supported_units": [
"TEASPOONS",
"TABLESPOONS",
"FLUID_OUNCES",
"CUPS",
"PINTS",
"QUARTS",
"GALLONS",
"MILLILITERS",
"LITERS",
"DECILITERS"
],
"default_portion": {
"amount": 2,
"unit": "CUPS"
}
}
],
"supportedDispensePresets": [
{
"preset_name": "cat_water_bowl_key",
"preset_name_synonyms": [
{
"lang": "en",
"synonyms": [
"Cat water bowl",
"Cat water dish",
"Cat water cup"
]
},
{
"lang": "es",
"synonyms": [
"Plato de agua para gato",
"Bebedero para gato"
]
},
{
"lang": "fr",
"synonyms": [
"Bol d'eau de chat",
"Bac \u00e0 eau pour chat",
"Tasse d'eau de chat"
]
}
]
}
],
"temperatureRange": {
"minThresholdCelsius": 25,
"maxThresholdCelsius": 100
},
"temperatureUnitForUX": "F"
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}
Beispiel für QUERY-Antwort
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}
{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"on": false,
"temperatureSetpointCelsius": 30,
"dispenseItems": [
{
"itemName": "water_key",
"amountLastDispensed": {
"amount": 2.5,
"unit": "CUPS"
},
"isCurrentlyDispensing": false
}
]
}
}
}
}
Beispiele für EXECUTE-Befehle
Ausgabe
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.Dispense.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.Dispense",
"params": {
"amount": 1,
"unit": "CUPS",
"item": "water_key"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"dispenseItems": [
{
"itemName": "water_key",
"amountLastDispensed": {
"amount": 1,
"unit": "CUPS"
},
"isCurrentlyDispensing": true
}
]
}
}
]
}
}
SetTemperature
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.TemperatureControl.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.SetTemperature",
"params": {
"temperature": 65
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"temperatureSetpointCelsius": 65
}
}
]
}
}
OnOff
Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu
action.devices.traits.OnOff.
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}