开源按键组件MultiButton支持菜单操作(事件驱动型)

之前一个老友写的MultiButton开源按键组件的剖析讲解，它的设计思想简洁且高效，这篇文章我上周也分享出来给大家共同来学习了。 

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

至于介绍和使用在这里我就不多说了，相信看上面这篇文章你应该就懂了，但我想，能不能跟菜单操作绑定在一块呢？这样我不就可以利用起来，实现一个高效稳定的菜单+按键结合的状态机框架？纵观网上很多写菜单框架的，要不写得太死板，要不写得太冗长了，还有的写的还很难看得懂，超级麻烦，虽然各有各的方法去实现，都对，但有些真的不好维护和升级，比如下面这个，这应该是网上广泛流传的一个菜单框架的版本。但我觉得我实在看不下去了。

还有一些年代久远的论文：

https://wenku.baidu.com/view/576bae38ee06eff9aef807b9.html
https://blog.csdn.net/embedded_guzi/article/details/35835755
https://blog.csdn.net/cjqqschoolqq/article/details/8701387

我的项目设计原则：简单看得懂，实用，稳定，高效可拓展。

通常一些手持式设备都会有各种各样的按键，比如左、中、右、确定、返回、电源键等等(非矩阵键盘)，以我目前公司的产品，一般就这几个按键。

我们公司的产品主要的业务逻辑还是应用，应用逻辑最大的工作量其实就是利用按键+页面的形式来体现，这就少不了需要实现一套简单、高效、稳定、可拓展、可维护的菜单+按键的软件框架，有了这么一套好用的框架，后面随便换一个产品，就不用重新再去开发了，我们就可以专注于应用实现，把精力放在更有意义的软件业务逻辑上来。接下来我们在MultiButton的.h文件中添加菜单框架相关的结构体以及一些枚举：

/*菜单，具体是哪个页面，这个留给用户自己去添加*/
typedef enum
{
    MAIN_PAGE = 0,
    LOG_PAGE,
} MENU;

/*事件值，可以留给用户自己去定义，这里我定义了一些我需要的事件*/
typedef enum
{
    /*第一个事件为-1用来定义一个防止重复触发的值*/
    NULL_KEY_EVENT = -1,
    LEFT_KEY_SHORT = 0,
    LEFT_KEY_LONG  = 1,
    ENTER_KEY_SHORT = 2,
    ENTER_KEY_LONG = 3,
    RIGHT_LEY_SHORT = 4,
    RIGHT_KEY_LONG = 5,
    UP_KEY_SHORT = 6,
    UP_KEY_LONG = 7,
    DOWN_KEY_SHORT = 6,
    DOWN_KEY_LONG = 7,
    RETRUN_KEY_SHORT = 8,
    RETRUN_KEY_LONG = 9,
    POWER_KEY_SHORT = 10,
    POWER_KEY_LONG = 11,
} EVENT_CODE;

/*菜单操作结构体*/
typedef struct Menu
{
    /*当前正在执行的页面*/
    uint8_t Current_Page ;
    /*当前触发的事件*/
    int KeyEvent ;
} Menu ;


/*菜单初始化*/
void menu_init(struct Menu *handle, uint8_t Page, int EVENT_CODE);
/*获取当前菜单*/
uint8_t Get_Menu(struct Menu *handle);
/*菜单跳转*/
void Set_Menu(struct Menu *handle, uint8_t Page);
/*获取当前发生的事件值*/
int Get_Event_Code(struct Menu *handle);
/*设置当前发生的事件值*/
void Set_Event_Code(struct Menu *handle, int Event_Code);

再来看看.c文件相关函数的实现：

/*菜单初始化*/
void menu_init(struct Menu *handle, uint8_t Page, int EVENT_CODE)
{
    memset(handle, 0, sizeof(struct Menu));
    handle->Current_Page = Page  ;
    handle->KeyEvent = EVENT_CODE ;
}

/*菜单跳转*/
void Set_Menu(struct Menu *handle, uint8_t Page)
{
    handle->Current_Page = Page  ;
}

/*获取当前菜单*/
uint8_t Get_Menu(struct Menu *handle)
{
    return handle->Current_Page ;
}

