MultiButton按键驱动模块的使用

1. MultiButton

MultiButton 是一个事件驱动型的按键驱动模块。作者的 github 仓库地址：

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

MultiButton 可以无限量扩展按键，支持按键事件的回调处理机制，可以让代码结构更加清晰。也可以调用获取按键事件接口，轮询按键事件。

支持的按键事件有：

在STM32F407中移植MultiButton

MultiButton 使用起来非常简单，用户只需要提供一个读取按键电平的函数即可。可以在裸机中使用，也可以在 RTOS 中使用。大致的使用步骤：

1. 定义一个按键对象
2. 初始化按键按键对象，绑定按键的读取电平函数，提供按键的触发条件（是低电平触发还是高电平触发）
3. 注册按键事件回调函数（如果不使用回调编程方法，可以不用注册）
4. 启动按键
5. 间隔 5-20ms 扫描按键处理函数，可以使用定时器中断每隔 5-20ms 扫描一次，或者使用 RTOS 创建间隔 5-20ms 的按键扫描任务。

移植前，先准备一份可以运行的工程源码，我直接使用 STM32CubeMX 生成了一份FreeRTOS的例程。例程可以保证初始化了自己板子上的按键 GPIO 口，以及可以打印输出串口（需要用到串口打印输出调试信息）。

下面添加 MultiButton 的应用层代码。

添加按键电平读取函数

uint8_t read_key0_gpio(void)
{
	return HAL_GPIO_ReadPin(KEY0_GPIO_Port, KEY0_Pin);
}

uint8_t read_key1_gpio(void)
{
	return HAL_GPIO_ReadPin(KEY1_GPIO_Port, KEY1_Pin);
}
1
2
3
4
5
6
7
8
9

定义按键结构体，初始化按键

/* 定义两个按键结构体待使用 */
struct Button key0;
struct Button key1;

/* 第三个参数0，代表按键是低电平触发 */
button_init(&key0, read_key0_gpio, 0);
button_init(&key1, read_key1_gpio, 0);
1
2
3
4
5
6
7

注册按键事件回调函数

void key1_press_down_callback(void *button)
{
	printf("************* key1 press down *************\n");
}

void key1_long_press_start_callback(void *button)
{
	printf("************* key1 long press start *************\n");
}

/* 如果有多种事件回调函数需要注册的话，可以所有事件集中在一个回调函数中判断，只写一个事件回调函数即可 */
void key1_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! *************\n"); 
	    	break; 
	
	    case PRESS_UP: 
	        printf("************* key1 press up! *************\n");
	    	break; 
	
	    case PRESS_REPEAT: 
	        printf("************* key1 press repeat! *************\n");
	    	break; 
	
	    case SINGLE_CLICK: 
	        printf("************* key1 single click! *************\n");
	    	break; 
	
	    case DOUBLE_CLICK: 
	        printf("************* key1 double click! *************\n");
	    	break; 
	
	    case LONG_PRESS_START: 
	        printf("************* key1 long press start! *************\n");
	   		break; 
	
	    case LONG_PRESS_HOLD: 
	        printf("************* key1 long press hold! *************\n");
	    	break; 
	}
}

button_attach(&key1, PRESS_DOWN, key1_press_down_callback);
button_attach(&key1, LONG_PRESS_START, key1_long_press_start_callback);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

注册了回调函数之后，当检测到按键触发了相应事件时，就会调用用户注册的事件回调函数。

启动按键

button_start(&key0);
button_start(&key1);
1
2

间隔5-20ms循环调用button_ticks()函数

如果是裸机的话，那么可以在定时器中断中间隔调用 button_ticks() 函数，又或者在 main 函数的 while(1) 主循环中，延时 5-20ms 再调用，代码如下：

while(1)
{
    button_ticks();
    HAL_Delay(20);
}
1
2
3
4
5

对于按键扫描，我使用了 FreeRTOS 创建了一个按键扫描任务，在这个任务中不断调用 button_ticks() 函数。代码如下：

void button_scan_task(void *argument)
{
    /* USER CODE BEGIN StartDefaultTask */
    /* Infinite loop */
    for(;;)
    {
        button_ticks();
        osDelay(20);
    }
    /* USER CODE END StartDefaultTask */
}

/* 创建按键扫描任务 */
xTaskCreate((TaskFunction_t )button_scan_task,       //任务函数
            (const char*    )"button_scan_task",     //任务名称
            (uint16_t       )128,        			 //任务堆栈大小
            (void*          )NULL,             		 //传递给任务函数的参数
            (UBaseType_t    )1,       				 //任务优先级
            (TaskHandle_t*  )NULL);     			 //任务句柄
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

思考：这里我创建了一个按键扫描任务，是每隔 20ms 就扫描一次，我在想不断的进行按键扫描，总感觉有点浪费 CPU 资源。所以，是否可以使用中断的方式，等到按键按下触发了中断之后，由按键中断释放信号量唤醒这个按键扫描任务才进行按键扫描。这样就不用每隔 20ms 就扫描一次了，等按键按下触发了中断之后才来扫描。

有了这个想法，我马上就写代码进行验证，遗憾的是，并没有出现我想象的结果：按键按下就会运行相应的按键事件回调函数。实验过程中发现，按键中断确实是唤醒了按键扫描任务的，但并没有调用按键事件回调函数。我猜问题应该是运行 button_ticks() 这个函数的次数太少了，因为按键中断按下一次就触发一次中断，也就是按下一次只是运行一次 button_ticks() 这个函数，所以可能没有达到事件触发的条件吧？

实验结果

当按键按下时，就会调用我们注册的事件回调函数，我注册了两个事件回调函数：按下事件、长按事件。在里面都只是打印输出，打开串口可以看到下面打印信息：

不使用事件回调方法使用MultiButton

我们在使用 MultiButton 的时候，也可以不使用事件回调的方式。我们可以在 while(1) 死循环里面查询按键事件。

比如，我可以创建一个按键事件的处理任务，在这个任务里面，我只是不断去检测是否有按键事件发生。

/* 按键事件处理任务函数 */
void StartDefaultTask(void *argument)
{
	static uint8_t btn1_event_val = NONE_PRESS;
	
	/* USER CODE BEGIN StartDefaultTask */
	/* Infinite loop */
	for(;;)
	{
		if (btn1_event_val != get_button_event(&key0))
		{
			btn1_event_val = get_button_event(&key0);
			if (btn1_event_val == PRESS_DOWN)
			{
				printf("********** 按键按下 **********\n");
			}
			else if (btn1_event_val == PRESS_UP)
			{
				printf("********** 按键弹起 **********\n");
			}
			else if (btn1_event_val == LONG_PRESS_START)
			{
				printf("********** 按键长按 **********\n");
			}
		}
		osDelay(1);
	}
	/* USER CODE END StartDefaultTask */
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

编译后，测试结果如下：