专栏首页TencentOS-tiny第1期 | MultiButton,一个小巧简单易用的事件驱动型按键驱动模块

第1期 | MultiButton,一个小巧简单易用的事件驱动型按键驱动模块

嵌入式开源项目精选专栏

本专栏由Mculover666创建,主要内容为寻找嵌入式领域内的优质开源项目,一是帮助开发者使用开源项目实现更多的功能,二是通过这些开源项目,学习大佬的代码及背后的实现思想,提升自己的代码水平,和其它专栏相比,本专栏的优势在于:

不会单纯的介绍分享项目,还会包含作者亲自实践的过程分享,甚至还会有对它背后的设计思想解读

目前本专栏包含的开源项目有:

  • SFUD | 一个简洁实用的开源项目,帮你轻松搞定SPI Flash
  • cJSON | 一个轻量级C语言JSON解析器
  • paho | 支持10种语言编写mqtt客户端,总有一款适合你!

如果您自己编写或者发现的开源项目不错,欢迎留言或者私信投稿到本专栏,分享获得双倍的快乐!

1. MultiButton

本期给大家带来的开源项目是 MultiButton,一个小巧简单易用的事件驱动型按键驱动模块,作者 0x1abin,目前收获 222 个star,遵循 MIT 开源许可。

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

MuliButton 支持如下的按钮事件:

事件

说明

PRESS_DOWN

按键按下,每次按下都触发

PRESS_UP

按键弹起,每次松开都触发

PRESS_REPEAT

重复按下触发,变量repeat计数连击次数

SINGLE_CLICK

单击按键事件

DOUBLE_CLICK

双击按键事件

LONG_RRESS_START

达到长按时间阈值时触发一次

LONG_PRESS_HOLD

长按期间一直触发

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

2. 使用MultiButton

2.1. 准备一份裸机工程

需要掌握使用HAL库读取GPIO输入的函数、串口的使用、printf重定向、以及systick的使用:

  • STM32CubeMX | 04-使用GPIO进行按键检测
  • STM32CubeMX | 06-使用USART发送和接收数据(查询模式)
  • STM32CubeMX | 09-重定向printf函数到串口输出的多种方法
  • STM32CubeMX | 27-系统滴答定时器Systick的使用

本文中我使用小熊派IoT开发板,主控为STM32L431RCT6:

配置外部时钟:

按键GPIO配置:

打印串口配置:

时钟配置:

配置工程,生成代码,重定向printf,printf可以正常打印后进行下面的步骤

2.2. 移植MultiButton

① 复制MultiButton源码到裸机工程中:

② 添加MultiButton源码到项目中:

此时编译没有问题。

2.3. 编写MultiButton应用代码

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

包含头文件

/* USER CODE BEGIN Includes */

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

/* USER CODE END Includes */

定义一个按键结构(按键对象)

/* USER CODE BEGIN PV */

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

/* USER CODE END PV */

初始化按键对象

初始化按键对象使用的API为:

  • 第一个参数为刚刚创建的按键对象的指针;
  • 第二个参数为绑定按键的GPIO电平读取接口;
  • 第三个参数为设置有效触发电平;

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

/* USER CODE BEGIN 0 */

//按键状态读取接口
uint8_t read_button1_GPIO()
{
	return HAL_GPIO_ReadPin(KEY1_GPIO_Port, KEY1_Pin);
}

/* USER CODE END 0 */

初始化按键对象的代码在main函数中,while(1)之前编写,如下:

/* USER CODE BEGIN 2 */
printf("MultiButton Test...\r\n");

//初始化按键对象
button_init(&button1, read_button1_GPIO, 0);

/* USER CODE END 2 */

④ 注册按键事件

注册按钮事件的API如下:

  • 第一个参数为按钮对象指针;
  • 第二个参数为MultiButton支持的按钮事件;
  • 第三个参数为要注册的该事件回调函数;

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

首先在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)
{
    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");
	    	break;
	
	    case SINGLE_CLICK:
	        printf("---> key1 single click! <---\r\n");
	    	break;
	
	    case DOUBLE_CLICK:
	        printf("***> key1 double click! <***\r\n");
	    	break;
	
	    case LONG_RRESS_START:
	        printf("---> key1 long press start! <---\r\n");
	   		break;
	
	    case LONG_PRESS_HOLD:
	        printf("***> key1 long press hold! <***\r\n");
	    	break;
	}
}

