按鍵庫(kù)源碼及應(yīng)用

按鍵在電子產(chǎn)品中很常見，今天給大家分享一套按鍵庫(kù)源碼及應(yīng)用。

https://gitee.com/zhengnianli/EmbedSummary

FlexibleButton介紹

FlexibleButton 是一個(gè)基于標(biāo)準(zhǔn) C 語(yǔ)言的小巧靈活的按鍵處理庫(kù)，支持單擊、連擊、短按、長(zhǎng)按、自動(dòng)消抖，可以自由設(shè)置組合按鍵，可用于中斷和低功耗場(chǎng)景。

該按鍵庫(kù)解耦了具體的按鍵硬件結(jié)構(gòu)，理論上支持輕觸按鍵與自鎖按鍵，并可以無(wú)限擴(kuò)展按鍵數(shù)量。

另外，F(xiàn)lexibleButton 使用掃描的方式一次性讀取所有所有的按鍵狀態(tài)，然后通過事件回調(diào)機(jī)制上報(bào)按鍵事件。

核心的按鍵掃描代碼僅有三行，沒錯(cuò)，就是經(jīng)典的三行按鍵掃描算法。使用 C 語(yǔ)言標(biāo)準(zhǔn)庫(kù) API 編寫，也使得該按鍵庫(kù)可以無(wú)縫兼容任意的處理器平臺(tái)，并且支持任意 OS 和 non-OS（裸機(jī)編程）。

倉(cāng)庫(kù)鏈接：

https://github.com/murphyzhao/FlexibleButton

license：Apache-2.0。

關(guān)于開源軟件協(xié)議相關(guān)文章：常用的開源協(xié)議有哪些？

同類型的按鍵處理庫(kù)還有MultiButton：

https://github.com/0x1abin/MultiButton

FlexibleButton的使用

FlexibleButton 包含有兩個(gè)文件：

flexible_button.c、flexible_button.h

使用起來(lái)很簡(jiǎn)單，作者在README中也很詳細(xì)地介紹了FlexibleButton 的使用。

下面，我們基于小熊派IOT開發(fā)板來(lái)簡(jiǎn)單實(shí)踐實(shí)踐：基于裸機(jī)及基于RT-Thread。

1、基于non-OS（裸機(jī)編程）

板子上有兩個(gè)用戶按鍵及一個(gè)用戶LED。

我們實(shí)現(xiàn)如下操作：

• 單擊button0（即F1按鍵），點(diǎn)亮led。
• 單機(jī)button1（即F2按鍵），熄滅led。
• 雙擊button0（即F1按鍵），點(diǎn)亮led。
• 雙擊button1（即F2按鍵），熄滅led。
• 同時(shí)按下button0及button1，點(diǎn)亮led。

FlexibleButton 給我們提供了很多按鍵事件給我們使用，基本涵蓋了我們?nèi)粘Ｊ褂冒存I的各種場(chǎng)景。FlexibleButton支持的按鍵事件如：

左右滑動(dòng)查看全部代碼>>>

typedefenum
{
FLEX_BTN_PRESS_DOWN=0,//按下事件
FLEX_BTN_PRESS_CLICK,//單擊事件
FLEX_BTN_PRESS_DOUBLE_CLICK,//雙擊事件
FLEX_BTN_PRESS_REPEAT_CLICK,//連擊事件，使用flex_button_t中的click_cnt斷定連擊次數(shù)
FLEX_BTN_PRESS_SHORT_START,//短按開始事件
FLEX_BTN_PRESS_SHORT_UP,//短按抬起事件
FLEX_BTN_PRESS_LONG_START,//長(zhǎng)按開始事件
FLEX_BTN_PRESS_LONG_UP,//長(zhǎng)按抬起事件
FLEX_BTN_PRESS_LONG_HOLD,//長(zhǎng)按保持事件
FLEX_BTN_PRESS_LONG_HOLD_UP,//長(zhǎng)按保持的抬起事件
FLEX_BTN_PRESS_MAX,
FLEX_BTN_PRESS_NONE,
}flex_button_event_t;

所以，哪怕我們的板子只有一兩個(gè)按鍵，也可以做很多按鍵控制。

下面來(lái)一起實(shí)操一下：

首先，準(zhǔn)備一個(gè)按鍵相關(guān)工程，把flexible_button.c、flexible_button.h添加到工程里。

flexible_button.h對(duì)外提供了如下幾個(gè)接口：

左右滑動(dòng)查看全部代碼>>>

int32_tflex_button_register(flex_button_t*button);//按鍵注冊(cè)
flex_button_event_tflex_button_event_read(flex_button_t*button);//按鍵事件讀取
uint8_tflex_button_scan(void);//按鍵掃描

• 按鍵ID
• 按鍵引腳電平讀取函數(shù)
• 事件回調(diào)函數(shù)
• 設(shè)置按鍵按下的邏輯電平
• 設(shè)置短按事件觸發(fā)的起始 tick
• 設(shè)置長(zhǎng)按事件觸發(fā)的起始 tick
• 設(shè)置長(zhǎng)按保持事件觸發(fā)的起始 tick

