Skema Fitur ArmDisarm Smart Home

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 fitur ini dapat melaporkan atribut berikut sebagai bagian dari operasi SYNC. Untuk mempelajari lebih lanjut cara menangani SYNC intent, lihat Pemenuhan intent.

Atribut Jenis Deskripsi
availableArmLevels Objek

Menjelaskan tingkat keamanan perangkat yang didukung. 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 mungkin tidak mudah digunakan dan dibagikan di semua bahasa.
level_values Array

Wajib.

Berisi level_synonym dan lang.
[item, ...] Objek

Sinonim tingkat untuk bahasa tertentu. Setidaknya satu item dengan nilai lang en diperlukan untuk menyediakan penggantian bahasa.
level_synonym Array

Wajib.

Nama yang mudah digunakan untuk tingkat di setiap bahasa yang didukung. Item pertama diperlakukan sebagai nama kanonis.
[item, ...] String

Nama sinonim. Setidaknya satu item dengan nilai lang en diperlukan untuk menyediakan penggantian bahasa.
lang String

Wajib.

Kode bahasa untuk sinonim tingkat. Lihat Bahasa yang didukung.
ordered Boolean

Wajib.

Jika ditetapkan ke benar (true), tata bahasa tambahan untuk logika penambahan/pengurangan akan diterapkan, sesuai urutan array tingkat. Misalnya, "Ok Google, tingkatkan tingkat keamanan saya sebesar 1", akan menghasilkan Asisten yang menentukan tingkat keamanan saat ini, lalu meningkatkan tingkat keamanan tersebut sebesar satu. Jika nilai ini ditetapkan ke salah (false), tata bahasa tambahan untuk logika penambahan/pengurangan tidak akan didukung.

Contoh

Sistem keamanan dengan dua tingkat pengaktifan 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 fitur ini dapat melaporkan status berikut sebagai bagian dari operasi QUERY. Untuk mempelajari lebih lanjut cara menangani QUERY intent, lihat Pemenuhan intent.

Status Jenis Deskripsi
isArmed Boolean

Wajib.

Menunjukkan apakah perangkat saat ini aktif.
currentArmLevel String

Wajib.

Wajib jika atribut availableArmLevels ditentukan. Jika ada beberapa tingkat keamanan, menunjukkan nama tingkat keamanan saat ini.
exitAllowance Bilangan Bulat

Menunjukkan waktu, dalam detik, yang dimiliki pengguna untuk keluar sebelum currentArmLevel berlaku.

Contoh

Sistem keamanan yang melaporkan tingkat pengaktifan yang berbeda

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

PERINTAH Perangkat

Perangkat dengan fitur ini dapat merespons perintah berikut sebagai bagian dari operasi EXECUTE. Untuk mempelajari lebih lanjut cara menangani intent EXECUTE, lihat Pemenuhan intent.

action.devices.commands.ArmDisarm

Menetapkan 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 (true) jika perintahnya adalah mengaktifkan. Salah (false) untuk menonaktifkan.
cancel Boolean

Wajib.

Benar (true) jika perintahnya adalah membatalkan nilai arm.

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. Salah (false) untuk menonaktifkan.
armLevel String

level_name yang akan diaktifkan.

Contoh

Mengaktifkan 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
  }
}

Terjadi error saat mengaktifkan atau menonaktifkan perangkat.

Nilai yang didukung:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

ERROR Perangkat

Lihat daftar lengkap error dan pengecualian.