Cechy

Cecha w interfejsie SDM API składa się z pól, komend i zdarzeń.

Pola

Pola to wartości z popularnymi typami danych, np. liczba lub ciąg znaków. Na przykład pole może zawierać bieżący tryb lub wilgotność otoczenia termostatu Google Nest.

Cechy i pola można wyświetlić, wysyłając wywołanie GET do odpowiedniego punktu końcowego interfejsu 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ń

Obiektu sdm.devices.types.device-type zwróconego przez interfejs SDM API nie należy używać do wydedukowania ani wnioskowania o funkcjonalności rzeczywistego urządzenia, do którego jest przypisany. Nie ma gwarancji, że typ urządzenia pozostanie stabilny w przypadku konkretnego urządzenia, ponieważ do interfejsu SDM API dodawane są kolejne funkcje. Zamiast tego użyj cech zwróconych urządzenia.

parentRelations

Obiekt parentRelations reprezentuje zasób nadrzędny bieżącego zasobu – strukturę lub salę. Wyświetlana nazwa odpowiada polu customName w strukturzeWłaściwość Info na urządzeniach z jednostką nadrzędną struktury lubWłaściwość RoomInfo na urządzeniach z jednostką nadrzędną pokoju.

Polecenia

Polecenia to żądania powiązane z cechą. Może to być na przykład zmiana bieżącego trybu lub punktu odniesienia temperatury w termostacie Google Nest.

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 po prostu powodzenie lub błąd. Przykłady użycia poszczególnych poleceń znajdziesz w przewodnikach dotyczących poszczególnych atrybutów.

Wydarzenia

Zdarzenia są asynchroniczne i zarządzane przez Google Cloud Pub/Sub w ramach jednego tematu na identyfikator Project .

Zdarzenia są domyślnie wysyłane w przypadku każdej zmiany wartości pola cechy. Mogą być też wysyłane w odpowiedzi na określone działania na urządzeniu lub zmiany w przypisaniu zasobów. Więcej informacji znajdziesz w sekcji Zdarzenia.

Kategorie cech

Struktura

Cechy
Informacje
sdm.structures.traits.Info
Ten atrybut należy do dowolnej struktury zawierającej informacje o strukturze.
RoomInfo
sdm.structures.traits.RoomInfo
Ta cecha należy do każdego pokoju i zawiera informacje o nim.

Urządzenie

Cechy
Połączenia
sdm.devices.traits.Connectivity
Ta cecha należy do każdego urządzenia, które ma informacje o połączeniu.
Fan
sdm.devices.traits.Fan
Ta cecha należy do każdego urządzenia, które ma system umożliwiający sterowanie wentylatorem.
Wilgotność
sdm.devices.traits.Humidity
Ta cecha należy do każdego urządzenia, które ma czujnik 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ń THERMOSTAT, które obsługują tryby ECO.
TermostatHvac
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.
Tryb termostatu
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 temperatury.

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 z 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 transmisję na żywo.
Ruch kamery
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 dzwonek do drzwi i powiązane zdarzenia naciśnięcia.