トレイト

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 への機能の追加に伴い、そのデバイスタイプの安定性が維持される API代わりに、返されたデバイス用トレイトを使用します。

parentRelations

parentRelations オブジェクトは、現在のリソースの親リソースを表します。 ストラクチャまたは部屋です。表示名は、UDM イベントの 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 によって管理され、 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 のデバイスタイプに使用します。

カメラ

トレイト
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
このトレイトは、ドアホンのチャイムや関連する押下イベントをサポートするデバイスに使用します。