Esquema de la función de ArmDisarm de Smart Home

action.devices.traits.ArmDisarm: Esta característica admite la activación y la desactivación como se usa, por ejemplo, en 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 el manejo de intents SYNC, consulta Entrega de intents.

Atributos Tipo Descripción
availableArmLevels Objeto

Describe los niveles de seguridad compatibles con el dispositivo. Si no se informa este atributo, el dispositivo solo admite un nivel.

levels Matriz

Obligatorio.

Lista de los niveles de seguridad compatibles con el dispositivo.

[item, ...] Objeto

Nivel de seguridad.

level_name String

Obligatorio.

El nombre interno del nivel de seguridad que se usa en los comandos y estados. Este nombre puede ser poco fácil de usar y se comparte en todos los idiomas.

level_values Matriz

Obligatorio.

Contiene level_synonym y lang.

[item, ...] Objeto

Nivel sinónimo para un idioma determinado.

level_synonym Matriz

Obligatorio.

Nombres fáciles de usar para el nivel en cada idioma compatible. El primer elemento se trata como el nombre canónico.

[item, ...] String

Nombre del sinónimo.

lang String

Obligatorio.

Código de idioma para los sinónimos de nivel. Consulta Idiomas compatibles.

ordered Booleano

Obligatorio.

Si se establece como verdadera, se aplica una gramática adicional para la lógica de aumento o disminución, en el orden de la matriz de niveles. Por ejemplo, si dices "Hey Google, aumenta mi nivel de seguridad en 1", el Asistente determinará su nivel de seguridad actual y, luego, aumentará ese nivel en uno. Si este valor se establece como falso, no se admiten gramáticas adicionales para la lógica de aumento o disminución.

Ejemplos

Sistema de seguridad con dos niveles de brazos 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
  }
}

Dispositivo STATEs

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 el manejo de intents QUERY, consulta Entrega de intents.

Estados Tipo Descripción
isArmed Booleano

Obligatorio.

Indica si el dispositivo está activado actualmente.

currentArmLevel String

Obligatorio.

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 la hora, en segundos, que el usuario debe abandonar antes de que currentArmLevel entre en vigencia.

Ejemplos

Sistema de seguridad que informa el nivel de los grupos

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

Dispositivo COMMANDS

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 el manejo de 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 el brazo o desactiva el funcionamiento

Parámetros Tipo Descripción
followUpToken String

Token de Google para la respuesta de seguimiento.

arm Booleano

Obligatorio.

Verdadero cuando se activa el comando. Falso para desactivar.

cancel Booleano

Obligatorio.

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

Token de Google para la respuesta de seguimiento.

arm Booleano

Obligatorio.

Verdadero cuando se activa el comando. Falso para desactivar.

armLevel String

El level_name al que se activará.

Ejemplos

Activa el sistema

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

Configura el sistema para activar el nivel L1

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

Cancela la operación de activación

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

Se produjo un error al activar o desactivar el dispositivo.

Valores admitidos:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

Dispositivo ERRORS

Consulta la lista completa de errores y excepciones.