Схема параметров включения/отключения системы «Умный дом»

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

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

АТРИБУТЫ УСТРОЙСТВА

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

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

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

levels Множество

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

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

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

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

level_name Нить

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

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

level_values Множество

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

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

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

Уровень синонима для заданного языка. Для обеспечения резервного языка требуется как минимум один элемент со значением lang , равным en .

level_synonym Множество

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

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

[ item, ... ] Нить

Название синонима. Для обеспечения возможности выбора языка требуется как минимум один элемент со значением lang , равным en .

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 Логический

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

Возвращает true, если команда предназначена для отмены значения 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

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

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