Cechy

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

Pola

Pola to wartości o typowych typach danych, takich jak liczba lub ciąg znaków. Pole może na przykład zawierać bieżący tryb lub wilgotność otoczenia termostatu Google Nest.

Cechy i pola można wyświetlić za pomocą wywołania GET do żądanego 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 zwracanej przez interfejs SDM API nie należy używać do wyciągania wniosków na temat funkcjonalności rzeczywistego urządzenia, do którego jest przypisana. 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żywaj cech zwracanych przez urządzenie.

parentRelations

Obiekt parentRelations reprezentuje zasób nadrzędny bieżącego zasobu, czyli strukturę lub pomieszczenie. Nazwa wyświetlana odpowiada polu customName w przypadku urządzeń z cechą Info w przypadku urządzeń z cechą StructureInfo lub cechą RoomInfo w przypadku urządzeń z cechą RoomInfo.

Polecenia

Polecenia to żądania powiązane z cechą. Na przykład zmiana bieżącego trybu lub ustawionej temperatury na 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 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 identyfikator.

Zdarzenia są domyślnie wysyłane przy każdej zmianie wartości pola cechy. Mogą być też wysyłane w odpowiedzi na konkretne działania urządzenia lub zmiany w przypisaniach zasobów. Więcej informacji znajdziesz w artykule Zdarzenia.

Kategorie cech

Struktura

Cechy
Informacje
sdm.structures.traits.Info
Ta cecha należy do każdej struktury, która zawiera informacje o strukturze.
RoomInfo
sdm.structures.traits.RoomInfo
Ta cecha należy do każdego pomieszczenia, które zawiera informacje o pomieszczeniu.

Urządzenie

Cechy
Połączenia
sdm.devices.traits.Connectivity
Ta cecha należy do każdego urządzenia, które zawiera informacje o połączeniu.
Wentylator
sdm.devices.traits.Fan
Ta cecha należy do każdego urządzenia, które ma możliwość sterowania 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, które zawiera informacje o urządzeniu.
Ustawienia
sdm.devices.traits.Settings
Ta cecha należy do każdego urządzenia, które 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
Ta cecha należy do typów urządzeń THERMOSTAT, które obsługują tryby ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Ta cecha należy do typów urządzeń THERMOSTAT, które mogą zgłaszać szczegóły dotyczące HVAC.
ThermostatMode
sdm.devices.traits.ThermostatMode
Ta cecha należy do typów urządzeń THERMOSTAT, które obsługują różne tryby termostatu.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Ta cecha 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 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 transmisję 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 dzwonek i powiązane z nim zdarzenia naciśnięcia.