Smart Device Management API

Interfejs SDM API to interfejs API typu REST, który udostępnia różne metody wyświetlania cech i wykonywania poleceń dotyczących cech na potrzeby zarządzania urządzeniami Google Nest. Używaj tokenu dostępu przyznanego podczas procesu autoryzacji w każdym wywołaniu interfejsu API.

Cechy

Interfejs SDM API używa modelu opartego na cechach do obsługi informacji i funkcji urządzenia. Aby sprawdzić, jakie cechy są dostępne dla danego urządzenia, zapoznaj się z poradnikami dotyczącymi poszczególnych urządzeń:

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. Aby na przykład zmienić tryb termostatu:

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. Więcej informacji znajdziesz w pełnej liście cech.

get

Pobiera informacje o autoryzowanej strukturze 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 termostat Nest 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, pokoi lub urządzeń.

Aby wyświetlić listę wszystkich struktur, pomieszczeń lub urządzeń autoryzowanych za pomocą jednego tokena dostępu, wykonaj wywołanie GET do 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 będzie wiedzieć o jego istnieniu w domu Graph i bezpośrednio nim zarządzać. 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.