Tratti

Una trait nell'API SDM comprende campi, comandi ed eventi.

Campi

I campi sono valori con tipi di dati comuni, come un numero o una stringa. Ad esempio, un campo potrebbe contenere la modalità attuale o l'umidità ambientale di un termostato Google Nest.

I tratti e i campi possono essere visualizzati con una chiamata GET all'endpoint API desiderato:

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

Tipi di dispositivo

Il valore sdm.devices.types.device-type restituito dall'API SDM non deve essere utilizzato per dedurre o dedurre la funzionalità del dispositivo effettivo a cui è assegnato. Non vi è alcuna garanzia che un tipo di dispositivo rimanga stabile per un dispositivo specifico man mano che vengono aggiunte altre funzionalità all'API SDM. Utilizza invece i trait restituiti per il dispositivo.

parentRelations

L'oggetto parentRelations rappresenta la risorsa padre della risorsa attuale, una struttura o una stanza. Il nome visualizzato corrisponde al campo customName di Informazioni per i dispositivi con struttura principale o al trait RoomInfo{18/parent}{21/i dispositivi con una stanza virtuale

Comandi

I comandi sono richieste associate a un trait. Ad esempio, modificare la modalità corrente o il set-point di temperatura su Google Nest Thermostat.

Un comando viene inviato da una chiamata API executeCommand:

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

La maggior parte delle risposte a un comando è semplice. Consulta le singole guide ai tratti per esempi specifici di utilizzo dei comandi.

Eventi

Gli eventi sono asincroni e vengono gestiti da Google Cloud Pub/Sub in un unico argomento per ID Project .

Gli eventi vengono inviati per impostazione predefinita quando viene modificato il valore di un campo trait. Possono anche essere inviate in risposta ad azioni specifiche del dispositivo o modifiche nelle assegnazioni di risorse. Per ulteriori informazioni, consulta Eventi.

Categorie di tratti

Struttura

Tratti
Informazioni
sdm.structures.traits.Info
Questo tratto appartiene a qualsiasi struttura per le informazioni relative alla struttura.
RoomInfo
sdm.structures.traits.RoomInfo
Questo trait appartiene a qualsiasi spazio per le informazioni relative alle camere.

Dispositivo

Tratti
Connettività
sdm.devices.traits.Connectivity
Questo trait appartiene a qualsiasi dispositivo con informazioni sulla connettività.
Fan
sdm.devices.traits.Fan
Questo tratto appartiene a qualsiasi dispositivo che ha la capacità di sistema di controllare la ventola.
Umidità
sdm.devices.traits.Humidity
Questo tratto appartiene a qualsiasi dispositivo dotato di un sensore per misurare l'umidità.
Informazioni
sdm.devices.traits.Info
Questo trait appartiene a qualsiasi dispositivo per le informazioni relative al dispositivo.
Impostazioni
sdm.devices.traits.Settings
Questo trait appartiene a qualsiasi dispositivo per le informazioni sulle impostazioni relative al dispositivo.
Temperatura
sdm.devices.traits.Temperature
Questo tratto appartiene a qualsiasi dispositivo che dispone di un sensore per misurare la temperatura.

Termostato

Tratti
ThermostatEco
sdm.devices.traits.ThermostatEco
Questo tratto appartiene ai tipi di dispositivi TERMOSTATO che supportano le modalità ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Questo trait appartiene ai tipi di dispositivi del TERMOSTATO che possono segnalare i dettagli dell'impianto.
ThermostatMode
sdm.devices.traits.ThermostatMode
Questo tratto appartiene ai tipi di dispositivi del TERMOSTATO che supportano diverse modalità del termostato.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Questo tratto appartiene ai tipi di dispositivi TERMOSTATO che supportano l'impostazione della temperatura ottimale e dell'intervallo di temperatura.

Fotocamera

Tratti
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Questo trait appartiene a qualsiasi dispositivo che supporta il download dell'anteprima di un clip.
CameraEventImage
sdm.devices.traits.CameraEventImage
Questo trait appartiene a qualsiasi dispositivo che supporta la generazione di immagini dagli eventi.
CameraImage
sdm.devices.traits.CameraImage
Questo tratto appartiene a qualsiasi dispositivo che supporta l'acquisizione di immagini.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Questo trait appartiene a qualsiasi dispositivo che supporta il live streaming.
CameraMotion
sdm.devices.traits.CameraMotion
Questo trait appartiene a qualsiasi dispositivo che supporta gli eventi di rilevamento dei movimenti.
CameraPerson
sdm.devices.traits.CameraPerson
Questo trait appartiene a qualsiasi dispositivo che supporta gli eventi di rilevamento persone.
CameraSound
sdm.devices.traits.CameraSound
Questo trait appartiene a qualsiasi dispositivo che supporta gli eventi di rilevamento dei suoni.

Campanello

Tratti
DoorbellChime
sdm.devices.traits.DoorbellChime
Questo trait appartiene a qualsiasi dispositivo che supporta il cicalino di un campanello e gli eventi di pressione correlati.