Tratti

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

Campi

I campi sono valori con tipi di dati comuni, ad esempio 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 sdm.devices.types.device-type restituito dall'API SDM non deve essere utilizzato per dedurre o inferire la funzionalità del dispositivo effettivo a cui è assegnato. Non è garantito che un tipo di dispositivo rimanga stabile per un dispositivo specifico man mano che vengono aggiunte altre funzionalità all'API SDM. Utilizza invece i tratti restituiti per il dispositivo.

parentRelations

L'oggetto parentRelations rappresenta la risorsa principale della risorsa attuale, ovvero una struttura o una stanza. Il nome visualizzato corrisponde al campo customName di tratto Info per i dispositivi con una struttura principale o al tratto RoomInfo per i dispositivi con una stanza principale.

Comandi

I comandi sono richieste associate a una caratteristica. Ad esempio, la modifica della modalità attuale o del setpoint di temperatura su un termostato Google Nest.

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 indica semplicemente se l'operazione è riuscita o meno. Consulta le guide alle singole caratteristiche 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 per qualsiasi modifica del valore di un campo caratteristica. Possono anche essere inviati in risposta ad azioni specifiche del dispositivo o a modifiche nelle assegnazioni delle risorse. Per saperne di più, consulta la sezione Eventi.

Categorie di tratti

Struttura

Tratti
Informazioni
sdm.structures.traits.Info
Questo tratto appartiene a qualsiasi struttura per le informazioni correlate alla struttura.
RoomInfo
sdm.structures.traits.RoomInfo
Questo tratto appartiene a qualsiasi stanza per informazioni relative alla stanza.

Dispositivo

Tratti
Connettività
sdm.devices.traits.Connectivity
Questa caratteristica appartiene a qualsiasi dispositivo che disponga di informazioni sulla connettività.
Ventola
sdm.devices.traits.Fan
Questa caratteristica appartiene a qualsiasi dispositivo in grado di controllare la ventola.
Umidità
sdm.devices.traits.Humidity
Questa caratteristica appartiene a qualsiasi dispositivo dotato di un sensore per misurare l'umidità.
Informazioni
sdm.devices.traits.Info
Questo tratto appartiene a qualsiasi dispositivo per informazioni correlate al dispositivo.
Impostazioni
sdm.devices.traits.Settings
Questo tratto appartiene a qualsiasi dispositivo per le informazioni sulle impostazioni relative al dispositivo.
Temperatura
sdm.devices.traits.Temperature
Questa caratteristica appartiene a qualsiasi dispositivo dotato di un sensore per misurare la temperatura.

Termostato

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

Fotocamera

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

Campanello

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