Guida al campanello per smart home

action.devices.types.DOORBELL: i campanelli possono far sapere alle persone che c'è qualcuno alla porta. Questo dispositivo può inviare notifiche e riprodurre video in streaming se dispone delle funzionalità corrispondenti.

Questo tipo indica che sul dispositivo viene visualizzata l'icona del campanello e alcuni contenuti correlati sinonimi e alias.

Funzionalità del dispositivo

Consulta la documentazione sui trait corrispondente per dettagli di implementazione, come gli attributi e gli stati che il servizio dovrebbe supportare e come creare risposte EXECUTE e QUERY.

Questi trait sono consigliati, se applicabili al tuo dispositivo. Tuttavia, puoi combinare tutte le caratteristiche disponibili per associarle al meglio a quelle esistenti. funzionalità del prodotto.

Requisiti di qualità

  • Latenza: deve essere inferiore o uguale a 2000 ms.
  • Affidabilità: deve essere superiore o uguale al 97%.

Esempio di dispositivo: campanello semplice

Questa sezione contiene payload di esempio per intent che rappresentano un "campanello" comune in base al tipo di dispositivo e alle caratteristiche di cui sopra. Se aggiungi o rimuovi i trait nell'implementazione, modificare le tue risposte di conseguenza per riflettere tali cambiamenti.

Esempio di risposta SYNC

Richiedi
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Risposta
{
  "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"
        }
      }
    ]
  }
}

Esempio di risposta QUERY

Richiedi
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Risposta
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true
      }
    }
  }
}

Esempi di comandi EXECUTE

GetCameraStream

Per ulteriori dettagli sui parametri del comando, consulta action.devices.traits.CameraStream riferimento.

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

Esempio di report NOTIFICATIONS

ObjectDetection

Per ulteriori dettagli sulle proprietà delle notifiche, consulta action.devices.traits.ObjectDetection riferimento.

Richiedi
{
  "requestId": "6894439706274654518",
  "payload": {
    "devices": {
      "notifications": {
        "123": {
          "ObjectDetection": {
            "objects": {
              "named": [
                "Alice"
              ]
            },
            "priority": 0,
            "detectionTimestamp": 946684800000
          }
        }
      }
    }
  }
}
Risposta
{
  "requestId": "6894439706274654518"
}

ERRORI dispositivo

Consulta l'elenco completo errori ed eccezioni.