ファン スキーマ
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 エラーコードのリファレンスをご覧ください。