Schéma du trait Smart Home ArmDisarm
action.devices.traits.ArmDisarm
: ce trait permet d'armer et de désarmer un système, comme un système de sécurité.
Pour les appareils comportant plusieurs niveaux de sécurité, ces niveaux doivent être indiqués avec l'attribut availableArmLevels
.
ATTRIBUTS de l'appareil
Les appareils dotés de ce trait peuvent signaler les attributs suivants dans le cadre de l'opération SYNC
. Pour en savoir plus sur la gestion des intents SYNC
, consultez Fulfillment d'intent.
Attributs | Type | Description |
---|---|---|
availableArmLevels |
Objet |
Décrit les niveaux de sécurité compatibles de l'appareil. Si cet attribut n'est pas indiqué, l'appareil n'est compatible qu'avec un seul niveau. |
levels |
Array |
Obligatoire. Liste des niveaux de sécurité disponibles acceptés par l'appareil. |
[item, ...] |
Objet |
Niveau de sécurité. |
level_name |
String |
Obligatoire. Nom interne du niveau de sécurité utilisé dans les commandes et les états. Ce nom peut ne pas être facile à retenir pour les utilisateurs et est partagé dans toutes les langues. |
level_values |
Array |
Obligatoire. Contient |
[item, ...] |
Objet |
Synonyme de niveau pour une langue donnée. Au moins un élément avec une valeur |
level_synonym |
Array |
Obligatoire. Noms conviviaux pour le niveau dans chaque langue disponible. Le premier élément est considéré comme le nom canonique. |
[item, ...] |
String |
Nom du synonyme. Au moins un élément avec une valeur |
lang |
String |
Obligatoire. Code de langue pour les synonymes de niveau. Consultez Langues acceptées. |
ordered |
Valeur booléenne |
Obligatoire. Si la valeur est définie sur "true", une grammaire supplémentaire s'applique à la logique d'augmentation/diminution, dans l'ordre du tableau des niveaux. Par exemple, si vous dites "Hey Google, augmente mon niveau de sécurité de 1", l'Assistant détermine le niveau de sécurité actuel, puis l'augmente de 1. Si cette valeur est définie sur "false", la grammaire supplémentaire pour la logique d'augmentation/diminution n'est pas prise en charge. |
Exemples
Système de sécurité avec deux niveaux d'activation distincts
{ "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 } }
ÉTATS des appareils
Les entités dotées de ce trait peuvent signaler les états suivants dans le cadre de l'opération QUERY
. Pour en savoir plus sur la gestion des intents QUERY
, consultez Fulfillment d'intent.
États | Type | Description |
---|---|---|
isArmed |
Valeur booléenne |
Obligatoire. Indique si l'appareil est actuellement armé. |
currentArmLevel |
String |
Obligatoire. Obligatoire si l'attribut |
exitAllowance |
Entier |
Indique le temps, en secondes, que l'utilisateur doit attendre avant que |
Exemples
Système de sécurité qui indique un niveau d'activation distinct
{ "isArmed": true, "currentArmLevel": "L1" }
COMMANDES de l'appareil
Les appareils dotés de ce trait peuvent répondre aux commandes suivantes dans le cadre de l'opération EXECUTE
. Pour en savoir plus sur la gestion des intents EXECUTE
, consultez Fulfillment d'intent.
action.devices.commands.ArmDisarm
Définissez le niveau d'alarme de cet appareil.
Paramètres
La charge utile contient l'un des éléments suivants :
Annuler l'opération d'activation ou de désactivation
Paramètres | Type | Description |
---|---|---|
followUpToken |
String |
Jeton fourni par Google pour la réponse de suivi. |
arm |
Valeur booléenne |
Obligatoire. Vrai lorsque la commande consiste à armer. Faux pour désactiver. |
cancel |
Valeur booléenne |
Obligatoire. True lorsque la commande consiste à annuler la valeur |
Activez ou désactivez l'appareil, avec un niveau de sécurité facultatif.
Paramètres | Type | Description |
---|---|---|
followUpToken |
String |
Jeton fourni par Google pour la réponse de suivi. |
arm |
Valeur booléenne |
Obligatoire. Vrai lorsque la commande consiste à armer. Faux pour désactiver. |
armLevel |
String |
Le |
Exemples
Activer le système
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "followUpToken": "123" } }
Régler le système sur le niveau d'activation L1
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "L1", "followUpToken": "456" } }
Annuler l'opération d'armement
{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "cancel": true } }
Erreurs associées
Une erreur s'est produite lors de l'activation ou de la désactivation de l'appareil.
Valeurs acceptées :
alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled