Przewodnik dotyczący inteligentnego dzwonka

action.devices.types.DOORBELL – dzwonek pozwala poinformować innych, że ktoś jest przy drzwiach. To urządzenie może wysyłać powiadomienia i strumieniować wideo, jeśli ma odpowiednią funkcję.

Ten typ oznacza, że urządzenie otrzyma ikonę dzwonka oraz pewne powiązane synonimy i aliasy.

Funkcje urządzenia

W dokumentacji odpowiedniej cechy znajdziesz szczegółowe informacje na temat implementacji, takie jak atrybuty i stany, które powinna obsługiwać usługa, oraz informacje o tworzeniu odpowiedzi EXECUTE i QUERY.

Te cechy są zalecane, jeśli korzystasz z urządzenia. Możesz jednak zestawiać ze sobą wszystkie dostępne cechy, aby jak najlepiej dopasować je do dotychczasowych funkcji produktu.

Wymagania dotyczące jakości

  • Czas oczekiwania: nie może przekraczać 2000 ms.
  • Niezawodność: musi wynosić co najmniej 97%.

Przykładowe urządzenie: prosty dzwonek

Ta sekcja zawiera przykładowe ładunki intencji reprezentujące wspólny „dzwonek do drzwi” na podstawie powyższego typu urządzenia i cech. Jeśli dodasz lub usuniesz cechy w swojej implementacji, zmodyfikuj odpowiedzi, by uwzględnić 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.DOORBELL",
        "traits": [
          "action.devices.traits.CameraStream",
          "action.devices.traits.ObjectDetection"
        ],
        "name": {
          "name": "Simple doorbell"
        },
        "willReportState": true,
        "notificationSupportedByAgent": true,
        "attributes": {
          "cameraStreamSupportedProtocols": [
            "hls"
          ],
          "cameraStreamNeedAuthToken": true
        },
        "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
      }
    }
  }
}

Przykładowe polecenia EXECUTE

GetCameraStream

Więcej informacji o parametrach poleceń znajdziesz w dokumentacji action.devices.traits.CameraStream.

Prośba
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.GetCameraStream",
                "params": {
                  "StreamToChromecast": true,
                  "SupportedStreamProtocols": [
                    "hls"
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Odpowiedź
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "cameraStreamAccessUrl": "https://example.com/stream.mp4",
          "cameraStreamProtocol": "hls"
        }
      }
    ]
  }
}

Przykładowy raport POWIADOMIENIA

ObjectDetection

Więcej informacji o właściwościach powiadomień znajdziesz w dokumentacji action.devices.traits.ObjectDetection.

Prośba
{
  "requestId": "6894439706274654518",
  "payload": {
    "devices": {
      "notifications": {
        "123": {
          "ObjectDetection": {
            "objects": {
              "named": [
                "Alice"
              ]
            },
            "priority": 0,
            "detectionTimestamp": 946684800000
          }
        }
      }
    }
  }
}
Odpowiedź
{
  "requestId": "6894439706274654518"
}

Urządzenie ERRORS

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