Cechy

Cechy w interfejsie SDM API obejmują pola, polecenia i zdarzenia.

Pola

Pola to wartości o typowych typach danych, np. liczby lub ciągi znaków. Pole może na przykład zawierać bieżący tryb lub wilgotność otoczenia urządzenia Google Nest Thermostat.

Cechy i pola można wyświetlić za pomocą wywołania GET do wybranego 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ń

Wartości sdm.devices.types.device-type zwracane przez interfejs SDM API nie powinny być używane do wyciągania wniosków na temat funkcji rzeczywistego urządzenia, do którego są przypisane. 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 zwróconych cech urządzenia.

parentRelations

Obiekt parentRelations reprezentuje zasób nadrzędny bieżącego zasobu, czyli strukturę lub pomieszczenie. Wyświetlana nazwa odpowiada polu customName w cechy Info w przypadku urządzeń z rodzicem struktury lub w cechy RoomInfo w przypadku urządzeń z rodzicem pomieszczenia.

Polecenia

Polecenia to żądania powiązane z cechą. Na przykład zmiana bieżącego trybu lub ustawionej temperatury na termostacie 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 proste potwierdzenie powodzenia lub niepowodzenia. Przykłady użycia konkretnych poleceń znajdziesz w przewodnikach dotyczących poszczególnych cech.

Wydarzenia

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

Zdarzenia są wysyłane domyślnie w przypadku każdej zmiany wartości pola cechy. Mogą być też wysyłane w odpowiedzi na określone działania urządzenia 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 każdej struktury, która zawiera informacje związane ze strukturą.
RoomInfo
sdm.structures.traits.RoomInfo
Ta cecha należy do każdego pokoju i zawiera informacje z nim związane.

Urządzenie

Cechy
Połączenia
sdm.devices.traits.Connectivity
Ten stan należy do każdego urządzenia, które ma informacje o łączności.
Fan
sdm.devices.traits.Fan
Ta cecha dotyczy każdego urządzenia, które ma możliwość sterowania wentylatorem.
Wilgotność
sdm.devices.traits.Humidity
Ta cecha dotyczy każdego urządzenia, które ma czujnik do pomiaru wilgotności.
Informacje
sdm.devices.traits.Info
Ten atrybut należy do każdego urządzenia i zawiera informacje dotyczące urządzenia.
Ustawienia
sdm.devices.traits.Settings
Ten atrybut należy do każdego urządzenia i zawiera informacje o ustawieniach urządzenia.
Temperatura
sdm.devices.traits.Temperature
Ta cecha należy do każdego urządzenia, które ma czujnik do pomiaru temperatury.

Termostat

Cechy
ThermostatEco
sdm.devices.traits.ThermostatEco
Ten atrybut należy do typów urządzeń THERMOSTAT, które obsługują tryby ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Ten atrybut należy do typów urządzeń THERMOSTAT, które mogą zgłaszać szczegóły HVAC.
ThermostatMode
sdm.devices.traits.ThermostatMode
Ten atrybut należy do typów urządzeń THERMOSTAT, które obsługują różne tryby termostatu.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Ten atrybut należy do typów urządzeń THERMOSTAT, które obsługują ustawianie temperatury docelowej i zakresu temperatur.

Aparat

Cechy
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Ta cecha dotyczy 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 wydarzeń.
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
Ten atrybut dotyczy każdego urządzenia, które obsługuje transmisje na żywo.
CameraMotion
sdm.devices.traits.CameraMotion
Ten atrybut 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
Ten atrybut należy do każdego urządzenia, które obsługuje zdarzenia wykrywania dźwięku.

Dzwonek

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