Skema Fitur Smart Home ArmDisarm
action.devices.traits.ArmDisarm
- Ciri 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 yang didukung perangkat. Jika atribut ini tidak dilaporkan, perangkat hanya mendukung satu tingkat. |
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 bisa jadi tidak mudah dipahami pengguna dan digunakan di semua bahasa. |
level_values |
Array |
Wajib. Berisi |
[item, ...] |
Objek |
Sinonim level untuk bahasa tertentu. Setidaknya satu item dengan nilai |
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. Setidaknya satu item dengan nilai |
lang |
String |
Wajib. Kode bahasa untuk sinonim level. Lihat Bahasa yang didukung. |
ordered |
Boolean |
Wajib. Jika disetel ke benar (true), tata bahasa tambahan untuk logika penambahan/pengurangan akan diterapkan, dalam urutan array tingkat. 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 aktivasi 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 lebih lanjut cara menangani intent QUERY
, lihat Fulfillment intent.
Negara bagian | Jenis | Deskripsi |
---|---|---|
isArmed |
Boolean |
Wajib. Menunjukkan apakah perangkat saat ini dipersenjatai. |
currentArmLevel |
String |
Wajib. Wajib jika atribut |
exitAllowance |
Bilangan Bulat |
Menunjukkan waktu, dalam detik, yang harus dilewati 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
Setel tingkat alarm perangkat ini.
Parameter
Payload berisi salah satu hal berikut:
Membatalkan operasi mengaktifkan atau menonaktifkan
Parameter | Jenis | Deskripsi |
---|---|---|
followUpToken |
String |
Token yang disediakan Google untuk respons lanjutan. |
arm |
Boolean |
Wajib. Benar (True) jika perintahnya adalah mengaktifkan. Gagal menonaktifkan. |
cancel |
Boolean |
Wajib. Benar jika perintahnya adalah membatalkan nilai |
Mengaktifkan atau menonaktifkan perangkat, dengan tingkat keamanan opsional.
Parameter | Jenis | Deskripsi |
---|---|---|
followUpToken |
String |
Token yang disediakan Google untuk respons lanjutan. |
arm |
Boolean |
Wajib. Benar (True) jika perintahnya adalah mengaktifkan. Gagal menonaktifkan. |
armLevel |
String |
|
Contoh
Mengaktifkan sistem
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "followUpToken": "123" } }
Menyetel sistem ke tingkat keamanan L1
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "L1", "followUpToken": "456" } }
Membatalkan operasi mempersenjatai
{ "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