開源按鍵組件MultiButton支持菜單操作(事件驅(qū)動型)

之前一個老友寫的MultiButton開源按鍵組件的剖析講解，它的設計思想簡潔且高效，這篇文章我上周也分享出來給大家共同來學習了。 

第1期 | MultiButton，一個小巧簡單易用的事件驅(qū)動型按鍵驅(qū)動模塊

至于介紹和使用在這里我就不多說了，相信看上面這篇文章你應該就懂了，但我想，能不能跟菜單操作綁定在一塊呢？這樣我不就可以利用起來，實現(xiàn)一個高效穩(wěn)定的菜單+按鍵結合的狀態(tài)機框架？縱觀網(wǎng)上很多寫菜單框架的，要不寫得太死板，要不寫得太冗長了，還有的寫的還很難看得懂，超級麻煩，雖然各有各的方法去實現(xiàn)，都對，但有些真的不好維護和升級，比如下面這個，這應該是網(wǎng)上廣泛流傳的一個菜單框架的版本。但我覺得我實在看不下去了。

還有一些年代久遠的論文：

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

我的項目設計原則：簡單看得懂，實用，穩(wěn)定，高效可拓展。

通常一些手持式設備都會有各種各樣的按鍵，比如左、中、右、確定、返回、電源鍵等等(非矩陣鍵盤)，以我目前公司的產(chǎn)品，一般就這幾個按鍵。

我們公司的產(chǎn)品主要的業(yè)務邏輯還是應用，應用邏輯最大的工作量其實就是利用按鍵+頁面的形式來體現(xiàn)，這就少不了需要實現(xiàn)一套簡單、高效、穩(wěn)定、可拓展、可維護的菜單+按鍵的軟件框架，有了這么一套好用的框架，后面隨便換一個產(chǎn)品，就不用重新再去開發(fā)了，我們就可以專注于應用實現(xiàn)，把精力放在更有意義的軟件業(yè)務邏輯上來。接下來我們在MultiButton的.h文件中添加菜單框架相關的結構體以及一些枚舉：

/*菜單，具體是哪個頁面，這個留給用戶自己去添加*/
typedef enum
{
    MAIN_PAGE = 0,
    LOG_PAGE,
} MENU;

/*事件值，可以留給用戶自己去定義，這里我定義了一些我需要的事件*/
typedef enum
{
    /*第一個事件為-1用來定義一個防止重復觸發(fā)的值*/
    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
{
    /*當前正在執(zhí)行的頁面*/
    uint8_t Current_Page ;
    /*當前觸發(fā)的事件*/
    int KeyEvent ;
} Menu ;


/*菜單初始化*/
void menu_init(struct Menu *handle, uint8_t Page, int EVENT_CODE);
/*獲取當前菜單*/
uint8_t Get_Menu(struct Menu *handle);
/*菜單跳轉(zhuǎn)*/
void Set_Menu(struct Menu *handle, uint8_t Page);
/*獲取當前發(fā)生的事件值*/
int Get_Event_Code(struct Menu *handle);
/*設置當前發(fā)生的事件值*/
void Set_Event_Code(struct Menu *handle, int Event_Code);

再來看看.c文件相關函數(shù)的實現(xiàn)：

/*菜單初始化*/
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 ;
}

/*菜單跳轉(zhuǎn)*/
void Set_Menu(struct Menu *handle, uint8_t Page)
{
    handle->Current_Page = Page  ;
}

/*獲取當前菜單*/
uint8_t Get_Menu(struct Menu *handle)
{
    return handle->Current_Page ;
}

/*設置當前發(fā)生的事件值*/
void Set_Event_Code(struct Menu *handle, int Event_Code)
{
    handle->KeyEvent = Event_Code ;
}

/*獲取當前發(fā)生的事件值*/
int Get_Event_Code(struct Menu *handle)
{
    return handle->KeyEvent ;
}

非常簡單，菜單的操作就在MutilButton的兩個文件中添加完成了，接下來看看怎么來使用吧？

1、常規(guī)的MultiButton的使用方法

Button button ;
/*讀取按鍵狀態(tài)*/
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);

當前我注冊的這個按鍵的回調(diào)函數(shù)是同一個函數(shù)，而同一個函數(shù)做不同的處理：

void button_callback(void *event)
{
    uint8_t button_event = get_button_event(&button) ;
	
    switch(button_event)
    {
        case SINGLE_CLICK:
            /*當按鍵發(fā)生單擊時，注冊為ENTER_KEY_SHORT*/
            Set_Event_Code(&menu, ENTER_KEY_SHORT);
            break ;

        case LONG_RRESS_START:
            /*當按鍵發(fā)生長按時，注冊為ENTER_KEY_LONG*/
            Set_Event_Code(&menu, ENTER_KEY_LONG);
            break ;

        default:
            break ;
    }
}

2、初始化菜單以及初始化觸發(fā)事件

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

3、循環(huán)調(diào)用菜單處理函數(shù)

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

注意，這里還需要一個5ms的定時器來調(diào)用button_ticks();這樣MultiButton才能真正工作起來，我采用的是另外一套開源的軟件定時器框架MultiTimer來實現(xiàn)的，這里就不貼出來了，后面直接分享工程實踐測試源代碼。

菜單處理函數(shù)的實現(xiàn)：

/*菜單處理*/
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 ;
    }

    /*及時將事件清除，防止重復觸發(fā)*/
    Set_Event_Code(handle, NULL_KEY_EVENT);
}

菜單對應的頁面處理函數(shù)：

void main_page_process(uint8_t Event_Code)
{
    switch(Event_Code)
    {
    	/*當發(fā)生事件時，需要的時候做狀態(tài)切換*/
        case ENTER_KEY_SHORT:
            printf("發(fā)生單擊，進入頁面1\n");
            Set_Menu(&menu, LOG_PAGE);
            break ;

        case ENTER_KEY_LONG:
            printf("在頁面0發(fā)生長按\n");
            break ;
    }
}

void log_page_process(uint8_t Event_Code)
{
    switch(Event_Code)
    {
        case ENTER_KEY_SHORT:
            printf("在頁面1發(fā)生單擊\n");
            break ;
	/*當發(fā)生事件時，需要的時候做狀態(tài)切換*/
        case ENTER_KEY_LONG:
            printf("發(fā)生長按，返回頁面0\n");
            Set_Menu(&menu, MAIN_PAGE);
            break ;
    }
}

測試運行結果：

測試平臺：stm32f103c8t6

測試工程下載：

鏈接：https://pan.baidu.com/s/124jks9I9uVXmKN3SXHQXvg
提取碼：hv3g
復制這段內(nèi)容后打開百度網(wǎng)盤手機App，操作更方便哦

或者公眾號后臺回復：菜單 即可輕松獲得！

若覺得本次分享的文章對您有幫助，隨手點[在看]并轉(zhuǎn)發(fā)分享，也是對我的支持。