Smart Device Management API

SDM API to interfejs API typu REST, który udostępnia różne metody wyświetlaj cechy i wykonuj polecenia trait do zarządzania Urządzenia Google Nest. Używaj tokena dostępu przyznanego podczas procesu autoryzacji w każdym wywołaniu interfejsu API.

Cechy

SDM API używa modelu opartego na cechach do podawania informacji o urządzeniu i funkcjonalności. Informacje o cechach znajdziesz w przewodnikach dotyczących poszczególnych urządzeń. na urządzenie:

Metody

Pełne informacje o wszystkich metodach dostępnych w interfejsie SDM API znajdziesz w dokumentacji API.

executeCommand

Wykonuje polecenie na autoryzowanym urządzeniu.

Aby wykonać polecenie, użyj wywołania POST. Na przykład, żeby zmienić ustawienia termostatu tryb:

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

Więcej przykładów poleceń znajdziesz na stronie z informacjami o każdej właściwości. Zobacz pełną listę cech. .

get

Pobiera informacje o autoryzowanym budynku lub urządzeniu.

Wywołanie GET zwraca pojedynczą odpowiedź z bieżącymi polami i wartościami wszystkich cech dostępnych dla budynku lub urządzenia, które zostało autoryzowane przez user , oraz obiekt „parentRelations”, który reprezentuje nadrzędny zasób bieżącego zasobu, czyli budynek lub pokój.

Na przykład Nest Thermostat może zwrócić :

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

lista

Wyświetla listę autoryzowanych budynków, pomieszczeń lub urządzeń.

Aby wyświetlić listę wszystkich obiektów, pomieszczeń lub urządzeń autoryzowanych w ramach pojedynczego dostępu wykonaj wywołanie GET względem odpowiedniego punktu końcowego zasobu:

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

Integracje z Asystentem Google

Gdy urządzenie zostanie autoryzowane do SDM, Google zauważy, że urządzenie znajduje się w domu Wykres i bezpośrednio zarządza jego stanem. Jeśli masz integrację z Asystentem Google w ramach oferty komercyjnej:

Błędy

Pełną listę kodów błędów interfejsu API znajdziesz w przewodniku po kodach błędów interfejsu API.