性狀

SDM API 中的「特徵」包含「欄位」、「指令」和「事件」。

所有 SDM API 呼叫都應使用下列端點：
https://smartdevicemanagement.googleapis.com/v1

欄位

欄位是具有常見資料類型的值，例如數字或字串。舉例來說，欄位可能包含 Google Nest 溫度控制器的目前模式或環境濕度。

您可以透過對所需 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 API 新增更多功能，我們無法保證特定裝置的裝置類型會保持穩定。請改用裝置傳回的特徵。

parentRelations

parentRelations 物件代表目前資源的父項資源，可以是建築物或房間。顯示名稱對應於具有結構體父項的裝置的Info 特徵 ，或是具有房間父項的裝置的RoomInfo 特徵 。

指令

指令是與特徵相關聯的要求。例如變更 Google Nest 溫度控制器的目前模式或設定溫度。

透過 executeCommand API 呼叫傳送指令：

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

大多數指令的回應都是簡單的成功或失敗。如需特定指令的使用範例，請參閱個別特徵指南。

事件

事件為非同步資料，是由 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 這個特徵屬於支援節能模式的恆溫器裝置類型。
ThermostatHvac	sdm.devices.traits.ThermostatHvac 這項特徵屬於可回報空調詳細資料的 THERMOSTAT 裝置類型。
ThermostatMode	sdm.devices.traits.ThermostatMode 這項特徵屬於支援不同溫度控制器模式的 THERMOSTAT 裝置類型。
ThermostatTemperatureSetpoint	sdm.devices.traits.ThermostatTemperatureSetpoint 這項特徵屬於支援設定目標溫度和溫度範圍的 THERMOSTAT 裝置類型。

相機

特徵
CameraClipPreview	sdm.devices.traits.CameraClipPreview 只要裝置支援下載短片預覽畫面，就屬於這項特徵。
CameraEventImage	sdm.devices.traits.CameraEventImage 只要裝置支援從事件生成圖片，就屬於這項特徵。
CameraImage	sdm.devices.traits.CameraImage 只要裝置支援拍攝圖片，就屬於這項特徵。
CameraLiveStream	sdm.devices.traits.CameraLiveStream 只要裝置支援直播，就會有這項特徵。
CameraMotion	sdm.devices.traits.CameraMotion 只要裝置支援動作偵測事件，就屬於這項特徵。
CameraPerson	sdm.devices.traits.CameraPerson 只要裝置支援人物偵測事件，就會具備這項特徵。
CameraSound	sdm.devices.traits.CameraSound 這項特徵屬於支援聲響偵測事件的任何裝置。

門鈴

特徵
DoorbellChime	sdm.devices.traits.DoorbellChime 凡是支援門鈴鈴聲和相關按鈕事件的裝置，都屬於這項特徵。