Ti diamo il benvenuto nel Centro sviluppatori Google Home, la nuova destinazione per imparare a sviluppare azioni per la smart home. Nota:continuerai a creare azioni nella Console Actions.
Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Schema trattino armarma per la smart home

action.devices.traits.ArmDisarm: questa caratteristica supporta l'abilitazione e la disabilitazione nell'uso, ad esempio, nei sistemi di sicurezza.

Per i dispositivi con livelli di sicurezza multipli, questi livelli devono essere segnalati con l'attributo availableArmLevels.

ATTRIBUTE del dispositivo

I dispositivi con questa caratteristica potrebbero segnalare i seguenti attributi come parte dell'operazione SYNC. Per scoprire di più sulla gestione degli intent SYNC, consulta Soddisfazione degli intent.

Attributi Tipo Descrizione
availableArmLevels Oggetto

Descrive i livelli di sicurezza supportati del dispositivo. Se questo attributo non viene segnalato, 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 Stringa

Obbligatorio.

Il nome interno del livello di sicurezza utilizzato nei comandi e negli stati. Questo nome non è facile da usare ed è condiviso in tutte le lingue.

level_values Array

Obbligatorio.

Contiene level_synonym e lang.

[item, ...] Oggetto

Sinonimo del livello per una determinata lingua.

level_synonym Array

Obbligatorio.

Nomi facili da usare per il livello in ogni lingua supportata. Il primo elemento viene considerato come il nome canonico.

[item, ...] Stringa

Nome sinonimo.

lang Stringa

Obbligatorio.

Codice lingua per i sinonimi di livello. Vedi Lingue supportate.

ordered Booleano

Obbligatorio.

Se viene impostato su vero, vengono applicate regole grammaticali aggiuntive per l'aumento e la riduzione nell'ordine della matrice dei livelli. Ad esempio, "Hey Google, aumenta il mio livello di sicurezza di 1", l'assistente determina il livello di sicurezza attuale e poi aumenta quello di uno. Se questo valore è impostato su false, la grammatica aggiuntiva per la logica di aumento o diminuzione non è supportata.

Esempi

Sistema di sicurezza con due livelli di braccia 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
  }
}

STATEs dispositivo

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

Stati Tipo Descrizione
isArmed Booleano

Obbligatorio.

Indica se il dispositivo è attualmente abilitato.

currentArmLevel Stringa

Obbligatorio.

Obbligatorio se viene specificato l'attributo availableArmLevels. Se sono presenti più livelli di sicurezza, indica il nome del livello di sicurezza corrente.

exitAllowance Intero

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

Esempi

Sistema di sicurezza che segnala un livello di braccio 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 Soddisfazione degli intent.

action.devices.commands.ArmDisarm

Imposta il livello di sveglia di questo dispositivo.

Parametri

Il payload contiene uno dei seguenti valori:

Annulla l'operazione di attivazione o disattivazione

Parametri Tipo Descrizione
followUpToken Stringa

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

arm Booleano

Obbligatorio.

True quando il comando deve essere abilitato. Falso da disabilitare.

cancel Booleano

Obbligatorio.

True quando il comando deve annullare il valore arm.

Abilitare o disabilitare il dispositivo con un livello di sicurezza facoltativo.

Parametri Tipo Descrizione
followUpToken Stringa

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

arm Booleano

Obbligatorio.

True quando il comando deve essere abilitato. Falso da disabilitare.

armLevel Stringa

Il level_name a cui eseguire l'abilitazione.

Esempi

Abilitare il sistema

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

Impostare il sistema sul braccio L1

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

Annullare l'operazione di attivazione

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

Si è verificato un errore durante l'abilitazione o la disabilitazione del dispositivo.

Valori supportati:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

ERRORI del dispositivo

Consulta l'elenco completo degli errori e delle eccezioni.