摘要：FlexibleButton是一个基于标准C语言的小巧灵活的按键处理库，支持单击、连击、短按、长按、自动消抖，可以自由设置组合按键，可用于中断和低功耗场景。

https://gitee.com/zhengnianli/EmbedSummary

FlexibleButton

FlexibleButton 是一个基于标准 C 语言的小巧灵活的按键处理库，支持单击、连击、短按、长按、自动消抖，可以自由设置组合按键，可用于中断和低功耗场景。

该按键库解耦了具体的按键硬件结构，理论上支持轻触按键与自锁按键，并可以无限扩展按键数量。

另外，FlexibleButton 使用扫描的方式一次性读取所有所有的按键状态，然后通过事件回调机制上报按键事件。

核心的按键扫描代码仅有三行，没错，就是经典的三行按键扫描算法。使用 C 语言标准库 API 编写，也使得该按键库可以无缝兼容任意的处理器平台，并且支持任意 OS 和 non-OS（裸机编程）。

仓库链接：

https://github.com/murphyzhao/FlexibleButton

license：Apache-2.0。

关于开源软件协议相关文章：常用的开源协议有哪些？

同类型的按键处理库还有MultiButton：

https://github.com/0x1abin/MultiButton

FlexibleButton的使用

FlexibleButton 包含有两个文件：

flexible_button.c、flexible_button.h

使用起来很简单。作者在README中也很详细地介绍了FlexibleButton 的使用。

下面我们基于小熊派IOT开发板来简单实践实践：基于裸机及基于RT-Thread。

1、基于non-OS（裸机编程）

板子上有两个用户按键及一个用户LED。

我们实现如下操作：

单击button0（即F1按键），点亮led。
单机button1（即F2按键），熄灭led。
双击button0（即F1按键），点亮led。
双击button1（即F2按键），熄灭led。
同时按下button0及button1，点亮led。

FlexibleButton给我们提供了很多按键事件给我们使用，基本涵盖了我们日常使用按键的各种场景。FlexibleButton支持的按键事件如：

typedef enum
{
    FLEX_BTN_PRESS_DOWN = 0,        // 按下事件
    FLEX_BTN_PRESS_CLICK,           // 单击事件
    FLEX_BTN_PRESS_DOUBLE_CLICK,    // 双击事件
    FLEX_BTN_PRESS_REPEAT_CLICK,    // 连击事件，使用 flex_button_t 中的 click_cnt 断定连击次数
    FLEX_BTN_PRESS_SHORT_START,     // 短按开始事件
    FLEX_BTN_PRESS_SHORT_UP,        // 短按抬起事件
    FLEX_BTN_PRESS_LONG_START,      // 长按开始事件
    FLEX_BTN_PRESS_LONG_UP,         // 长按抬起事件
    FLEX_BTN_PRESS_LONG_HOLD,       // 长按保持事件
    FLEX_BTN_PRESS_LONG_HOLD_UP,    // 长按保持的抬起事件
    FLEX_BTN_PRESS_MAX,
    FLEX_BTN_PRESS_NONE,
} flex_button_event_t;

这些按键事件就是FlexibleButton返回给我们应用层的，我们只要在应用层做相关的按键处理就可以。比如单击按键时，我们要做什么逻辑控制；按键双击时，又要做怎样的逻辑控制等等。

所以，哪怕我们的板子只有一两个按键，也可以做很多按键控制。

下面来一起实操一下：

首先，准备一个按键相关工程，把flexible_button.c、flexible_button.h添加到工程里。

flexible_button.h对外提供了如下几个接口：

int32_t flex_button_register(flex_button_t *button); // 按键注册
flex_button_event_t flex_button_event_read(flex_button_t* button); // 按键事件读取
uint8_t flex_button_scan(void);  // 按键扫描

flex_button_register用于按键注册，需要用户至少提供如下按键信息：

按键ID
按键引脚电平读取函数
事件回调函数
设置按键按下的逻辑电平
设置短按事件触发的起始 tick
设置长按事件触发的起始 tick
设置长按保持事件触发的起始 tick

