特性

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 オブジェクトは、現在のリソースの親リソース(構造または部屋)を表します。表示名は、Info トレイト({/11/}customName

コマンド

コマンドとは、トレイトに関連するリクエストです。たとえば、Google Nest Thermostat の現在のモードや設定温度を変更する場合です。

コマンドは 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
この特性は、構造情報に関するすべての構造に属します。
会議室情報
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
このトレイトは、暖房換気空調システムの詳細を報告できるデバイスタイプです。
ThermostatMode
sdm.devices.traits.ThermostatMode
このトレイトは、各種のサーモスタット モードをサポートするサーモスタットのタイプに属します。
ThermostatTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
このトレイトは、設定温度と設定温度範囲をサポートするサーモスタットのタイプに含まれています。

カメラ

トレイト
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
このトレイトは、モーション検知イベントをサポートするすべてのデバイスに属します。
カメラマン
sdm.devices.traits.CameraPerson
このトレイトは、人感センサー イベントをサポートするすべてのデバイスに属します。
CameraSound
sdm.devices.traits.CameraSound
このトレイトは、サウンド検知イベントをサポートするすべてのデバイスに属します。

ドアホン

トレイト
DoorbellChime
sdm.devices.traits.DoorbellChime
このトレイトは、ドアホンのチャイムと関連するプレスイベントをサポートするすべてのデバイスに帰属します。