button_smartLed

[SLOT_n]
mode = button_smartLed

Программный модуль для кнопки с подсветкой на адресных светодиодах (WS2812 и совместимых).

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

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

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

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

Все светодиоды ленты светятся одним цветом, заданным опцией RGBcolor или командой setRGB. Анимация выбирается опцией ledMode.

Топики

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

• <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. По умолчанию 24.
• ledInverse — флаг, флаг определяет инверсию светодиода.
• ledEnableOnStart — число(int), состояние при запуске. Диапазон 0–1. По умолчанию 0.
• minBright — число(int), минимальное свечение. Диапазон 0–255. По умолчанию 0.
• maxBright — число(int), максимальное свечение. Диапазон 0–255. По умолчанию 255.
• RGBcolor — строка(RGB), начальный цвет в формате RGB. По умолчанию 0 0 255.
• ledMode — строка(enum), задаёт режим анимации. По умолчанию ‘default’. Значения - default, flash, rainbow. Значения: default, flash, rainbow.
• fadeTime — число(int), время затухания свечения в мс. Диапазон 10–10000. По умолчанию 1000.
• periodicUpdate — флаг, принудительно отправлять буфер ленты каждый цикл обновления, даже если картинка не изменилась.

Общие опции:

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

События

Топик	Payload	Описание
button_<slot>/event/press	0 / 1	Рапортует при изменении состояния кнопки
button_<slot>/event/longPress	0 / 1	Рапортует при регистрации длинного нажатия
button_<slot>/event/doubleClick	0 / 1	Рапортует при регистрации двойного нажатия
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	Команда задаёт цвет подсветки. Три параметра RGB ‘0 0 255’
led_<slot>/action/setMode	default, flash, rainbow	Установить режим анимации цветов. Значения - default, flash, rainbow
led_<slot>/action/setFadeTime	10–10000	Время переходного процесса при изменении яркости, $мСек$
led_<slot>/action/enable	0 / 1	Включить (1) или выключить (0) подсветку

Пример: топик moduleBox/led_0/action/setRGB, payload 255 0 0.

Режимы анимации

• default — статичное свечение. В состоянии «включено» яркость равна maxBright, в состоянии «выключено» — minBright.
• flash — вспышки с равными промежутками времени, от minBright до maxBright.
• rainbow — переливание цветов по палитре HSV.

Примеры

[SLOT_0]
mode = button_smartLed
options = ledMode:flash, minBright:0, maxBright:127, RGBcolor:255 0 0, fadeTime:500
;включить подсветку при нажатии кнопки
crosslink = button_0/event/press:1->led_0/action/enable:1

При активации подсветка плавно моргает красным цветом в половину яркости.

[SLOT_1]
mode = button_smartLed
options = numOfLed:12, ledMode:rainbow, maxBright:200
;двойное нажатие переключает режим на статичный
crosslink = button_1/event/doubleClick:1->led_1/action/setMode:default

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

Архив

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