Esquema do DoorbellChime

Nest Doorbell (legada) Nest Doorbell (com bateria) Nest Doorbell (com fio) 

sdm.devices.traits.DoorbellChime

Essa característica pertence a qualquer dispositivo que oferece suporte a uma campainha e eventos de pressionamento 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 pressionada.

Este evento é compatível com notificações atualizáveis. As notificações de apps criadas com base nesse evento podem ser atualizadas usando o conteúdo de um evento subsequente com o mesmo eventThreadId.

Evento de campainha

Payload

{
  "eventId" : "c3f53bfc-dee3-4373-a311-97b5a0decb6f",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "3E5_sCBV59G9WehGbV2614GUk5..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }

Campos de evento da campainha

Campo Descrição Tipo de dados
eventSessionId Nest Doorbell (com bateria) Nest Doorbell (com fio) Um código fornecido a eventos que ocorrem em uma única sessão do 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 código associado ao evento.

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

string
Exemplo: "3E5_sCBV59G9WehGbV2614GUk5..."

Campos de payload de evento

Campo Descrição Tipo de dados
eventId O identificador exclusivo do evento. string
Exemplo: "c3f53bfc-dee3-4373-a311-97b5a0decb6f"
timestamp A hora em que o evento ocorreu. string
Exemplo: "2019-01-01T00:00:01Z"
resourceUpdate Um objeto que detalha informações sobre a atualização de recursos. 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 próprio 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 do evento expiram 30 segundos após a publicação do evento. Faça o download da imagem antes que ela expire.
O ID do evento não pertence à câmera. FAILED_PRECONDITION Use a eventID correta retornada pelo evento da câmera.

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