Esquema de atributos ArmDisarm de la casa inteligente

action.devices.traits.ArmDisarm: Esta función admite la activación y desactivación, como se usa en, por ejemplo, los sistemas de seguridad.

En el caso de los dispositivos con varios niveles de seguridad, estos niveles se deben informar con el atributo availableArmLevels.

ATRIBUTOS del dispositivo

Los dispositivos con esta característica pueden informar los siguientes atributos como parte de la operación SYNC. Para obtener más información sobre cómo controlar intents SYNC, consulta Cómo entregar intents.

Atributos Tipo Descripción
availableArmLevels Objeto

Describe los niveles de seguridad admitidos del dispositivo. Si no se informa este atributo, el dispositivo solo admite un nivel.
levels Matriz

Obligatorio.

Es la lista de los niveles de seguridad disponibles que admite el dispositivo.
[item, ...] Objeto

Nivel de seguridad
level_name String

Obligatorio.

Es el nombre interno del nivel de seguridad que se usa en los comandos y estados. Este nombre no puede ser fácil de usar y se comparte en todos los idiomas.
level_values Matriz

Obligatorio.

Contiene level_synonym y lang.
[item, ...] Objeto

Es el sinónimo de nivel para un idioma determinado.
level_synonym Matriz

Obligatorio.

Nombres fáciles de usar para el nivel en cada idioma admitido. El primer elemento se considera el nombre canónico.
[item, ...] String

Es el nombre del sinónimo.
lang String

Obligatorio.

Código de idioma para los sinónimos de nivel. Consulta Idiomas admitidos.
ordered Booleano

Obligatorio.

Si se establece en verdadero, se aplica una gramática adicional para la lógica de aumento o disminución, en el orden del array de niveles. Por ejemplo, si dices "Hey Google, aumenta mi nivel de seguridad en 1", Asistente determinará el nivel de seguridad actual y, luego, lo aumentará en uno. Si este valor se establece en "false", no se admite la gramática adicional para la lógica de aumento o disminución.

Ejemplos

Sistema de seguridad con dos niveles de activación distintos

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

ESTADOS DEL DISPOSITIVO

Las entidades con esta característica pueden informar los siguientes estados como parte de la operación QUERY. Para obtener más información sobre cómo controlar intents QUERY, consulta Cómo entregar intents.

Estados Tipo Descripción
isArmed Booleano

Obligatorio.

Indica si el dispositivo está armado actualmente.
currentArmLevel String

Obligatorio.

Es obligatorio si se especifica el atributo availableArmLevels. Si existen varios niveles de seguridad, indica el nombre del nivel de seguridad actual.
exitAllowance Número entero

Indica el tiempo, en segundos, que debe salir el usuario para que currentArmLevel entre en vigencia.

Ejemplos

Sistema de seguridad que informa un nivel de activación distinto

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

COMANDOS del dispositivo

Los dispositivos con esta característica pueden responder a los siguientes comandos como parte de la operación EXECUTE. Para obtener más información sobre cómo controlar los intents EXECUTE, consulta Entrega de intents.

action.devices.commands.ArmDisarm

Establece el nivel de alarma de este dispositivo.

Parámetros

La carga útil contiene una de las siguientes opciones:

Cancela la operación de activación o desactivación

Parámetros Tipo Descripción
followUpToken String

Es el token que proporciona Google para la respuesta de seguimiento.
arm Booleano

Obligatorio.

Es verdadero cuando el comando es para activar. Falso para desactivar.
cancel Booleano

Obligatorio.

Es verdadero cuando el comando es cancelar el valor arm.

Activa o desactiva el dispositivo con un nivel de seguridad opcional.

Parámetros Tipo Descripción
followUpToken String

Es el token que proporciona Google para la respuesta de seguimiento.
arm Booleano

Obligatorio.

Es verdadero cuando el comando es activar. Falso para desarmar.
armLevel String

El level_name que se activará.

Ejemplos

Arma el sistema

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

Establece el sistema en el nivel de armado L1

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

Cómo cancelar la operación de armado

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

Se produjo un error cuando se armó o desarmó el dispositivo.

Valores admitidos:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

ERRORES DE DISPOSITIVO

Consulta la lista completa de errores y excepciones.