Sifat

Trait di SDM API terdiri dari kolom, perintah, dan peristiwa.

Kolom

Kolom adalah nilai dengan jenis data umum, seperti angka atau string. Misalnya, kolom dapat berisi mode saat ini atau kelembapan sekitar Google Nest Thermostat.

Ciri dan kolom dapat dilihat dengan panggilan GET ke endpoint API yang diinginkan:

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

Jenis perangkat

sdm.devices.types.device-type yang ditampilkan oleh SDM API tidak boleh digunakan untuk menyimpulkan atau menyimpulkan fungsi perangkat sebenarnya yang ditetapkan untuknya. Tidak ada jaminan bahwa jenis perangkat akan tetap stabil untuk perangkat tertentu saat lebih banyak fitur ditambahkan ke SDM API. Sebagai gantinya, gunakan trait yang ditampilkan untuk perangkat.

parentRelations

Objek parentRelations merepresentasikan resource induk dari resource saat ini, baik struktur maupun ruang. Nama tampilan sesuai dengan kolom customName dari trait untuk perangkat dengan induk struktur atau trait RoomInfo untuk perangkat dengan induk ruangan.

Perintah

Perintah adalah permintaan yang terkait dengan sifat. Misalnya, mengubah mode saat ini atau titik setel suhu di Termostat Google Nest.

Perintah dikirim oleh panggilan API executeCommand:

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

Sebagian besar respons terhadap perintah adalah keberhasilan atau kegagalan sederhana. Lihat panduan masing-masing karakteristik untuk contoh penggunaan perintah tertentu.

Acara

Peristiwa bersifat asinkron dan dikelola oleh Google Cloud Pub/Sub dalam satu topik per ID Project .

Peristiwa dikirim secara default untuk setiap perubahan pada nilai kolom karakteristik. Peristiwa juga dapat dikirim sebagai respons terhadap tindakan perangkat tertentu atau perubahan dalam penetapan resource. Lihat Peristiwa untuk mengetahui informasi selengkapnya.

Kategori sifat

Struktur

Sifat
Info
sdm.structures.traits.Info
Trait ini termasuk dalam struktur apa pun untuk informasi terkait struktur.
RoomInfo
sdm.structures.traits.RoomInfo
Trait ini digunakan untuk ruangan mana pun untuk informasi terkait ruangan.

Perangkat

Sifat
Konektivitas
sdm.devices.traits.Connectivity
Trait ini digunakan untuk perangkat apa pun yang memiliki informasi konektivitas.
Fan
sdm.devices.traits.Fan
Trait ini digunakan untuk perangkat apa pun yang memiliki kemampuan sistem untuk mengontrol kipas.
Kelembapan
sdm.devices.traits.Humidity
Trait ini digunakan untuk perangkat apa pun yang memiliki sensor untuk mengukur kelembapan.
Info
sdm.devices.traits.Info
Trait ini digunakan untuk perangkat apa pun untuk informasi terkait perangkat.
Setelan
sdm.devices.traits.Settings
Trait ini digunakan untuk perangkat apa pun yang memiliki informasi setelan terkait perangkat.
Suhu
sdm.devices.traits.Temperature
Trait ini digunakan untuk perangkat apa pun yang memiliki sensor untuk mengukur suhu.

Termostat

Sifat
ThermostatEco
sdm.devices.traits.ThermostatEco
Trait ini digunakan untuk jenis perangkat THERMOSTAT yang mendukung mode ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Trait ini termasuk dalam jenis perangkat THERMOSTAT yang dapat melaporkan detail HVAC.
ThermostatMode
sdm.devices.traits.ThermostatMode
Trait ini digunakan untuk jenis perangkat THERMOSTAT yang mendukung berbagai mode termostat.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Trait ini digunakan untuk jenis perangkat THERMOSTAT yang mendukung penyetelan suhu target dan rentang suhu.

Kamera

Sifat
CameraClipPreview
sdm.devices.traits.CameraClipPreview
Trait ini digunakan untuk perangkat apa pun yang mendukung download pratinjau klip.
CameraEventImage
sdm.devices.traits.CameraEventImage
Trait ini digunakan untuk perangkat apa pun yang mendukung pembuatan gambar dari peristiwa.
CameraImage
sdm.devices.traits.CameraImage
Trait ini digunakan untuk perangkat apa pun yang mendukung pengambilan gambar.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
Trait ini digunakan untuk perangkat apa pun yang mendukung live streaming.
CameraMotion
sdm.devices.traits.CameraMotion
Trait ini digunakan untuk perangkat apa pun yang mendukung peristiwa deteksi gerakan.
CameraPerson
sdm.devices.traits.CameraPerson
Trait ini digunakan untuk perangkat apa pun yang mendukung peristiwa deteksi orang.
CameraSound
sdm.devices.traits.CameraSound
Trait ini digunakan untuk perangkat apa pun yang mendukung peristiwa deteksi suara.

Bel pintu

Sifat
DoorbellChime
sdm.devices.traits.DoorbellChime
Karakteristik ini digunakan untuk perangkat apa pun yang mendukung bel pintu dan peristiwa penekanan terkait.