STM32移植嵌入式开源按键框架

目录

STM32移植嵌入式开源按键框架

MultiButton简介

multi_button.c文件

multi_button.h文件

按键事件

案例使用方法

学习剖析

STM32移植嵌入式开源按键框架

今天移植了一款嵌入式按键框架工程MultiButton，MultiButton是一个小巧简单易用的事件驱动型按键驱动模块。

Github地址：GitHub - 0x1abin/MultiButton: Button driver for embedded system

现于2024.04.15进行移植，具体就两个文件：multi_button的c文件和h文件。

MultiButton简介

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

multi_button.c文件

把license内容放到代码首段。

/** MIT License* Copyright (c) 2018 Zibin Zheng* * Permission is hereby granted, free of charge, to any person obtaining a copy* of this software and associated documentation files (the "Software"), to deal* in the Software without restriction, including without limitation the rights* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell* copies of the Software, and to permit persons to whom the Software is* furnished to do so, subject to the following conditions:* * The above copyright notice and this permission notice shall be included in all* copies or substantial portions of the Software.* * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE* SOFTWARE.*//* github:https://github.com/0x1abin/MultiButton */#include "driver_button.h"#define EVENT_CB(ev)   if(handle->cb[ev])handle->cb[ev]((void*)handle)
#define PRESS_REPEAT_MAX_NUM  15 /*!< The maximum value of the repeat counter *///button handle list head.
static struct Button* head_handle = NULL;static void button_handler(struct Button* handle);/*** @brief  Initializes the button struct handle.* @param  handle: the button handle struct.* @param  pin_level: read the HAL GPIO of the connected button level.* @param  active_level: pressed GPIO level.* @param  button_id: the button id.* @retval None*/
void button_init(struct Button* handle, uint8_t(*pin_level)(uint8_t), uint8_t active_level, uint8_t button_id)
{memset(handle, 0, sizeof(struct Button));handle->event = (uint8_t)NONE_PRESS;handle->hal_button_Level = pin_level;handle->button_level = handle->hal_button_Level(button_id);handle->active_level = active_level;handle->button_id = button_id;
}/*** @brief  Attach the button event callback function.* @param  handle: the button handle struct.* @param  event: trigger event type.* @param  cb: callback function.* @retval None*/
void button_attach(struct Button* handle, PressEvent event, BtnCallback cb)
{handle->cb[event] = cb;
}/*** @brief  Inquire the button event happen.* @param  handle: the button handle struct.* @retval button event.*/
PressEvent get_button_event(struct Button* handle)
{return (PressEvent)(handle->event);
}/*** @brief  Button driver core function, driver state machine.* @param  handle: the button handle struct.* @retval None*/
static void button_handler(struct Button* handle)
{uint8_t read_gpio_level = handle->hal_button_Level(handle->button_id);//ticks counter working..if((handle->state) > 0) handle->ticks++;/*------------button debounce handle---------------*/if(read_gpio_level != handle->button_level) { //not equal to prev one//continue read 3 times same new level changeif(++(handle->debounce_cnt) >= DEBOUNCE_TICKS) {handle->button_level = read_gpio_level;handle->debounce_cnt = 0;}} else { //level not change ,counter reset.handle->debounce_cnt = 0;}/*-----------------State machine-------------------*/switch (handle->state) {case 0:if(handle->button_level == handle->active_level) {	//start press downhandle->event = (uint8_t)PRESS_DOWN;EVENT_CB(PRESS_DOWN);handle->ticks = 0;handle->repeat = 1;handle->state = 1;} else {handle->event = (uint8_t)NONE_PRESS;}break;case 1:if(handle->button_level != handle->active_level) { //released press uphandle->event = (uint8_t)PRESS_UP;EVENT_CB(PRESS_UP);handle->ticks = 0;handle->state = 2;} else if(handle->ticks > LONG_TICKS) {handle->event = (uint8_t)LONG_PRESS_START;EVENT_CB(LONG_PRESS_START);handle->state = 5;}break;case 2:if(handle->button_level == handle->active_level) { //press down againhandle->event = (uint8_t)PRESS_DOWN;EVENT_CB(PRESS_DOWN);if(handle->repeat != PRESS_REPEAT_MAX_NUM) {handle->repeat++;}EVENT_CB(PRESS_REPEAT); // repeat hithandle->ticks = 0;handle->state = 3;} else if(handle->ticks > SHORT_TICKS) { //released timeoutif(handle->repeat == 1) {handle->event = (uint8_t)SINGLE_CLICK;EVENT_CB(SINGLE_CLICK);} else if(handle->repeat == 2) {handle->event = (uint8_t)DOUBLE_CLICK;EVENT_CB(DOUBLE_CLICK); // repeat hit}handle->state = 0;}break;case 3:if(handle->button_level != handle->active_level) { //released press uphandle->event = (uint8_t)PRESS_UP;EVENT_CB(PRESS_UP);if(handle->ticks < SHORT_TICKS) {handle->ticks = 0;handle->state = 2; //repeat press} else {handle->state = 0;}} else if(handle->ticks > SHORT_TICKS) { // SHORT_TICKS < press down hold time < LONG_TICKShandle->state = 1;}break;case 5:if(handle->button_level == handle->active_level) {//continue hold triggerhandle->event = (uint8_t)LONG_PRESS_HOLD;EVENT_CB(LONG_PRESS_HOLD);} else { //releasedhandle->event = (uint8_t)PRESS_UP;EVENT_CB(PRESS_UP);handle->state = 0; //reset}break;default:handle->state = 0; //resetbreak;}
}/*** @brief  Start the button work, add the handle into work list.* @param  handle: target handle struct.* @retval 0: succeed. -1: already exist.*/
int button_start(struct Button* handle)
{struct Button* target = head_handle;while(target) {if(target == handle) return -1;	//already exist.target = target->next;}handle->next = head_handle;head_handle = handle;return 0;
}/*** @brief  Stop the button work, remove the handle off work list.* @param  handle: target handle struct.* @retval None*/
void button_stop(struct Button* handle)
{struct Button** curr;for(curr = &head_handle; *curr; ) {struct Button* entry = *curr;if(entry == handle) {*curr = entry->next;
//			free(entry);return;//glacier add 2021-8-18} else {curr = &entry->next;}}
}/*** @brief  background ticks, timer repeat invoking interval 5ms.* @param  None.* @retval None*/
void button_ticks(void)
{struct Button* target;for(target=head_handle; target; target=target->next) {button_handler(target);}
}

multi_button.h文件

extern使用函数，供外部文件使用。 

/** Copyright (c) 2016 Zibin Zheng <znbin@qq.com>* All rights reserved*/#ifndef _MULTI_BUTTON_H_
#define _MULTI_BUTTON_H_#include <stdint.h>
#include <string.h>//According to your need to modify the constants.
#define TICKS_INTERVAL    5	//ms
#define DEBOUNCE_TICKS    3	//MAX 7 (0 ~ 7)
#define SHORT_TICKS       (300 /TICKS_INTERVAL)		// ms
#define LONG_TICKS        (1000 /TICKS_INTERVAL)	// mstypedef void (*BtnCallback)(void*);typedef enum {PRESS_DOWN = 0,		/* 按键按下，每次按下都触发 */PRESS_UP,			/* 按键弹起，每次松开都触发 */PRESS_REPEAT,		/* 重复按下触发，变量repeat计数连击次数 */SINGLE_CLICK,		/* 单击按键事件 */DOUBLE_CLICK,		/* 双击按键事件 */LONG_PRESS_START,	/* 达到长按时间阈值时触发一次 */LONG_PRESS_HOLD,	/* 长按期间一直触发 */number_of_event,	/* 只为记录在此之前的事件次数 */NONE_PRESS			/* 默认状态，无按键按下 */
}PressEvent;typedef struct Button {uint16_t ticks;uint8_t  repeat : 4;								/* 重复按下次数，0~15 */uint8_t  event : 4;									/* 按键事件类型，默认NONE_PRESS，0~15 */uint8_t  state : 3;									/* 按键状态机状态：0~7 */uint8_t  debounce_cnt : 3;							/* 防抖次数，0~7 */uint8_t  active_level : 1;							/* 按键按下电平，0~1 */uint8_t  button_level : 1;							/* 按键电平，0~1 */uint8_t  button_id;									/* 按键id */uint8_t  (*hal_button_Level)(uint8_t button_id_);	/* 按键电平检测函数 */BtnCallback  cb[number_of_event];					/* 创建各事件处理函数数组 */struct Button* next;								/* 指向下一个按钮对象 */
}Button;#ifdef __cplusplus
extern "C" {
#endifextern void button_init(struct Button* handle, uint8_t(*pin_level)(uint8_t), uint8_t active_level, uint8_t button_id);	/* 初始化按键对象 */
extern void button_attach(struct Button* handle, PressEvent event, BtnCallback cb);	/* 注册按键事件 */
extern PressEvent get_button_event(struct Button* handle);
extern int  button_start(struct Button* handle);	/* 开始按键检测 */
extern void button_stop(struct Button* handle);		/* 停止按键检测 */
extern void button_ticks(void);#ifdef __cplusplus
}
#endif#endif

按键事件

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

案例使用方法

结合自身项目需求实现。我使用到了FreeRTOS V2操作系统。

只需调用MultiButton_Init()函数初始化，调用xxx_Handler()函数处理。

#include "driver_button.h"enum Button_IDs 
{btn1_id,btn2_id,
};static osTimerId_t 	multiButtonTimer;
struct Button btn1;
struct Button btn2;static void MultiButtonTimerCallback (void *argument);
static uint8_t read_button_GPIO(uint8_t button_id);
static void BTN1_PRESS_CLICK_Handler(void* btn);
static void BTN2_PRESS_CLICK_Handler(void* btn);static uint8_t read_button_GPIO(uint8_t button_id)
{// you can share the GPIO read function with multiple Buttonsswitch(button_id){case btn1_id:return HAL_GPIO_ReadPin(OLED_KEY1_GPIO_Port, OLED_KEY1_Pin);case btn2_id:return !HAL_GPIO_ReadPin(USER_KEY_GPIO_Port, USER_KEY_Pin);default:return 0;}
}static void BTN1_PRESS_CLICK_Handler(void* btn)
{/* 事件处理时间不宜过长 *///do something...
}static void BTN2_PRESS_CLICK_Handler(void* btn)
{/* 事件处理时间不宜过长 *///do something...
}void MultiButton_Init(void)
{multiButtonTimer = osTimerNew(MultiButtonTimerCallback, osTimerPeriodic, NULL, NULL);/* 单按键初始化 */button_init(&btn1, read_button_GPIO, 0, btn1_id);	button_init(&btn2, read_button_GPIO, 0, btn2_id);/* 单按键注册，可单按键多事件注册 */button_attach(&btn1, SINGLE_CLICK,         BTN1_PRESS_CLICK_Handler);button_attach(&btn2, SINGLE_CLICK,         BTN2_PRESS_CLICK_Handler);/* 单按键检测 */button_start(&btn1);button_start(&btn2);osTimerStart(multiButtonTimer, 5); 		//启动定时器，5ms每轮
}/************************************************************************	5ms进一次定时器回调函数**********************************************************************/
static void MultiButtonTimerCallback (void *argument)
{button_ticks();
}

学习剖析

学习要点：

        按键各种类型事件。

        状态机思想。

        单向链表语法。

button_init()函数很简单，默认记录了单按键句柄的按键事件类型、按键此刻电平、按键按下电平、按键ID和按键电平检测函数。

使用方法：

button_init(&btn1, read_button_GPIO, 0, btn1_id);    // 低电平按下

button_attach()函数也很简单，注册按钮，即将按键处理函数放入单按键句柄的对应按键事件数组位置。

使用方法：

button_attach(&btn1, SINGLE_CLICK,         BTN1_PRESS_CLICK_Handler);

get_button_event()函数也很简单，获取当前单按键句柄的发生事件类型。

button_handler()函数采用了状态机的思想。大概思想如下：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/818822.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Qt 3 QVariant类的使用和实例

Qt 3 QVariant类的使用和实例

QVariant, 类本质为 C联合(Union)数据类型&#xff0c;它可以保存很多Qt 类型的值&#xff0c;包括 QBrush、QColor、QString 等等。也能够存放Qt的容器类型的值。QVariant::StringList 是 Qt定义的一个 QVariant::type 枚举类型的变量&#xff0c;其他常用的枚举类型变量如下表…
阅读更多...
【Qt】：对话框（二）

【Qt】：对话框（二）

对话框 一.消息对话框&#xff08;QMessageBox&#xff09;1.自己构建2.使用静态函数构建 二.颜色对话框&#xff08;QDialog&#xff09;三.文件对话框&#xff08;QFileDialog&#xff09;四.字体对话框&#xff08;QFontDialog&#xff09;五.输入对话框&#xff08;QInputD…
阅读更多...
沐风老师3DMAX物品摆放插件ObjectPlacer安装和使用方法详解

沐风老师3DMAX物品摆放插件ObjectPlacer安装和使用方法详解

3DMAX物品摆放插件ObjectPlacer安装和使用教程 3DMAX物品摆放插件ObjectPlacer&#xff0c;一键在曲面上摆放对象&#xff0c;如摆放家具物品、种植花草树木、布设电线杆交通标志等。它的功能是将对象与几何体对象&#xff08;网格、多边形、面片或NURBS&#xff09;的面法线对…
阅读更多...
中电金信：夯实云原生时代的系统韧性建设——中电金信混沌工程金融业实践

中电金信：夯实云原生时代的系统韧性建设——中电金信混沌工程金融业实践

IT系统建设在经历过单机、集中、分布式的演变历程后&#xff0c;系统运维演练、故障模拟测试的复杂度也不断提高。在复杂的分布式系统中&#xff0c;基础设施、应用平台都可能产生不可预知的故障&#xff0c;在不能确知故障根源的情况下&#xff0c;我们无法阻止故障的发生。更…
阅读更多...
3D可视化技术：研发基地的科技新篇章

3D可视化技术：研发基地的科技新篇章

在科技日新月异的今天&#xff0c;我们生活在一个充满无限可能性的时代。而在这个时代中&#xff0c;3D可视化技术正以其独特的魅力&#xff0c;引领着科技领域的新一轮变革。 3D可视化技术通过三维图像的方式&#xff0c;将现实世界或虚拟世界中的物体、场景等以立体、逼真的形…
阅读更多...
Mockito单元测试

Mockito单元测试

文章目录 Mockito单元测试 为什么要使用Mock?导入依赖import导入包使用Mock模拟测试某个类中的某个方法是否可以成功执行使用Mock模拟某个类的方法&#xff0c;自己给这个方法返回我们指定的值使用Mock模拟某个方法调用后会抛出指定的异常使用Mock模拟测试某个类中的某个方法(…
阅读更多...
04—常用方法和正则表达式

04—常用方法和正则表达式

一、字符串 1.length 属性返回字符串的长度(字符数)。 2.在字符串中查找字符串 indexOf() 字符串使用 indexOf() 来定位字符串中某一个指定的字符首次出现的位置 如果没找到对应的字符函数返回-1 lastIndexOf() 方法在字符串末尾开始查找字符串出现的位置。 3.replace() 方…
阅读更多...
网络字节序

网络字节序

什么是网络字节序 网络字节序是网络传输的过程中所采用的字节序，那么网络传输的过程中一般都采用什么字节序呢？ 答案是大端字节序。 字节序分为大端和小端，他们代表多字节数值在内存中的存储方式。下面咱们讲解一下什么是大端，什么是小端？ 大端字节序：数值的最高位字…
阅读更多...
Linux安装docker（含Centos系统和Ubuntu系统）

Linux安装docker（含Centos系统和Ubuntu系统）

一、Centos系统 1. 卸载旧版本依赖 sudo yum remove docker \docker-client \docker-client-latest \docker-common \docker-latest \docker-latest-logrotate \docker-logrotate \docker-engine 2. 设置仓库 安装所需的软件包。yum-utils 提供了 yum-config-manager &…
阅读更多...
实时传输，弹性优先——物联网通讯打造数据上传新标杆

实时传输，弹性优先——物联网通讯打造数据上传新标杆

随着信息技术的飞速发展&#xff0c;物联网技术已经成为连接物理世界和数字世界的桥梁。在物联网领域&#xff0c;数据上传的速度、稳定性和灵活性是评价通讯技术优劣的重要指标。近年来&#xff0c;物联网通讯在实时传输、弹性优先方面取得了显著进展&#xff0c;为数据上传树…
阅读更多...
设计模式：时序图

设计模式：时序图

设计模式&#xff1a;时序图 设计模式&#xff1a;时序图时序图元素&#xff08;Sequence Diagram Elements&#xff09;角色&#xff08;Actor&#xff09;对象&#xff08;Object&#xff09;生命线&#xff08;Lifeline&#xff09;控制焦点&#xff08;Focus of Control&am…
阅读更多...
Spring Boot 统一功能处理（三）

Spring Boot 统一功能处理（三）

本篇主要介绍Spring Boot的统一异常处理。 目录 一、统一异常处理的使用 二、测试统一异常处理效果 三、浅析原理 ControllerAdvice简析 统一处理异常简析 一、统一异常处理的使用 在前面介绍统一数据返回时&#xff0c;我们在程序发生异常时会把整个报错信息都封装在da…
阅读更多...
ELK日志收集和备份填坑实战 （滞后8个小时等时区问题）

ELK日志收集和备份填坑实战 （滞后8个小时等时区问题）

ES的备份&#xff1a;ES快照备份 根据时间&#xff0c;每天零点在Linux机器crontab来调用api接口实现快照备份&#xff0c;通过快照备份&#xff0c;可以定准恢复到某一天的日志。 现象&#xff1a;&#xff08;坑&#xff1a;但是恢复某一天日志&#xff0c;发现会少8小时的日…
阅读更多...
《云原生安全攻防》-- 云原生攻防矩阵

《云原生安全攻防》-- 云原生攻防矩阵

在本节课程中&#xff0c;我们将开始学习如何从攻击者的角度思考&#xff0c;一起探讨常见的容器和K8s攻击手法&#xff0c;包含以下两个主要内容&#xff1a; 云原生环境的攻击路径: 了解云原生环境的整体攻击流程。 云原生攻防矩阵: 云原生环境攻击路径的全景视图&#xff0…
阅读更多...
Python数据可视化库—Bokeh与Altair指南【第161篇—数据可视化】

Python数据可视化库—Bokeh与Altair指南【第161篇—数据可视化】

&#x1f47d;发现宝藏 前些天发现了一个巨牛的人工智能学习网站&#xff0c;通俗易懂&#xff0c;风趣幽默&#xff0c;忍不住分享一下给大家。【点击进入巨牛的人工智能学习网站】。 在数据科学和数据分析领域&#xff0c;数据可视化是一种强大的工具&#xff0c;可以帮助我们…
阅读更多...
【数据库】表的增删改（CUD）

【数据库】表的增删改（CUD）

目录 一、insert 插入 1.单行插入&#xff1a; 2.多行插入&#xff1a; (1) insert into 插入&#xff1a; (2) replace into 替换插入&#xff1a; (3) 图片插入 &#xff1a; 二、update 修改 三、delete 删除 一、insert 插入 语法&#xff1a; INSERT INTO table_name…
阅读更多...
服务器负载均衡SLB/加密原理

服务器负载均衡SLB/加密原理

多台服务器提供相同的服务 SLB(server load balancing) 多台服务器对应一个虚拟地址&#xff0c;该地址是防火墙虚拟出来的。 服务器负载均衡功能仅支持IPV4协议 多通道协议仅支持FTP协议
阅读更多...
【架构-13】云原生架构

【架构-13】云原生架构

云原生架构产生背景&#xff1f; &#xff08;1&#xff09;大量资源被占用且难以分享&#xff0c;上云后&#xff0c;云厂商提供统一的IaaS能力和云服务。 &#xff08;2&#xff09;提供极致性能的云原生算力。 &#xff08;3&#xff09;集成服务&#xff0c;构建管理数据、…
阅读更多...
Android Studio通过修改文件gradle-wrapper.properties内容下载gradle

Android Studio通过修改文件gradle-wrapper.properties内容下载gradle

一、问题描述 在Android Studio中新建项目后会下载你所新建的项目的activity/gradle/wrapper目录下所配置的gradle-7.3.3-bin.zip包&#xff08;笔者的是该版本包&#xff09;&#xff0c;而大多数时候会下载失败&#xff0c;如下 二、解决办法 新建工程后&#xff0c;取消下…
阅读更多...
AI术语大全：AGI、LLM、GenAI、GPT、ChatGPT和AIGC是什么意思？

AI术语大全：AGI、LLM、GenAI、GPT、ChatGPT和AIGC是什么意思？

讲动人的故事，写懂人的代码 自2022年底ChatGPT在全球AI界闪亮登场以后，你是不是经常听到AGI、LLM、GenAI、GPT和AIGC这几个词，但总是分不清它们到底是什么意思？ 今天，我就用简单的话来给你讲讲这些词到底是什么意思。 AI，人工智能（Artificial Intelligence），就是让机…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023