スマートホームの Timer トレイトのスキーマ

action.devices.traits.Timer - タイマー トレイトは、デバイスのタイマーを表します。

たとえば、スマート スプリンクラー コントローラやスマートライト スイッチにタイマーを内蔵している可能性があります。このトレイトを使用すると、新しいタイマーの開始、実行中のタイマーの一時停止とキャンセル、残り時間の確認など、デバイスの組み込みタイマーを制御できます。

デバイスの属性

このトレイトを持つデバイスは、SYNC オペレーションの一部として次の属性を報告できます。SYNC インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

属性 タイプ 説明
maxTimerLimitSec Integer

必須。

デバイスで使用できる最も長いタイマー設定を秒単位で示します。
commandOnlyTimer ブール値

（デフォルト: false）

デバイスが一方向（True）または双方向（False）の通信に対応しているかどうかを示します。デバイスがこのトレイトの QUERY インテントまたは Report State に応答できない場合は、この属性を true に設定します。

例

デバイスにタイマーの時間制限（2 時間）が設定されています。

{
  "maxTimerLimitSec": 7200
}

デバイスのステータス

このトレイトを使用するエンティティは、QUERY オペレーションの一部として次の状態を報告できます。QUERY インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

状態 タイプ 説明
timerRemainingSec Integer

必須。

現在の残り時間（秒単位、-1 または [0, maxTimerLimitSec]）。タイマーが動作していないことを示すには、-1 に設定します。
timerPaused ブール値

アクティブなタイマーが存在しても、現在一時停止中の場合は true。

例

デバイスのタイマーの残り時間は？（実行されていません）。

{
  "timerRemainingSec": -1
}

デバイスのタイマーの残り時間は？（実行中）。

{
  "timerRemainingSec": 60
}

デバイスのタイマーの残り時間は？（一時停止）

{
  "timerRemainingSec": 30,
  "timerPaused": true
}

デバイスのコマンド

このトレイトを持つデバイスは、EXECUTE オペレーションの一環として次のコマンドに応答できます。EXECUTE インテントの処理の詳細については、インテントのフルフィルメントをご覧ください。

action.devices.commands.TimerStart

新しいタイマーを開始します。

パラメータ

パラメータ タイプ 説明
timerTimeSec Integer

必須。

タイマーの期間（秒）。[1, maxTimerLimitSec] の範囲内で指定する必要があります。

例

デバイス タイマーを 5 分間実行します。

{
  "command": "action.devices.commands.TimerStart",
  "params": {
    "timerTimeSec": 300
  }
}

タイマーの開始中にエラーが発生しました。

サポートされる値:

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerAdjust

タイマーの時間を調整します。

パラメータ

パラメータ タイプ 説明
timerTimeSec Integer

必須。

タイマーの正または負の調整（秒単位）。[-maxTimerLimitSec, maxTimerLimitSec] の範囲内で指定する必要があります。

例

デバイス タイマーを 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

デバイスエラー

エラーと例外の全一覧をご覧ください。