使用这种回调函数的时候需要在MultiButton的源码中添加一行代码:

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

//注册按钮事件回调函数

button_attach(&button1, PRESS_DOWN,       button_callback);
button_attach(&button1, PRESS_UP,         button_callback);
//button_attach(&button1, PRESS_REPEAT,     button_callback);
//button_attach(&button1, SINGLE_CLICK,     button_callback);
//button_attach(&button1, DOUBLE_CLICK,     button_callback);
//button_attach(&button1, LONG_RRESS_START, button_callback);
//button_attach(&button1, LONG_PRESS_HOLD,  button_callback);

⑤ 启动按键 启动按键的API如下:

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

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

⑥ 设置一个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. 实验现象

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

2.5. 扩展实验

在注册回调函数时将这按下和松开屏蔽,将单击和双击打开进行测试:

//注册按钮事件回调函数
//button_attach(&button1, PRESS_DOWN,       button_callback);
//button_attach(&button1, PRESS_UP,         button_callback);
//button_attach(&button1, PRESS_REPEAT,     button_callback);
button_attach(&button1, SINGLE_CLICK,     button_callback);
button_attach(&button1, DOUBLE_CLICK,     button_callback);
//button_attach(&button1, LONG_RRESS_START, button_callback);
//button_attach(&button1, LONG_PRESS_HOLD,  button_callback);

再测试长按:

	//注册按钮事件回调函数
	//button_attach(&button1, PRESS_DOWN,       button_callback);
	//button_attach(&button1, PRESS_UP,         button_callback);
	//button_attach(&button1, PRESS_REPEAT,     button_callback);
	//button_attach(&button1, SINGLE_CLICK,     button_callback);
	//button_attach(&button1, DOUBLE_CLICK,     button_callback);
	button_attach(&button1, LONG_RRESS_START, button_callback);
	button_attach(&button1, LONG_PRESS_HOLD,  button_callback);

3. MultiButton设计思想解读

3.1. 面向对象思想

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

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

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

3.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前面,凭什么?

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

3.3. 状态机处理思想

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

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

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

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

读取当前引脚状态

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

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

按键消抖(连续读取3次,15ms,如果引脚状态一直与之前不同,则改变按键对象中的引脚状态):

状态机(整个设计的灵魂所在)

本文分享自微信公众号 - Mculover666(Mculover666),作者:mculover666

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-03-21

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 第9期 | CmBacktrace,一款 ARM Cortex-M 系列 MCU 错误追踪库

    本专栏由Mculover666创建,主要内容为寻找嵌入式领域内的优质开源项目,一是帮助开发者使用开源项目实现更多的功能,二是通过这些开源项目,学习大佬的代码及背...

    Mculover666
  • CoAP协议详细讲解+服务器搭建测试+数据抓包分析

    在IoT项目架构中,除了基于TCP的MQTT协议,使用最多的就是基于UDP的CoAP协议,两者可以说是平分秋色,各有优势。

    Mculover666
  • STM32 内存分配解析及变量的存储位置

    在一些桌面程序中,整个内存映射是通过虚拟内存来进行管理的,使用一种称为内存管理单元(MMU)的硬件结构来将程序的内存映射到物理RAM。在对于 RAM 紧缺的嵌入...

    Mculover666
  • 微信小程序云开发数据库操作查询记录

    数据库操作参考API:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-cl...

    王小婷
  • 微信小程序云开发数据库操作更新记录

    王小婷
  • Educational Codeforces Round 63 (Rated for Div. 2) D. Beautiful Array(dp)

    题目链接:https://codeforces.com/contest/1155/problem/D

    Ch_Zaqdt
  • 容器之查看minikue的environment——minikube的环境信息

    (adsbygoogle = window.adsbygoogle || []).push({});

    克虏伯
  • 学习协同过滤推荐 \w 100行Python代码

    用一百行 Python 代码,入门协同过滤推荐。

    刘笑江
  • 2017"百度之星"程序设计大赛 - 复赛1005&&HDU 6148 Valley Numer【数位dp】

    Valley Numer Time Limit: 2000/1000 MS (Java/Others)    Memory Limit: 32768/32768...

    Angel_Kitty
  • 【leetcode刷题】T157-不同路径 II

    一个机器人位于一个 m x n 网格的左上角 (起始点在下图中标记为“Start” )。

    木又AI帮

扫码关注云+社区

领取腾讯云代金券