智慧家庭計時器計時器結構定義

action.devices.traits.Timer - 計時器特性是代表裝置的計時器，

舉例來說，智慧型灑水器控制器或智慧型燈具開關可能內建內建計時器。此特性可用於控制裝置上的內建計時器，例如啟動新的計時器、暫停和取消執行中的計時器，以及詢問還剩多少時間。

裝置屬性

具有此特性的裝置可能會在 SYNC 作業中回報下列屬性。如要進一步瞭解如何處理 SYNC 意圖，請參閱意圖執行要求一文。

屬性	類型	說明
maxTimerLimitSec	整數	必填。 指出裝置最長的計時器設定，以秒為單位 (以秒為單位)。
commandOnlyTimer	布林	(預設：false) 指出裝置是否支援單向 (true) 或雙向 (false) 通訊。如果裝置無法回應此特徵的 QUERY 意圖或報告狀態，請將此屬性設為 true。

範例

裝置的時間上限為 2 小時。

{
  "maxTimerLimitSec": 7200
}

裝置狀態：STATE

具有此特性的裝置可能會在 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] 內)。

範例

執行裝置計時器達五分鐘。

{
  "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

裝置錯誤：ERRORS

請參閱錯誤和例外狀況的完整清單。