Sifat

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

Kolom

Kolom adalah nilai dengan jenis data umum, seperti angka atau string. Misalnya, kolom mungkin berisi mode saat ini atau kelembapan ruangan 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. Tidak ada jaminan bahwa jenis perangkat akan tetap stabil untuk perangkat tertentu karena semakin banyak fitur yang ditambahkan ke SDM API. Sebagai gantinya, gunakan karakteristik yang ditampilkan untuk perangkat.

parentRelations

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

Perintah

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

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 setiap karakteristik untuk contoh penggunaan perintah tertentu.

Acara

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

Peristiwa dikirim secara default untuk setiap perubahan nilai kolom sifat. Notifikasi 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
Sifat ini termasuk dalam struktur apa pun untuk informasi terkait struktur.
RoomInfo
sdm.structures.traits.RoomInfo
Sifat ini dimiliki oleh setiap ruangan untuk informasi terkait ruangan.

Perangkat

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

Termostat

Sifat
ThermostatEco
sdm.devices.traits.ThermostatEco
Sifat ini termasuk dalam jenis perangkat THER semata-mata yang mendukung mode ECO.
ThermostatHvac
sdm.devices.traits.ThermostatHvac
Sifat ini termasuk dalam jenis perangkat THERMOSTAT yang dapat melaporkan detail HVAC.
ThermostatMode
sdm.devices.traits.ThermostatMode
Sifat ini termasuk dalam jenis perangkat THERMOSTAT yang mendukung berbagai mode termostat.
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
Sifat ini termasuk dalam jenis perangkat THERMOSTAT yang mendukung setelan suhu target dan rentang suhu.

Kamera

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

Bel pintu

Sifat
DoorbellChime
sdm.devices.traits.DoorbellChime
Sifat ini dimiliki oleh perangkat apa pun yang mendukung bel pintu dan peristiwa tekan terkait.