mirror of
https://github.com/gunner47/GyverLamp.git
synced 2025-08-08 09:20:59 +03:00
105 lines
6.9 KiB
C++
105 lines
6.9 KiB
C++
#ifndef GyverButton_h
|
||
#define GyverButton_h
|
||
#include <Arduino.h>
|
||
|
||
/*
|
||
GyverButton - библиотека для многофункциональной отработки нажатия кнопки. Возможности:
|
||
- Работа с нормально замкнутыми и нормально разомкнутыми кнопками
|
||
- Работа с подключением PULL_UP и PULL_DOWN
|
||
- Опрос кнопки с программным антидребезгом контактов
|
||
- Настраиваемое время антидребезга
|
||
- Отработка нажатия, удерживания, отпускания, клика по кнопке
|
||
- Настраиваемый таймаут удержания
|
||
- Отработка одиночного, двойного и тройного нажатия (вынесено отдельно)
|
||
- Отработка любого количества нажатий кнопки (функция возвращает количество нажатий)
|
||
- Настраиваемый таймаут повторного нажатия/удержания
|
||
- Функция изменения значения переменной с заданным шагом и заданным интервалом по времени
|
||
- Возможность опрашивать не кнопку, а напрямую давать величину (все возможности библиотеки для матричных и резистивных клавиатур)
|
||
|
||
Текущая версия: 2.12 от 18.03.2019:
|
||
- Поправлены баги при совместной работе методов опроса
|
||
*/
|
||
|
||
#pragma pack(push,1)
|
||
typedef struct
|
||
{
|
||
bool btn_state: 1;
|
||
bool btn_deb: 1;
|
||
bool btn_flag: 1;
|
||
bool hold_flag: 1;
|
||
bool counter_flag: 1;
|
||
bool isHolded_f: 1;
|
||
bool isRelease_f: 1;
|
||
bool isPress_f: 1;
|
||
bool step_flag: 1;
|
||
bool oneClick_f: 1;
|
||
bool isOne_f: 1;
|
||
bool inv_state: 1;
|
||
bool mode: 1;
|
||
bool type: 1;
|
||
bool tickMode: 1;
|
||
} GyverButtonFlags;
|
||
#pragma pack(pop)
|
||
|
||
class GButton
|
||
{
|
||
public:
|
||
GButton(uint8_t pin); // класс кнопки, принимает пин
|
||
|
||
GButton(uint8_t pin, boolean type, boolean dir); // класс кнопки, принимает PIN пин, тип type (HIGH_PULL / LOW_PULL) и направление dir (NORM_OPEN / NORM_CLOSE)
|
||
// HIGH_PULL - кнопка подключена к GND, пин подтянут к VCC, pinMode - INPUT_PULLUP (по умолчанию)
|
||
// LOW_PULL - кнопка подключена к VCC, пин подтянут к GND, pinMode - INPUT
|
||
// NORM_OPEN - кнопка по умолчанию разомкнута (по умолчанию)
|
||
// NORM_CLOSE - кнопка по умолчанию замкнута
|
||
|
||
void setDebounce(uint16_t debounce); // установка времени антидребезга (по умолчанию 80 мс)
|
||
void setTimeout(uint16_t timeout); // установка таймаута удержания (по умолчанию 300 мс)
|
||
void setClickTimeout(uint16_t timeout); // установка таймаута между кликами (по умолчанию 500 мс)
|
||
void setStepTimeout(uint16_t step_timeout); // установка таймаута между инкрементами (по умолчанию 400 мс)
|
||
void setType(boolean type); // установка типа кнопки (HIGH_PULL - подтянута к питанию, LOW_PULL - к gnd)
|
||
void setDirection(boolean dir); // установка направления (разомкнута/замкнута по умолчанию - NORM_OPEN, NORM_CLOSE)
|
||
|
||
void setTickMode(boolean tickMode); // (MANUAL / AUTO) ручной или автоматический опрос кнопки функцией tick()
|
||
// MANUAL - нужно вызывать функцию tick() вручную
|
||
// AUTO - tick() входит во все остальные функции и опрашивается сама
|
||
|
||
void tick(); // опрос кнопки
|
||
void tick(boolean state); // опрос внешнего значения (0 нажато, 1 не нажато) (для матричных, резистивных клавиатур и джойстиков)
|
||
|
||
boolean isPress(); // возвращает true при нажатии на кнопку. Сбрасывается после вызова
|
||
boolean isRelease(); // возвращает true при отпускании кнопки. Сбрасывается после вызова
|
||
boolean isClick(); // возвращает true при клике. Сбрасывается после вызова
|
||
boolean isHolded(); // возвращает true при удержании дольше timeout. Сбрасывается после вызова
|
||
boolean isHold(); // возвращает true при нажатой кнопке, не сбрасывается
|
||
boolean state(); // возвращает состояние кнопки
|
||
|
||
boolean isSingle(); // возвращает true при одиночном клике. Сбрасывается после вызова
|
||
boolean isDouble(); // возвращает true при двойном клике. Сбрасывается после вызова
|
||
boolean isTriple(); // возвращает true при тройном клике. Сбрасывается после вызова
|
||
|
||
boolean hasClicks(); // проверка на наличие кликов. Сбрасывается после вызова
|
||
uint8_t getClicks(); // вернуть количество кликов
|
||
uint8_t getHoldClicks();// вернуть количество кликов, предшествующее удержанию кнопки (для шаблона управления "клик + удержание")
|
||
|
||
boolean isStep(); // возвращает true по таймеру setStepTimeout, смотри пример
|
||
|
||
private:
|
||
void init();
|
||
GyverButtonFlags flags;
|
||
uint8_t _PIN = 0;
|
||
uint16_t _debounce = 0;
|
||
uint16_t _timeout = 0;
|
||
uint16_t _click_timeout = 0;
|
||
uint16_t _step_timeout = 0;
|
||
uint8_t btn_counter = 0, last_counter = 0, last_hold_counter = 0;
|
||
uint32_t btn_timer = 0;
|
||
};
|
||
|
||
#define HIGH_PULL 0
|
||
#define LOW_PULL 1
|
||
#define NORM_OPEN 0
|
||
#define NORM_CLOSE 1
|
||
#define MANUAL 0
|
||
#define AUTO 1
|
||
|
||
#endif |