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 tokena dostępu przyznanego w procesie autoryzacji z każdym wywołaniem interfejsu API.
Cechy
W przypadku informacji o urządzeniu i funkcjonowania interfejs SDM API wykorzystuje model oparty na cechach. Przeczytaj przewodniki po poszczególnych urządzeniach, aby dowiedzieć się, jakie cechy są dostępne na danym urządzeniu:
- Aparat
- Aparat (na baterie)
- Kamera z Floodlight
- Kamera (przewodowa)
- Wyświetlacz
- Dzwonek
- Dzwonek (na baterie)
- Dzwonek (zasilany z sieci)
- Termostat
Metody
Szczegółowe informacje o wszystkich metodach dostępnych dla interfejsu SDM API znajdziesz w dokumentacji API.
executeCommand
Wykonuje polecenie na autoryzowanym urządzeniu.
Do wykonania polecenia 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" } }
Dalsze przykłady poleceń znajdziesz na stronie z informacjami o poszczególnych cechach. Sprawdź pełną listę cech, aby dowiedzieć się więcej.
get
Uzyskuje informacje o autoryzowanym konstrukcji lub urządzeniu.
Wywołanie GET
zwraca pojedynczą odpowiedź z bieżącymi polami i wartościami wszystkich cech dostępnych dla struktury lub urządzenia, które user zautoryzował, i obiektu „parentRelations”, który reprezentuje zasób nadrzędny bieżącego zasobu – budowę lub salę.
Na przykład Nest Thermostat może zwrócić te komunikaty:
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 obiektów, pomieszczeń lub urządzeń.
Aby wyświetlić listę wszystkich obiektów, sal lub urządzeń autoryzowanych za pomocą jednego tokena dostępu, wykonaj wywołanie GET
dla odpowiedniego punktu końcowego zasobu:
GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices
Integracja z Asystentem Google
Po autoryzacji urządzenia na potrzeby SDM Google otrzymuje informacje o nim na wykresie głównym i bezpośrednio zarządza jego stanem. Jeśli w ramach oferty handlowej masz integrację z Asystentem Google:
- Nie wysyłaj żądań synchronizacji urządzeń SDM
- Pomiń urządzenia SDM w odpowiedziach na zamiar SYNC
Błędy
Pełną listę kodów błędów interfejsu API znajdziesz w dokumentacji błędów interfejsu API.