作者:赵军涛 Murphy
前言
前几天,正好工作中用到按键处理,需要处理单击、长按等按键事件,然后就造了这么一个轮子,为了以后更方便地加入其它的项目中使用,遂将其开源到 GitHub 中。
后面发现 RT-Thread 软件包里也有一个开源的按键库 MultiButton(https://github.com/liu2guang/MultiButton),看到这个按键库的时候,心想,完了,又重复造轮子了,好伤心 QAQ。后来想想,既然按键处理方式不同,而且时间已经花出去了,那就把轮子圆一圆,放到 GitHub 中,给有缘人用吧,然后就有了这个不太圆的轮子 FlexibleButton(https://github.com/zhaojuntao/FlexibleButton)
概述
FlexibleButton 是一个基于 C 语言的小巧灵活的按键处理库。该按键库解耦了具体的按键硬件结构,理论上支持轻触按键与自锁按键,并可以无限扩展按键数量。另外,FlexibleButton 使用扫描的方式一次性读取所有所有的按键状态,然后通过事件回调机制上报按键事件。
该按键库使用 C 语言编写,驱动与应用程序解耦,便于灵活应用,比如用户可以方便地在应用层增加按键中断、处理按键功耗、定义按键事件处理方式,而无需修改 FlexibleButton 库中的代码。
另外,使用 C 语言标准库 API 编写,也使得该按键库可以无缝兼容任意的处理器平台,并且支持任意 OS 和 non-OS(裸机程序)。
另外,该按键库核心的按键扫描代码仅有三行,没错,就是经典的三行按键扫描算法,出自哪位大神之手就无从得知了,也欢迎知道此高人的读者文后留言哈。算法介绍可以去搜索引擎里查找,这里就不作介绍了。
获取
1git clone https://github.com/zhaojuntao/FlexibleButton.git
测试
FlexibleButton 库中提供了一个 DEMO flexible_button_demo.c
,这里基于 RT-Thread OS 进行测试,当然你可以选择使用其他的 OS,或者使用裸机测试,只需要移除 OS 相关的特性即可。
将 FlexibleButton 库放到 RT-Thread BSP 下即可使用 scons 进行编译构建。
DEMO 程序说明
程序入口
1int flex_button_main(void)
2{
3 rt_thread_t tid = RT_NULL;
4 user_button_init();
5 /* Create background ticks thread */
6 tid = rt_thread_create("flex_btn", button_scan, RT_NULL, 1024, 10, 10);
7 if(tid != RT_NULL)
8 {
9 rt_thread_startup(tid);
10 }
11 return 0;
12}
13INIT_APP_EXPORT(flex_button_main);
如上所示,首先使用 user_button_init();
初始化用户按键硬件,并挂载到 FlexibleButton库。然后,使用了 RT-Thread 的 INIT_APP_EXPORT
接口导出为上电自动初始化,创建了一个 “flex_btn” 名字的按键扫描线程,线程里扫描检查按键事件。
用户初始化代码
user_button_init();
初始化代码如下所示:
1static void user_button_init(void)
2{
3 int i;
4 rt_memset(&user_button[0], 0x0, sizeof(user_button));
5 user_button[USER_BUTTON_0].usr_button_read = button_key0_read;
6 user_button[USER_BUTTON_0].cb = (flex_button_response_callback)btn_0_cb;
7 user_button[USER_BUTTON_1].usr_button_read = button_key1_read;
8 user_button[USER_BUTTON_1].cb = (flex_button_response_callback)btn_1_cb;
9 user_button[USER_BUTTON_2].usr_button_read = button_key2_read;
10 user_button[USER_BUTTON_3].usr_button_read = button_keywkup_read;
11 rt_pin_mode(PIN_KEY0, PIN_MODE_INPUT); /* set KEY pin mode to input */
12 rt_pin_mode(PIN_KEY1, PIN_MODE_INPUT); /* set KEY pin mode to input */
13 rt_pin_mode(PIN_KEY2, PIN_MODE_INPUT); /* set KEY pin mode to input */
14 rt_pin_mode(PIN_WK_UP, PIN_MODE_INPUT); /* set KEY pin mode to input */
15 for (i = 0; i < USER_BUTTON_MAX; i ++)
16 {
17 user_button[i].status = 0;
18 user_button[i].pressed_logic_level = 0;
19 user_button[i].click_start_tick = 20;
20 user_button[i].short_press_start_tick = 100;
21 user_button[i].long_press_start_tick = 200;
22 user_button[i].long_hold_start_tick = 300;
23 if (i == USER_BUTTON_3)
24 {
25 user_button[USER_BUTTON_3].pressed_logic_level = 1;
26 }
27 flex_button_register(&user_button[i]);
28 }
29}
user_button_init();
主要用于初始化按键硬件,设置按键长按和短按的 tick 数(RT-Thread上面默认一个 tick 为 1ms),然后注册按键到 FlexibleButton 库。
事件处理代码
1static void btn_0_cb(flex_button_t *btn)
2{
3 rt_kprintf("btn_0_cb\n");
4 switch (btn->event)
5 {
6 case FLEX_BTN_PRESS_DOWN:
7 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_DOWN]\n");
8 break;
9 case FLEX_BTN_PRESS_CLICK:
10 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_CLICK]\n");
11 break;
12 case FLEX_BTN_PRESS_DOUBLE_CLICK:
13 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_DOUBLE_CLICK]\n");
14 break;
15 case FLEX_BTN_PRESS_SHORT_START:
16 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_SHORT_START]\n");
17 break;
18 case FLEX_BTN_PRESS_SHORT_UP:
19 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_SHORT_UP]\n");
20 break;
21 case FLEX_BTN_PRESS_LONG_START:
22 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_START]\n");
23 break;
24 case FLEX_BTN_PRESS_LONG_UP:
25 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_UP]\n");
26 break;
27 case FLEX_BTN_PRESS_LONG_HOLD:
28 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_HOLD]\n");
29 break;
30 case FLEX_BTN_PRESS_LONG_HOLD_UP:
31 rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_HOLD_UP]\n");
32 break;
33 }
34}
FlexibleButton 代码说明
按键事件定义
按键事件的定义并没有使用 Windows 驱动上的定义,主要是方便嵌入式设备中的应用场景(也可能是我理解的偏差),按键事件定义如下:
1typedef enum
2{
3 FLEX_BTN_PRESS_DOWN = 0, // 按下事件
4 FLEX_BTN_PRESS_CLICK, // 单击事件
5 FLEX_BTN_PRESS_DOUBLE_CLICK, // 双击事件
6 FLEX_BTN_PRESS_SHORT_START, // 短按开始事件
7 FLEX_BTN_PRESS_SHORT_UP, // 短按抬起事件
8 FLEX_BTN_PRESS_LONG_START, // 长按开始事件
9 FLEX_BTN_PRESS_LONG_UP, // 长按抬起事件
10 FLEX_BTN_PRESS_LONG_HOLD, // 长按保持事件
11 FLEX_BTN_PRESS_LONG_HOLD_UP, // 长按保持的抬起事件
12 FLEX_BTN_PRESS_MAX,
13 FLEX_BTN_PRESS_NONE,
14} flex_button_event_t;
按键注册接口
使用该接口注册一个用户按键,入参为一个 flex_button_t 结构体实例的地址。
1int8_t flex_button_register(flex_button_t *button);
按键事件读取接口
使用该接口获取指定按键的事件。
1flex_button_event_t flex_button_event_read(flex_button_t* button);
按键扫描接口
按键扫描的核心函数,需要放到应用程序中定时扫描间隔 5-20ms 即可。
1void flex_button_scan(void);
RT-Thread
让物联网终端的开发变得简单、快速,芯片的价值得到最大化发挥。GPLv2+协议,可免费在商业产品中使用。
扫描二维码,关注我们