Схема признаков умного дома ArmDisarm

action.devices.traits.ArmDisarm — этот трейт поддерживает постановку и снятие с охраны, как это используется, например, в системах безопасности.

Для устройств с несколькими уровнями безопасности эти уровни должны сообщаться с помощью атрибута availableArmLevels .

АТРИБУТЫ устройства

Устройства с этой чертой могут сообщать о следующих атрибутах как часть операции SYNC . Дополнительные сведения об обработке намерений SYNC см. в разделе Выполнение намерений .

Атрибуты Тип Описание
availableArmLevels Объект

Описывает поддерживаемые уровни безопасности устройства. Если этот атрибут не указан, устройство поддерживает только один уровень.

levels Множество

Необходимый.

Список доступных уровней безопасности, поддерживаемых устройством.

[ item, ... ] Объект

Уровень безопасности.

level_name Нить

Необходимый.

Внутреннее имя уровня безопасности, которое используется в командах и состояниях. Это имя может быть неудобным для пользователя и используется на всех языках.

level_values Множество

Необходимый.

Содержит level_synonym и lang .

[ item, ... ] Объект

Синоним уровня для данного языка.

level_synonym Множество

Необходимый.

Удобные названия уровней на каждом поддерживаемом языке. Первый элемент рассматривается как каноническое имя.

[ item, ... ] Нить

Синоним имени.

lang Нить

Необходимый.

Код языка для синонимов уровня. См. Поддерживаемые языки .

ordered логический

Необходимый.

Если установлено значение true, применяется дополнительная грамматика для логики увеличения/уменьшения в порядке массива уровней. Например, «Окей, Google, повысь мой уровень безопасности на 1» приводит к тому, что Помощник определяет текущий уровень безопасности, а затем увеличивает этот уровень безопасности на единицу. Если для этого значения задано значение false, дополнительная грамматика для логики увеличения/уменьшения не поддерживается.

Примеры

Система безопасности с двумя отдельными уровнями рук

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

СОСТОЯНИЯ устройства

Сущности с этим признаком могут сообщать о следующих состояниях как часть операции QUERY . Дополнительные сведения об обработке намерений QUERY см. в разделе Выполнение намерений .

состояния Тип Описание
isArmed логический

Необходимый.

Указывает, поставлено ли устройство в настоящее время на охрану.

currentArmLevel Нить

Необходимый.

Требуется, если указан атрибут availableArmLevels . Если существует несколько уровней безопасности, указывает имя текущего уровня безопасности.

exitAllowance Целое число

Указывает время в секундах, которое пользователь должен покинуть, прежде чем currentArmLevel вступит в силу.

Примеры

Система безопасности, которая сообщает об определенном уровне руки

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

КОМАНДЫ устройства

Устройства с этой чертой могут отвечать на следующие команды как часть операции EXECUTE . Дополнительные сведения об обработке намерений EXECUTE см. в разделе Выполнение намерений .

action.devices.commands.ArmDisarm

Установите уровень сигнала тревоги этого устройства.

Параметры

Полезная нагрузка содержит одно из следующего:

Отменить постановку или снятие с охраны

Параметры Тип Описание
followUpToken Нить

Предоставленный Google токен для последующего ответа.

arm логический

Необходимый.

Истинно, когда команда состоит в том, чтобы взяться за оружие. Ложь для разоружения.

cancel логический

Необходимый.

Истинно, когда команда должна отменить значение arm .

Поставьте или снимите устройство с охраны с дополнительным уровнем безопасности.

Параметры Тип Описание
followUpToken Нить

Предоставленный Google токен для последующего ответа.

arm логический

Необходимый.

Истинно, когда команда состоит в том, чтобы взяться за оружие. Ложь для разоружения.

armLevel Нить

level_name для постановки на охрану.

Примеры

Включите систему

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

Установите систему на уровень охраны L1.

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

Отменить постановку на охрану

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

Произошла ошибка при постановке или снятии устройства с охраны.

Поддерживаемые значения:

alreadyInState
deviceTampered
passphraseIncorrect
pinIncorrect
securityRestriction
tooManyFailedAttempts
userCancelled

ОШИБКИ устройства

См. полный список ошибок и исключений .