移植按键框架(MultiButton )到STM32 并使用

一、MultiButton

MultiButton，一个小巧简单易用的事件驱动型按键驱动模块，作者 0x1abin，目前收获 222 个star，遵循 MIT 开源许可。

这个项目非常精简，只有两个文件，可无限量扩展按键，按键事件的回调异步处理方式可以简化程序结构，去除冗余的按键处理硬编码，让你的按键业务逻辑更清晰。

1.1 MuliButton 支持如下的按钮事件：

事件	说明
PRESS_DOWN	按键按下，每次按下都触发
PRESS_UP	按键弹起，每次松开都触发
PRESS_REPEAT	重复按下触发，变量repeat计数连击次数
SINGLE_CLICK	单击按键事件
DOUBLE_CLICK	双击按键事件
LONG_RRESS_START	达到长按时间阈值时触发一次
LONG_PRESS_HOLD	长按期间一直触发

1.2 下载MuliButton

GIthub地址：https://github.com/0x1abin/MultiButton

二、移植MultiButton

2.1 复制MultiButton源码到裸机工程中：

2.2 添加MultiButton源码到项目中：

此时编译没有问题。

2.3 编写MultiButton应用代码

在 main.c 文件中编写以下代码。

2.3.1 包含头文件

/* USER CODE BEGIN Includes */

#include <stdio.h>		//要使用printf
#include "multi_button.h"

typedef enum {
	SW_S1 = 0,
	SW_S2,
	SW_S3,
	KEY_NUM,
}KEY_IDe;

/* USER CODE END Includes */

2.3.2 定义一个按键结构（按键对象）

/* USER CODE BEGIN PV */

//申请一个按键结构
struct Button button1;

/* USER CODE END PV */

2.3.3 初始化按键对象

• handle: 创建的按键对象的指针

• pin_level: 绑定按键GPIO电平读取接口的回调函数指针

• active_level: 设置有效触发电平

• button_id: 按键id，每个按键唯一标识

• 首先在main函数之前实现一个GPIO电平读取接口：

  /**button_id 每一个按键的唯一ID**/
  uint8_t ucButtonRead_GPIO(uint8_t button_id)
  {
      // you can share the GPIO read function with multiple Buttons
      switch(button_id)
      {
      case SW_S1:
          return HAL_GPIO_ReadPin(S1_GPIO_Port, S1_Pin);
  
      case SW_S2:
          return HAL_GPIO_ReadPin(S2_GPIO_Port, S2_Pin);
  
      case SW_S3:
          return HAL_GPIO_ReadPin(S3_GPIO_Port, S3_Pin);
  
  
      default:
          return 0;
  
      }
  }
  

2.3.4 注册按键事件

注册按钮事件的 API 如下：

• handle: 创建的按键对象的指针
• event: 为 MultiButton 支持的按钮事件
• cb: 要注册的该事件回调函数

MultiButton 支持的按钮事件枚举如下:

2.3.5 首先在main函数之前定义这两个事件的回调函数，回调函数有两种写法。

第一种适合于按键事件较少的情况：

//按键1按下事件回调函数
void btn1_press_down_Handler(void* btn)
{
	printf("---> key1 press down! <---\r\n");
}

//按键1松开事件回调函数
void btn1_press_up_Handler(void* btn)
{
	printf("***> key1 press up! <***\r\n");
}

在main函数中，while(1)之前注册这两个回调函数：

//注册按钮事件回调函数
button_attach(&button1, PRESS_DOWN, btn1_press_down_Handler);
button_attach(&button1, PRESS_UP, btn1_press_up_Handler);

第二种 适合于按键事件较多的情况(推荐方法)

如果每个按键都要写 7 个回调函数，那么代码量会非常的大，所以可以将这 7 个回调函数写在一起，一次性全部注册，回调函数如下：

void Button_Callback(void *button)
{
    PressEvent btn_event_val;
    btn_event_val = get_button_event((struct Button *)button);
//
    if((struct Button *)button == &button1)
    {
        if(btn_event_val == PRESS_DOWN)
        {
            printf("---> key1 press down! <---\r\n");
        }
        else if(btn_event_val == PRESS_UP)
        {
            printf("---> key1 press up! <---\r\n");
        }

    }
    else if((struct Button *)button == &button2)
    {
        if(btn_event_val == PRESS_DOWN)
        {
            printf("---> key2 press down! <---\r\n");
        }
        else if(btn_event_val == PRESS_UP)
        {
            printf("---> key2 press up! <---\r\n");
        }
    }
    else if((struct Button *)button == &button3)
    {
        if(btn_event_val == PRESS_DOWN)
        {
            printf("---> key3 press down! <---\r\n");
        }
        else if(btn_event_val == PRESS_UP)
        {
            printf("---> key3 press up! <---\r\n");
        }
    }

}