/*设置当前发生的事件值*/
void Set_Event_Code(struct Menu *handle, int Event_Code)
{
    handle->KeyEvent = Event_Code ;
}

/*获取当前发生的事件值*/
int Get_Event_Code(struct Menu *handle)
{
    return handle->KeyEvent ;
}

非常简单，菜单的操作就在MutilButton的两个文件中添加完成了，接下来看看怎么来使用吧？

1、常规的MultiButton的使用方法

Button button ;
/*读取按键状态*/
uint8_t read_button_pin_status(void)
{
    return HAL_GPIO_ReadPin(KEY_GPIO_Port, KEY_Pin); ;
}

初始化multi_button并注册button event

button_init(&button, read_button_pin_status, 0);
button_attach(&button, SINGLE_CLICK, button_callback);
button_attach(&button, LONG_RRESS_START, button_callback);
button_start(&button);

当前我注册的这个按键的回调函数是同一个函数，而同一个函数做不同的处理：

void button_callback(void *event)
{
    uint8_t button_event = get_button_event(&button) ;
	
    switch(button_event)
    {
        case SINGLE_CLICK:
            /*当按键发生单击时，注册为ENTER_KEY_SHORT*/
            Set_Event_Code(&menu, ENTER_KEY_SHORT);
            break ;

        case LONG_RRESS_START:
            /*当按键发生长按时，注册为ENTER_KEY_LONG*/
            Set_Event_Code(&menu, ENTER_KEY_LONG);
            break ;

        default:
            break ;
    }
}

2、初始化菜单以及初始化触发事件

Menu   menu ;
//初始化页面为主页面，初始事件为NULL_KEY_EVENT
menu_init(&menu, MAIN_PAGE, NULL_KEY_EVENT);

3、循环调用菜单处理函数

while(1)
{
        /*用户代码*/
        /*......*/
	Menu_Handler(&menu);
	/*......*/
        timer_loop();
	 /*用户代码*/
}

注意，这里还需要一个5ms的定时器来调用button_ticks();这样MultiButton才能真正工作起来，我采用的是另外一套开源的软件定时器框架MultiTimer来实现的，这里就不贴出来了，后面直接分享工程实践测试源代码。

菜单处理函数的实现：

/*菜单处理*/
void Menu_Handler(struct Menu *handle)
{
    /*当前是菜单的哪个页面*/
    switch(handle->Current_Page)
    {
        case MAIN_PAGE :
            /*针对注册的键值做相应的处理*/
            main_page_process(handle->KeyEvent);
            break ;

        case LOG_PAGE:
            /*针对注册的键值做相应的处理*/
            log_page_process(handle->KeyEvent);
            break ;

        default:
            break ;
    }

    /*及时将事件清除，防止重复触发*/
    Set_Event_Code(handle, NULL_KEY_EVENT);
}

菜单对应的页面处理函数：

void main_page_process(uint8_t Event_Code)
{
    switch(Event_Code)
    {
    	/*当发生事件时，需要的时候做状态切换*/
        case ENTER_KEY_SHORT:
            printf("发生单击，进入页面1\n");
            Set_Menu(&menu, LOG_PAGE);
            break ;

        case ENTER_KEY_LONG:
            printf("在页面0发生长按\n");
            break ;
    }
}

void log_page_process(uint8_t Event_Code)
{
    switch(Event_Code)
    {
        case ENTER_KEY_SHORT:
            printf("在页面1发生单击\n");
            break ;
	/*当发生事件时，需要的时候做状态切换*/
        case ENTER_KEY_LONG:
            printf("发生长按，返回页面0\n");
            Set_Menu(&menu, MAIN_PAGE);
            break ;
    }
}

测试运行结果：

测试平台：stm32f103c8t6

测试工程下载：

链接：https://pan.baidu.com/s/124jks9I9uVXmKN3SXHQXvg
提取码：hv3g
复制这段内容后打开百度网盘手机App，操作更方便哦

或者公众号后台回复：菜单 即可轻松获得！

若觉得本次分享的文章对您有帮助，随手点[在看]并转发分享，也是对我的支持。