flex_button_register在初始化時(shí)進(jìn)行調(diào)用，如：

左右滑動(dòng)查看全部代碼>>>

staticvoiduser_button_init(void)
{
inti;

memset(&user_button[0],0x0,sizeof(user_button));

for(i=0;i//按鍵的ID號(hào)
user_button[i].usr_button_read=common_btn_read;//按鍵引腳電平讀取函數(shù)
user_button[i].cb=common_btn_evt_cb;//事件回調(diào)函數(shù)
user_button[i].pressed_logic_level=0;//設(shè)置按鍵按下的邏輯電平
user_button[i].short_press_start_tick=FLEX_MS_TO_SCAN_CNT(1500);//設(shè)置短按事件觸發(fā)的起始tick
user_button[i].long_press_start_tick=FLEX_MS_TO_SCAN_CNT(3000);//設(shè)置長(zhǎng)按事件觸發(fā)的起始tick
user_button[i].long_hold_start_tick=FLEX_MS_TO_SCAN_CNT(4500);//設(shè)置長(zhǎng)按保持事件觸發(fā)的起始tick

flex_button_register(&user_button[i]);//按鍵注冊(cè)
}
}

比如，一些美食教程，常常提供一些制作巧克力的方法，而不是每種口味的巧克力都教一遍，因?yàn)榉椒ɑ径疾畈欢唷２煌娜讼矚g不同的巧克力口味，根據(jù)自己需要，準(zhǔn)備做巧克力的原料，再套用制作方法就可以。

FlexibleButton提供一個(gè)管理按鍵的框架，我們根據(jù)不同的的芯片或者不同的環(huán)境提供FlexibleButton需要的一些按鍵信息，就可以起到相同效果。

FlexibleButton數(shù)據(jù)結(jié)構(gòu)：

左右滑動(dòng)查看全部代碼>>>

typedefstructflex_button
{
structflex_button*next;//按鍵庫(kù)使用單向鏈表串起所有的按鍵

uint8_t(*usr_button_read)(void*);//用戶設(shè)備的按鍵引腳電平讀取函數(shù)，重要
flex_button_response_callbackcb;//設(shè)置按鍵事件回調(diào)，用于應(yīng)用層對(duì)按鍵事件的分類處理

uint16_tscan_cnt;//用于記錄掃描次數(shù)，按鍵按下是開始從零計(jì)數(shù)
uint16_tclick_cnt;//記錄單擊次數(shù)，用于判定單擊、連擊
uint16_tmax_multiple_clicks_interval;//連擊間隙，用于判定是否結(jié)束連擊計(jì)數(shù)，有默認(rèn)值

uint16_tdebounce_tick;//消抖時(shí)間，暫未使用，依靠掃描間隙進(jìn)行消抖
uint16_tshort_press_start_tick;//設(shè)置短按事件觸發(fā)的起始tick
uint16_tlong_press_start_tick;//設(shè)置長(zhǎng)按事件觸發(fā)的起始tick
uint16_tlong_hold_start_tick;//設(shè)置長(zhǎng)按保持事件觸發(fā)的起始tick

uint8_tid;//當(dāng)多個(gè)按鍵使用同一個(gè)回調(diào)函數(shù)時(shí)，用于斷定屬于哪個(gè)按鍵
uint8_tpressed_logic_level:1;//設(shè)置按鍵按下的邏輯電平
uint8_tevent:4;//用于記錄當(dāng)前按鍵事件
uint8_tstatus:3;//用于記錄當(dāng)前按鍵的狀態(tài)，用于內(nèi)部狀態(tài)機(jī)
}flex_button_t;

左右滑動(dòng)查看全部代碼>>>

staticuint8_tcommon_btn_read(void*arg)
{
uint8_tvalue=0;

flex_button_t*btn=(flex_button_t*)arg;

switch(btn->id)
{
caseUSER_BUTTON_0:
value=HAL_GPIO_ReadPin(USER_BUTTON_0_PORT,USER_BUTTON_0_PIN);
break;
caseUSER_BUTTON_1:
value=HAL_GPIO_ReadPin(USER_BUTTON_1_PORT,USER_BUTTON_1_PIN);
break;
default:
assert_param(0);
}

returnvalue;
}

左右滑動(dòng)查看全部代碼>>>