注册回调函数的代码如下：

    button_attach(&button1, PRESS_DOWN, Button_Callback);
    button_attach(&button2, PRESS_DOWN, Button_Callback);
    button_attach(&button3, PRESS_DOWN, Button_Callback);
		
		button_attach(&button1, PRESS_UP, Button_Callback);
    button_attach(&button2, PRESS_UP, Button_Callback);
    button_attach(&button3, PRESS_UP, Button_Callback);

2.3.6 启动按键

启动按键的API如下：

接着在main函数中，while(1) 之前编写代码，启动按键：

//启动按键
button_start(&button1);

2.3.7 设置一个5ms间隔的定时器循环调用后台处理函数

这里就要用到 systick 了，在 main 函数的 while(1) 循环中编写如下代码：

  /* Infinite loop */
  /* USER CODE BEGIN WHILE */
  while (1)
  {
    /* USER CODE END WHILE */

    /* USER CODE BEGIN 3 */
		//每隔5ms调用一次后台处理函数
		button_ticks();
		HAL_Delay(5);
  }
  /* USER CODE END 3 */

2.4 MultiButton配置

在 MultiButton.h 文件里面有这样的几段代码

• TICKS_INTERVAL： 这个是定时时间
• DEBOUNCE_TICKS： 消抖时间
• SHORT_TICKS： 识别短按的时间
• LONG_TICKS： 识别长按的时间

三、实验现象

编译、下载之后，每次按下 Key1时打印按下提示，松开Key1时打印松开提示：

四、MultiButton设计思想解读

4.1 面向对象思想

MultiButton 中每个按键都抽象为了一个按键对象，每个按键对象是独立的，系统中所有的按键对象使用单链表串起来，结构如下：

其中在变量后面跟冒号的语法称为位域，使用位域的优势是节省内存。

比如在这个结构体中，本来 6 个uint8_t 类型的变量需要占用 6 个字节，但使用位域语法后，这6个变量只占用两个字节：

4.2 按键对象单链表

MultiButton 自己定义了一个头指针

//button handle list head.
static struct Button* head_handle = NULL;

用户插入一个按键对象的代码如下：

//启动按键
button_start(&button1);

那么，button_start插入新的按键对象之后，单链表长啥样呢？

理解了 button_start 的源码就很好知道答案了：

第一次插入时，因为head_hanler 为 NULL，所以只需要执行 while 之后的代码，

按照它的插入于原理，如果再插入一个buuton2按键对象，结果是不是可以猜出来了呢？

没错，它长这样：

这样做是不是有点不符合常理？后插入Button2竟然在button1前面，凭什么？

这又不是排队抢鸡蛋，在前在后没什么关系的。只是这样的插入方法在代码算法上会非常简洁，两行代码完成插入。

4.3 状态机处理思想

MultiButton中使用状态机来处理每个按键对象（的状态），比如在上述应用中根据 Systick 提供的时基信号，每隔 5ms 调用一次 button_tick()，该函数会依次调用状态机对单链表上的所有按键对象进行遍历处理：

根据上一节的单链表讲解，系统中定义的链表头指针 head_handle 永远指向最后一个插入的按键对象，所以无需任何参数即可遍历整个单链表上的对象，非常之牛逼。

使用 button_handler 来对按键对象的状态进行处理，该函数源码如下：

（读源码的时候只需要记住该函数每隔5ms进入一次就很好分析了）

4.3.1 读取当前引脚状态

• 调用该按键对象注册的读取状态函数进行读取：

4.3.2 判断当前状态机的状态

读取之后，判断当前状态机的状态，如果有功能正在执行（state不为0），则按键对象的tick值加1（后续一切功能的基础）：

4.3.3 按键消抖

（连续读取3次，15ms，如果引脚状态一直与之前不同，则改变按键对象中的引脚状态）：

4.3.4 状态机（整个设计的灵魂所在）

五、资源工程下载

移植按键框架(MultiButton)到STM32并使用资源-优快云文库

---

文章是自己总结而记录，有些知识点没说明白的，请各位看官多多提意见，多多交流，欢迎大家留言
如果技术交流可以加以下群，方便沟通
QQ群：370278903