Smart Home ArmDisarm Trait 結構定義
action.devices.traits.ArmDisarm
- 這類特性支援穿戴式裝置,例如用於保全系統的武裝和解除武器。
如果裝置有多個安全等級,請使用 availableArmLevels
屬性回報這些等級。
裝置屬性
具有此特性的裝置可能會在 SYNC
作業中回報下列屬性。如要進一步瞭解如何處理 SYNC
意圖,請參閱意圖執行要求一文。
屬性 | 類型 | 說明 |
---|---|---|
availableArmLevels |
物件 |
說明裝置支援的安全性等級。如果沒有回報這個屬性,裝置就只能支援一個層級。 |
levels |
陣列 |
必填。 裝置支援的安全等級清單。 |
[item, ...] |
物件 |
安全層級。 |
level_name |
字串 |
必填。 指令和狀態中使用的安全性層級內部名稱。此名稱不容易理解,且適用於所有語言。 |
level_values |
陣列 |
必填。 包含 |
[item, ...] |
物件 |
特定語言的層級同義詞。 |
level_synonym |
陣列 |
必填。 以各種支援語言表示使用者的層級名稱。系統會將第一個項目視為標準名稱。 |
[item, ...] |
字串 |
同義詞名稱。 |
lang |
字串 |
必填。 層級同義詞的語言代碼。請參閱支援的語言。 |
ordered |
布林 |
必填。 設為 true 時,系統會依照等級陣列的順序將增加/減少邏輯增加的文法。例如,「Ok Google,將我的安全等級調高 1」後,Google 助理會判定目前的安全等級,再調高安全等級 1。如果將這個值設為 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 } }
裝置狀態:STATE
具有此特性的實體可能會在 QUERY
作業中回報下列狀態。如要進一步瞭解如何處理 QUERY
意圖,請參閱意圖執行要求一文。
州 | 類型 | 說明 |
---|---|---|
isArmed |
布林 |
必填。 指出裝置目前是否啟動。 |
currentArmLevel |
字串 |
必填。 如果指定了 |
exitAllowance |
整數 |
表示使用者需要在 |
範例
回報不同實驗組層級的安全系統
{ "isArmed": true, "currentArmLevel": "L1" }
裝置指令
具有此特性的裝置可能會在 EXECUTE
作業中回應下列指令。如要進一步瞭解如何處理 EXECUTE
意圖,請參閱意圖執行要求一文。
action.devices.commands.ArmDisarm
設定這部裝置的鬧鐘等級。
參數
酬載包含下列其中一個值:
取消手臂或拆卸作業
參數 | 類型 | 說明 |
---|---|---|
followUpToken |
字串 |
Google 提供的後續追蹤權杖。 |
arm |
布林 |
必填。 指令設為 rm 時為 true。設為 False 即可解除。 |
cancel |
布林 |
必填。 當指令取消 |
設置或解除安全等級,可選擇是否提供安全等級。
參數 | 類型 | 說明 |
---|---|---|
followUpToken |
字串 |
Google 提供的後續追蹤權杖。 |
arm |
布林 |
必填。 指令設為 rm 時為 true。設為 False 即可解除。 |
armLevel |
字串 |
要啟動的 |
範例
啟動系統
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "followUpToken": "123" } }
將系統設為實驗組 L1
{ "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