特性

SDM API のトレイト は、フィールド 、コマンド 、イベント で構成されます。

フィールド

フィールドは、数値や文字列などの一般的なデータ型の値です。たとえば、フィールド には、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"
  }
}

コマンドに対するレスポンスのほとんどは、成功または失敗のシンプルなものです。特定のコマンドの使用例については、個々のトレイトのガイドをご覧ください。

イベント

イベントは非同期で、 Project ID ごとに 1 つのトピックで Google Cloud Pub/Sub によって管理されます。

イベントは、トレイト フィールドの値が変更されるとデフォルトで送信されます。特定のデバイス アクションやリソース割り当ての変更に応じて送信することもできます。詳細については、 イベント をご覧ください。

トレイトのカテゴリ

構造

トレイト
情報
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
このトレイトは、HVAC の詳細を報告できる 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
このトレイトは、ドアホンのチャイムと関連する押下イベントをサポートするすべてのデバイスに使用します。