Tratti

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

Tutte le chiamate all'API SDM devono utilizzare il seguente endpoint:
https://smartdevicemanagement.googleapis.com/v1

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à corrente o l'umidità ambientale di Google Nest Thermostat.

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 reale 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 le caratteristiche restituite per il dispositivo.

parentRelations

L'oggetto parentRelations rappresenta la risorsa principale della risorsa corrente, che può essere una struttura o una stanza. Il nome visualizzato corrisponde al campo customName di Info trait per i dispositivi con una struttura principale o al RoomInfo trait per i dispositivi con una camera principale.

Comandi

I comandi sono richieste associate a un tratto. Ad esempio, la modifica della modalità o del setpoint di temperatura corrente su Google Nest Thermostat.

Un comando viene inviato tramite 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 è un semplice esito positivo o negativo. Consulta le guide dei singoli tratti per trovare esempi specifici di utilizzo dei comandi.

Eventi

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

Per impostazione predefinita, gli eventi vengono inviati per qualsiasi modifica del valore di un campo tratto. Possono anche essere inviati in risposta a azioni specifiche del dispositivo o a modifiche nelle assegnazioni delle risorse. Per saperne di più, consulta Eventi.

Categorie di tratti

Struttura

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

Dispositivo

Tratti
Connettività	sdm.devices.traits.Connectivity Questo tratto appartiene a qualsiasi dispositivo con informazioni sulla connettività.
Fan	sdm.devices.traits.Fan Questa caratteristica appartiene a qualsiasi dispositivo che ha la capacità del sistema 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 attributo appartiene a qualsiasi dispositivo per informazioni correlate al dispositivo.
Impostazioni	sdm.devices.traits.Settings Questo attributo appartiene a qualsiasi dispositivo per 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 Questo attributo appartiene ai tipi di dispositivi THERMOSTAT che supportano le modalità ECO.
ThermostatHvac	sdm.devices.traits.ThermostatHvac Questo attributo appartiene ai tipi di dispositivi THERMOSTAT che possono segnalare i dettagli dell'impianto di climatizzazione.
ThermostatMode	sdm.devices.traits.ThermostatMode Questo attributo appartiene ai tipi di dispositivi THERMOSTAT che supportano diverse modalità di termostato.
ThermostatTemperatureSetpoint	sdm.devices.traits.ThermostatTemperatureSetpoint Questo attributo appartiene ai tipi di dispositivi THERMOSTAT che supportano l'impostazione della temperatura ottimale e dell'intervallo di temperatura.

Fotocamera

Tratti
CameraClipPreview	sdm.devices.traits.CameraClipPreview Questo attributo appartiene a qualsiasi dispositivo che supporta il download dell'anteprima di un clip.
CameraEventImage	sdm.devices.traits.CameraEventImage Questo tratto appartiene a qualsiasi dispositivo che supporta la generazione di immagini da eventi.
CameraImage	sdm.devices.traits.CameraImage Questo tratto appartiene a qualsiasi dispositivo che supporta l'acquisizione di immagini.
CameraLiveStream	sdm.devices.traits.CameraLiveStream Questo attributo appartiene a qualsiasi dispositivo che supporta il live streaming.
CameraMotion	sdm.devices.traits.CameraMotion Questa caratteristica appartiene a qualsiasi dispositivo che supporta gli eventi di rilevamento dei movimenti.
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 attributo appartiene a qualsiasi dispositivo che supporta un cicalino per campanello ed eventi di pressione correlati.