Schema della caratteristica ArmDisarm per la smart home

action.devices.traits.ArmDisarm: questa funzionalità supporta l'abilitazione e la disabilitazione come utilizzata, ad esempio, nei sistemi di sicurezza.

Per i dispositivi con più livelli di sicurezza, questi livelli devono essere registrati con l'attributo availableArmLevels.

ATTRIBUTI del dispositivo

I dispositivi con questa caratteristica possono segnalare i seguenti attributi nell'ambito dell'operazione SYNC. Per scoprire di più sulla gestione degli intent SYNC, consulta Adempimento degli intent.

Attributi Tipo Descrizione
availableArmLevels Oggetto

Descrive i livelli di sicurezza supportati del dispositivo. Se questo attributo non viene registrato, il dispositivo supporta un solo livello.
levels Array

Obbligatorio.

Elenco dei livelli di sicurezza disponibili supportati dal dispositivo.
[item, ...] Oggetto

Livello di sicurezza.
level_name String

Obbligatorio.

Il nome interno del livello di sicurezza utilizzato nei comandi e negli stati. Questo nome può non essere user-friendly ed è condiviso in tutte le lingue.
level_values Array

Obbligatorio.

Contiene level_synonym e lang.
[item, ...] Oggetto

Sinonimo di livelli per una determinata lingua.
level_synonym Array

Obbligatorio.

Nomi facili da ricordare per il livello in ogni lingua supportata. Il primo elemento viene considerato come il nome canonico.
[item, ...] String

Nome del sinonimo.
lang String

Obbligatorio.

Codice lingua per i sinonimi del livello. Consulta la sezione Lingue supportate.
ordered Valore booleano

Obbligatorio.

Se il valore è impostato su true, viene applicata una grammatica aggiuntiva per la logica di aumento/diminuzione, nell'ordine dell'array dei livelli. Ad esempio, "Hey Google, aumenta il mio livello di sicurezza di 1" fa sì che l'assistente determini il livello di sicurezza attuale e lo aumenti di 1. Se questo valore è impostato su false, la grammatica aggiuntiva per la logica di aumento/diminuzione non è supportata.

Esempi

Sistema di sicurezza con due livelli di attivazione distinti

{
  "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
  }
}

STATI del dispositivo

Le entità con questo attributo possono segnalare i seguenti stati nell'ambito dell'operazione QUERY. Per scoprire di più sulla gestione degli intent QUERY, consulta Completamento dell'intent.

Stati Tipo Descrizione
isArmed Valore booleano

Obbligatorio.

Indica se il dispositivo è attualmente abilitato.
currentArmLevel String

Obbligatorio.

Obbligatorio se è specificato l'attributo availableArmLevels. Se esistono più livelli di sicurezza, indica il nome del livello di sicurezza corrente.
exitAllowance Intero

Indica il tempo, in secondi, che l'utente deve attendere prima che currentArmLevel venga applicato.

Esempi

Sistema di sicurezza che segnala un livello di attivazione distinto

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

COMANDI del dispositivo

I dispositivi con questa caratteristica possono rispondere ai seguenti comandi nell'ambito dell'operazione EXECUTE. Per scoprire di più sulla gestione degli intent EXECUTE, consulta Adempimento degli intent.

action.devices.commands.ArmDisarm

Imposta il livello di sveglia di questo dispositivo.

Parametri

Il payload contiene uno dei seguenti elementi:

Annulla l'operazione di abilitazione o disabilitazione

Parametri Tipo Descrizione
followUpToken String

Token fornito da Google per la risposta di follow-up.
arm Valore booleano

Obbligatorio.

True quando il comando è di abilitare l'antifurto. False per disarmare.
cancel Valore booleano

Obbligatorio.

True se il comando deve annullare il valore arm.

Attiva o disattiva il sistema con un livello di sicurezza facoltativo.

Parametri Tipo Descrizione
followUpToken String

Token fornito da Google per la risposta di follow-up.
arm Valore booleano

Obbligatorio.

True quando il comando è di abilitare l'antifurto. Il sistema è falso per disabilitare il sistema.
armLevel String

Il level_name da abilitare.

Esempi

Attivare l'impianto

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "followUpToken": "123"
  }
}

Imposta il sistema sul livello di abilitazione L1

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "armLevel": "L1",
    "followUpToken": "456"
  }
}

Annullare l'operazione di abilitazione

{
  "command": "action.devices.commands.ArmDisarm",
  "params": {
    "arm": true,
    "cancel": true
  }
}

Si è verificato un errore durante l'attivazione o la disattivazione del dispositivo.

Valori supportati:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

ERRORI del dispositivo

Consulta l'elenco completo di errori ed eccezioni.