# cotKey

**Repository Path**: cot_package/cot_key

## Basic Information

- **Project Name**: cotKey
- **Description**: 嵌入式设备常用的按键动作识别模块组件代码
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 23
- **Forks**: 21
- **Created**: 2023-06-21
- **Last Updated**: 2025-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 轻量级按键识别模块

轻量级的按键动作识别软件框架，可以十分方便地获取按键的各种状态，通过配置按键不同模式，完成对应的按键动作识别。

#### 特点

轻量级的按键动作识别代码：

* 移植方便，无需修改，只需要初始化提供读取相关IO状态函数即可
* 丰富的接口实现，通过这些接口能及时处理按键操作，同时可以实现单击、双击、多击、短按和长按等多种要求的功能
* 代码量少，且代码注释丰富，风格统一，便于阅读和使用

#### 软件架构

##### 文件介绍

* cot_key.c 和 cot_key.h

  > 实现具体功能，对外提供的 API 接口函数
  >

#### 使用说明

1. 使用前初始化函数 cotKey_Init，添加所有按键
   > 需要实现读取IO状态的函数，然后初始化结构体的 `pfnKeyState`即可。
   >
2. 周期调用函数 `cotKey_Scan`, 入参为毫秒级的系统时长，用来扫描按键动作并触发回调函数处理
3. 通过函数 `cotKey_Listen` 添加回调函数监听按键操作状态
4. 在回调函数中调用其他函数进一步识别按键的动作，做出相应处理。

#### 示例工程代码

代码链接：[stm32 工程](https://gitee.com/cot_package/demo_stm32)

#### 关于作者

1. CSDN 博客 [大橙子疯](https://blog.csdn.net/qq_24130227?spm=1010.2135.3001.5343)
2. 联系邮箱 `const_zpc@163.com`
3. 了解更多可关注微信公众号

![大橙子疯嵌入式](微信公众号.jpg)

如果对你有帮助，可以多多支持一下，感谢！

![收款码](收款码.jpg)