Merkmale

Eine Eigenschaft in der SDM API besteht aus Feldern, Befehlen und Ereignissen.

Felder

Felder sind Werte mit gängigen Datentypen, z. B. Zahlen oder Strings. Ein Feld kann beispielsweise den aktuellen Modus oder die Luftfeuchtigkeit eines Google Nest Thermostats enthalten.

Attribute und Felder können mit einem GET-Aufruf an den gewünschten API-Endpunkt aufgerufen werden:

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

Gerätetypen

Die von der SDM API zurückgegebene sdm.devices.types.device-type sollte nicht verwendet werden, um die Funktionen des tatsächlichen Geräts abzuleiten oder abzuleiten, dem sie zugewiesen ist. Es gibt keine Garantie, dass ein Gerätetyp für ein bestimmtes Gerät stabil bleibt, wenn der SDM API weitere Features hinzugefügt werden. Verwenden Sie stattdessen die zurückgegebenen Eigenschaften für das Gerät.

übergeordnete Beziehungen

Das Objekt parentRelations stellt die übergeordnete Ressource der aktuellen Ressource dar, entweder eine Struktur oder einen Raum. Der Anzeigename entspricht dem Feld customName derInfo Merkmal für Geräte mit einem Übergeordneten Element oder der EigenschaftRoomInfo {20/room].

Befehle

Befehle sind Anfragen, die mit einem Merkmal verknüpft sind. Beispielsweise können Sie den aktuellen Modus oder Temperatursollwert eines Google Nest Thermostats ändern.

Ein Befehl wird von einem executeCommand-API-Aufruf gesendet:

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

Die meisten Antworten auf einen Befehl sind ein einfacher Erfolg. Beispiele für die Verwendung von Befehlen finden Sie in den jeweiligen Trait-Guides.

Veranstaltungen

Ereignisse sind asynchron und werden von Google Cloud Pub/Sub in einem einzigen Thema pro Project -ID verwaltet.

Ereignisse werden standardmäßig gesendet, wenn sich der Wert eines Eigenschaftsfelds ändert. Sie können auch als Reaktion auf bestimmte Geräteaktionen oder Änderungen bei Ressourcenzuweisungen gesendet werden. Weitere Informationen finden Sie unter Ereignisse.

Straßenkategorien

Struktur

Eigenschaften
Informationen
sdm.structures.traits.Info
Diese Eigenschaft gehört zu jeder Struktur für strukturbezogene Informationen.
Rauminfo
sdm.structures.traits.RoomInfo
Diese Eigenschaft gehört zu jedem Raum mit raumbezogenen Informationen.

Gerät

Eigenschaften
Konnektivität
sdm.devices.traits.Connectivity
Diese Eigenschaft gehört zu jedem Gerät, das Verbindungsinformationen hat.
Lüfter
sdm.devices.traits.Fan
Diese Eigenschaft gehört zu jedem Gerät, das die Möglichkeit hat, den Lüfter zu steuern.
Luftfeuchte
sdm.devices.traits.Humidity
Diese Eigenschaft gehört zu jedem Gerät, das über einen Sensor zur Messung der Luftfeuchtigkeit verfügt.
Informationen
sdm.devices.traits.Info
Diese Eigenschaft gehört zu jedem Gerät für gerätebezogene Informationen.
Einstellungen
sdm.devices.traits.Settings
Die Eigenschaft gehört zu einem beliebigen Gerät, um gerätebezogene Einstellungen zu erhalten.
Temperatur
sdm.devices.traits.Temperature
Diese Eigenschaft gehört zu jedem Gerät, das einen Sensor zur Messung der Temperatur hat.

Thermostat

Eigenschaften
ThermostatEco
sdm.devices.traits.ThermostatEco
Diese Eigenschaft gehört zu Gerätetypen THERMOSTAT, die ECO-Modi unterstützen.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Diese Eigenschaft gehört zu Gerätetypen THERMOSTAT, die HLK-Details melden können.
Thermostatmodus
sdm.devices.traits.ThermostatMode
Diese Eigenschaft gehört zu Gerätetypen THERMOSTAT, die verschiedene Thermostatmodi unterstützen.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Diese Eigenschaft gehört zu Gerätetypen THERMOSTAT, die das Festlegen der Zieltemperatur und des Temperaturbereichs unterstützen.

Kamera

Eigenschaften
Kamera-Clip-Vorschau
sdm.devices.traits.CameraClipPreview
Diese Eigenschaft gehört zu jedem Gerät, das den Download einer Clipvorschau unterstützt.
CameraEventImage
sdm.devices.traits.CameraEventImage
Diese Eigenschaft gehört zu jedem Gerät, das das Generieren von Bildern aus Ereignissen unterstützt.
Kamerabild
sdm.devices.traits.CameraImage
Diese Eigenschaft gehört zu jedem Gerät, das Bilder aufnehmen kann.
Kamera-Livestream
sdm.devices.traits.CameraLiveStream
Diese Eigenschaft gehört zu jedem Gerät, das Livestreaming unterstützt.
Kamerabewegung
sdm.devices.traits.CameraMotion
Diese Eigenschaft gehört zu jedem Gerät, das Bewegungserkennungsereignisse unterstützt.
Kameramann
sdm.devices.traits.CameraPerson
Diese Eigenschaft gehört zu jedem Gerät, das Personenerkennungsereignisse unterstützt.
Kamera-Sound
sdm.devices.traits.CameraSound
Diese Eigenschaft gehört zu jedem Gerät, das Geräuscherkennungsereignisse unterstützt.

Türklingel

Eigenschaften
Türklingel & Glocke
sdm.devices.traits.DoorbellChime
Diese Eigenschaft gehört zu jedem Gerät, das eine Glocke und entsprechende Presseereignisse unterstützt.