//按鍵事件回調(diào)函數(shù)
staticvoidcommon_btn_evt_cb(void*arg)
{
flex_button_t*btn=(flex_button_t*)arg;

//非組合按鍵事件處理
non_combination_btn_event(btn);

//組合按鍵事件處理
if((flex_button_event_read(&user_button[USER_BUTTON_0])==FLEX_BTN_PRESS_CLICK)&&
(flex_button_event_read(&user_button[USER_BUTTON_1])==FLEX_BTN_PRESS_CLICK))
{
printf("[combination]:button0andbutton1,LEDON>>>>>>>>>>>>>>>>>>>>>>>
");
HAL_GPIO_WritePin(LED_GPIO_Port,LED_Pin,GPIO_PIN_SET);//亮
}
}

//非組合按鍵事件處理
staticvoidnon_combination_btn_event(flex_button_t*btn)
{
switch(btn->id)
{
caseUSER_BUTTON_0:
{
switch(btn->event)
{
caseFLEX_BTN_PRESS_DOWN:
printf("%s:%s
",enum_btn_id_string[btn->id],enum_event_string[btn->event]);
break;
caseFLEX_BTN_PRESS_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port,LED_Pin,GPIO_PIN_SET);//亮
printf("%s:%s
",enum_btn_id_string[btn->id],enum_event_string[btn->event]);
printf("<<<<<<<<<<<<<<<<<<<<<<<);
break;
caseFLEX_BTN_PRESS_DOUBLE_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port,LED_Pin,GPIO_PIN_SET);//亮
printf("%s:%s
",enum_btn_id_string[btn->id],enum_event_string[btn->event]);
printf("<<<<<<<<<<<<<<<<<<<<<<<);
break;
default:
break;
}
break;
}

caseUSER_BUTTON_1:
{
switch(btn->event)
{
caseFLEX_BTN_PRESS_DOWN:
printf("%s:%s
",enum_btn_id_string[btn->id],enum_event_string[btn->event]);
break;
caseFLEX_BTN_PRESS_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port,LED_Pin,GPIO_PIN_RESET);//滅
printf("%s:%s
",enum_btn_id_string[btn->id],enum_event_string[btn->event]);
printf("<<<<<<<<<<<<<<<<<<<<<<<);
break;
caseFLEX_BTN_PRESS_DOUBLE_CLICK:
HAL_GPIO_WritePin(LED_GPIO_Port,LED_Pin,GPIO_PIN_RESET);//滅
printf("%s:%s
",enum_btn_id_string[btn->id],enum_event_string[btn->event]);
printf("<<<<<<<<<<<<<<<<<<<<<<<);
break;
default:
break;
}
break;
}

default:
break;
}
}

主函數(shù)中需要調(diào)用flex_button_scan進(jìn)行按鍵掃描，主函數(shù)如：

左右滑動(dòng)查看全部代碼>>>

intmain(void)
{
HAL_Init();
SystemClock_Config();
MX_GPIO_Init();
MX_USART1_Init();
printf("微信公眾號(hào)：嵌入式大雜燴
");
user_button_init();

while(1)
{
flex_button_scan();
HAL_Delay(20);
}
}

編譯、下載運(yùn)行：

其中，每次按鍵的按下都會(huì)觸發(fā)FLEX_BTN_PRESS_DOWN事件。

在對(duì)按鍵進(jìn)行注冊(cè)時(shí)有設(shè)置短按、長(zhǎng)按、長(zhǎng)按保持的tick：

左右滑動(dòng)查看全部代碼>>>

user_button[i].short_press_start_tick=FLEX_MS_TO_SCAN_CNT(1500);//設(shè)置短按事件觸發(fā)的起始tick
user_button[i].long_press_start_tick=FLEX_MS_TO_SCAN_CNT(3000);//設(shè)置長(zhǎng)按事件觸發(fā)的起始tick
user_button[i].long_hold_start_tick=FLEX_MS_TO_SCAN_CNT(4500);//設(shè)置長(zhǎng)按保持事件觸發(fā)的起始tick

我們應(yīng)用比較敏感的是1500、3000、4500，這對(duì)應(yīng)的就是按鍵按下的時(shí)間（單位是ms），即：

• 按鍵保持1500ms按下狀態(tài)時(shí)，flexible_button會(huì)向應(yīng)用上報(bào)FLEX_BTN_PRESS_SHORT_START事件。
• 按鍵保持3000ms按下狀態(tài)時(shí)，flexible_button會(huì)向應(yīng)用上報(bào)FLEX_BTN_PRESS_LONG_START事件。
• 按鍵保45000ms按下狀態(tài)時(shí)，flexible_button會(huì)向應(yīng)用上報(bào)FLEX_BTN_PRESS_LONG_HOLD事件。

下面我們修改代碼，按鍵事件回調(diào)函數(shù)加入所有事件的處理，觸發(fā)則打印相應(yīng)信息。

我們做一個(gè)實(shí)驗(yàn)，按住button0超過5m，再放開。則打印的信息如：

2、基于RT-Thread

FlexibleButton已經(jīng)有作為一個(gè)軟件包貢獻(xiàn)到RT-Thread中，我們只需要簡(jiǎn)單的配置，就可以使用了。

RT-Thread menuconfig 方式：

RT-Threadonlinepackages--->
miscellaneouspackages--->
[*]FlexibleButton:Smallandflexiblebuttondriver--->
[*]Enableflexiblebuttondemo
version(latest)--->

配置完成后，輸入pkgs --update下載軟件包：

運(yùn)行測(cè)試：

以上就是本次的分享，希望大家喜歡！文章如有錯(cuò)誤，歡迎指出！

審核編輯 ：李倩