Schema del tratto ArmDisarm di Smart Home
action.devices.traits.ArmDisarm
: questa caratteristica supporta l'abilitazione e la disabilitazione come, ad esempio, nei sistemi di sicurezza.
Per i dispositivi con più livelli di livelli di sicurezza, questi livelli devono essere segnalati con l'attributo availableArmLevels
.
ATTRIBUTE dispositivo
I dispositivi con questo trattino potrebbero segnalare i seguenti
attributi come parte dell'operazione SYNC
. Per saperne di più sulla gestione degli intent SYNC
, consulta la sezione fulfillment di intent.
Attributi | Tipo | Descrizione |
---|---|---|
availableArmLevels |
Oggetto |
Descrive i livelli di sicurezza supportati del dispositivo. Se non viene segnalato questo attributo, 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 non è facile da usare e viene condiviso in tutte le lingue. |
level_values |
Array |
Obbligatorio. Contiene |
[item, ...] |
Oggetto |
Sinonimo di 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, ...] |
String |
Nome sinonimo. |
lang |
String |
Obbligatorio. Codice lingua per i sinonimi di livello. Vedi Lingue supportate. |
ordered |
Booleano |
Obbligatorio. Se impostato su true, si applica una grammatica aggiuntiva per la logica di aumento/diminuzione, nell'ordine della matrice di livelli. Ad esempio, "Hey Google, aumenta il mio livello di sicurezza di 1", l'assistente determina l'attuale livello di sicurezza e poi aumenta il livello di sicurezza 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 braccioli 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 } }
STATO dispositivo
Le entità con questa caratteristica possono segnalare i seguenti
stati nell'ambito dell'operazione QUERY
, Per saperne di più sulla gestione degli intent QUERY
, consulta la sezione fulfillment di intent.
Stati | Tipo | Descrizione |
---|---|---|
isArmed |
Booleano |
Obbligatorio. Indica se il dispositivo è attualmente abilitato. |
currentArmLevel |
String |
Obbligatorio. Obbligatorio se viene specificato l'attributo |
exitAllowance |
Intero |
Indica il tempo, in secondi, in cui l'utente deve uscire prima che |
Esempi
Sistema di sicurezza che segnala livelli di braccio distinti
{ "isArmed": true, "currentArmLevel": "L1" }
COMANDI dispositivo
I dispositivi con questo trattino potrebbero rispondere ai seguenti
comandi nell'ambito dell'operazione EXECUTE
. Per saperne di più sulla gestione degli intent EXECUTE
, consulta la sezione fulfillment di intent.
action.devices.commands.ArmDisarm
Imposta il livello di allarme di questo dispositivo.
Parametri
Il payload contiene uno dei seguenti valori:
Annullare l'operazione di braccio o disabilitazione
Parametri | Tipo | Descrizione |
---|---|---|
followUpToken |
String |
Token fornito da Google per il follow-up. |
arm |
Booleano |
Obbligatorio. True quando il comando deve essere abilitato. Falso per il disabilitazione. |
cancel |
Booleano |
Obbligatorio. True quando il comando serve per annullare il valore |
Abilitare o disabilitare il dispositivo con un livello di sicurezza facoltativo.
Parametri | Tipo | Descrizione |
---|---|---|
followUpToken |
String |
Token fornito da Google per il follow-up. |
arm |
Booleano |
Obbligatorio. True quando il comando deve essere abilitato. Falso per il disabilitazione. |
armLevel |
String |
Devi abilitare |
Esempi
Abilita il sistema
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "followUpToken": "123" } }
Impostare il sistema sul livello L1 del braccio
{ "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 } }
Errori correlati
Si è verificato un errore durante l'abilitazione o la disabilitazione del dispositivo.
Valori supportati:
alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled