Características

Uma característica na API SDM é composta por campos, comandos e eventos.

Todas as chamadas para a API SDM precisam usar este endpoint:
https://smartdevicemanagement.googleapis.com/v1

Campos

Os campos são valores com tipos de dados comuns, como um número ou uma string. Por exemplo, um campo pode conter o modo atual ou a umidade ambiente de um Google Nest Thermostat.

As características e os campos podem ser visualizados com uma chamada GET para o endpoint da API desejado:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.device-type",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

Tipos de dispositivo

O sdm.devices.types.device-type retornado pela API SDM não pode ser usado para deduzir ou inferir a funcionalidade do dispositivo real a que está atribuído. Não há garantia de que um tipo de dispositivo permanecerá estável em um dispositivo específico à medida que mais recursos forem adicionados à API SDM. Em vez disso, use as características retornadas.

ParentRelations

O objeto parentRelations representa o recurso pai do recurso atual, uma estrutura ou uma sala. O nome de exibição corresponde ao campo customName da Info para dispositivos com uma mãe de estrutura ou à característica RoomInfo .

Comandos

Os comandos são solicitações associadas a uma característica. Por exemplo, mudar o modo atual ou a temperatura programada em um Google Nest Thermostat.

Um comando é enviado por uma chamada de API executeCommand:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

A maioria das respostas a um comando é um simples sucesso ou falha. Consulte os guias de traço individuais para ver exemplos específicos de uso de comando.

Eventos

Os eventos são assíncronos e gerenciados pelo Google Cloud Pub/Sub em um único tópico por ID Project .

Os eventos são enviados por padrão para qualquer alteração no valor de um campo de característica. Elas também podem ser enviadas em resposta a ações específicas do dispositivo ou alterações nas atribuições de recursos. Consulte Eventos para mais informações.

Categorias de características

Estrutura

Características
Informações	sdm.structures.traits.Info Essa característica pertence a qualquer estrutura para informações relacionadas à estrutura.
Informações da sala	sdm.structures.traits.RoomInfo Essa característica pertence a qualquer sala para informações relacionadas.

Dispositivo

Características
Conectividade	sdm.devices.traits.Connectivity Essa característica pertence a qualquer dispositivo que tenha informações de conectividade.
Fã	sdm.devices.traits.Fan Essa característica pertence a qualquer dispositivo que tenha o sistema para controlar o ventilador.
Umidade	sdm.devices.traits.Humidity Essa característica pertence a qualquer dispositivo que tenha um sensor para medir a umidade.
Informações	sdm.devices.traits.Info Essa característica pertence a qualquer dispositivo para receber informações relacionadas ao dispositivo.
Configurações	sdm.devices.traits.Settings Essa característica pertence a qualquer dispositivo para informações de configurações relacionadas ao dispositivo.
Temperatura	sdm.devices.traits.Temperature Essa característica pertence a qualquer dispositivo que tenha um sensor para medir a temperatura.

Termostato

Características
ThermostatEco	sdm.devices.traits.ThermostatEco Esta característica pertence a tipos de dispositivo de THERMOSTAT compatíveis com modos ECO.
ThermostatHvac	sdm.devices.traits.ThermostatHvac Essa característica pertence a tipos de dispositivos de THERMOSTAT que podem relatar detalhes do sistema HVAC (Aquecimento, ventilação e ar-condicionado).
ThermostatMode	sdm.devices.traits.ThermostatMode Esta característica pertence a tipos de dispositivos de THERMOSTAT compatíveis com diferentes modos de termostato.
Definição de ThermostatTemperatureSetpoint	sdm.devices.traits.ThermostatTemperatureSetpoint Esta característica pertence a tipos de dispositivos de THERMOSTAT compatíveis com a definição da temperatura-alvo e da faixa de temperatura.

Câmera

Características
Visualização de clipes da câmera	sdm.devices.traits.CameraClipPreview Essa característica pertence a qualquer dispositivo compatível com o download de uma visualização de clipe.
CameraEventImage	sdm.devices.traits.CameraEventImage Essa característica pertence a qualquer dispositivo compatível com a geração de imagens a partir de eventos.
Câmera	sdm.devices.traits.CameraImage Essa característica pertence a qualquer dispositivo compatível com a captura de imagens.
CameraLiveStream	sdm.devices.traits.CameraLiveStream Essa característica pertence a qualquer dispositivo compatível com transmissão ao vivo.
CameraMotion	sdm.devices.traits.CameraMotion Essa característica pertence a qualquer dispositivo compatível com eventos de detecção de movimento.
Câmera	sdm.devices.traits.CameraPerson Essa característica pertence a qualquer dispositivo compatível com eventos de detecção de pessoas.
Som da câmera	sdm.devices.traits.CameraSound Essa característica pertence a qualquer dispositivo compatível com eventos de detecção de som.

Campainha

Características
Campainha	sdm.devices.traits.DoorbellChime Essa característica pertence a qualquer dispositivo compatível com uma campainha e a eventos de imprensa relacionados.