Traits de caractère

Un trait de l'API SDM comprend des champs, des commandes et des événements.

Champs

Les champs sont des valeurs associées à des types de données courants, tels qu'un nombre ou une chaîne. Par exemple, un champ peut contenir le mode actuel ou l'humidité ambiante d'un Google Nest Thermostat.

Les traits et les champs peuvent être affichés avec un appel GET au point de terminaison d'API souhaité:

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"
    }
  ]
}

Types d'appareil

L'élément sdm.devices.types.device-type renvoyé par l'API SDM ne doit pas être utilisé pour déduire ou déduire les fonctionnalités de l'appareil auquel il est attribué. Rien ne garantit qu'un type d'appareil restera stable pour un appareil spécifique, car de nouvelles fonctionnalités sont ajoutées à l'API SDM. Utilisez plutôt les caractéristiques renvoyées pour l'appareil.

parentRelations

L'objet parentRelations représente la ressource parente de la ressource actuelle, qu'il s'agisse d'une structure ou d'une salle. Le nom à afficher correspond au champ customName deInfo pour les appareils ayant un parent de structure ou letrait RoomInfo {/19/}.

Commandes

Les commandes sont des requêtes associées à un trait. (par exemple, pour modifier le mode actuel ou la température mémorisée sur un Google Nest Thermostat).

Une commande est envoyée par un appel d'API executeCommand:

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

La plupart des réponses à une commande indiquent simplement une réussite ou un échec. Consultez les guides de traits individuels pour obtenir des exemples d'utilisation de commandes spécifiques.

Événements

Les événements sont asynchrones et gérés par Google Cloud Pub/Sub dans un seul sujet par Project ID.

Des événements sont envoyés par défaut pour toute modification de la valeur d'un champ de trait. Ils peuvent également être envoyés en réponse à des actions spécifiques sur l'appareil ou à des modifications dans les attributions de ressources. Pour en savoir plus, consultez la section Événements.

Catégories de caractéristiques

Structurer

Caractéristiques
Infos
sdm.structures.traits.Info
Cette caractéristique appartient à n'importe quelle structure d'informations liées à la structure.
RoomInfo
sdm.structures.traits.RoomInfo
Ce trait appartient à toute pièce contenant des informations sur une chambre.

Appareil

Caractéristiques
Connectivité
sdm.devices.traits.Connectivity
Cette caractéristique appartient à tout appareil disposant d'informations de connectivité.
Ventilateur
sdm.devices.traits.Fan
Cette caractéristique appartient à tout appareil capable de contrôler le ventilateur.
Humidité
sdm.devices.traits.Humidity
Cette caractéristique appartient à tout appareil doté d'un capteur pour mesurer l'humidité.
Infos
sdm.devices.traits.Info
Cette caractéristique appartient à n'importe quel appareil pour les informations liées à l'appareil.
Paramètres
sdm.devices.traits.Settings
Cette caractéristique appartient à n'importe quel appareil pour les informations sur les paramètres liés à l'appareil.
Température
sdm.devices.traits.Temperature
Cette caractéristique appartient à tout appareil doté d'un capteur pour mesurer la température.

Thermostat

Caractéristiques
ThermostatEco
sdm.devices.traits.ThermostatEco
Cette caractéristique appartient aux types d'appareils de THERMOSTAT compatibles avec les modes ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Cette caractéristique appartient aux types d'appareils de THERMOSTAT qui peuvent fournir des informations sur le système CVC.
ThermostatMode
sdm.devices.traits.ThermostatMode
Cette caractéristique appartient aux types d'appareils de THERMOSTAT compatibles avec différents modes de thermostat.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Cette caractéristique appartient aux types d'appareils de THERMOSTAT qui permettent de définir une température cible et une plage de températures.

Appareil photo

Caractéristiques
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Cette caractéristique appartient à n'importe quel appareil compatible avec le téléchargement d'un aperçu d'extrait.
CameraEventImage
sdm.devices.traits.CameraEventImage
Cette caractéristique appartient à n'importe quel appareil compatible avec la génération d'images à partir d'événements.
CameraImage
sdm.devices.traits.CameraImage
Cette caractéristique appartient à n'importe quel appareil compatible avec la prise d'images.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Cette caractéristique appartient à n'importe quel appareil compatible avec le streaming en direct.
CameraMotion
sdm.devices.traits.CameraMotion
Cette caractéristique appartient à n'importe quel appareil prenant en charge les événements de détection de mouvement.
CameraPerson
sdm.devices.traits.CameraPerson
Cette caractéristique appartient à n'importe quel appareil compatible avec les événements de détection de personnes.
CameraSound
sdm.devices.traits.CameraSound
Cette caractéristique appartient à n'importe quel appareil compatible avec les événements de détection des sons.

Sonnette

Caractéristiques
DoorbellChime
sdm.devices.traits.DoorbellChime
Cette caractéristique appartient à tout appareil compatible avec le carillon et les événements d'appui associés.