Traits de caractère

Une caractéristique 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, comme un nombre ou une chaîne. Par exemple, un champ peuvent contenir le mode actuel ou l'humidité ambiante d'un Google Nest Thermostat.

Vous pouvez consulter les traits et les champs en appelant GET au point de terminaison de l'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

Le 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 elle est attribuée. Il n'y a aucune garantie qu'un type d'appareil reste stable pour un appareil spécifique à mesure que des fonctionnalités supplémentaires sont ajoutées au SDM. API. Utilisez plutôt les caractéristiques renvoyées pour l'appareil.

parentRelations

L'objet parentRelations représente la ressource parente de la ressource actuelle. soit une structure, soit une pièce. Le nom à afficher correspond au champ customName de Caractéristique d'information pour les appareils dotés d'un parent de structure Caractéristique RoomInfo pour les appareils dotés d'un parent de la chambre.

Commandes

Les commandes sont des requêtes associées à une caractéristique. Par exemple, changer 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 sont une simple réussite ou un échec. Consultez les guides des caractéristiques individuelles pour 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.

Les événements sont envoyés par défaut pour toute modification de la valeur d'un champ de caractéristique. Ils peuvent également être envoyés dans en réponse à des actions spécifiques de l'appareil ou à des modifications d'attribution de ressources. Voir Événements pour en savoir plus.

Catégories de traits

Structure

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

Appareil

Caractéristiques
Connectivité
sdm.devices.traits.Connectivity
Cette caractéristique appartient à tout appareil disposant d'informations de connectivité.
Fan
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 équipé 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 équipé d'un capteur pour mesurer la température.

Thermostat

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

Appareil photo

Caractéristiques
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Cette caractéristique appartient à tous les appareils qui permettent de télécharger un extrait d'extrait.
CameraEventImage
sdm.devices.traits.CameraEventImage
Cette caractéristique appartient à tout appareil compatible avec la génération d'images à partir d'événements.
CameraImage
sdm.devices.traits.CameraImage
Cette caractéristique appartient à tout appareil compatible avec la prise d'images.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Cette caractéristique appartient à tout appareil compatible avec la diffusion en direct.
CameraMotion
sdm.devices.traits.CameraMotion
Cette caractéristique appartient à tout appareil compatible avec les événements de détection de mouvement.
CameraPerson
sdm.devices.traits.CameraPerson
Cette caractéristique appartient à tout appareil compatible avec les événements de détection de personnes.
CameraSound
sdm.devices.traits.CameraSound
Cette caractéristique appartient à tout appareil compatible avec les événements de détection de sons.

Sonnette

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