button_swiperLed

[SLOT_n]
mode = button_swiperLed

Программный модуль для кнопки с подсветкой, поддерживающей световые эффекты свайпа в четырёх направлениях.

Совместимость

• Модуль кнопка с управляемой подсветкой

Принцип работы

Рапортует об изменении состояния кнопки: нажатие, отпускание, а при включённых опциях — длинное и двойное нажатие. Подсветкой управляет по командам и внутренним связям.

По команде swipe лента отыгрывает анимацию проведения в заданном направлении: up, down, left или right — например, по жесту датчика или по нажатию кнопки.

Топики

База топика события:

• <deviceName>/button_<slot> — например moduleBox/button_0

База топика действия:

• <deviceName>/led_<slot> — например moduleBox/led_0

Полный топик — база плюс направление и имя: moduleBox/button_0/event/press.

Опции

Доступные опции для кнопки:

• buttonInverse — флаг, флаг определяет инверсию кнопки.
• buttonDebounceGap — число(int), глубина фильтра от дребезга контактов в мс. Диапазон 1–4096. По умолчанию 10.
• longPressTime — число(int), продолжительность длинного нажатия. Диапазон 0–65535. По умолчанию 0.
• doubleClickTime — число(int), длительность промежутка между нажатиями для регистрации двойного нажатия. Диапазон 0–65535. По умолчанию 0.
• eventFilter — флаг, подавляет короткое событие press, когда сработало длинное или двойное нажатие. По умолчанию выключен — короткие события шлются всегда.
• switchModeButton — флаг, режим переключателя: каждое нажатие меняет состояние 0/1 и рапортует event/switch, событие press при этом не шлётся. На старте модуль рапортует switch = 0. По умолчанию выключен.

Доступные опции для подсветки:

• numOfLed — число(int), количество светодиодов в кольце. Диапазон 1–1024. По умолчанию 16.
• offset — число(int), смещение светового эффекта. По умолчанию 0.
• ledDefaultState — число(int), состояние при запуске. Диапазон 0–1. По умолчанию 0.
• minBright — число(int), минимальное свечение. Диапазон 0–255. По умолчанию 0.
• maxBright — число(int), максимальное свечение. Диапазон 0–255. По умолчанию 255.
• RGBcolor — строка(RGB), начальный цвет в формате R G B. По умолчанию 0 0 255.

Общие опции:

• refreshRate — число(int), частота обновления, кадров в секунду. Задаёт период опроса кнопки и период перерисовки ленты. По умолчанию 40 для кнопки и 25 для подсветки.

События

Топик	Payload	Описание
button_<slot>/event/press	целое	Рапортует при изменении состояния кнопки
button_<slot>/event/longPress	целое	Рапортует при регистрации длинного нажатия
button_<slot>/event/doubleClick	целое	Рапортует при регистрации двойного нажатия
button_<slot>/event/switch	0 / 1	Состояние переключателя, при опции switchModeButton

Пример: топик moduleBox/button_0/event/longPress, payload 1.

События longPress и doubleClick рапортуются только при ненулевых опциях longPressTime и doubleClickTime соответственно.

Команды

Топик	Payload	Описание
led_<slot>/action/toggleLedState	—	Переключить состояние подсветки на противоположное
led_<slot>/action/setRGB	R G B	Команда задаёт цвет подсветки. Три параметра R G B
led_<slot>/action/swipe	up, down, left, right	Команда запускает световой эффект свайпа. Значения - up, down, left, right
led_<slot>/action/enable	0 / 1	Включить (1) или выключить (0) подсветку

Примеры

[SLOT_2]
mode = button_swiperLed
options = RGBcolor:0 255 0
;нажатие и отпускание кнопки запускают свайпы в разные стороны
crosslink = button_2/event/press:1->led_2/action/swipe:down, button_2/event/press:0->led_2/action/swipe:up

[SLOT_3]
mode = button_swiperLed
options = numOfLed:16, RGBcolor:0 128 255
;нажатие своей кнопки - эффект вверх, отпускание - вниз
crosslink = button_3/event/press:1->led_3/action/swipe:up, button_3/event/press:0->led_3/action/swipe:down

Подробнее — внутренние связи (crossLink).

Архив

Описание модуля для прошивок до перехода на конституцию — button_swiperLed (архив).