Przewodnik do instalacji inteligentnego domu

action.devices.types.FAUCET – krany mogą wysyłać płyny w różnych ilościach i gotowych ustawieniach. Baterie mogą mieć różne tryby, a każdy z nich ma swoje powiązane ustawienia. Są one związane z kranem i są interpretowane w formie uogólnionej.

Ten typ oznacza, że na urządzeniu pojawia się ikona kranu oraz kilka powiązanych synonimy i aliasy.

Funkcje urządzenia

Zapoznaj się z dokumentacją dotyczącą cech, aby: szczegóły implementacji, takie jak atrybuty i stany, które powinna obsługiwać Twoja usługa, oraz sposób kompilować odpowiedzi EXECUTE i QUERY.

Są one zalecane (jeśli mają zastosowanie do Twojego urządzenia). Możesz jednak dowolnie łączyć ze sobą wszystkie cechy, aby jak najlepiej dopasować funkcji produktu.

Wymagania dotyczące jakości

  • Czas oczekiwania: nie może przekraczać 800 ms.
  • Miarodajność: wartość nie może być mniejsza niż 97%.

Przykładowe urządzenie: prosty kran

Ta sekcja zawiera przykładowe ładunki intencji reprezentujące wspólny komponent „Faucet” na podstawie typu urządzenia i cech wymienionych powyżej. Jeśli dodasz lub usuniesz cechy swojej implementacji, odpowiednio zmodyfikuj swoje odpowiedzi, by odzwierciedlić te zmiany.

Przykładowa odpowiedź SYNC

Prośba
.
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
.
Odpowiedź
{
  "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"
        }
      }
    ]
  }
}

Przykładowa odpowiedź na zapytanie QUERY

Prośba
.
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
.
Odpowiedź
{
  "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
          }
        ]
      }
    }
  }
}

Przykładowe polecenia EXECUTE

Dozownik

Więcej informacji o parametrach polecenia: zobacz action.devices.traits.Dispense odwołania.

Prośba
.
{
  "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"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
.
Odpowiedź
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "dispenseItems": [
            {
              "itemName": "water_key",
              "amountLastDispensed": {
                "amount": 1,
                "unit": "CUPS"
              },
              "isCurrentlyDispensing": true
            }
          ]
        }
      }
    ]
  }
}

SetTemperature

Więcej informacji o parametrach polecenia: zobacz action.devices.traits.TemperatureControl odwołania.

Prośba
.
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetTemperature",
                "params": {
                  "temperature": 65
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
.
Odpowiedź
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "temperatureSetpointCelsius": 65
        }
      }
    ]
  }
}

OnOff

Więcej informacji o parametrach polecenia: zobacz action.devices.traits.OnOff odwołania.

Prośba
.
{
  "requestId": "6894439706274654520",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OnOff",
                "params": {
                  "on": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
.
Odpowiedź
{
  "requestId": "6894439706274654520",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "on": true
        }
      }
    ]
  }
}

Urządzenie ERRORS

Zobacz pełną listę błędów i wyjątków.