# ry_key

**Repository Path**: dauywan/ry_key

## Basic Information

- **Project Name**: ry_key
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-07
- **Last Updated**: 2024-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 按键处理

## README

# ry_key  
# 概述  
嵌入式领域，C语言编写的按键驱动。  
* **两种类型**  
  * 独立按键  
  * 组合键  
* **2种状态**  
  `按下`、`弹起`  
* **9类事件**  
  `组合键`、`按压`、`弹起`、`单击`、`双击`、`三击`、`长按`、`超长按`、`无事件`  

![系统结构](图片/按键驱动简介.png) 

*网盘下载地址：https://pan.baidu.com/s/1uoS-Xpm8JSPdkq5KYSMFFA?pwd=g1di*
---


# 数据结构  
## 独立按键  
![独立按键结构](图片/独立按键结构.png) 
## 组合键  
![组合键结构](图片/组合键结构.png) 


# 独立按键的状态机  
## 状态转移图  
![独立按键扫描状态机](图片/独立按键扫描状态机.png) 


# 按键扫描的具体流程  
![按键扫描的具体流程](图片/按键扫描的具体流程.png) 


# 如何使用  
建议使用一个定时器外设，配置成系统时基，定时调用`ry_key_scan`  


```
#include "ry_key.h"

static ry_key_t __keyPower;              /* 电源按键 */
static ry_key_t __keyCtr;                /* 控制按键 */
static ry_key_compound_t __compoundKey1; /* 组合键 */


extern uint8_t key_power_get_level(void);
extern uint8_t key_ctr_get_level(void);

void key_power_long_press_callback(ry_key_t *key)
{
	printf("key_power_long_press_callback");
}
void key_ctr_single_click_callback(ry_key_t *key)
{
	printf("key_ctr_single_click_callback");
}
void compound_key1_callback(ry_key_t *key)
{
	printf("compound_key1_callback");
}

void user_key_init(void)
{
	ry_key_reg(&__keyPower, 0, 0, key_power_get_level);
	ry_key_reg(&__keyCtr,   0, 1, key_ctr_get_level);
	ry_key_compound_reg(&__compoundKey1, compound_key1_callback);
	
	RY_KEY_SET_EVENT_HANDLER(__keyPower, KEY_LONG_PRESS_EVENT, key_power_long_press_callback);
	RY_KEY_SET_EVENT_HANDLER(__keyCtr, KEY_SINGLE_CLICK_EVENT, key_ctr_single_click_callback);
	
	ry_key_compound_insert_key_sn(&__compoundKey1, &__keyPower);
	ry_key_compound_insert_key_sn(&__compoundKey1, &__keyCtr);
}

int main(void)
{
	//system_init();
	user_key_init();
	while(1)
	{
		/* 配置定时器，定时扫描按键效果更好 */
		ry_key_scan();
	}
}
```

https://blog.csdn.net/kq851211/article/details/132055208