Skema Smart Home ArmDisarm Trait
action.devices.traits.ArmDisarm
- Fitur ini mendukung pengaktifan dan penonaktifan seperti yang digunakan dalam, misalnya, sistem keamanan.
Untuk perangkat dengan beberapa tingkat keamanan, tingkat ini harus dilaporkan dengan
atribut availableArmLevels
.
ATRIBUT Perangkat
Perangkat dengan karakteristik ini dapat melaporkan atribut berikut
sebagai bagian dari operasi SYNC
. Untuk mempelajari
lebih lanjut cara menangani intent SYNC
, lihat
Fulfillment intent.
Atribut | Jenis | Deskripsi |
---|---|---|
availableArmLevels |
Objek |
Menjelaskan tingkat keamanan perangkat yang didukung. Jika atribut ini tidak dilaporkan, perangkat hanya mendukung satu level. |
levels |
Array |
Wajib. Daftar tingkat keamanan yang tersedia dan didukung oleh perangkat. |
[item, ...] |
Objek |
Tingkat keamanan. |
level_name |
String |
Wajib. Nama internal tingkat keamanan yang digunakan dalam perintah dan status. Nama ini mungkin tidak mudah digunakan dan dibagikan dalam semua bahasa. |
level_values |
Array |
Wajib. Berisi |
[item, ...] |
Objek |
Sinonim level untuk bahasa tertentu. |
level_synonym |
Array |
Wajib. Nama yang mudah digunakan untuk level dalam setiap bahasa yang didukung. Item pertama diperlakukan sebagai nama kanonis. |
[item, ...] |
String |
Nama sinonim. |
lang |
String |
Wajib. Kode bahasa untuk sinonim level. Lihat Bahasa yang didukung. |
ordered |
Boolean |
Wajib. Jika disetel ke true, tata bahasa tambahan untuk logika peningkatan/penurunan akan diterapkan, dalam urutan array level. Misalnya, "Ok Google, tingkatkan tingkat keamanan saya sebesar 1", akan membuat Asisten menentukan tingkat keamanan saat ini, lalu meningkatkan tingkat keamanan tersebut sebesar satu. Jika nilai ini disetel ke salah (false), tata bahasa tambahan untuk logika peningkatan/penurunan tidak didukung. |
Contoh
Sistem keamanan dengan dua tingkat grup yang berbeda
{ "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 } }
Status PERANGKAT
Entitas dengan karakteristik ini dapat melaporkan status
berikut sebagai bagian dari operasi QUERY
. Untuk mempelajari
penanganan intent QUERY
lebih lanjut, lihat
fulfillment intent.
Negara bagian | Jenis | Deskripsi |
---|---|---|
isArmed |
Boolean |
Wajib. Menunjukkan apakah perangkat saat ini aktif. |
currentArmLevel |
String |
Wajib. Wajib jika atribut |
exitAllowance |
Bilangan Bulat |
Menunjukkan waktu, dalam detik, yang harus dihabiskan pengguna sebelum |
Contoh
Sistem keamanan yang melaporkan tingkat aktivasi yang berbeda
{ "isArmed": true, "currentArmLevel": "L1" }
Perintah Perangkat
Perangkat dengan karakteristik ini dapat merespons perintah
berikut sebagai bagian dari operasi EXECUTE
. Untuk mempelajari
lebih lanjut cara menangani intent EXECUTE
, lihat
Fulfillment intent.
action.devices.commands.ArmDisarm
Tetapkan tingkat alarm perangkat ini.
Parameter
Payload berisi salah satu hal berikut:
Membatalkan operasi pengaktifan atau penonaktifan
Parameter | Jenis | Deskripsi |
---|---|---|
followUpToken |
String |
Token yang disediakan Google untuk respons lanjutan. |
arm |
Boolean |
Wajib. Benar jika perintahnya adalah mengaktifkan. Salah untuk melumpuhkan. |
cancel |
Boolean |
Wajib. Benar jika perintahnya adalah membatalkan nilai |
Aktifkan atau nonaktifkan perangkat, dengan tingkat keamanan opsional.
Parameter | Jenis | Deskripsi |
---|---|---|
followUpToken |
String |
Token yang disediakan Google untuk respons lanjutan. |
arm |
Boolean |
Wajib. Benar jika perintahnya adalah mengaktifkan. Salah untuk menonaktifkan. |
armLevel |
String |
|
Contoh
Membekali sistem
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "followUpToken": "123" } }
Menetapkan sistem ke tingkat pengaktifan L1
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "L1", "followUpToken": "456" } }
Membatalkan operasi pengaktifan
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "cancel": true } }
Error terkait
Terjadi error saat mengaktifkan atau menonaktifkan perangkat.
Nilai yang didukung:
alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled