Guia da campainha da casa inteligente

action.devices.types.DOORBELL: as campainhas podem avisar as pessoas de que alguém está na porta. Esse dispositivo pode enviar notificações e fazer streaming de vídeo se tiver a capacidade correspondente.

Esse tipo indica que o dispositivo recebe o ícone da campainha e alguns sinônimos e pseudônimos relacionados.

Recursos do dispositivo

Consulte a documentação de atributo correspondente para detalhes de implementação, como atributos e estados que seu serviço precisa oferecer suporte e como criar respostas EXECUTE e QUERY.

Essas características são recomendadas, se aplicável ao seu dispositivo. No entanto, você pode misturar e combinar todas as características disponíveis para corresponder melhor à funcionalidade do produto.

Requisitos de qualidade

  • Latência:precisa ser menor ou igual a 2000ms.
  • Confiabilidade:precisa ser maior ou igual a 97%.

Exemplo de dispositivo: campainha simples

Esta seção contém exemplos de payloads de intent que representam uma "Campainha" comum com base no tipo de dispositivo e nas características acima. Se você adicionar ou remover características na implementação, modifique as respostas para refletir essas mudanças.

Exemplo de resposta de sincronização

Solicitação
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Resposta
{
  "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"
        }
      }
    ]
  }
}

Exemplo de resposta de QUERY

Solicitação
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Resposta
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true
      }
    }
  }
}

Exemplos de comandos EXECUTE

GetCameraStream

Para mais detalhes sobre os parâmetros de comando, consulte a referência action.devices.traits.CameraStream.

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

Exemplo de relatório NOTIFICAÇÕES

ObjectDetection

Para mais detalhes sobre as propriedades de notificação, consulte a referência action.devices.traits.ObjectDetection.

Solicitação
{
  "requestId": "6894439706274654518",
  "payload": {
    "devices": {
      "notifications": {
        "123": {
          "ObjectDetection": {
            "objects": {
              "named": [
                "Alice"
              ]
            },
            "priority": 0,
            "detectionTimestamp": 946684800000
          }
        }
      }
    }
  }
}
Resposta
{
  "requestId": "6894439706274654518"
}

ERROS do dispositivo

Confira a lista completa de erros e exceções.