Rasgos

Un rasgo en la API de SDM incluye los campos, los comandos y los eventos.

Campos

Los campos son valores con tipos de datos comunes, como un número o una string. Por ejemplo, un campo puede contener el modo actual o la humedad ambiente de un Google Nest Thermostat.

Los atributos y campos se pueden ver con una llamada GET al extremo de la API deseado:

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 dispositivos

No se debe usar el objeto sdm.devices.types.device-type que muestra la API de SDM para deducir o inferir la funcionalidad del dispositivo real al que está asignado. No se garantiza que un tipo de dispositivo se mantenga estable para un dispositivo específico a medida que se agreguen más funciones a la API de SDM. En su lugar, usa las características mostradas para el dispositivo.

relaciones superiores

El objeto parentRelations representa el recurso superior del recurso actual, ya sea una estructura o una sala. El nombre visible corresponde al campo customName decaracterística de información para dispositivos con una estructura principal o laRoomInfo trait {/19/21/}}.

Comandos

Los comandos son solicitudes asociadas a una característica. Por ejemplo, cambiar el modo actual o el punto de ajuste de la temperatura en un Google Nest Thermostat.

Una llamada a la API de executeCommand envía un comando:

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

La mayoría de las respuestas a un comando son simples o no exitosos. Consulta las guías de características individuales para obtener ejemplos de uso de comandos específicos.

Events

Los eventos son asíncronos y los administra Google Cloud Pub/Sub en un solo tema por ID de Project .

Los eventos se envían de forma predeterminada para cualquier cambio en el valor de un campo de característica. También se pueden enviar en respuesta a acciones específicas del dispositivo o cambios en las asignaciones de recursos. Consulta Eventos para obtener más información.

Categorías de rasgos

Estructura

Rasgo
Información
sdm.structures.traits.Info
Esta característica pertenece a cualquier estructura para la información relacionada con la estructura.
RoomInfo
sdm.structures.traits.RoomInfo
Esta característica pertenece a cualquier habitación para obtener información relacionada.

Dispositivo

Rasgo
Conectividad
sdm.devices.traits.Connectivity
Esta característica pertenece a cualquier dispositivo que tenga información de conectividad.
Ventilador
sdm.devices.traits.Fan
Esta característica pertenece a cualquier dispositivo que tenga la capacidad del sistema para controlar el ventilador.
Humedad
sdm.devices.traits.Humidity
Esta característica pertenece a cualquier dispositivo que tenga un sensor para medir la humedad.
Información
sdm.devices.traits.Info
Esta característica pertenece a cualquier dispositivo para obtener información relacionada con el dispositivo.
Configuración
sdm.devices.traits.Settings
Esta característica pertenece a cualquier dispositivo para la información de configuración relacionada con el dispositivo.
Temperatura
sdm.devices.traits.Temperature
Esta característica pertenece a cualquier dispositivo que tenga un sensor para medir la temperatura.

Termostato

Rasgo
Termostato Thermostat
sdm.devices.traits.ThermostatEco
Esta característica pertenece a los tipos de TERMOSTATO del dispositivo que admiten los modos ECO.
TermostatoThermostat
sdm.devices.traits.ThermostatHvac
Esta característica pertenece a tipos de dispositivos TERMOSTATOS que pueden informar detalles de HVAC.
Modo termostato
sdm.devices.traits.ThermostatMode
Esta característica pertenece a tipos de dispositivos TERMOSTATOS que admiten diferentes modos del termostato.
Punto de temperatura del termostato
sdm.devices.traits.ThermostatTemperatureSetpoint
Esta característica pertenece a los tipos de dispositivo TERMOSTATO que admiten la configuración de la temperatura final y el rango de temperatura.

Cámara

Rasgo
Vista previa de la cámara
sdm.devices.traits.CameraClipPreview
Esta característica pertenece a cualquier dispositivo que admita la descarga de una vista previa de clip.
CámaraEventoImagen
sdm.devices.traits.CameraEventImage
Esta característica pertenece a cualquier dispositivo que admita la generación de imágenes a partir de eventos.
Imagen de la cámara
sdm.devices.traits.CameraImage
Esta característica pertenece a cualquier dispositivo que admita la captura de imágenes.
CámaraEn vivo
sdm.devices.traits.CameraLiveStream
Esta característica pertenece a cualquier dispositivo que admita transmisiones en vivo.
CámaraMovimiento
sdm.devices.traits.CameraMotion
Esta característica pertenece a cualquier dispositivo que admita eventos de detección de movimiento.
CameraPerson
sdm.devices.traits.CameraPerson
Esta característica pertenece a cualquier dispositivo que admita eventos de detección de personas.
CámaraSonido
sdm.devices.traits.CameraSound
Esta característica pertenece a cualquier dispositivo que admita eventos de detección de sonido.

Timbre

Rasgo
Timbre con timbre
sdm.devices.traits.DoorbellChime
Esta característica pertenece a cualquier dispositivo que admita una campanilla de timbre y eventos de prensa relacionados.