Esquema DoorbellChime

Nest Doorbell (legado) Nest Doorbell (com bateria) Nest Doorbell (com fio) 

sdm.devices.traits.DoorbellChime

Essa característica pertence a qualquer dispositivo com suporte a um toque de campainha e eventos de pressão relacionados.

Campos

Não há campos disponíveis para essa característica.

Comandos

Não há comandos disponíveis para essa característica.

Eventos

Campainha

Atualizável 

A campainha foi tocada.

Esse evento aceita notificações atualizáveis. As notificações do app criadas a partir desse evento podem ser atualizadas usando o conteúdo de um evento subsequente com o mesmo eventThreadId.

Evento da campainha

Payload

{
  "eventId" : "3d1862ad-879e-4556-b3e2-5e82e937a970",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "7mlG0D6z-nHJOgqsfQkAmKk9IB..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Campos de evento do Chime

Campo Descrição Tipo de dados
eventSessionId Nest Doorbell (com bateria) Nest Doorbell (com fio) Um ID atribuído a eventos que ocorrem como parte de uma única sessão de eventos relacionados. Pode ser usado para consolidar eventos.

Use-o para associar esse evento ao evento ClipPreview relacionado da característica CameraClipPreview.

 string
Exemplo: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
eventId Nest Doorbell (legado) Um ID associado ao evento.

Use-o com o comando GenerateImage para fazer o download da imagem da câmera relacionada a esse evento.

 string
Exemplo: "7mlG0D6z-nHJOgqsfQkAmKk9IB..."

Campos de payload do evento

Campo Descrição Tipo de dados
eventId O identificador exclusivo do evento. string
Exemplo: "3d1862ad-879e-4556-b3e2-5e82e937a970"
timestamp O horário em que o evento ocorreu. string
Exemplo: "2019-01-01T00:00:01Z"
resourceUpdate Um objeto que detalha informações sobre a atualização do recurso. object
userId Um identificador exclusivo e ofuscado que representa o usuário. string
Exemplo: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
eventThreadId Atualizável O identificador exclusivo da linha de execução de eventos. string
Exemplo: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
eventThreadState Atualizável O estado da linha de execução de eventos. string
Valores: "STARTED", "UPDATED", "ENDED"
resourceGroup Um objeto que indica recursos que podem ter atualizações semelhantes a esse evento. O recurso do evento (do objeto resourceUpdate) sempre estará presente nesse objeto. object

Consulte Eventos para mais informações sobre os diferentes tipos de eventos e como eles funcionam.

Erros

Os seguintes códigos de erro podem ser retornados em relação a essa característica:

Mensagem de erro RPC Solução de problemas
A imagem da câmera não está mais disponível para download. DEADLINE_EXCEEDED As imagens de eventos expiram 30 segundos após a publicação do evento. Faça o download da imagem antes do prazo de validade.
O ID do evento não pertence à câmera. FAILED_PRECONDITION Use o eventID correto retornado pelo evento da câmera.

Consulte a Referência de códigos de erro da API para conferir a lista completa de códigos de erro da API.