ファン スキーマ

Nest サーモスタット 

sdm.devices.traits.Fan

このトレイトは、ファンを制御するシステム機能を備えたすべてのデバイスに使用します。

フィールド

フィールド 説明 データ型
timerMode 現在のタイマーモード。 string
値: "ON"、"OFF"
timerTimeout タイマーモードが OFF に切り替わるタイムスタンプ（RFC 3339 形式）。 string
例: "2019-05-10T03:22:54Z"

GET リクエストとレスポンスの例

リクエスト

GET /enterprises/project-id/devices/device-id

レスポンス

{
  "name" : "enterprises/project-id/devices/device-id",
  "traits" : {
    "sdm.devices.traits.Fan" : {
      "timerMode" : "ON",
      "timerTimeout" : "2019-05-10T03:22:54Z"
    }
  }
}

コマンド

SetTimer

ファンのタイマーを変更します。

SetTimer リクエストとレスポンス

リクエスト

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.Fan.SetTimer",
  "params" : {
    "timerMode" : "ON",
    "duration" : "3600s"
  }
}

レスポンス

{}

SetTimer リクエスト フィールド

フィールド 説明 データ型
timerMode ファンのタイマーを設定するモード。 string
値: "ON"、"OFF"
duration 省略可。 タイマーが実行される時間（秒単位）を指定します。 string
範囲: "1s"～ "43200s"
デフォルト: "900s"

エラー

このトレイトに関連して、次のエラーコードが返されることがあります。

エラー メッセージ RPC トラブルシューティング
サーモスタットのファンを使用できません。 FAILED_PRECONDITION サーモスタットにファン機能がありません。 このデバイスでは、ファン関連のトレイトとコマンドを使用できません。

API エラーコードの一覧については、API エラーコードのリファレンスを ご覧ください。