SDM API 中的「特徵」由「欄位」、「指令」和「事件」組成。
欄位
欄位是具有常見資料類型的值,例如數字或字串。例如欄位
可能含有目前模式或 Google Nest Thermostat 的環境濕度。
如要查看特徵和欄位,可以使用對所需 API 端點的 GET
呼叫:
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"
}
]
}
裝置類型
不應使用 SDM API 傳回的 sdm.devices.types.device-type
推斷或推斷其所指派裝置的功能。無法保證
會讓特定裝置類型保持穩定,因為 SDM 會新增更多功能
也能使用 Google Cloud CLI 或
Compute Engine API請改為使用裝置傳回的特徵。
parentRelations
parentRelations
物件代表目前資源的父項資源
區分結構或房間顯示名稱會對應
customName
資訊特徵
適用於結構父項或
RoomInfo 特性 (適用於
父系物件
指令
指令是與特徵相關聯的要求。例如,變更目前的模式或
Google Nest Thermostat 控制溫度設定點
executeCommand
API 呼叫會傳送指令:
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "command-name",
"params" : {
"field" : "value"
}
}
對指令的回應大多是單純的成功或失敗。請參閱 的個別特性指南
特定指令用法範例
活動
事件由 Google Cloud Pub/Sub 非同步管理,並由 Google Cloud Pub/Sub 管理,在每個主題中
Project ID。
根據預設,當特徵欄位的值有任何變更時,就會傳送事件。這些也可以傳送
回應特定裝置動作或資源指派變更。詳情請見
活動
瞭解詳情
特徵類別
結構
特徵 |
資訊 |
sdm.structures.traits.Info |
這個特徵屬於結構相關資訊的任何結構。 |
|
RoomInfo |
sdm.structures.traits.RoomInfo |
這個特徵屬於會議室相關資訊的房間。 |
|
裝置
特徵 |
連線能力 |
sdm.devices.traits.Connectivity |
這項特徵適用於所有有連線資訊的裝置。 |
|
粉絲 |
sdm.devices.traits.Fan |
凡是能控制風扇的裝置都能使用此特徵。 |
|
濕度 |
sdm.devices.traits.Humidity |
凡是搭載感應器且可測量濕度的裝置,都屬於這項特徵。 |
|
資訊 |
sdm.devices.traits.Info |
此特徵屬於任何裝置相關資訊。 |
|
設定 |
sdm.devices.traits.Settings |
這項特徵屬於任何裝置相關設定資訊。 |
|
溫度 |
sdm.devices.traits.Temperature |
凡是搭載感應器的裝置,都能使用這項特徵。 |
|
溫度控制器
特徵 |
ThermostatEco |
sdm.devices.traits.ThermostatEco |
這項特徵屬於支援 ECO 模式的 THERMOSTAT 裝置類型。 |
|
ThermostatHvac |
sdm.devices.traits.ThermostatHvac |
這項特徵屬於可回報空調詳細資料的 THERMOSTAT 裝置類型。 |
|
ThermostatMode |
sdm.devices.traits.ThermostatMode |
這項特徵屬於支援不同溫度控制器模式的 THERMOSTAT 裝置類型。 |
|
ThermostatTemperatureSetpoint |
sdm.devices.traits.ThermostatTemperatureSetpoint |
這項特徵屬於支援設定目標溫度和溫度範圍的 THERMOSTAT 裝置類型。 |
|
相機
門鈴
特徵 |
DoorbellChime |
sdm.devices.traits.DoorbellChime |
這個特徵適用於所有支援門鈴鈴聲及相關媒體事件的裝置。 |
|