flex_button_register在初始化时进行调用，如：

static void user_button_init(void)
{
    int i;
    
    memset(&user_button[0], 0x0, sizeof(user_button));

for (i = 0; i < USER_BUTTON_MAX; i ++)
{
user_button[i].id = i;   // 按键的ID号
user_button[i].usr_button_read = common_btn_read; // 按键引脚电平读取函数
user_button[i].cb = common_btn_evt_cb;   // 事件回调函数
user_button[i].pressed_logic_level = 0;  // 设置按键按下的逻辑电平
user_button[i].short_press_start_tick = FLEX_MS_TO_SCAN_CNT(1500); // 设置短按事件触发的起始 tick
user_button[i].long_press_start_tick = FLEX_MS_TO_SCAN_CNT(3000);  // 设置长按事件触发的起始 tick
user_button[i].long_hold_start_tick = FLEX_MS_TO_SCAN_CNT(4500);   // 设置长按保持事件触发的起始 tick

flex_button_register(&user_button[i]); // 按键注册
}
}

这种机制很常用。

比如，一些美食教程，常常提供一些制作巧克力的方法，而不是每种口味的巧克力都教一遍，因为方法基本都差不多。不同的人喜欢不同的巧克力口味，根据自己需要，准备做巧克力的原料，再套用制作方法就可以。

FlexibleButton提供一个管理按键的框架，我们根据不同的的芯片或者不同的环境提供FlexibleButton需要的一些按键信息，就可以起到相同效果。

FlexibleButton数据结构：

typedef struct flex_button
{
    struct flex_button* next; // 按键库使用单向链表串起所有的按键

uint8_t (*usr_button_read)(void *); // 用户设备的按键引脚电平读取函数，重要
flex_button_response_callback cb; // 设置按键事件回调，用于应用层对按键事件的分类处理

uint16_t scan_cnt; // 用于记录扫描次数，按键按下是开始从零计数
uint16_t click_cnt; // 记录单击次数，用于判定单击、连击
uint16_t max_multiple_clicks_interval; // 连击间隙，用于判定是否结束连击计数，有默认值

uint16_t debounce_tick;          // 消抖时间，暂未使用，依靠扫描间隙进行消抖
uint16_t short_press_start_tick; // 设置短按事件触发的起始 tick
uint16_t long_press_start_tick;  // 设置长按事件触发的起始 tick
uint16_t long_hold_start_tick;   // 设置长按保持事件触发的起始 tick

uint8_t id;                      // 当多个按键使用同一个回调函数时，用于断定属于哪个按键
uint8_t pressed_logic_level : 1; // 设置按键按下的逻辑电平
uint8_t event               : 4; // 用于记录当前按键事件
uint8_t status              : 3; // 用于记录当前按键的状态，用于内部状态机
} flex_button_t;

按键引脚电平读取函数如：

static uint8_t common_btn_read(void *arg)
{
    uint8_t value = 0;

flex_button_t *btn = (flex_button_t *)arg;

switch (btn->id)
{
case USER_BUTTON_0:
value = HAL_GPIO_ReadPin(USER_BUTTON_0_PORT, USER_BUTTON_0_PIN);
break;
case USER_BUTTON_1:
value = HAL_GPIO_ReadPin(USER_BUTTON_1_PORT, USER_BUTTON_1_PIN);
break;
default:
assert_param(0);
}

return value;
}

按键事件回调函数如：

// 按键事件回调函数
static void common_btn_evt_cb(void *arg)
{
    flex_button_t *btn = (flex_button_t *)arg;

// 非组合按键事件处理
non_combination_btn_event(btn);

// 组合按键事件处理
if ((flex_button_event_read(&user_button[USER_BUTTON_0]) == FLEX_BTN_PRESS_CLICK) &&
(flex_button_event_read(&user_button[USER_BUTTON_1]) == FLEX_BTN_PRESS_CLICK))
{
printf(“[combination]: button 0 and button 1, LED ON>>>>>>>>>>>>>>>>>>>>>>>n”);
HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_SET); // 亮
}
}

