Cechy

Cecha w interfejsie SDM API obejmuje pola, polecenia i zdarzenia.

Pola

Pola to wartości z typowymi typami danych, takimi jak liczba lub ciąg znaków. Na przykład pole może zawierać bieżący tryb lub wilgotność otoczenia urządzenia Google Nest Thermostat.

Cechy i pola można wyświetlać za pomocą wywołania GET do odpowiedniego punktu końcowego API:

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

Typy urządzeń

Nie należy używać obiektu sdm.devices.types.device-type zwróconego przez interfejs SDM API wywnioskować lub wywnioskować funkcje rzeczywistego urządzenia, do którego zostało przypisane. Nie ma gwarancji że typ urządzenia pozostanie stabilny w miarę dodawania kolejnych funkcji do SDM. API. Zamiast tego użyj cech zwróconych urządzenia.

parentRelations

Obiekt parentRelations reprezentuje zasób nadrzędny bieżącego zasobu, może to być dom lub pomieszczenie. Wyświetlana nazwa odpowiada polu customName w sekcji Cecha informacyjna w przypadku urządzeń z ustawieniem nadrzędnym lub trata RoomInfo w przypadku urządzeń z elementu nadrzędnego w pokoju.

Polecenia

Polecenia to żądania powiązane z cechą. Na przykład zmiana bieżącego trybu lub nastawę temperatury na urządzeniu Google Nest Thermostat.

Polecenie jest wysyłane przez wywołanie interfejsu API executeCommand:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

Większość odpowiedzi na polecenie to prosty sukces lub niepowodzenie. Zobacz przewodniki po cechach poszczególnych osób: konkretne przykłady użycia poleceń.

Wydarzenia

Zdarzenia są asynchroniczne i zarządzane przez Google Cloud Pub/Sub w jednym temacie na Project Identyfikator

Zdarzenia są domyślnie wysyłane w przypadku każdej zmiany wartości w polu cechy. Można je również wysłać w reakcja na określone działania na urządzeniach lub zmiany w przypisaniach zasobów. Zobacz Zdarzenia .

Kategorie cech

Struktura

Cechy
Informacje
sdm.structures.traits.Info
Ta cecha należy do każdej struktury informacji związanych ze strukturą.
RoomInfo
sdm.structures.traits.RoomInfo
Ta cecha należy do każdego miejsca na informacje związane z pokojami.

Urządzenie

Cechy
Łączność
sdm.devices.traits.Connectivity
Ta cecha należy do każdego urządzenia z informacjami o połączeniach.
Fan
sdm.devices.traits.Fan
Ta cecha należy do każdego urządzenia, które może sterować wentylatorem.
Wilgotność
sdm.devices.traits.Humidity
Ta cecha należy do każdego urządzenia z czujnikiem do pomiaru wilgotności.
Informacje
sdm.devices.traits.Info
Ta cecha należy do każdego urządzenia w przypadku informacji związanych z urządzeniem.
Ustawienia
sdm.devices.traits.Settings
Ta cecha należy do każdego urządzenia w przypadku informacji o ustawieniach związanych z urządzeniem.
Temperatura
sdm.devices.traits.Temperature
Ta cecha należy do każdego urządzenia z czujnikiem do pomiaru temperatury.

Termostat

Cechy
ThermostatEco
sdm.devices.traits.ThermostatEco
Ta cecha należy do typów urządzeń TERMOSTATU, które obsługują tryby ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Ta cecha należy do typów urządzeń Termostat, które mogą zgłaszać szczegóły dotyczące ogrzewania/wentylacji/klimatyzacji.
ThermostatMode
sdm.devices.traits.ThermostatMode
Ta cecha należy do typów urządzeń Termostat, które obsługują różne tryby termostatu.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Ta cecha należy do typów urządzeń Termostat, które obsługują ustawianie docelowej temperatury i zakresu temperatur.

Aparat

Cechy
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Ta cecha należy do każdego urządzenia, które obsługuje pobieranie podglądu klipu.
CameraEventImage
sdm.devices.traits.CameraEventImage
Ta cecha należy do każdego urządzenia, które obsługuje generowanie obrazów na podstawie zdarzeń.
CameraImage
sdm.devices.traits.CameraImage
Ta cecha należy do każdego urządzenia, które obsługuje robienie zdjęć.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Ta cecha należy do każdego urządzenia, które obsługuje transmisje na żywo.
CameraMotion
sdm.devices.traits.CameraMotion
Ta cecha należy do każdego urządzenia, które obsługuje zdarzenia wykrywania ruchu.
CameraPerson
sdm.devices.traits.CameraPerson
Ta cecha należy do każdego urządzenia, które obsługuje zdarzenia wykrywania osób.
CameraSound
sdm.devices.traits.CameraSound
Ta cecha należy do każdego urządzenia, które obsługuje zdarzenia wykrywania dźwięku.

Dzwonek

Cechy
DoorbellChime
sdm.devices.traits.DoorbellChime
Ta cecha należy do każdego urządzenia, które obsługuje gong dzwonka i powiązane zdarzenia naciśnięcia.