สคีมาของ HomeDisarm Trait ของ Smart Home
action.devices.traits.ArmDisarm
- ลักษณะเฉพาะนี้รองรับการเปิดระบบและปิดใช้ระบบต่างๆ อย่างเช่นระบบรักษาความปลอดภัย
สําหรับอุปกรณ์ที่มีระดับความปลอดภัยหลายระดับ ควรรายงานระดับเหล่านี้ด้วยแอตทริบิวต์ availableArmLevels
แอตทริบิวต์อุปกรณ์
อุปกรณ์ที่มีลักษณะเฉพาะนี้อาจรายงานแอตทริบิวต์ต่อไปนี้เป็นส่วนหนึ่งของการดําเนินการ SYNC
ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดการ Intent ของ SYNC
ได้ที่การดําเนินการตามความตั้งใจ
แอตทริบิวต์ | ประเภท | คำอธิบาย |
---|---|---|
availableArmLevels |
วัตถุ |
อธิบายระดับความปลอดภัยที่รองรับของอุปกรณ์ หากไม่รายงานแอตทริบิวต์นี้ อุปกรณ์จะรองรับเพียงระดับเดียวเท่านั้น |
levels |
อาร์เรย์ |
ต้องระบุ รายการระดับความปลอดภัยที่ใช้ได้ซึ่งอุปกรณ์รองรับ |
[item, ...] |
วัตถุ |
ระดับความปลอดภัย |
level_name |
สตริง |
ต้องระบุ ชื่อภายในของระดับความปลอดภัยที่ใช้ในคําสั่งและสถานะ ชื่อนี้อาจใช้งานยากและแชร์ได้ในทุกภาษา |
level_values |
อาร์เรย์ |
ต้องระบุ มี |
[item, ...] |
วัตถุ |
คําพ้องความหมายของภาษาที่ระบุ |
level_synonym |
อาร์เรย์ |
ต้องระบุ ชื่อที่ใช้ง่ายสําหรับระดับในแต่ละภาษาที่รองรับ รายการแรกจะถือเป็นชื่อ Canonical |
[item, ...] |
สตริง |
ชื่อคําพ้องความหมาย |
lang |
สตริง |
ต้องระบุ รหัสภาษาสําหรับคําพ้องความหมายระดับ ดูภาษาที่รองรับ |
ordered |
บูลีน |
ต้องระบุ หากตั้งค่าเป็น "จริง" ระบบจะใช้ไวยากรณ์เพิ่มเติมสําหรับตรรกะการเพิ่ม/ลดตามลําดับของอาร์เรย์ระดับ ตัวอย่างเช่น "Ok Google เพิ่มระดับความปลอดภัยเป็น 1" ทําให้ Assistant ตั้งระดับความปลอดภัยปัจจุบันได้ แล้วเพิ่มระดับความปลอดภัยนั้นอีก 1 ระดับ หากตั้งค่านี้เป็น "เท็จ" ระบบจะไม่รองรับไวยากรณ์เพิ่มเติมสําหรับตรรกะการเพิ่ม/ลด |
ตัวอย่าง
ระบบรักษาความปลอดภัยที่มี 2 ระดับแตกต่างกัน
{ "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
ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดการ Intent ของ QUERY
ได้ที่การดําเนินการตามความตั้งใจ
รัฐ | ประเภท | คำอธิบาย |
---|---|---|
isArmed |
บูลีน |
ต้องระบุ ระบุว่าอุปกรณ์เปิดอยู่หรือไม่ |
currentArmLevel |
สตริง |
ต้องระบุ ต้องระบุหากระบุแอตทริบิวต์ |
exitAllowance |
จำนวนเต็ม |
ระบุเวลาเป็นวินาทีที่ผู้ใช้ต้องออกจากก่อนที่ |
ตัวอย่าง
ระบบรักษาความปลอดภัยที่รายงานระดับแขนที่แตกต่าง
{ "isArmed": true, "currentArmLevel": "L1" }
คําสั่งของอุปกรณ์
อุปกรณ์ที่มีลักษณะเฉพาะนี้อาจตอบสนองต่อคําสั่งต่อไปนี้ซึ่งเป็นส่วนหนึ่งของการดําเนินการ EXECUTE
ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดการ Intent ของ EXECUTE
ได้ที่การดําเนินการตามความตั้งใจ
action.devices.commands.ArmDisarm
ตั้งค่าระดับการปลุกของอุปกรณ์นี้
พารามิเตอร์
เพย์โหลดมีองค์ประกอบอย่างใดอย่างหนึ่งต่อไปนี้
ยกเลิกการเปิดและปิดระบบป้องกัน
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
followUpToken |
สตริง |
โทเค็นที่ Google มีให้สําหรับการตอบกลับติดตามผล |
arm |
บูลีน |
ต้องระบุ เป็นจริงเมื่อคําสั่งเริ่มทํางาน เท็จที่จะปิดระบบ |
cancel |
บูลีน |
ต้องระบุ เป็นจริงเมื่อคําสั่งคือการยกเลิกค่า |
เปิดหรือปิดระบบป้องกันอุปกรณ์ด้วยระดับความปลอดภัยที่ไม่บังคับ
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
followUpToken |
สตริง |
โทเค็นที่ Google มีให้สําหรับการตอบกลับติดตามผล |
arm |
บูลีน |
ต้องระบุ เป็นจริงเมื่อคําสั่งเริ่มทํางาน เท็จที่จะปิดระบบ |
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