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

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

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

デバイスの属性

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

属性 タイプ 説明
maxTimerLimitSec 整数

必須。

デバイスで利用可能なタイマーの最長設定値（秒単位）。
commandOnlyTimer ブール値

（デフォルト: false）

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

例

タイマーの上限が 2 時間のデバイス

{
  "maxTimerLimitSec": 7200
}

デバイスのステータス

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

状態 タイプ 説明
timerRemainingSec 整数

必須。

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

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

例

デバイスのタイマーの残り時間はどれくらいですか？（実行中でない）。

{
  "timerRemainingSec": -1
}

デバイスのタイマーの残り時間はどれくらいですか？（実行中）。

{
  "timerRemainingSec": 60
}

デバイスのタイマーの残り時間はどれくらいですか？（一時停止）。

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

デバイスのコマンド

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

action.devices.commands.TimerStart

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

パラメータ

パラメータ タイプ 説明
timerTimeSec 整数

必須。

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

例

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

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

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

サポートされている値:

noTimerExists
timerValueOutOfRange
aboveMaximumTimerDuration
belowMinimumTimerDuration

action.devices.commands.TimerAdjust

タイマーの長さを調整します。

パラメータ

パラメータ タイプ 説明
timerTimeSec 整数

必須。

タイマーの正または負の調整（秒単位）。[-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

デバイスエラー

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