RT-Thread MultiButton小巧简单易用的事件驱动型按键驱动模块

鸣涧_GC96O

RT-Thread MultiButton小巧简单易用的事件驱动型按键驱动模块简介

MultiButton 是一个小巧简单易用的事件驱动型按键驱动模块，可无限量扩展按键，按键事件的回调异步处理方式可以简化你的程序结构，去除冗余的按键处理硬编码，让你的按键业务逻辑更清晰。

MultiButton的作者是0x1abin, github地址: https://github.com/0x1abin/MultiButton.

使用方法

1.先申请一个按键结构

1. struct Button button1;

复制代码

2.初始化按键对象，绑定按键的GPIO电平读取接口read_button_pin() ，后一个参数设置有效触发电平

1. button_init(&button1, read_button_pin, 0);

复制代码

3.注册按键事件

1. button_attach(&button1, SINGLE_CLICK, Callback_SINGLE_CLICK_Handler);
   
2. button_attach(&button1, DOUBLE_CLICK, Callback_DOUBLE_Click_Handler);
   
3. ...

复制代码

4.启动按键

1. button_start(&button1);

复制代码

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

1. while(1) {
   
2.     ...
   
3.     if(timer_ticks == 5) {
   
4.         timer_ticks = 0;
   
5.         
   
6.         button_ticks();
   
7.     }
   
8. }

复制代码

特性

MultiButton 使用C语言实现，基于面向对象方式设计思路，每个按键对象单独用一份数据结构管理：

1. struct Button {
   
2.     uint16_t ticks;
   
3.     uint8_t  repeat: 4;
   
4.     uint8_t  event : 4;
   
5.     uint8_t  state : 3;
   
6.     uint8_t  debounce_cnt : 3;
   
7.     uint8_t  active_level : 1;
   
8.     uint8_t  button_level : 1;
   
9.     uint8_t  (*hal_button_Level)(void);
   
10.     BtnCallback  cb[number_of_event];
    
11.     struct Button* next;
    
12. };

复制代码

这样每个按键使用单向链表相连，依次进入 button_handler(struct Button* handle) 状态机处理，所以每个按键的状态彼此独立。

按键事件

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

Examples

1. #include "button.h"
   
2. 
   
3. struct Button btn1;
   
4. 
   
5. uint8_t read_button1_GPIO()
   
6. {
   
7.     return HAL_GPIO_ReadPin(B1_GPIO_Port, B1_Pin);
   
8. }
   
9. 
   
10. void BTN1_PRESS_DOWN_Handler(void* btn)
    
11. {
    
12.     //do something...
    
13. }
    
14. void BTN1_PRESS_UP_Handler(void* btn)
    
15. {
    
16.     //do something...
    
17. }
    
18. 
    
19. int main()
    
20. {
    
21.     button_init(&btn1, read_button1_GPIO, 0);
    
22.     button_attach(&btn1, PRESS_DOWN,       BTN1_PRESS_DOWN_Handler);
    
23.     button_attach(&btn1, PRESS_UP,         BTN1_PRESS_UP_Handler);
    
24.     button_attach(&btn1, PRESS_REPEAT,     BTN1_PRESS_REPEAT_Handler);
    
25.     button_attach(&btn1, SINGLE_CLICK,     BTN1_SINGLE_Click_Handler);
    
26.     button_attach(&btn1, DOUBLE_CLICK,     BTN1_DOUBLE_Click_Handler);
    
27.     button_attach(&btn1, LONG_PRESS_START, BTN1_LONG_PRESS_START_Handler);
    
28.     button_attach(&btn2, LONG_PRESS_HOLD,  BTN1_LONG_PRESS_HOLD_Handler);
    
29.     button_start(&btn1);
    
30.    
    
31.     //make the timer invoking the button_ticks() interval 5ms.
    
32.     //This function is implemented by yourself.
    
33.     __timer_start(button_ticks, 0, 5);
    
34.    
    
35.     while(1)
    
36.     {}
    
37. }
    
38. 
    
39. ...

复制代码

状态图