scenario_button

Обновлено 30 августа 2023

Сценарная кнопка — устройство, которое умеет запускать сценарии умного дома. Сценарная кнопка физически оснащается одной или несколькими кнопками, каждая из них может реагировать на разные типы нажатий: однократное, двукратное, долгое. На каждый тип нажатия пользователь может назначить сценарий или команду управления устройствами умного дома.

Доступные функции устройства

У устройства могут быть все нижеперечисленные функции или только часть из них. Например, если сценарная кнопка кнопка оборудована только одной физической кнопкой, функции button_1_event, button_2_event и др. указывать не нужно.

Для сценарной кнопки обязательно должна быть описана функция online, а также как минимум одна функция нажатия на кнопку.

Функция	Обязательная?	Описание
battery_low_power		Разряжена ли батарея или нет
battery_percentage		Уровень заряда батареи
button_event		Нажатие на кнопку
button_1_event		Нажатие на первую кнопку
button_2_event		Нажатие на вторую кнопку
button_3_event		Нажатие на третью кнопку
button_4_event		Нажатие на четвертую кнопку
button_5_event		Нажатие на пятую кнопку
button_6_event		Нажатие на шестую кнопку
button_7_event		Нажатие на седьмую кнопку
button_8_event		Нажатие на восьмую кнопку
button_9_event		Нажатие на девятую кнопку
button_10_event		Нажатие на десятую кнопку
button_bottom_left_event		Нажатие на левую нижнюю кнопку
button_bottom_right_event		Нажатие на правую нижнюю кнопку
button_left_event		Нажатие на левую кнопку
button_right_event		Нажатие на правую кнопку
button_top_left_event		Нажатие на левую верхнюю кнопку
button_top_right_event		Нажатие на правую верхнюю кнопку
online	✔︎	Доступность устройства: офлайн или онлайн
signal_strength		Сила сигнала

Пример описания модели сценарной кнопки

Модель описывается в соответствии со структурой model. В примере описана сценарная кнопка с двумя физическими кнопками на корпусе. Также сценарная кнопка умеет сообщать о силе сигнала и заряде батареи.

Кроме того, у модели изменены доступные значения для функции button_1_event (нажатие на первую кнопку): первая кнопка этой модели не поддерживает долгое нажатие long_press, оно исключено.

{
   "id": "QWERTY124",
   "manufacturer": "Xiaqara",
   "model": "SM1123456789",
   "hw_version": "3.1",
   "sw_version": "5.6",
   "description": "Сценарная кнопка Xiaqara",
   "category": "scenario_button",
   "features": [
      "online",
      "signal_strength",
      "battery_percentag",
      "button_1_event",
      "button_2_event"
   ],
   "allowed_values": {
      "button_1_event": {
         "type": "ENUM",
         "enum_values": {
            "values": [
               "click",
               "double_click"
            ]
         }
      }
   }
}

Пример описания сценарной кнопки пользователя

Устройство описывается в соответствии со структурой device. В примере нет описания модели сценарной кнопки — считаем, что модели описаны отдельно, поэтому достаточно указать только ID модели (здесь — QWERTY124).

{
    "id": "ABCD_004",
    "name": "Моя кнопка",
    "default_name": "Сценарная кнопка",
    "nicknames": ["Смарт-кнопка", "Кнопка для сценариев"],
    "home": "Мой дом",
    "room": "Гостиная",
    "groups": [],
    "model_id": "QWERTY124",
    "hw_version": "3.1",
    "sw_version": "5.6",
    "partner_meta": {
        "internal-id": 1234,
        "specificity": "microchip 2A"
    },
}