AceButton 项目教程

AceButton 项目教程

AceButtonAn adjustable, compact, event-driven button library for Arduino that debounces and dispatches events to a user-defined event handler.项目地址:https://gitcode.com/gh_mirrors/ac/AceButton

1. 项目的目录结构及介绍

AceButton 项目的目录结构如下：

AceButton/
├── examples/
│   ├── Basic/
│   ├── SingleButton/
│   ├── HelloButton/
│   └── ...
├── src/
│   ├── AceButton.h
│   ├── ace_button/
│   │   ├── ButtonConfig.cpp
│   │   ├── ButtonConfig.h
│   │   └── ...
│   └── ace_button/testing/
│       └── ...
├── tests/
│   └── ...
├── docs/
│   ├── binary_encoding/
│   │   └── README.md
│   ├── resistor_ladder/
│   │   └── README.md
│   └── ...
├── README.md
└── ...

目录结构介绍

• examples/: 包含多个示例代码，展示了如何使用 AceButton 库。
  • Basic/: 基本的按钮示例。
  • SingleButton/: 单按钮示例。
  • HelloButton/: 最小的程序示例，读取开关并控制内置 LED。
• src/: 包含 AceButton 库的核心源代码。
  • AceButton.h: 主头文件。
  • ace_button/: 包含所有实现文件。
  • ace_button/testing/: 内部测试文件。
• tests/: 包含单元测试文件，需要 AUnit 库。
• docs/: 包含项目的文档。
  • binary_encoding/: 解释如何通过二进制编码读取按钮。
  • resistor_ladder/: 解释如何通过电阻梯形网络读取按钮。
• README.md: 项目的主文档文件。

2. 项目的启动文件介绍

AceButton 项目的启动文件是 AceButton.h，位于 src/ 目录下。这个文件是 AceButton 库的主头文件，包含了库的核心功能和类定义。

启动文件介绍

• AceButton.h: 这是 AceButton 库的主头文件，包含了库的核心功能和类定义。用户在使用 AceButton 库时，首先需要包含这个头文件。

#include <AceButton.h>

3. 项目的配置文件介绍

AceButton 项目的配置文件主要是 ButtonConfig 类，位于 src/ace_button/ 目录下。ButtonConfig 类用于配置按钮的行为和事件处理。

配置文件介绍

• ButtonConfig.h: 定义了 ButtonConfig 类，用于配置按钮的行为和事件处理。
• ButtonConfig.cpp: ButtonConfig 类的实现文件。

配置示例

#include <AceButton.h>
using namespace ace_button;

ButtonConfig config;
config.setFeature(ButtonConfig::kFeatureClick);
config.setFeature(ButtonConfig::kFeatureDoubleClick);
config.setFeature(ButtonConfig::kFeatureLongPress);
config.setFeature(ButtonConfig::kFeatureRepeatPress);

通过 ButtonConfig 类，用户可以配置按钮的各种事件，如单击、双击、长按等。

AceButtonAn adjustable, compact, event-driven button library for Arduino that debounces and dispatches events to a user-defined event handler.项目地址:https://gitcode.com/gh_mirrors/ac/AceButton