Fan Schema
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 範囲: 「1 秒」~「43,200 秒」 デフォルト: 「900 秒」 |
エラー
このトレイトに関連して、次のエラーコードが返されることがあります。
エラー メッセージ | RPC | トラブルシューティング |
---|---|---|
サーモスタットのファンを使用できません。 | FAILED_PRECONDITION |
サーモスタットに送風機能がありません。このデバイスでは、ファン関連の特性とコマンドを使用できません。 |
API エラーコードの一覧については、API エラーコードのリファレンスをご覧ください。