ファンのスキーマ
sdm.devices.traits.Fan
このトレイトは、システムがファンを制御する機能を備えているデバイスに使用します。
フィールド
フィールド | 説明 | データ型 |
---|---|---|
timerMode |
現在のタイマーモードです。 | string 値: "ON"、"OFF" |
timerTimeout |
タイマーモードがオフになるタイムスタンプ(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 エラーコードの完全なリスト。