智慧型住宅 ArmDisarm Trait 結構定義

action.devices.traits.ArmDisarm - 此特性支援啟動和解除功能，例如保全系統。

如果裝置有多個安全等級，請使用 availableArmLevels 屬性回報這些層級。

裝置屬性

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

屬性 類型 說明
availableArmLevels 物件

說明裝置支援的安全等級。如果未提交這個屬性，裝置就只能使用一個層級。
levels 陣列

必要。

裝置支援的安全性等級清單。
[item, ...] 物件

安全等級
level_name String

必要。

指令與狀態中使用的安全性內部名稱。這個名稱可能不容易使用，而且會由所有語言共用。
level_values 陣列

必要。

包含 level_synonym 和 lang。
[item, ...] 物件

指定語言的同義詞。
level_synonym 陣列

必要。

等級中每個語言支援的語言，使用者容易理解的名稱。系統會將第一個項目視為標準名稱。
[item, ...] String

同義詞名稱。
lang String

必要。

層級同義詞的語言代碼。請參閱「支援的語言」。
ordered 布林

必要。

設為 true 時，系統會按照關卡陣列的順序，套用增加/減少邏輯的其他文法。例如，說出「Ok Google，將我的安全等級提高 1」之後，Google 助理就會判定目前的安全等級，再增加相應的安全等級。如果這個值設為 false，則不支援提高/減少邏輯的其他文法。

範例

具有兩個不同手臂的保全系統

{
  "availableArmLevels": {
    "levels": [
      {
        "level_name": "L1",
        "level_values": [
          {
            "level_synonym": [
              "Home and Guarding",
              "SL1"
            ],
            "lang": "en"
          },
          {
            "level_synonym": [
              "Zuhause und Bewachen",
              "SL1"
            ],
            "lang": "de"
          }
        ]
      },
      {
        "level_name": "L2",
        "level_values": [
          {
            "level_synonym": [
              "Away and Guarding",
              "SL2"
            ],
            "lang": "en"
          },
          {
            "level_synonym": [
              "Weg und Bewachen",
              "SL2"
            ],
            "lang": "de"
          }
        ]
      }
    ],
    "ordered": true
  }
}

裝置狀態

具有這個特性的實體可能會在 QUERY 作業中回報下列狀態。如要進一步瞭解如何處理 QUERY 意圖，請參閱意圖執行要求。

州 類型 說明
isArmed 布林

必要。

指出裝置目前是否在啟動。
currentArmLevel String

必要。

如果已指定 availableArmLevels 屬性，則為必要屬性。如果有多個安全性修補程式等級，請指明目前的安全等級名稱。
exitAllowance 整數

表示使用者必須先離開時間 (以秒為單位)，currentArmLevel 才會生效。

範例

回報不同手臂層級的安全系統

{
  "isArmed": true,
  "currentArmLevel": "L1"
}

裝置指令

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

action.devices.commands.ArmDisarm

設定這部裝置的鬧鐘音量。

參數

酬載包含下列內容：

取消實驗組或實驗組

參數 類型 說明
followUpToken String

Google 提供的後續追蹤權杖。
arm 布林

必要。

指令在實驗組時則為 True。解除即可。
cancel 布林

必要。

如果有指令取消 arm 值時，則傳回 True。

以選用的安全性修補程式等級啟動或解除裝置配對。

參數 類型 說明
followUpToken String

Google 提供的後續追蹤權杖。
arm 布林

必要。

指令在實驗組時則為 True。解除即可。
armLevel String

level_name 的選單到底。

範例

啟動系統

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "followUpToken": "123"
  }
}

將系統設定為第 1 級實驗組

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "armLevel": "L1",
    "followUpToken": "456"
  }
}

取消實驗組

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "cancel": true
  }
}

啟動或解除裝置時發生錯誤。

支援的值：

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

裝置 ERRORS

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