// 非组合按键事件处理
static void non_combination_btn_event(flex_button_t *btn)
{
switch (btn->id)
{
case USER_BUTTON_0:
{
switch (btn->event)
{
case FLEX_BTN_PRESS_DOWN:
printf(“%s : %sn”,  enum_btn_id_string[btn->id], enum_event_string[btn->event]);
break;
case FLEX_BTN_PRESS_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_SET); // 亮
printf(“%s : %sn”,  enum_btn_id_string[btn->id], enum_event_string[btn->event]);
printf(“<<<<<<<<<<<<<<<<<<<<<<<<LED ONn”);
break;
case FLEX_BTN_PRESS_DOUBLE_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_SET); // 亮
printf(“%s : %sn”,  enum_btn_id_string[btn->id], enum_event_string[btn->event]);
printf(“<<<<<<<<<<<<<<<<<<<<<<<<LED ONn”);
break;
default:
break;
}
break;
}

case USER_BUTTON_1:
{
switch (btn->event)
{
case FLEX_BTN_PRESS_DOWN:
printf(“%s : %sn”,  enum_btn_id_string[btn->id], enum_event_string[btn->event]);
break;
case FLEX_BTN_PRESS_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_RESET); // 灭
printf(“%s : %sn”,  enum_btn_id_string[btn->id], enum_event_string[btn->event]);
printf(“<<<<<<<<<<<<<<<<<<<<<<<<LED OFFn”);
break;
case FLEX_BTN_PRESS_DOUBLE_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_RESET); // 灭
printf(“%s : %sn”,  enum_btn_id_string[btn->id], enum_event_string[btn->event]);
printf(“<<<<<<<<<<<<<<<<<<<<<<<<LED OFFn”);
break;
default:
break;
}
break;
}

default:
break;
}
}

主函数中需要调用flex_button_scan进行按键扫描，主函数如：

int main(void)
{
    HAL_Init();
    SystemClock_Config();
    MX_GPIO_Init();
    MX_USART1_Init();
    user_button_init();

while (1)
{
flex_button_scan();
HAL_Delay(20);
}
}

编译、下载运行：

<<< 左右滑动见更多 >>>

其中，每次按键的按下都会触发FLEX_BTN_PRESS_DOWN事件。

在对按键进行注册时有设置短按、长按、长按保持的tick：

左右滑动查看全部代码>>>

user_button[i].short_press_start_tick = FLEX_MS_TO_SCAN_CNT(1500); // 设置短按事件触发的起始 tick
user_button[i].long_press_start_tick = FLEX_MS_TO_SCAN_CNT(3000);  // 设置长按事件触发的起始 tick
user_button[i].long_hold_start_tick = FLEX_MS_TO_SCAN_CNT(4500);   // 设置长按保持事件触发的起始 tick

我们应用比较敏感的是1500、3000、4500，这对应的就是按键按下的时间（单位是ms），即：

按键保持1500ms按下状态时，flexible_button会向应用上报FLEX_BTN_PRESS_SHORT_START事件。
按键保持3000ms按下状态时，flexible_button会向应用上报FLEX_BTN_PRESS_LONG_START事件。
按键保45000ms按下状态时，flexible_button会向应用上报FLEX_BTN_PRESS_LONG_HOLD事件。

下面我们修改代码，按键事件回调函数加入所有事件的处理，触发则打印相应信息。

我们做一个实验，按住button0超过5m，再放开。则打印的信息如：

2、基于RT-Thread

FlexibleButton已经有作为一个软件包贡献到RT-Thread中，我们只需要简单的配置，就可以使用了。

RT-Thread menuconfig 方式：

RT-Thread online packages  --->
    miscellaneous packages  --->
        [*] FlexibleButton: Small and flexible button driver  --->
        [*]   Enable flexible button demo
              version (latest)  --->