Schéma Armitarm Trait pour maison connectée

action.devices.traits.ArmDisarm : cette caractéristique permet d'activer et de désactiver le système, par exemple dans les systèmes de sécurité.

Pour les appareils dotés de plusieurs niveaux de sécurité, ils doivent être indiqués avec l'attribut availableArmLevels.

ATTRIBUTS de l'appareil

Les appareils disposant de cette caractéristique peuvent signaler les attributs suivants lors de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Traitement des intents.

Attributs	Type	Description
availableArmLevels	Objet	Décrit les niveaux de sécurité de l'appareil. Si cet attribut n'est pas indiqué, l'appareil n'accepte qu'un seul niveau.
levels	Array	Obligatoire. Liste des niveaux de sécurité disponibles sur 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 n'est pas facile à utiliser et est partagé dans toutes les langues.
level_values	Array	Obligatoire. Contient level_synonym et lang.
[item, ...]	Objet	Synonyme de niveau pour une langue donnée.
level_synonym	Array	Obligatoire. Noms conviviaux du niveau dans chaque langue acceptée. Le premier élément est considéré comme le nom canonique.
[item, ...]	String	Nom du synonyme.
lang	String	Obligatoire. Code de langue des synonymes de niveau. Consultez la section Langues acceptées.
ordered	Booléen	Obligatoire. Si la valeur est définie sur "true", la grammaire supplémentaire pour la logique d'augmentation/de réduction s'applique, dans l'ordre du tableau des niveaux. Par exemple, si vous dites "Hey Google, augmente le niveau de sécurité de 1", l'Assistant détermine le niveau de sécurité actuel, puis augmente ce niveau de sécurité d'un. Si cette valeur est définie sur "false", la grammaire supplémentaire pour la logique d'augmentation/de diminution n'est pas disponible.

Exemples

Système de sécurité avec deux niveaux 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
  }
}

Appareil STATES

Les entités dotées de cette caractéristique peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez Traitement des intents.

États	Type	Description
isArmed	Booléen	Obligatoire. Indique si l'appareil est actuellement activé.
currentArmLevel	String	Obligatoire. Obligatoire si l'attribut availableArmLevels est spécifié. S'il existe plusieurs niveaux de sécurité, indique le nom du niveau de sécurité actuel.
exitAllowance	Entier	Indique le délai, en secondes, au terme duquel l'utilisateur doit quitter currentArmLevel.

Exemples

Système de sécurité indiquant un niveau de bras distinct

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

Appareil COMMANDS

Les appareils disposant de cette caractéristique 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 Traitement des intents.

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 "Activer le bras" ou "Désactiver"

Paramètres	Type	Description
followUpToken	String	Jeton fourni par Google pour la réponse de suivi.
arm	Booléen	Obligatoire. Vrai lorsque la commande doit être activée. Faux pour désactiver.
cancel	Booléen	Obligatoire. Vrai lorsque la commande consiste à annuler la valeur arm.

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	Booléen	Obligatoire. Vrai lorsque la commande doit être activée. Faux pour désactiver.
armLevel	String	level_name auquel activer.

Exemples

Activer le système

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

Règle le système sur le niveau L1

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

Annuler l'activation de l'activation

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

ERREURS sur l'appareil

Consultez la liste complète des erreurs et exceptions.