Eventos

Os eventos são assíncronos e gerenciados pelo Google Cloud Pub/Sub, em um único tópico por Project. Os eventos fornecem atualizações para todos os dispositivos e estruturas, e o recebimento dos eventos é garantido, desde que o token de acesso não seja revogado pelo usuário e as mensagens do evento não tenham expirado.

Ativar eventos

Os eventos são um recurso opcional da API SDM. Consulte Ativar eventos para saber como ativá-los no seu Project.

Google Cloud Pub/Sub

Consulte a documentação do Google Cloud Pub/Sub para saber mais sobre como o Pub/Sub funciona. Especificamente, faça o seguinte:

Inscrição no evento

Quando os eventos estiverem ativados para seu Project, você receberá um tema específico para esse ID de Project , na forma de:

projects/sdm-prod/topics/enterprise-project-id

Para receber eventos, crie uma assinatura de pull ou push para esse tópico, dependendo do seu caso de uso. Há suporte para várias assinaturas no tópico do SDM. Consulte Como gerenciar assinaturas para mais informações.

Iniciar eventos

Para iniciar eventos pela primeira vez após a criação da assinatura do Pub/Sub, faça uma chamada de API devices.list como um gatilho único. Os eventos de todas as estruturas e dispositivos serão publicados após a chamada.

Para ver um exemplo, consulte a página Autorizar no Guia de início rápido.

Ordem do evento

O Pub/Sub não garante a entrega ordenada de eventos, e a ordem de recebimento dos eventos pode não corresponder à ordem em que eles realmente ocorreram. Use o campo timestamp para ajudar na reconciliação da ordem do evento. Os eventos também podem chegar individualmente ou combinados em uma única mensagem de evento.

Para mais informações, consulte Como ordenar mensagens.

User-IDs

Se a implementação for baseada nos usuários, e não na estrutura ou no dispositivo, use o campo userID do payload do evento para correlacionar recursos e eventos. Esse campo é um ID ofuscado que representa um usuário específico.

O userID também está disponível no cabeçalho de resposta HTTP de cada chamada de API.

Eventos de relação

Os eventos de relação representam uma atualização relacional de um recurso. Por exemplo, quando um dispositivo é adicionado a uma estrutura ou excluído de uma estrutura.

Há três tipos de eventos de relação:

  • CREATED
  • EXCLUÍDA
  • ATUALIZADO

O payload de um evento de relação é o seguinte:

Payload

{
  "eventId" : "ea8dae81-4324-4352-aa5f-99b537d4b132",
  "timestamp" : "2019-01-01T00:00:01Z",
  "relationUpdate" : {
    "type" : "CREATED",
    "subject" : "enterprises/project-id/structures/structure-id",
    "object" : "enterprises/project-id/devices/device-id"
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
}

Em um evento de relação, object é o recurso que acionou o evento e subject é o recurso com que object agora tem uma relação. No exemplo acima, um user concedeu acesso a esse dispositivo específico para um developer, e o dispositivo autorizado do useragora está relacionado à estrutura autorizada, que aciona o evento.

Um subject só pode ser um cômodo ou uma estrutura. Se a developer não tiver permissão para visualizar a estrutura do user, o subject estará sempre vazio.

Campos

Field Descrição Tipo de dados
eventId O identificador exclusivo do evento. string
Exemplo: "ea8b6058-59d8-4b2f-a049-af51eaa5fb43"
timestamp A hora em que o evento ocorreu. string
Exemplo: "2019-01-01T00:00:01Z"
relationUpdate Um objeto que detalha informações sobre a atualização da relação. object
userId Identificador exclusivo e ofuscado que representa o usuário. string
Exemplo: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"

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

Exemplos

Os payloads de evento são diferentes para cada tipo de evento de relação:

CREATED

Estrutura criada

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

Dispositivo criado

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Dispositivo criado

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

ATUALIZADO

Dispositivo movido

"relationUpdate" : {
  "type" : "UPDATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

EXCLUÍDA

Estrutura excluída

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

Dispositivo excluído

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Dispositivo excluído

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Os eventos de relação não são enviados quando:

  • Uma sala foi excluída

Eventos do recurso

Um evento de recurso representa uma atualização específica de um recurso. Isso pode ser uma resposta a uma mudança no valor de um campo de característica, como a mudança do modo de um termostato. Ela também pode representar uma ação do dispositivo que não muda um campo de características, como pressionar um botão do dispositivo.

Um evento gerado em resposta a uma mudança no valor do campo de característica contém um objeto traits, semelhante a uma chamada GET de dispositivo:

Payload

{
  "eventId" : "2d273363-5525-410a-993f-26443fc18320",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "traits" : {
      "sdm.devices.traits.ThermostatMode" : {
        "mode" : "COOL"
      }
    }
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Consulte a documentação de características individuais para entender o formato do payload de qualquer evento de recurso de alteração de campos de características.

Um evento gerado em resposta a uma ação do dispositivo que não altera um campo de característica também tem um payload com um objeto resourceUpdate, mas com um objeto events em vez de um objeto traits:

Payload

{
  "eventId" : "411559ed-f740-43e3-8920-84b8c42a6a63",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.CameraMotion.Motion" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "xnMHasy9BtPZfsWp5chZopLRfA...", } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }

Esses tipos de eventos de recursos são definidos em características específicas. Por exemplo, o evento de movimento é definido na característica CameraMotion . Consulte a documentação de cada característica para entender o formato de payload para esses tipos de eventos de recursos.

Campos

Field Descrição Tipo de dados
eventId O identificador exclusivo do evento. string
Exemplo: "411559ed-f740-43e3-8920-84b8c42a6a63"
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 Identificador exclusivo e ofuscado que representa o usuário. string
Exemplo: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
eventThreadId O identificador exclusivo da sequência de eventos. string
Exemplo: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
eventThreadState O estado da sequência 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.

Notificações atualizáveis

Notificações baseadas em eventos de recursos podem ser implementadas em um app, como para Android ou iOS. Para reduzir o número de notificações enviadas, um recurso chamado notificações atualizáveis pode ser implementado, em que as notificações existentes são atualizadas com novas informações com base em eventos subsequentes na mesma linha de execução de eventos.

Os eventos selecionados oferecem suporte a recursos de notificações atualizáveis e são marcados como Atualizáveis  na documentação. Esses eventos têm um campo adicional chamado eventThreadId nos payloads. Use esse campo para vincular eventos individuais e atualizar uma notificação que foi exibida para um usuário.

Uma sequência de eventos não é a mesma coisa que uma sessão de evento. A linha de execução de eventos identifica o status atualizado de um evento anterior na mesma linha de execução. A sessão de eventos identifica eventos separados que se relacionam entre si, e pode haver várias sequências de eventos para uma determinada sessão de eventos.

Para fins de notificação, diferentes tipos de eventos são agrupados em diferentes linhas de execução.

Essa lógica de agrupamento de linhas de execução e de tempo é processada pelo Google e está sujeita a mudanças a qualquer momento. Um developer precisa atualizar as notificações com base nas sessões e linhas de execução de eventos fornecidas pela API SDM.

Estado da linha de execução

Os eventos compatíveis com notificações atualizáveis também têm um campo eventThreadState que indica o estado da linha de execução de eventos naquele momento. Esse campo tem os seguintes valores:

  • STARTED: o primeiro evento em uma sequência de eventos.
  • UPDATED: um evento em uma sequência de eventos em andamento. Pode haver zero ou mais eventos com esse estado em uma única linha de execução.
  • ENDED — o último evento em uma sequência de eventos, que pode ser uma cópia do último evento UPDATED, dependendo do tipo de sequência.

Esse campo pode ser usado para acompanhar o progresso de uma linha de execução de evento e quando ela terminou.

Filtragem de eventos

Em alguns casos, os eventos detectados por um dispositivo podem ser filtrados da publicação em um tópico do Pub/Sub do SDM. Esse comportamento é chamado de filtragem de eventos. O objetivo da filtragem de eventos é evitar a publicação de muitas mensagens de eventos semelhantes em um curto período.

Por exemplo, uma mensagem pode ser publicada em um tópico do SDM para um evento de movimento inicial. Outras mensagens para "Movimento" depois disso serão filtradas da publicação até que um determinado período passe. Após esse período, uma mensagem desse tipo poderá ser publicada novamente.

No app Google Home (GHA, na sigla em inglês), os eventos que foram filtrados ainda serão mostrados no histórico de eventos de user. No entanto, esses eventos não geram uma notificação do app, mesmo que esse tipo esteja ativado.

Cada tipo de evento tem a própria lógica de filtragem de eventos, definida pelo Google e sujeita a mudanças a qualquer momento. Essa lógica de filtragem de eventos é independente da linha de execução do evento e da lógica da sessão.

Contas de serviço

As contas de serviço são recomendadas para gerenciar assinaturas da API SDM e mensagens de eventos. Uma conta de serviço é usada por um aplicativo ou máquina virtual, não por uma pessoa, e tem sua própria chave de conta exclusiva.

A autorização da conta de serviço para a API Pub/Sub usa o OAuth de duas etapas (2LO).

No fluxo de autorização 2LO:

  • developer solicita um token de acesso usando uma chave de serviço.
  • O developer usa o token de acesso com chamadas para a API.

Para saber mais sobre o Google 2LO e como configurá-lo, consulte Como usar o OAuth 2.0 para aplicativos de servidor para servidor.

Autorização

A conta de serviço precisa ser autorizada para uso com a API Pub/Sub:

  1. Ative a API Cloud Pub/Sub no Google Cloud.
  2. Crie uma conta de serviço e uma chave de conta de serviço, conforme descrito em Como criar uma conta de serviço. Recomendamos conceder apenas o papel Assinante do Pub/Sub. Faça o download da chave da conta de serviço para a máquina que usará a API Pub/Sub.
  3. Forneça as credenciais de autenticação (chave da conta de serviço) ao código do aplicativo seguindo as instruções na página da etapa anterior ou receba um token de acesso manualmente usando oauth2l, se quiser testar rapidamente o acesso à API.
  4. Use as credenciais da conta de serviço ou o token de acesso com a API Pub/Sub project.subscriptions para extrair e confirmar mensagens.

OAuth 2

O Google oauth2l é uma ferramenta de linha de comando para OAuth escrita em Go. Instale-o para Mac ou Linux usando Go.

  1. Se você não tem o Go no seu sistema, faça o download e instale-o primeiro.
  2. Depois que o Go for instalado, instale oauth2l e adicione o local à variável de ambiente PATH:
    go install github.com/google/oauth2l@latest
    export PATH=$PATH:~/go/bin
  3. Use oauth2l para receber um token de acesso à API, usando os escopos OAuth apropriados:
    oauth2l fetch --credentials path-to-service-key.json --scope https://www.googleapis.com/auth/pubsub
    https://www.googleapis.com/auth/cloud-platform
    Por exemplo, se a chave de serviço estiver localizada em ~/myServiceKey-eb0a5f900ee3.json:
    oauth2l fetch --credentials ~/myServiceKey-eb0a5f900ee3.json --scope https://www.googleapis.com/auth/pubsub
    https://www.googleapis.com/auth/cloud-platform
    ya29.c.Elo4BmHXK5...

Consulte o README do oauth2l (em inglês) para mais informações de uso.

Bibliotecas de cliente de APIs do Google

Há várias bibliotecas de cliente disponíveis para as APIs do Google que utilizam o OAuth 2.0. Consulte Bibliotecas de cliente das APIs do Google para mais informações sobre a linguagem de sua escolha.

Ao usar essas bibliotecas com o Pub/Sub API, use as seguintes strings de escopo:

https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

Erros

Os seguintes códigos de erro podem ser retornados em relação a este guia:

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 ver a lista completa de códigos de erro de API.