API Smart Device Management

L'API SDM è un'API REST che fornisce vari metodi per visualizzare i trait ed eseguire comandi trait per la gestione Dispositivi Google Nest. Utilizza il token di accesso concesso durante processo di autorizzazione a ogni chiamata API.

Tratti

L'API SDM utilizza un modello basato sui trait per le informazioni del dispositivo e funzionalità. Consulta le guide dei singoli dispositivi per scoprire quali sono le caratteristiche disponibili per un dispositivo:

Metodi

Consulta Riferimento API per i dettagli completi su tutti i metodi disponibili per l'API SDM.

Esecuzione

Esegue un comando su un dispositivo autorizzato.

Utilizza una chiamata POST per eseguire un comando. Ad esempio, per cambiare il termostato modalità:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.ThermostatMode.SetMode",
  "params" : {
    "mode" : "HEAT"
  }
}

Ulteriori esempi di comandi sono disponibili in ogni riferimento trait . Visualizza l'elenco dei tratti completo per ulteriori informazioni.

get

Recupera informazioni su una struttura o un dispositivo autorizzati.

Una chiamata GET restituisce una singola risposta con i campi e i valori correnti per tutti trait disponibili per una struttura o un dispositivo che user autorizzati e un "parentRelations" che rappresenta la risorsa padre della risorsa attuale, ovvero una struttura o una stanza.

Ad esempio, Nest Thermostat potrebbe restituire i seguenti:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.THERMOSTAT",
  "assignee" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "traits" : {
    "sdm.devices.traits.Connectivity" : {
      "status" : "ONLINE"
    },
    "sdm.devices.traits.Fan" : {
      "timerMode" : "ON",
      "timerTimeout" : "2019-05-10T03:22:54Z"
    },
    "sdm.devices.traits.Humidity" : {
      "ambientHumidityPercent" : 35.0
    },
    "sdm.devices.traits.Info" : {
      "customName" : "My device"
    },
    "sdm.devices.traits.Settings" : {
      "temperatureScale" : "CELSIUS"
    },
    "sdm.devices.traits.Temperature" : {
      "ambientTemperatureCelsius" : 23.0
    },
    "sdm.devices.traits.ThermostatEco" : {
      "availableModes" : ["MANUAL_ECO", "OFF"],
      "mode" : "MANUAL_ECO",
      "heatCelsius" : 20.0,
      "coolCelsius" : 22.0
    },
    "sdm.devices.traits.ThermostatHvac" : {
      "status" : "HEATING"
    },
    "sdm.devices.traits.ThermostatMode" : {
      "availableModes" : ["HEAT", "COOL", "HEATCOOL", "OFF"],
      "mode" : "COOL"
    },
    "sdm.devices.traits.ThermostatTemperatureSetpoint" : {
      "heatCelsius" : 20.0,
      "coolCelsius" : 22.0
    }
  },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

list

Elenca le strutture, le stanze o i dispositivi autorizzati.

Per elencare tutte le strutture, le stanze o i dispositivi autorizzati con un singolo accesso. token, effettua una chiamata GET sull'endpoint della risorsa appropriato:

GET /enterprises/project-id/structures
 
GET /enterprises/project-id/structures/structure-id/rooms
 
GET /enterprises/project-id/devices

Integrazioni dell'Assistente Google

Quando un dispositivo viene autorizzato per SDM, Google viene a conoscenza del dispositivo in Home Tracciare un grafico e gestire direttamente il relativo stato. Se hai l'integrazione con l'Assistente Google nell'ambito della tua offerta commerciale:

Errori

Consulta la documentazione sul codice di errore API per l'elenco completo dei codici di errore dell'API.