該按鍵庫使用 C 語言編寫，驅動與應用程式解耦，便於靈活應用，比如用戶可以方便地在應用層增加按鍵中斷、處理按鍵功耗、定義按鍵事件處理方式，而無需修改 FlexibleButton 庫中的代碼。另外，使用 C 語言標準庫 API 編寫，也使得該按鍵庫可以無縫相容任意的處理器平臺，並且支持任意 OS 和... ...
## 前言
正好工作中用到按鍵處理，需要處理單擊、長按等按鍵事件，然後就造了這麼一個輪子，為了以後更方便地加入其它的項目中使用，遂將其開源到 GitHub 中。
後面發現 RT-Thread 軟體包里也有一個開源的按鍵庫 [MultiButton](https://github.com/liu2guang/MultiButton)，看到這個按鍵庫的時候，心想，完了，又重覆造輪子了，好傷心 :joy:。想想，既然按鍵處理方式不同，而且時間已經花出去了，那就把輪子圓一圓，放到 GitHub 中，給有緣人用吧，然後就有了這個不太圓的輪子 [FlexibleButton](https://github.com/zhaojuntao/FlexibleButton)。
## 概述
FlexibleButton 是一個基於 C 語言的小巧靈活的按鍵處理庫。該按鍵庫解耦了具體的按鍵硬體結構，理論上支持輕觸按鍵與自鎖按鍵，並可以無限擴展按鍵數量。另外，FlexibleButton 使用掃描的方式一次性讀取所有所有的按鍵狀態，然後通過事件回調機制上報按鍵事件。
該按鍵庫使用 C 語言編寫，驅動與應用程式解耦，便於靈活應用，比如用戶可以方便地在應用層增加按鍵中斷、處理按鍵功耗、定義按鍵事件處理方式，而無需修改 FlexibleButton 庫中的代碼。
另外，使用 C 語言標準庫 API 編寫，也使得該按鍵庫可以無縫相容任意的處理器平臺，並且支持任意 OS 和 non-OS（裸機程式）。
另外，該按鍵庫核心的按鍵掃描代碼僅有三行，沒錯，就是經典的**三行按鍵掃描演算法**，出自哪位大神之手就無從得知了，也歡迎知道此高人的讀者文後留言哈。演算法介紹可以去搜索引擎里查找，這裡就不作介紹了。
## 獲取
```SHELL
git clone https://github.com/zhaojuntao/FlexibleButton.git
```
## 測試
FlexibleButton 庫中提供了一個 DEMO `flexible_button_demo.c`，這裡基於 RT-Thread OS 進行測試，當然你可以選擇使用其他的 OS，或者使用裸機測試，只需要移除 OS 相關的特性即可。
將 FlexibleButton 庫放到 RT-Thread BSP 下即可使用 scons 進行編譯構建。
## DEMO 程式說明
### 程式入口
```C
int flex_button_main(void)
{
rt_thread_t tid = RT_NULL;
user_button_init();
/* Create background ticks thread */
tid = rt_thread_create("flex_btn", button_scan, RT_NULL, 1024, 10, 10);
if(tid != RT_NULL)
{
rt_thread_startup(tid);
}
return 0;
}
INIT_APP_EXPORT(flex_button_main);
```
如上所示，首先使用 `user_button_init();` 初始化用戶按鍵硬體，並掛載到 FlexibleButton庫。然後，使用了 RT-Thread 的 `INIT_APP_EXPORT` 介面導出為上電自動初始化，創建了一個 “flex_btn” 名字的按鍵掃描線程，線程里掃描檢查按鍵事件。
### 用戶初始化代碼
`user_button_init();` 初始化代碼如下所示：
```C
static void user_button_init(void)
{
int i;
rt_memset(&user_button[0], 0x0, sizeof(user_button));
user_button[USER_BUTTON_0].usr_button_read = button_key0_read;
user_button[USER_BUTTON_0].cb = (flex_button_response_callback)btn_0_cb;
user_button[USER_BUTTON_1].usr_button_read = button_key1_read;
user_button[USER_BUTTON_1].cb = (flex_button_response_callback)btn_1_cb;
user_button[USER_BUTTON_2].usr_button_read = button_key2_read;
user_button[USER_BUTTON_3].usr_button_read = button_keywkup_read;
rt_pin_mode(PIN_KEY0, PIN_MODE_INPUT); /* set KEY pin mode to input */
rt_pin_mode(PIN_KEY1, PIN_MODE_INPUT); /* set KEY pin mode to input */
rt_pin_mode(PIN_KEY2, PIN_MODE_INPUT); /* set KEY pin mode to input */
rt_pin_mode(PIN_WK_UP, PIN_MODE_INPUT); /* set KEY pin mode to input */
for (i = 0; i < USER_BUTTON_MAX; i ++)
{
user_button[i].status = 0;
user_button[i].pressed_logic_level = 0;
user_button[i].click_start_tick = 20;
user_button[i].short_press_start_tick = 100;
user_button[i].long_press_start_tick = 200;
user_button[i].long_hold_start_tick = 300;
if (i == USER_BUTTON_3)
{
user_button[USER_BUTTON_3].pressed_logic_level = 1;
}
flex_button_register(&user_button[i]);
}
}
```
`user_button_init();` 主要用於初始化按鍵硬體，設置按鍵長按和短按的 tick 數（RT-Thread上面預設一個 tick 為 1ms），然後註冊按鍵到 FlexibleButton 庫。
### 事件處理代碼
```C
static void btn_0_cb(flex_button_t *btn)
{
rt_kprintf("btn_0_cb\n");
switch (btn->event)
{
case FLEX_BTN_PRESS_DOWN:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_DOWN]\n");
break;
case FLEX_BTN_PRESS_CLICK:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_CLICK]\n");
break;
case FLEX_BTN_PRESS_DOUBLE_CLICK:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_DOUBLE_CLICK]\n");
break;
case FLEX_BTN_PRESS_SHORT_START:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_SHORT_START]\n");
break;
case FLEX_BTN_PRESS_SHORT_UP:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_SHORT_UP]\n");
break;
case FLEX_BTN_PRESS_LONG_START:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_START]\n");
break;
case FLEX_BTN_PRESS_LONG_UP:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_UP]\n");
break;
case FLEX_BTN_PRESS_LONG_HOLD:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_HOLD]\n");
break;
case FLEX_BTN_PRESS_LONG_HOLD_UP:
rt_kprintf("btn_0_cb [FLEX_BTN_PRESS_LONG_HOLD_UP]\n");
break;
}
}
```
## FlexibleButton 代碼說明
### 按鍵事件定義
按鍵事件的定義並沒有使用 Windows 驅動上的定義，主要是方便嵌入式設備中的應用場景（也可能是我理解的偏差），按鍵事件定義如下：
```C
typedef enum
{
FLEX_BTN_PRESS_DOWN = 0, // 按下事件
FLEX_BTN_PRESS_CLICK, // 單擊事件
FLEX_BTN_PRESS_DOUBLE_CLICK, // 雙擊事件
FLEX_BTN_PRESS_SHORT_START, // 短按開始事件
FLEX_BTN_PRESS_SHORT_UP, // 短按抬起事件
FLEX_BTN_PRESS_LONG_START, // 長按開始事件
FLEX_BTN_PRESS_LONG_UP, // 長按抬起事件
FLEX_BTN_PRESS_LONG_HOLD, // 長按保持事件
FLEX_BTN_PRESS_LONG_HOLD_UP, // 長按保持的抬起事件
FLEX_BTN_PRESS_MAX,
FLEX_BTN_PRESS_NONE,
} flex_button_event_t;
```
### 按鍵註冊介面
使用該介面註冊一個用戶按鍵，入參為一個 flex_button_t 結構體實例的地址。
```C
int8_t flex_button_register(flex_button_t *button);
```
### 按鍵事件讀取介面
使用該介面獲取指定按鍵的事件。
```C
flex_button_event_t flex_button_event_read(flex_button_t* button);
````
### 按鍵掃描介面
按鍵掃描的核心函數，需要放到應用程式中定時掃描間隔 5-20ms 即可。
```C
void flex_button_scan(void);
```
## 問題和建議
如果您在應用的時候遇到了問題，或者有好的想法和建議，歡迎到這個 [issue](https://github.com/zhaojuntao/FlexibleButton/issues/1) 上討論，謝謝。
