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

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

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

デバイスの属性

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

属性 タイプ 説明
maxTimerLimitSec 整数

必須。

デバイスで設定できる最長のタイマー設定を秒単位で示します。

最小値: 1。
commandOnlyTimer ブール値

（デフォルト: false）

デバイスが一方向（true）または双方向（false）の通信をサポートしているかどうかを示します。デバイスがこのトレイトの QUERY インテントまたはステータスの通知に応答できない場合は、この属性を 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] の範囲内で指定する必要があります。

最小値: 1。

例

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

デバイスエラー

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