スマートホームの Timer トレイトのスキーマ
action.devices.traits.Timer
- タイマー トレイトは、デバイスのタイマーを表します。
たとえば、スマート スプリンクラー コントローラやスマートライト スイッチにはタイマーが内蔵されていることがあります。このトレイトは、内蔵タイマー(新しいタイマーの開始、実行中のタイマーの一時停止とキャンセル、残り時間の質問など)の制御に使用できます。
デバイスの属性
この特性を持つデバイスは、SYNC
オペレーションの一部として次の属性を報告する可能性があります。SYNC
インテントの処理の詳細については、インテント フルフィルメントをご覧ください。
属性 | タイプ | 説明 |
---|---|---|
maxTimerLimitSec |
Integer |
必須。 デバイスで使用できる最長のタイマー設定を秒単位で指定します。 |
commandOnlyTimer |
ブール値 |
(デフォルト: デバイスが一方向(True)または双方向(False)の通信をサポートしているかどうかを示します。デバイスがこのトレイトの QUERY インテントまたは Report State に応答できない場合は、この属性を true に設定します。 |
例
デバイスに 2 時間のタイマー上限がある。
{ "maxTimerLimitSec": 7200 }
デバイスのステータス
この特性を持つエンティティは、QUERY
オペレーションの一部として次の状態をレポートできます。QUERY
インテントの処理の詳細については、インテント フルフィルメントをご覧ください。
状態 | タイプ | 説明 |
---|---|---|
timerRemainingSec |
Integer |
必須。 現在の残り時間(秒、-1、または [0]。 |
timerPaused |
ブール値 |
アクティブなタイマーが存在するものの、現在一時停止されている場合は true。 |
例
デバイス タイマーの残り時間は?(実行されていません)。
{ "timerRemainingSec": -1 }
デバイス タイマーの残り時間は?(実行中)。
{ "timerRemainingSec": 60 }
デバイス タイマーの残り時間は?(一時停止)
{ "timerRemainingSec": 30, "timerPaused": true }
デバイスのコマンド
この特性を持つデバイスは、EXECUTE
オペレーションの一部として次のコマンドに応答できます。EXECUTE
インテントの処理の詳細については、インテント フルフィルメントをご覧ください。
action.devices.commands.TimerStart
新しいタイマーを開始します。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
timerTimeSec |
Integer |
必須。 タイマーの期間(秒)。[1 ~ |
例
デバイス タイマーを 5 分間実行します。
{ "command": "action.devices.commands.TimerStart", "params": { "timerTimeSec": 300 } }
関連エラー
タイマーの開始中にエラーが発生しました。
サポートされている値:
noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration
action.devices.commands.TimerAdjust
タイマーの時間を調整します。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
timerTimeSec |
Integer |
必須。 タイマーの正または負の調整(秒単位)。[ |
例
デバイスのタイマーを 1 分延長します。
{ "command": "action.devices.commands.TimerAdjust", "params": { "timerTimeSec": 60 } }
デバイス タイマーから 30 秒を差し引きます。
{ "command": "action.devices.commands.TimerAdjust", "params": { "timerTimeSec": -30 } }
関連エラー
タイマーの調整中にエラーが発生しました。
サポートされている値:
noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration
action.devices.commands.TimerPause
タイマーを一時停止します。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
デバイスのタイマーを一時停止します。
{ "command": "action.devices.commands.TimerPause", "params": {} }
関連エラー
タイマーの一時停止中にエラーが発生しました。
サポートされている値:
noTimerExists
action.devices.commands.TimerResume
タイマーを再開します。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
デバイス タイマーを再開します。
{ "command": "action.devices.commands.TimerResume", "params": {} }
関連エラー
タイマーの再開中にエラーが発生しました。
サポートされている値:
noTimerExists
action.devices.commands.TimerCancel
タイマーをキャンセルします。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
プロパティがありません |
例
デバイスのタイマーを停止します。
{ "command": "action.devices.commands.TimerCancel", "params": {} }
関連エラー
タイマーの停止中にエラーが発生しました。
サポートされている値:
noTimerExists