暂存，剩下APP的
This commit is contained in:
parent
8f72577baa
commit
ba4f6509cb
|
|
@ -124,7 +124,7 @@
|
||||||
#define CLK_OSC32K 1 // 该项请勿在此修改，必须在工程配置里的预处理中修改，如包含主机角色必须使用外部32K
|
#define CLK_OSC32K 1 // 该项请勿在此修改，必须在工程配置里的预处理中修改，如包含主机角色必须使用外部32K
|
||||||
#endif
|
#endif
|
||||||
#ifndef BLE_MEMHEAP_SIZE
|
#ifndef BLE_MEMHEAP_SIZE
|
||||||
#define BLE_MEMHEAP_SIZE (1024*6)
|
#define BLE_MEMHEAP_SIZE (1024*7)
|
||||||
#endif
|
#endif
|
||||||
#ifndef BLE_BUFF_MAX_LEN
|
#ifndef BLE_BUFF_MAX_LEN
|
||||||
#define BLE_BUFF_MAX_LEN 251
|
#define BLE_BUFF_MAX_LEN 251
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,325 @@
|
||||||
|
# FlexibleButton
|
||||||
|
|
||||||
|
FlexibleButton 是一个基于标准 C 语言的小巧灵活的按键处理库，支持单击、连击、短按、长按、自动消抖，可以自由设置组合按键，可用于中断和低功耗场景。
|
||||||
|
|
||||||
|
该按键库解耦了具体的按键硬件结构，理论上支持轻触按键与自锁按键，并可以无限扩展按键数量。另外，FlexibleButton 使用扫描的方式一次性读取所有所有的按键状态，然后通过事件回调机制上报按键事件。核心的按键扫描代码仅有三行，没错，就是经典的 **三行按键扫描算法**。使用 C 语言标准库 API 编写，也使得该按键库可以无缝兼容任意的处理器平台，并且支持任意 OS 和 non-OS（裸机编程）。
|
||||||
|
|
||||||
|
## 获取
|
||||||
|
|
||||||
|
### Git 方式
|
||||||
|
|
||||||
|
```SHELL
|
||||||
|
git clone https://github.com/murphyzhao/FlexibleButton.git
|
||||||
|
```
|
||||||
|
|
||||||
|
### RT-Thread menuconfig 方式
|
||||||
|
|
||||||
|
```
|
||||||
|
RT-Thread online packages --->
|
||||||
|
miscellaneous packages --->
|
||||||
|
[*] FlexibleButton: Small and flexible button driver --->
|
||||||
|
[*] Enable flexible button demo
|
||||||
|
version (latest) --->
|
||||||
|
```
|
||||||
|
|
||||||
|
配置完成后，输入 `pkgs --update` 下载软件包。
|
||||||
|
|
||||||
|
## 资源统计
|
||||||
|
|
||||||
|
ARMCC -O0 优化的情况下，FlexibleButton 资源占用如下：
|
||||||
|
|
||||||
|
- CODE：798 字节
|
||||||
|
- RO DATA：0
|
||||||
|
- RW DATA：13 字节
|
||||||
|
- ZI DATA：0
|
||||||
|
|
||||||
|
## 快速体验
|
||||||
|
|
||||||
|
FlexibleButton 库中提供了一个测试例程 [`./examples/demo_rtt_iotboard.c`](./examples/demo_rtt_iotboard.c)，该例程基于 RT-Thread OS 进行测试，硬件平台选择了 *RT-Thread IoT Board Pandora v2.51* 开发板。当然你可以选择使用其他的 OS，或者使用裸机测试，只需要移除 OS 相关的特性即可。
|
||||||
|
|
||||||
|
如果你使用自己的硬件平台，只需要将 FlexibleButton 库源码和例程加入你既有的工程下即可。
|
||||||
|
|
||||||
|
## DEMO 程序说明
|
||||||
|
|
||||||
|
该示例程序可以直接在 RT-Thread [`stm32l475-atk-pandora`](https://github.com/RT-Thread/rt-thread/tree/master/bsp/stm32/stm32l475-atk-pandora) BSP 中运行，可以在该 BSP 目录下，使用 menuconfig 获取本软件包。
|
||||||
|
|
||||||
|
### 确定用户按键
|
||||||
|
|
||||||
|
```C
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
USER_BUTTON_0 = 0, // 对应 IoT Board 开发板的 PIN_KEY0
|
||||||
|
USER_BUTTON_1, // 对应 IoT Board 开发板的 PIN_KEY1
|
||||||
|
USER_BUTTON_2, // 对应 IoT Board 开发板的 PIN_KEY2
|
||||||
|
USER_BUTTON_3, // 对应 IoT Board 开发板的 PIN_WK_UP
|
||||||
|
USER_BUTTON_MAX
|
||||||
|
} user_button_t;
|
||||||
|
|
||||||
|
static flex_button_t user_button[USER_BUTTON_MAX];
|
||||||
|
```
|
||||||
|
|
||||||
|
上述代码定义了 4 个按键，数据结构存储在 `user_button` 数组中。
|
||||||
|
|
||||||
|
### 程序入口
|
||||||
|
|
||||||
|
```C
|
||||||
|
int flex_button_main(void)
|
||||||
|
{
|
||||||
|
rt_thread_t tid = RT_NULL;
|
||||||
|
user_button_init();
|
||||||
|
/* 创建按键扫描线程 flex_btn，线程栈 1024 byte，优先级 10 */
|
||||||
|
tid = rt_thread_create("flex_btn", button_scan, RT_NULL, 1024, 10, 10);
|
||||||
|
if(tid != RT_NULL)
|
||||||
|
{
|
||||||
|
rt_thread_startup(tid);
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
/* 使用 RT-Thread 的自动初始化 */
|
||||||
|
INIT_APP_EXPORT(flex_button_main);
|
||||||
|
```
|
||||||
|
|
||||||
|
如上代码所示，首先使用 `user_button_init();` 初始化用户按键硬件，该步骤将用户按键绑定到 FlexibleButton 库。然后，使用 RT-Thread 的 `INIT_APP_EXPORT` 接口导出为上电自动初始化，创建了一个 “flex_btn” 名字的按键扫描线程，线程里扫描检查按键事件。
|
||||||
|
|
||||||
|
### 按键初始化代码
|
||||||
|
|
||||||
|
`user_button_init();` 初始化代码如下所示：
|
||||||
|
|
||||||
|
```
|
||||||
|
static void user_button_init(void)
|
||||||
|
{
|
||||||
|
int i;
|
||||||
|
|
||||||
|
/* 初始化按键数据结构 */
|
||||||
|
rt_memset(&user_button[0], 0x0, sizeof(user_button));
|
||||||
|
|
||||||
|
/* 初始化 IoT Board 按键引脚，使用 rt-thread PIN 设备框架 */
|
||||||
|
rt_pin_mode(PIN_KEY0, PIN_MODE_INPUT_PULLUP); /* 设置 GPIO 为上拉输入模式 */
|
||||||
|
rt_pin_mode(PIN_KEY1, PIN_MODE_INPUT_PULLUP); /* 设置 GPIO 为上拉输入模式 */
|
||||||
|
rt_pin_mode(PIN_KEY2, PIN_MODE_INPUT_PULLUP); /* 设置 GPIO 为上拉输入模式 */
|
||||||
|
rt_pin_mode(PIN_WK_UP, PIN_MODE_INPUT_PULLDOWN); /* 设置 GPIO 为下拉输入模式 */
|
||||||
|
|
||||||
|
for (i = 0; i < USER_BUTTON_MAX; i ++)
|
||||||
|
{
|
||||||
|
user_button[i].id = i;
|
||||||
|
user_button[i].usr_button_read = common_btn_read;
|
||||||
|
user_button[i].cb = common_btn_evt_cb;
|
||||||
|
user_button[i].pressed_logic_level = 0;
|
||||||
|
user_button[i].short_press_start_tick = FLEX_MS_TO_SCAN_CNT(1500);
|
||||||
|
user_button[i].long_press_start_tick = FLEX_MS_TO_SCAN_CNT(3000);
|
||||||
|
user_button[i].long_hold_start_tick = FLEX_MS_TO_SCAN_CNT(4500);
|
||||||
|
|
||||||
|
if (i == USER_BUTTON_3)
|
||||||
|
{
|
||||||
|
user_button[USER_BUTTON_3].pressed_logic_level = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
flex_button_register(&user_button[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
核心的配置如下：
|
||||||
|
|
||||||
|
|配置项|说明|
|
||||||
|
| :---- | :----|
|
||||||
|
| id | 按键编号 |
|
||||||
|
| usr_button_read | 设置按键读值回调函数 |
|
||||||
|
| cb | 设置按键事件回调函数 |
|
||||||
|
| pressed_logic_level | 设置按键按下时的逻辑电平 |
|
||||||
|
| short_press_start_tick | 短按起始 tick，使用 FLEX_MS_TO_SCAN_CNT 宏转化为扫描次数 |
|
||||||
|
| long_press_start_tick | 长按起始 tick，使用 FLEX_MS_TO_SCAN_CNT 宏转化为扫描次数 |
|
||||||
|
| long_hold_start_tick | 超长按起始 tick，使用 FLEX_MS_TO_SCAN_CNT 宏转化为扫描次数 |
|
||||||
|
|
||||||
|
注意，short_press_start_tick、long_press_start_tick 和 long_hold_start_tick 必须使用 `FLEX_MS_TO_SCAN_CNT` 将毫秒时间转化为扫描次数。
|
||||||
|
|
||||||
|
`user_button[i].short_press_start_tick = FLEX_MS_TO_SCAN_CNT(1500);` 表示按键按下开始计时，1500 ms 后按键依旧是按下状态的话，就断定为短按开始。
|
||||||
|
|
||||||
|
### 事件处理代码
|
||||||
|
|
||||||
|
```C
|
||||||
|
static void common_btn_evt_cb(void *arg)
|
||||||
|
{
|
||||||
|
flex_button_t *btn = (flex_button_t *)arg;
|
||||||
|
|
||||||
|
rt_kprintf("id: [%d - %s] event: [%d - %30s] repeat: %d\n",
|
||||||
|
btn->id, enum_btn_id_string[btn->id],
|
||||||
|
btn->event, enum_event_string[btn->event],
|
||||||
|
btn->click_cnt);
|
||||||
|
|
||||||
|
if (flex_button_event_read(&user_button[USER_BUTTON_0]) == flex_button_event_read(&user_button[USER_BUTTON_1]) == FLEX_BTN_PRESS_CLICK)
|
||||||
|
{
|
||||||
|
rt_kprintf("[combination]: button 0 and button 1\n");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
示例代码中，将所有的按键事件回调均绑定到 `common_btn_evt_cb` 函数，在该函数中打印了按键 ID 和按键事件，以及按键连击次数，并演示了如何使用组合按键。
|
||||||
|
|
||||||
|
## FlexibleButton 代码说明
|
||||||
|
|
||||||
|
### 按键事件定义
|
||||||
|
|
||||||
|
按键事件的定义并没有使用 Windows 驱动上的定义，主要是方便嵌入式设备中的应用场景（也可能是我理解的偏差），按键事件定义如下：
|
||||||
|
|
||||||
|
```C
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
FLEX_BTN_PRESS_DOWN = 0, // 按下事件
|
||||||
|
FLEX_BTN_PRESS_CLICK, // 单击事件
|
||||||
|
FLEX_BTN_PRESS_DOUBLE_CLICK, // 双击事件
|
||||||
|
FLEX_BTN_PRESS_REPEAT_CLICK, // 连击事件，使用 flex_button_t 中的 click_cnt 断定连击次数
|
||||||
|
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_BTN_PRESS_LONG_HOLD` 事件可以用来实现长按累加的应用场景。
|
||||||
|
|
||||||
|
### 按键数据结构
|
||||||
|
|
||||||
|
```
|
||||||
|
typedef struct flex_button
|
||||||
|
{
|
||||||
|
struct flex_button* next;
|
||||||
|
|
||||||
|
uint8_t (*usr_button_read)(void *);
|
||||||
|
flex_button_response_callback cb;
|
||||||
|
|
||||||
|
uint16_t scan_cnt;
|
||||||
|
uint16_t click_cnt;
|
||||||
|
uint16_t max_multiple_clicks_interval;
|
||||||
|
|
||||||
|
uint16_t debounce_tick;
|
||||||
|
uint16_t short_press_start_tick;
|
||||||
|
uint16_t long_press_start_tick;
|
||||||
|
uint16_t long_hold_start_tick;
|
||||||
|
|
||||||
|
uint8_t id;
|
||||||
|
uint8_t pressed_logic_level : 1;
|
||||||
|
uint8_t event : 4;
|
||||||
|
uint8_t status : 3;
|
||||||
|
} flex_button_t;
|
||||||
|
```
|
||||||
|
|
||||||
|
| 序号 | 数据成员 | 是否需要用户初始化 | 说明 |
|
||||||
|
| :----: | :---- | :----: | :---- |
|
||||||
|
| 1 | next | 否 | 按键库使用单向链表串起所有的按键 |
|
||||||
|
| 2 | usr_button_read | 是 | 用户设备的按键引脚电平读取函数，**重要** |
|
||||||
|
| 3 | cb | 是 | 设置按键事件回调，用于应用层对按键事件的分类处理 |
|
||||||
|
| 4 | scan_cnt | 否 | 用于记录扫描次数，按键按下是开始从零计数 |
|
||||||
|
| 5 | click_cnt | 否 | 记录单击次数，用于判定单击、连击 |
|
||||||
|
| 6 | max_multiple_clicks_interval | 是 | 连击间隙，用于判定是否结束连击计数，有默认值 `MAX_MULTIPLE_CLICKS_INTERVAL` |
|
||||||
|
| 7 | debounce_tick | 否 | 消抖时间，暂未使用，依靠扫描间隙进行消抖 |
|
||||||
|
| 8 | short_press_start_tick | 是 | 设置短按事件触发的起始 tick |
|
||||||
|
| 9 | long_press_start_tick | 是 | 设置长按事件触发的起始 tick |
|
||||||
|
| 10 | long_hold_start_tick | 是 | 设置长按保持事件触发的起始 tick |
|
||||||
|
| 11 | id | 是 | 当多个按键使用同一个回调函数时，用于断定属于哪个按键 |
|
||||||
|
| 12 | pressed_logic_level | 是 | 设置按键按下的逻辑电平。1：标识按键按下的时候为高电平；0：标识按键按下的时候未低电平，**重要** |
|
||||||
|
| 13 | event | 否 | 用于记录当前按键事件 |
|
||||||
|
| 14 | status | 否 | 用于记录当前按键的状态，用于内部状态机 |
|
||||||
|
|
||||||
|
注意，在使用 `max_multiple_clicks_interval`、`debounce_tick`、`short_press_start_tick`、`long_press_start_tick`、`long_hold_start_tick` 的时候，注意需要使用宏 `**FLEX_MS_TO_SCAN_CNT(ms)**` 将毫秒值转换为扫描次数。因为按键库基于扫描次数运转。示例如下：
|
||||||
|
|
||||||
|
```
|
||||||
|
user_button[1].short_press_start_tick = FLEX_MS_TO_SCAN_CNT(1500); // 1500 毫秒
|
||||||
|
```
|
||||||
|
|
||||||
|
上述代码表示：表示按键按下后开始计时，1500ms 的时候，按键依旧按下，则断定为短按开始，并上报 `FLEX_BTN_PRESS_SHORT_START` 事件。
|
||||||
|
|
||||||
|
### 按键注册接口
|
||||||
|
|
||||||
|
使用该接口注册一个用户按键，入参为一个 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);
|
||||||
|
````
|
||||||
|
|
||||||
|
### 按键扫描接口
|
||||||
|
|
||||||
|
按键扫描的核心函数，需要放到应用程序中定时扫描，扫描间隔建议 20 毫秒。
|
||||||
|
|
||||||
|
```C
|
||||||
|
void flex_button_scan(void);
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
- 阻塞问题
|
||||||
|
|
||||||
|
因为按键事件回调函数以及按键键值读取函数是在按键扫描的过程中执行的，因此请不要在这类函数中使用阻塞接口，不要进行延时操作。
|
||||||
|
|
||||||
|
- 按键扫描函数栈需求
|
||||||
|
|
||||||
|
按键扫描函数本身对栈的需求小于 300 字节，但是按键事件回调函数和按键键值读取函数都是在按键扫描函数的上下文中执行的，请格外关心按键事件回调函数与按键键值读取函数对栈空间的需求。
|
||||||
|
|
||||||
|
## 其它
|
||||||
|
|
||||||
|
### 关于低功耗
|
||||||
|
|
||||||
|
本按键库是通过不间断扫描的方式来检查按键状态，因此会一直占用 CPU 资源，这对低功耗应用场景是不友好的。为了降低正常工作模式下的功耗，建议合理配置扫描周期（5ms - 20ms），扫描间隙里 CPU 可以进入轻度睡眠。
|
||||||
|
|
||||||
|
该按键库不在底层实现低功耗处理，应用层可以根据自己的功耗模式灵活处理，通常会有以下两种方式：
|
||||||
|
|
||||||
|
1. 进入低功耗前，挂起按键扫描线程；退出低功耗后，唤醒按键扫描。
|
||||||
|
2. 增加按键中断模式，所有的按键中断来，就触发一次按键扫描，以确认所有的按键状态。
|
||||||
|
|
||||||
|
> 低功耗相关的探讨参考 [issue 1](https://github.com/murphyzhao/FlexibleButton/issues/1) 中的讨论。
|
||||||
|
|
||||||
|
### 关于按键中断模式
|
||||||
|
|
||||||
|
由于该按键库一次扫描可以确定所有的按键状态，因此可以将所有的按键中断通过 “**或**” 的方式转化为一个中断，然后在中断处理函数中执行一次按键扫描。
|
||||||
|
|
||||||
|
中断 “**或**” 的方式可以通过硬件来完成，也可以通过软件来完成。
|
||||||
|
|
||||||
|
硬件方式，需要使用一个 **或门** 芯片，多个输入条件转化为一个输出条件，然后通过一个外部中断即可完成所有按键的中断方式检测。
|
||||||
|
|
||||||
|
软件方式，需要为每一个按键配置为中断触发模式，然后在每一个按键中断的中断处理函数中执行按键扫描。
|
||||||
|
|
||||||
|
为了在降低中断处理函数中执行按键扫描带来的时延，可以通过信号量的方式来异步处理，仅在中断处理函数中释放一个按键扫描的信号量，然后在按键扫描线程中监测该信号量。
|
||||||
|
|
||||||
|
### 关于组合按键
|
||||||
|
|
||||||
|
该按键库仅做了底层的按键扫描处理，一次扫描可以确定所有的按键状态，并上报对应的按键事件，如果需要支持组合按键，请再封一层，根据按键库返回的事件封装需要的组合按键。[示例程序](./examples/demo_rtt_iotboard.c)提供了简单的实现。
|
||||||
|
|
||||||
|
### 关于矩阵键盘
|
||||||
|
|
||||||
|
不管你的矩阵键盘是通过什么通信方式获取按键状态的，只要你将读取按键状态的函数对接到 Flexible_button 数据结构中的 `uint8_t (*usr_button_read)(void*);` 函数上即可。
|
||||||
|
|
||||||
|
> 参考 [issue 2](https://github.com/murphyzhao/FlexibleButton/issues/2) 中的讨论。
|
||||||
|
|
||||||
|
## 问题和建议
|
||||||
|
|
||||||
|
如果有什么问题或者建议欢迎提交 [Issue](https://github.com/murphyzhao/FlexibleButton/issues) 进行讨论。
|
||||||
|
|
||||||
|
## 维护
|
||||||
|
|
||||||
|
- [MurphyZhao](https://github.com/murphyzhao)
|
||||||
|
|
||||||
|
## 感谢
|
||||||
|
|
||||||
|
感谢所有一起探讨的朋友，感谢所有使用 flexible_button 的朋友，感谢你们的 Star 和 Fork，谢谢你们的支持。
|
||||||
|
|
||||||
|
- 感谢 [BOBBOM](https://github.com/BOBBOM) 发现 flex_button_register 函数中的逻辑问题
|
||||||
|
- 感谢 [BOBBOM](https://github.com/BOBBOM) 解除 flexible_button 中对按键数量的限制
|
||||||
|
- 感谢 [**rt-thread**](https://mp.weixin.qq.com/s/HJEcSXhykBq1T5Hx0TdjMw) 的支持
|
||||||
|
- 感谢 [**电子发烧友**](https://mp.weixin.qq.com/s/mQFyrPAvz_TSktQLrSqQfA) 的支持
|
||||||
|
- 感谢 [**威驰电子**](https://mp.weixin.qq.com/s/oAwFXPostMFBtb2EGxTdig) 的支持
|
||||||
|
|
||||||
|
## 友情链接
|
||||||
|
|
||||||
|
- RT-Thread [IoT Board](https://github.com/RT-Thread/IoT_Board) 开发板
|
||||||
|
|
@ -0,0 +1,317 @@
|
||||||
|
/**
|
||||||
|
* @File: flexible_button.c
|
||||||
|
* @Author: MurphyZhao
|
||||||
|
* @Date: 2018-09-29
|
||||||
|
*
|
||||||
|
* Copyright (c) 2018-2019 MurphyZhao <d2014zjt@163.com>
|
||||||
|
* https://github.com/murphyzhao
|
||||||
|
* All rights reserved.
|
||||||
|
* License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
* Change logs:
|
||||||
|
* Date Author Notes
|
||||||
|
* 2018-09-29 MurphyZhao First add
|
||||||
|
* 2019-08-02 MurphyZhao Migrate code to github.com/murphyzhao account
|
||||||
|
* 2019-12-26 MurphyZhao Refactor code and implement multiple clicks
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "flexible_button.h"
|
||||||
|
|
||||||
|
#ifndef NULL
|
||||||
|
#define NULL 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define EVENT_SET_AND_EXEC_CB(btn, evt) \
|
||||||
|
do \
|
||||||
|
{ \
|
||||||
|
btn->event = evt; \
|
||||||
|
if(btn->cb) \
|
||||||
|
btn->cb((flex_button_t*)btn); \
|
||||||
|
} while(0)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* BTN_IS_PRESSED
|
||||||
|
*
|
||||||
|
* 1: is pressed
|
||||||
|
* 0: is not pressed
|
||||||
|
*/
|
||||||
|
#define BTN_IS_PRESSED(i) (g_btn_status_reg & (1 << i))
|
||||||
|
|
||||||
|
enum FLEX_BTN_STAGE
|
||||||
|
{
|
||||||
|
FLEX_BTN_STAGE_DEFAULT = 0,
|
||||||
|
FLEX_BTN_STAGE_DOWN = 1,
|
||||||
|
FLEX_BTN_STAGE_MULTIPLE_CLICK = 2
|
||||||
|
};
|
||||||
|
|
||||||
|
typedef uint32_t btn_type_t;
|
||||||
|
|
||||||
|
static flex_button_t *btn_head = NULL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* g_logic_level
|
||||||
|
*
|
||||||
|
* The logic level of the button pressed,
|
||||||
|
* Each bit represents a button.
|
||||||
|
*
|
||||||
|
* First registered button, the logic level of the button pressed is
|
||||||
|
* at the low bit of g_logic_level.
|
||||||
|
*/
|
||||||
|
btn_type_t g_logic_level = (btn_type_t)0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* g_btn_status_reg
|
||||||
|
*
|
||||||
|
* The status register of all button, each bit records the pressing state of a button.
|
||||||
|
*
|
||||||
|
* First registered button, the pressing state of the button is
|
||||||
|
* at the low bit of g_btn_status_reg.
|
||||||
|
*/
|
||||||
|
btn_type_t g_btn_status_reg = (btn_type_t)0;
|
||||||
|
|
||||||
|
static uint8_t button_cnt = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Register a user button
|
||||||
|
*
|
||||||
|
* @param button: button structure instance
|
||||||
|
* @return Number of keys that have been registered
|
||||||
|
*/
|
||||||
|
int8_t flex_button_register(flex_button_t *button)
|
||||||
|
{
|
||||||
|
flex_button_t *curr = btn_head;
|
||||||
|
|
||||||
|
if (!button || (button_cnt > sizeof(btn_type_t) * 8))
|
||||||
|
{
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
while (curr)
|
||||||
|
{
|
||||||
|
if(curr == button)
|
||||||
|
{
|
||||||
|
return -1; /* already exist. */
|
||||||
|
}
|
||||||
|
curr = curr->next;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* First registered button is at the end of the 'linked list'.
|
||||||
|
* btn_head points to the head of the 'linked list'.
|
||||||
|
*/
|
||||||
|
button->next = btn_head;
|
||||||
|
button->status = FLEX_BTN_STAGE_DEFAULT;
|
||||||
|
button->event = FLEX_BTN_PRESS_NONE;
|
||||||
|
button->scan_cnt = 0;
|
||||||
|
button->click_cnt = 0;
|
||||||
|
button->max_multiple_clicks_interval = MAX_MULTIPLE_CLICKS_INTERVAL;
|
||||||
|
btn_head = button;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* First registered button, the logic level of the button pressed is
|
||||||
|
* at the low bit of g_logic_level.
|
||||||
|
*/
|
||||||
|
g_logic_level |= (button->pressed_logic_level << button_cnt);
|
||||||
|
button_cnt ++;
|
||||||
|
|
||||||
|
return button_cnt;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Read all key values in one scan cycle
|
||||||
|
*
|
||||||
|
* @param void
|
||||||
|
* @return none
|
||||||
|
*/
|
||||||
|
static void flex_button_read(void)
|
||||||
|
{
|
||||||
|
uint8_t i;
|
||||||
|
flex_button_t* target;
|
||||||
|
|
||||||
|
/* The button that was registered first, the button value is in the low position of raw_data */
|
||||||
|
btn_type_t raw_data = 0;
|
||||||
|
|
||||||
|
for(target = btn_head, i = button_cnt - 1;
|
||||||
|
(target != NULL) && (target->usr_button_read != NULL);
|
||||||
|
target = target->next, i--)
|
||||||
|
{
|
||||||
|
raw_data = raw_data | ((target->usr_button_read)(target) << i);
|
||||||
|
}
|
||||||
|
|
||||||
|
g_btn_status_reg = (~raw_data) ^ g_logic_level;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Handle all key events in one scan cycle.
|
||||||
|
* Must be used after 'flex_button_read' API
|
||||||
|
*
|
||||||
|
* @param void
|
||||||
|
* @return none
|
||||||
|
*/
|
||||||
|
static void flex_button_process(void)
|
||||||
|
{
|
||||||
|
uint8_t i;
|
||||||
|
flex_button_t* target;
|
||||||
|
|
||||||
|
for (target = btn_head, i = 0; target != NULL; target = target->next, i ++)
|
||||||
|
{
|
||||||
|
if (target->status > FLEX_BTN_STAGE_DEFAULT)
|
||||||
|
{
|
||||||
|
target->scan_cnt ++;
|
||||||
|
if (target->scan_cnt >= ((1 << (sizeof(target->scan_cnt) * 8)) - 1))
|
||||||
|
{
|
||||||
|
target->scan_cnt = target->long_hold_start_tick;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (target->status)
|
||||||
|
{
|
||||||
|
case FLEX_BTN_STAGE_DEFAULT: /* stage: default(button up) */
|
||||||
|
if (BTN_IS_PRESSED(i)) /* is pressed */
|
||||||
|
{
|
||||||
|
target->scan_cnt = 0;
|
||||||
|
target->click_cnt = 0;
|
||||||
|
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_DOWN);
|
||||||
|
|
||||||
|
/* swtich to button down stage */
|
||||||
|
target->status = FLEX_BTN_STAGE_DOWN;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
target->event = FLEX_BTN_PRESS_NONE;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case FLEX_BTN_STAGE_DOWN: /* stage: button down */
|
||||||
|
if (BTN_IS_PRESSED(i)) /* is pressed */
|
||||||
|
{
|
||||||
|
if (target->click_cnt > 0) /* multiple click */
|
||||||
|
{
|
||||||
|
if (target->scan_cnt > target->max_multiple_clicks_interval)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target,
|
||||||
|
target->click_cnt < FLEX_BTN_PRESS_REPEAT_CLICK ?
|
||||||
|
target->click_cnt :
|
||||||
|
FLEX_BTN_PRESS_REPEAT_CLICK);
|
||||||
|
|
||||||
|
/* swtich to button down stage */
|
||||||
|
target->status = FLEX_BTN_STAGE_DOWN;
|
||||||
|
target->scan_cnt = 0;
|
||||||
|
target->click_cnt = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (target->scan_cnt >= target->long_hold_start_tick)
|
||||||
|
{
|
||||||
|
if (target->event != FLEX_BTN_PRESS_LONG_HOLD)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_LONG_HOLD);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (target->scan_cnt >= target->long_press_start_tick)
|
||||||
|
{
|
||||||
|
if (target->event != FLEX_BTN_PRESS_LONG_START)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_LONG_START);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (target->scan_cnt >= target->short_press_start_tick)
|
||||||
|
{
|
||||||
|
if (target->event != FLEX_BTN_PRESS_SHORT_START)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_SHORT_START);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else /* button up */
|
||||||
|
{
|
||||||
|
if (target->scan_cnt >= target->long_hold_start_tick)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_LONG_HOLD_UP);
|
||||||
|
target->status = FLEX_BTN_STAGE_DEFAULT;
|
||||||
|
}
|
||||||
|
else if (target->scan_cnt >= target->long_press_start_tick)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_LONG_UP);
|
||||||
|
target->status = FLEX_BTN_STAGE_DEFAULT;
|
||||||
|
}
|
||||||
|
else if (target->scan_cnt >= target->short_press_start_tick)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target, FLEX_BTN_PRESS_SHORT_UP);
|
||||||
|
target->status = FLEX_BTN_STAGE_DEFAULT;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
/* swtich to multiple click stage */
|
||||||
|
target->status = FLEX_BTN_STAGE_MULTIPLE_CLICK;
|
||||||
|
target->click_cnt ++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case FLEX_BTN_STAGE_MULTIPLE_CLICK: /* stage: multiple click */
|
||||||
|
if (BTN_IS_PRESSED(i)) /* is pressed */
|
||||||
|
{
|
||||||
|
/* swtich to button down stage */
|
||||||
|
target->status = FLEX_BTN_STAGE_DOWN;
|
||||||
|
target->scan_cnt = 0;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (target->scan_cnt > target->max_multiple_clicks_interval)
|
||||||
|
{
|
||||||
|
EVENT_SET_AND_EXEC_CB(target,
|
||||||
|
target->click_cnt < FLEX_BTN_PRESS_REPEAT_CLICK ?
|
||||||
|
target->click_cnt :
|
||||||
|
FLEX_BTN_PRESS_REPEAT_CLICK);
|
||||||
|
|
||||||
|
/* swtich to default stage */
|
||||||
|
target->status = FLEX_BTN_STAGE_DEFAULT;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* flex_button_event_read
|
||||||
|
*
|
||||||
|
* @brief Get the button event of the specified button.
|
||||||
|
*
|
||||||
|
* @param button: button structure instance
|
||||||
|
* @return button event
|
||||||
|
*/
|
||||||
|
flex_button_event_t flex_button_event_read(flex_button_t* button)
|
||||||
|
{
|
||||||
|
return (flex_button_event_t)(button->event);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* flex_button_scan
|
||||||
|
*
|
||||||
|
* @brief Start key scan.
|
||||||
|
* Need to be called cyclically within the specified period.
|
||||||
|
* Sample cycle: 5 - 20ms
|
||||||
|
*
|
||||||
|
* @param void
|
||||||
|
* @return none
|
||||||
|
*/
|
||||||
|
void flex_button_scan(void)
|
||||||
|
{
|
||||||
|
flex_button_read();
|
||||||
|
flex_button_process();
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,164 @@
|
||||||
|
/*
|
||||||
|
* @Author : stark1898y 1658608470@qq.com
|
||||||
|
* @Date : 2024-07-04 16:13:57
|
||||||
|
* @LastEditors : stark1898y 1658608470@qq.com
|
||||||
|
* @LastEditTime : 2024-12-14 15:56:11
|
||||||
|
* @FilePath : \BLE_TYQ_CH592F\common\FlexibleButton-2.0.1\flexible_button.h
|
||||||
|
* @Description :
|
||||||
|
*
|
||||||
|
* Copyright (c) 2024 by yzy, All Rights Reserved.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* @File: flexible_button.h
|
||||||
|
* @Author: MurphyZhao
|
||||||
|
* @Date: 2018-09-29
|
||||||
|
*
|
||||||
|
* Copyright (c) 2018-2019 MurphyZhao <d2014zjt@163.com>
|
||||||
|
* https://github.com/murphyzhao
|
||||||
|
* All rights reserved.
|
||||||
|
* License-Identifier: Apache-2.0
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
* not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
* Change logs:
|
||||||
|
* Date Author Notes
|
||||||
|
* 2018-09-29 MurphyZhao First add
|
||||||
|
* 2019-08-02 MurphyZhao Migrate code to github.com/murphyzhao account
|
||||||
|
* 2019-12-26 MurphyZhao Refactor code and implement multiple clicks
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef __FLEXIBLE_BUTTON_H__
|
||||||
|
#define __FLEXIBLE_BUTTON_H__
|
||||||
|
|
||||||
|
#include "stdint.h"
|
||||||
|
|
||||||
|
#define FLEX_BTN_SCAN_FREQ_HZ 50 // How often flex_button_scan () is called
|
||||||
|
#define FLEX_MS_TO_SCAN_CNT(ms) (ms / (1000 / FLEX_BTN_SCAN_FREQ_HZ)) //
|
||||||
|
/* Multiple clicks interval, default 300ms */
|
||||||
|
#define MAX_MULTIPLE_CLICKS_INTERVAL (FLEX_MS_TO_SCAN_CNT(300))
|
||||||
|
|
||||||
|
typedef void (*flex_button_response_callback)(void*);
|
||||||
|
|
||||||
|
typedef enum
|
||||||
|
{
|
||||||
|
FLEX_BTN_PRESS_DOWN = 0,
|
||||||
|
FLEX_BTN_PRESS_CLICK,
|
||||||
|
FLEX_BTN_PRESS_DOUBLE_CLICK,//
|
||||||
|
FLEX_BTN_PRESS_REPEAT_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
|
||||||
|
*
|
||||||
|
* @brief Button data structure
|
||||||
|
* Below are members that need to user init before scan.
|
||||||
|
*
|
||||||
|
* @member next
|
||||||
|
* Internal use.
|
||||||
|
* One-way linked list, pointing to the next button.
|
||||||
|
*
|
||||||
|
* @member usr_button_read
|
||||||
|
* User function is used to read button vaule.
|
||||||
|
*
|
||||||
|
* @member cb
|
||||||
|
* Button event callback function.
|
||||||
|
*
|
||||||
|
* @member scan_cnt
|
||||||
|
* Internal use, user read-only.
|
||||||
|
* Number of scans, counted when the button is pressed, plus one per scan cycle.
|
||||||
|
*
|
||||||
|
* @member click_cnt
|
||||||
|
* Internal use, user read-only.
|
||||||
|
* Number of button clicks
|
||||||
|
*
|
||||||
|
* @member max_multiple_clicks_interval
|
||||||
|
* Multiple click interval. Default 'MAX_MULTIPLE_CLICKS_INTERVAL'.
|
||||||
|
* Need to use FLEX_MS_TO_SCAN_CNT to convert milliseconds into scan cnts.
|
||||||
|
*
|
||||||
|
* @member debounce_tick
|
||||||
|
* Debounce. Not used yet.
|
||||||
|
* Need to use FLEX_MS_TO_SCAN_CNT to convert milliseconds into scan cnts.
|
||||||
|
*
|
||||||
|
* @member short_press_start_tick
|
||||||
|
* Short press start time. Requires user configuration.
|
||||||
|
* Need to use FLEX_MS_TO_SCAN_CNT to convert milliseconds into scan cnts.
|
||||||
|
*
|
||||||
|
* @member long_press_start_tick
|
||||||
|
* Long press start time. Requires user configuration.
|
||||||
|
* Need to use FLEX_MS_TO_SCAN_CNT to convert milliseconds into scan cnts.
|
||||||
|
*
|
||||||
|
* @member long_hold_start_tick
|
||||||
|
* Long hold press start time. Requires user configuration.
|
||||||
|
*
|
||||||
|
* @member id
|
||||||
|
* Button id. Requires user configuration.
|
||||||
|
* When multiple buttons use the same button callback function,
|
||||||
|
* they are used to distinguish the buttons.
|
||||||
|
* Each button id must be unique.
|
||||||
|
*
|
||||||
|
* @member pressed_logic_level
|
||||||
|
* Requires user configuration.
|
||||||
|
* The logic level of the button pressed, each bit represents a button.
|
||||||
|
*
|
||||||
|
* @member event
|
||||||
|
* Internal use, users can call 'flex_button_event_read' to get current button event.
|
||||||
|
* Used to record the current button event.
|
||||||
|
*
|
||||||
|
* @member status
|
||||||
|
* Internal use, user unavailable.
|
||||||
|
* Used to record the current state of buttons.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
typedef struct flex_button
|
||||||
|
{
|
||||||
|
struct flex_button* next;
|
||||||
|
|
||||||
|
uint8_t (*usr_button_read)(void *);
|
||||||
|
flex_button_response_callback cb;
|
||||||
|
|
||||||
|
uint16_t scan_cnt;
|
||||||
|
uint16_t click_cnt;
|
||||||
|
uint16_t max_multiple_clicks_interval;
|
||||||
|
|
||||||
|
uint16_t debounce_tick;
|
||||||
|
uint16_t short_press_start_tick;
|
||||||
|
uint16_t long_press_start_tick;
|
||||||
|
uint16_t long_hold_start_tick;
|
||||||
|
|
||||||
|
uint8_t id;
|
||||||
|
uint8_t pressed_logic_level : 1;
|
||||||
|
uint8_t event : 4;
|
||||||
|
uint8_t status : 3;
|
||||||
|
} flex_button_t;
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
int8_t flex_button_register(flex_button_t *button);
|
||||||
|
flex_button_event_t flex_button_event_read(flex_button_t* button);
|
||||||
|
void flex_button_scan(void);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
#endif /* __FLEXIBLE_BUTTON_H__ */
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
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.
|
||||||
|
|
@ -0,0 +1,131 @@
|
||||||
|
# MultiButton
|
||||||
|
|
||||||
|
## 简介
|
||||||
|
MultiButton 是一个小巧简单易用的事件驱动型按键驱动模块，可无限量扩展按键，按键事件的回调异步处理方式可以简化你的程序结构，去除冗余的按键处理硬编码，让你的按键业务逻辑更清晰。
|
||||||
|
|
||||||
|
## 使用方法
|
||||||
|
1.先申请一个按键结构
|
||||||
|
|
||||||
|
```c
|
||||||
|
struct Button button1;
|
||||||
|
```
|
||||||
|
2.初始化按键对象，绑定按键的GPIO电平读取接口**read_button_pin()** ，后一个参数设置有效触发电平
|
||||||
|
|
||||||
|
```c
|
||||||
|
button_init(&button1, read_button_pin, 0, 0);
|
||||||
|
```
|
||||||
|
3.注册按键事件
|
||||||
|
|
||||||
|
```c
|
||||||
|
button_attach(&button1, SINGLE_CLICK, Callback_SINGLE_CLICK_Handler);
|
||||||
|
button_attach(&button1, DOUBLE_CLICK, Callback_DOUBLE_Click_Handler);
|
||||||
|
...
|
||||||
|
```
|
||||||
|
4.启动按键
|
||||||
|
|
||||||
|
```c
|
||||||
|
button_start(&button1);
|
||||||
|
```
|
||||||
|
5.设置一个5ms间隔的定时器循环调用后台处理函数
|
||||||
|
|
||||||
|
```c
|
||||||
|
while(1) {
|
||||||
|
...
|
||||||
|
if(timer_ticks == 5) {
|
||||||
|
timer_ticks = 0;
|
||||||
|
|
||||||
|
button_ticks();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 特性
|
||||||
|
|
||||||
|
MultiButton 使用C语言实现，基于面向对象方式设计思路，每个按键对象单独用一份数据结构管理：
|
||||||
|
|
||||||
|
```c
|
||||||
|
struct Button {
|
||||||
|
uint16_t ticks;
|
||||||
|
uint8_t repeat: 4;
|
||||||
|
uint8_t event : 4;
|
||||||
|
uint8_t state : 3;
|
||||||
|
uint8_t debounce_cnt : 3;
|
||||||
|
uint8_t active_level : 1;
|
||||||
|
uint8_t button_level : 1;
|
||||||
|
uint8_t button_id;
|
||||||
|
uint8_t (*hal_button_Level)(uint8_t button_id_);
|
||||||
|
BtnCallback cb[number_of_event];
|
||||||
|
struct Button* next;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
这样每个按键使用单向链表相连，依次进入 button_handler(struct Button* handle) 状态机处理，所以每个按键的状态彼此独立。
|
||||||
|
|
||||||
|
|
||||||
|
## 按键事件
|
||||||
|
|
||||||
|
事件 | 说明
|
||||||
|
---|---
|
||||||
|
PRESS_DOWN | 按键按下，每次按下都触发
|
||||||
|
PRESS_UP | 按键弹起，每次松开都触发
|
||||||
|
PRESS_REPEAT | 重复按下触发，变量repeat计数连击次数
|
||||||
|
SINGLE_CLICK | 单击按键事件
|
||||||
|
DOUBLE_CLICK | 双击按键事件
|
||||||
|
LONG_PRESS_START | 达到长按时间阈值时触发一次
|
||||||
|
LONG_PRESS_HOLD | 长按期间一直触发
|
||||||
|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
```c
|
||||||
|
#include "button.h"
|
||||||
|
|
||||||
|
unit8_t btn1_id = 0;
|
||||||
|
|
||||||
|
struct Button btn1;
|
||||||
|
|
||||||
|
uint8_t read_button_GPIO(uint8_t button_id)
|
||||||
|
{
|
||||||
|
// you can share the GPIO read function with multiple Buttons
|
||||||
|
switch(button_id)
|
||||||
|
{
|
||||||
|
case btn1_id:
|
||||||
|
return HAL_GPIO_ReadPin(B1_GPIO_Port, B1_Pin);
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
return 0;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
void BTN1_PRESS_DOWN_Handler(void* btn)
|
||||||
|
{
|
||||||
|
//do something...
|
||||||
|
}
|
||||||
|
|
||||||
|
void BTN1_PRESS_UP_Handler(void* btn)
|
||||||
|
{
|
||||||
|
//do something...
|
||||||
|
}
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
button_init(&btn1, read_button_GPIO, 0, btn1_id);
|
||||||
|
button_attach(&btn1, PRESS_DOWN, BTN1_PRESS_DOWN_Handler);
|
||||||
|
button_attach(&btn1, PRESS_UP, BTN1_PRESS_UP_Handler);
|
||||||
|
button_attach(&btn1, PRESS_REPEAT, BTN1_PRESS_REPEAT_Handler);
|
||||||
|
button_attach(&btn1, SINGLE_CLICK, BTN1_SINGLE_Click_Handler);
|
||||||
|
button_attach(&btn1, DOUBLE_CLICK, BTN1_DOUBLE_Click_Handler);
|
||||||
|
button_attach(&btn1, LONG_PRESS_START, BTN1_LONG_PRESS_START_Handler);
|
||||||
|
button_attach(&btn1, LONG_PRESS_HOLD, BTN1_LONG_PRESS_HOLD_Handler);
|
||||||
|
button_start(&btn1);
|
||||||
|
|
||||||
|
//make the timer invoking the button_ticks() interval 5ms.
|
||||||
|
//This function is implemented by yourself.
|
||||||
|
__timer_start(button_ticks, 0, 5);
|
||||||
|
|
||||||
|
while(1)
|
||||||
|
{}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,208 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2016 Zibin Zheng <znbin@qq.com>
|
||||||
|
* All rights reserved
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "multi_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 = !active_level;
|
||||||
|
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 change
|
||||||
|
if(++(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 down
|
||||||
|
handle->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 up
|
||||||
|
handle->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 again
|
||||||
|
handle->event = (uint8_t)PRESS_DOWN;
|
||||||
|
EVENT_CB(PRESS_DOWN);
|
||||||
|
if(handle->repeat != PRESS_REPEAT_MAX_NUM) {
|
||||||
|
handle->repeat++;
|
||||||
|
}
|
||||||
|
EVENT_CB(PRESS_REPEAT); // repeat hit
|
||||||
|
handle->ticks = 0;
|
||||||
|
handle->state = 3;
|
||||||
|
} else if(handle->ticks > SHORT_TICKS) { //released timeout
|
||||||
|
if(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 up
|
||||||
|
handle->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_TICKS
|
||||||
|
handle->state = 1;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 5:
|
||||||
|
if(handle->button_level == handle->active_level) {
|
||||||
|
//continue hold trigger
|
||||||
|
handle->event = (uint8_t)LONG_PRESS_HOLD;
|
||||||
|
EVENT_CB(LONG_PRESS_HOLD);
|
||||||
|
} else { //released
|
||||||
|
handle->event = (uint8_t)PRESS_UP;
|
||||||
|
EVENT_CB(PRESS_UP);
|
||||||
|
handle->state = 0; //reset
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
handle->state = 0; //reset
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,62 @@
|
||||||
|
/*
|
||||||
|
* 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 (400 /TICKS_INTERVAL)
|
||||||
|
#define LONG_TICKS (1500 /TICKS_INTERVAL)
|
||||||
|
|
||||||
|
|
||||||
|
typedef void (*BtnCallback)(void*);
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
PRESS_DOWN = 0,
|
||||||
|
PRESS_UP,
|
||||||
|
PRESS_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;
|
||||||
|
uint8_t event : 4;
|
||||||
|
uint8_t state : 3;
|
||||||
|
uint8_t debounce_cnt : 3;
|
||||||
|
uint8_t active_level : 1;
|
||||||
|
uint8_t button_level : 1;
|
||||||
|
uint8_t button_id;
|
||||||
|
uint8_t (*hal_button_Level)(uint8_t button_id_);
|
||||||
|
BtnCallback cb[number_of_event];
|
||||||
|
struct Button* next;
|
||||||
|
}Button;
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
void button_init(struct Button* handle, uint8_t(*pin_level)(uint8_t), uint8_t active_level, uint8_t button_id);
|
||||||
|
void button_attach(struct Button* handle, PressEvent event, BtnCallback cb);
|
||||||
|
PressEvent get_button_event(struct Button* handle);
|
||||||
|
int button_start(struct Button* handle);
|
||||||
|
void button_stop(struct Button* handle);
|
||||||
|
void button_ticks(void);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
Loading…
Reference in New Issue