スマートホームの Timer トレイトのスキーマ
action.devices.traits.Timer
- タイマー トレイトはデバイスのタイマーを表します。
スマート スプリンクラー コントローラやスマートライトなど タイマーが組み込まれていることもあります。このトレイトを使用すると、Google Pixel の内蔵タイマーを (新しいタイマーの開始、動作中のタイマーの一時停止とキャンセルなど) 残り時間を尋ねるメッセージが表示されます
デバイスの属性
このトレイトを持つデバイスは、以下をレポートすることがあります。
SYNC
オペレーションの一部として使用できます。学習内容
SYNC
インテントの処理の詳細については、以下をご覧ください。
インテント フルフィルメント。
属性 | タイプ | 説明 |
---|---|---|
maxTimerLimitSec |
整数 |
必須。 デバイスで利用できるタイマー設定のうち、最も長い時間(秒単位)を示します。 |
commandOnlyTimer |
ブール値 |
(デフォルト: デバイスが一方向(true)または双方向(false)の通信の使用をサポートしているかどうかを示します。デバイスがこのトレイトの QUERY インテントまたは Report State に応答できない場合は、この属性を true に設定します。 |
例
2 時間のタイマー制限があるデバイス。
{ "maxTimerLimitSec": 7200 }
デバイスのステータス
このトレイトを持つエンティティは、以下を報告する場合があります。
複数の状態を QUERY
オペレーションの一部として呼び出します。学習内容
QUERY
インテントの処理の詳細については、以下をご覧ください。
インテント フルフィルメント。
州 | タイプ | 説明 |
---|---|---|
timerRemainingSec |
整数 |
必須。 現在の残り時間(秒、-1、または [0, |
timerPaused |
ブール値 |
アクティブなタイマーが存在し、現在一時停止中の場合は true。 |
例
デバイス タイマーの残り時間はどれくらいですか?(実行されていません)。
{ "timerRemainingSec": -1 }
デバイス タイマーの残り時間はどれくらいですか?(実行中)。
{ "timerRemainingSec": 60 }
デバイス タイマーの残り時間はどれくらいですか?(一時停止)。
{ "timerRemainingSec": 30, "timerPaused": true }
デバイスのコマンド
このトレイトを持つデバイスは、以下の動作に反応します。
コマンドを EXECUTE
オペレーションの一部として使用できます。学習内容
EXECUTE
インテントの処理の詳細については、以下をご覧ください。
インテント フルフィルメント。
action.devices.commands.TimerStart
新しいタイマーを開始します。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
timerTimeSec |
整数 |
必須。 タイマーの時間(秒)。[1, |
例
デバイス タイマーを 5 分実行します。
{ "command": "action.devices.commands.TimerStart", "params": { "timerTimeSec": 300 } }
関連エラー
タイマーの開始中にエラーが発生しました。
サポートされている値:
noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration
action.devices.commands.TimerAdjust
タイマーの長さを調整します。
パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
timerTimeSec |
整数 |
必須。 タイマーの正または負の調整(秒単位)。[ |
例
デバイスタイマーを 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