前言
最近沉迷于收集一些大佬所开源的一些通用模块，这样在以后开发的过程中就能极大的减轻重复劳动。
这次所带来的是MultiButton，一个小巧简单易用的事件驱动型按键驱动模块。
① MultiButton简介
这个项目非常精简，只有两个文件，可无限量扩展按键，按键事件的回调异步处理方式可以简化程序结构，去除冗余的按键处理硬编码，让你的按键业务逻辑更清晰。
所包括的按键事件如下：
| 事件 | 说明 |
|---|---|
| PRESS_DOWN | 按键按下，每次按下都触发 |
| PRESS_UP | 按键弹起，每次松开都触发 |
| PRESS_REPEAT | 重复按下触发，变量repeat计数连击次数 |
| SINGLE_CLICK | 单击按键事件 |
| DOUBLE_CLICK | 双击按键事件 |
| LONG_PRESS_START | 达到长按时间阈值时触发一次 |
| LONG_PRESS_HOLD | 长按期间一直触发 |
② MultiButton移植和使用
1.移植到已有工程
首先先去GitHub仓库地址
0x1abin/MultiButton: Button driver for embedded system (github.com)
下载一下代码，得到代码如下，十分简单就两个文件
利用STM32CubeMX建立一个工程，配置一个串口和按键输入的GPIO口即可，这里选择的硬件平台为STM32F411CE。
生成工程后将MultiButton两个代码文件添加进去，并且将printf重新定向，这样就可以通过串口打印log判断触发的状态了。
log_printf.c代码如下：
#include <stdio.h>
#include "usart.h"
#define LOG_PRINT_INTER (&huart1)
#ifdef __GNUC__
int _write(int fd, char* ptr, int len)
{
HAL_UART_Transmit(LOG_PRINT_INTER, (uint8_t*)ptr, len, 10);
return len;
}
#endif
#ifdef __CC_ARM
int fputc(int ch, FILE *f)
{
HAL_UART_Transmit(LOG_PRINT_INTER, (uint8_t *)&ch, 1, 10);
return ch;
}
#endif
到这里已经移植完成了，接下来就是如何使用这个库。
2.工程应用
按照官方说明使用
1.先申请一个按键结构
struct Button button1;
2.初始化按键对象，绑定按键的GPIO电平读取接口read_button_pin() ，后一个参数设置有效触发电平
button_init(&button1, read_button_pin, 0, 0);
read_button_pin() 函数
//按键状态读取接口 uint8_t read_button_GPIO() { return HAL_GPIO_ReadPin(KEY1_GPIO_Port, KEY1_Pin); }
3.注册按键事件
button_attach(&button1, SINGLE_CLICK, Callback_SINGLE_CLICK_Handler);
button_attach(&button1, DOUBLE_CLICK, Callback_DOUBLE_Click_Handler);
...
4.启动按键
button_start(&button1);
5.设置一个5ms间隔的定时器循环调用后台处理函数
while(1) {
...
if(timer_ticks == 5) {
timer_ticks = 0;
button_ticks();
}
}
整体回调使用
官方这种方式在按键事件较少时倒没什么，但是如果按键事件过多后，每个按键事件都要写个回调函数，有点过于麻烦，这里提供一个全部注册的方式，只需要一个回调函数即可。整体操作如下：
1.先申请一个按键结构和按键ID枚举
enum Button_IDs
{
btn1_id,
btn2_id,
};
static struct Button button_1;
2.编写回调函数和读取按键接口
uint8_t read_button_GPIO(uint8_t button_id)
{
// you can share the GPIO read function with multiple Buttons
switch(button_id)
{
case btn1_id:
return HAL_GPIO_ReadPin(GPIOA, GPIO_PIN_8);
default:
return 0;
}
}
void button_callback(void *button)
{
uint32_t btn_event_val;
btn_event_val = get_button_event((struct Button *)button);
switch(btn_event_val)
{
case PRESS_DOWN:
printf("---> key1 press down! <---\r\n");
break;
case PRESS_UP:
printf("***> key1 press up! <***\r\n");
break;
case PRESS_REPEAT:
printf("---> key1 press repeat! <---\r\n");
printf("repeat count: %d\r\n",((struct Button *)button)->repeat);
break;
case SINGLE_CLICK:
printf("---> key1 single click! <---\r\n");
break;
case DOUBLE_CLICK:
printf("***> key1 double click! <***\r\n");
break;
case LONG_PRESS_START:
printf("---> key1 long press start! <---\r\n");
break;
case LONG_PRESS_HOLD:
printf("***> key1 long press hold! <***\r\n");
break;
}
}
3.修改multi_button.c文件中button_handler里的内容，增加一句话
4.主函数初始化对象，注册回调函数，启动开始
printf("multibutton test...\r\n");
//初始化按键对象
button_init(&button_1, read_button_GPIO, 0, btn1_id);
//注册按钮事件回调函数
// button_attach(&button_1, PRESS_DOWN, button_callback);
// button_attach(&button_1, PRESS_UP, button_callback);
// button_attach(&button_1, PRESS_REPEAT, button_callback);
button_attach(&button_1, SINGLE_CLICK, button_callback);
button_attach(&button_1, DOUBLE_CLICK, button_callback);
button_attach(&button_1, LONG_PRESS_START, button_callback);
// button_attach(&button_1, LONG_PRESS_HOLD, button_callback);
//启动按键
button_start(&button_1);
5.button_ticks()5ms循环调用
while (1)
{
/* USER CODE END WHILE */
/* USER CODE BEGIN 3 */
//处理按键信号
button_ticks();
HAL_Delay(5);
}
测试按键单次按下，连击两次，长按，打印信息如下：
3.设计思路解读
参考文章：MultiButton | 一个小巧简单易用的事件驱动型按键驱动模块_Mculover666的博客-CSDN博客
3.1 面向对象思想
MultiButton中每个按键都抽象为了一个按键对象，每个按键对象是独立的，系统中所有的按键对象使用单链表串起来，结构如下：
其中在变量后面跟冒号的语法称为位域，使用位域的优势是节省内存。
比如在这个结构体中，本来 6 个uint8_t 类型的变量需要占用 6 个字节，但使用位域语法后，这6个变量只占用两个字节：
3.2 按键对象单链表
MultiButton自己定义了一个头指针：
用户插入一个按键对象的代码如下：
那么，button_start插入新的按键对象之后，单链表长啥样呢？
理解了 button_start 的源码就很好知道答案了：
第一次插入时，因为head_hanler 为 NULL，所以只需要执行while之后的代码，
按照它的插入于原理，如果再插入一个buuton2按键对象，结果是不是可以猜出来了呢？
没错，它长这样：
这样做是不是有点不符合常理？后插入Button2竟然在button1前面，凭什么？
这又不是排队抢鸡蛋，在前在后没什么关系的。只是这样的插入方法在代码算法上会非常简洁，两行代码完成插入
3.3 状态机处理思想
MultiButton中使用状态机来处理每个按键对象（的状态），比如在上述应用中根据Systick提供的时基信号，每隔5ms调用一次 button_tick()，该函数会依次调用状态机对单链表上的所有按键对象进行遍历处理：
根据上一节的单链表讲解，系统中定义的链表头指针 head_handle 永远指向最后一个插入的按键对象，所以无需任何参数即可遍历整个单链表上的对象，非常之牛逼。
使用 button_handler 来对按键对象的状态进行处理，该函数源码如下：
（读源码的时候只需要记住该函数每隔5ms进入一次就很好分析了）
1.读取当前引脚状态
调用该按键对象注册的读取状态函数进行读取：
2.读取之后，判断当前状态机的状态，如果有功能正在执行（state不为0），则按键对象的tick值加1（后续一切功能的基础）：
3.按键消抖（连续读取3次，15ms，如果引脚状态一直与之前不同，则改变按键对象中的引脚状态）：
4.状态机（整个设计的灵魂所在）
后记
使用优秀的开源代码，也不要忘记学开源代码作者的优秀思想，只有做到举一反三才是对开源代码最好的使用。