OneButton Arduino库使用教程

OneButton Arduino库使用教程

【免费下载链接】OneButton An Arduino library for using a single button for multiple purpose input. 项目地址: https://gitcode.com/gh_mirrors/on/OneButton

1. 项目目录结构及介绍

OneButton库的目录结构如下：

OneButton/
├── examples/
│   ├── SimpleOneButton/
│   └── ...
├── src/
│   ├── OneButton.cpp
│   └── OneButton.h
├── .clang-format
├── .gitignore
├── .markdownlint.json
├── CHANGELOG.md
├── LICENSE
├── README.md
├── keywords.txt
├── library.json
├── library.properties
└── run_cppcheck.sh

目录结构介绍

• examples/: 包含示例代码，帮助用户快速上手使用OneButton库。
• src/: 包含库的核心源代码文件，包括OneButton.cpp和OneButton.h。
• .clang-format: 代码格式化配置文件。
• .gitignore: Git忽略文件配置。
• .markdownlint.json: Markdown格式检查配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• keywords.txt: Arduino IDE关键字文件，用于高亮显示库中的关键字。
• library.json: 库的元数据文件，用于Arduino库管理器。
• library.properties: 库的属性文件，用于Arduino库管理器。
• run_cppcheck.sh: 用于运行代码检查的脚本。

2. 项目启动文件介绍

OneButton库的启动文件主要是OneButton.h和OneButton.cpp。这两个文件定义了OneButton类及其相关方法，用户可以通过包含OneButton.h来使用该库。

OneButton.h

OneButton.h文件定义了OneButton类的接口，包括构造函数、事件处理函数、状态更新函数等。用户可以通过包含该头文件来使用OneButton库。

#include <OneButton.h>

OneButton.cpp

OneButton.cpp文件实现了OneButton.h中定义的接口。它包含了按钮事件的处理逻辑，如单击、双击、长按等事件的检测和处理。

3. 项目配置文件介绍

OneButton库的配置文件主要包括library.properties和library.json。这些文件用于描述库的元数据，方便Arduino IDE进行管理和安装。

library.properties

library.properties文件包含了库的基本信息，如库的名称、版本、作者等。以下是该文件的内容示例：

name=OneButton
version=2.0.0
author=Matthias Hertel
maintainer=Matthias Hertel
sentence=An Arduino library for using a single button for multiple purpose input.
paragraph=This Arduino library is improving the usage of a single button for input. It shows how to use an digital input pin with a single pushbutton attached for detecting some of the typical button press events like single clicks, double clicks and long-time pressing.
category=Signal Input/Output
url=https://github.com/mathertel/OneButton
architectures=*

library.json

library.json文件是Arduino库管理器的元数据文件，包含了库的详细信息。以下是该文件的内容示例：

{
  "name": "OneButton",
  "version": "2.0.0",
  "keywords": "button, input, click, doubleclick, longpress",
  "description": "An Arduino library for using a single button for multiple purpose input.",
  "repository": {
    "type": "git",
    "url": "https://github.com/mathertel/OneButton.git"
  },
  "authors": [
    {
      "name": "Matthias Hertel",
      "url": "http://www.mathertel.de",
      "maintainer": true
    }
  ],
  "license": "BSD-3-Clause",
  "frameworks": "arduino",
  "platforms": "*"
}

通过这些配置文件，用户可以方便地在Arduino IDE中安装和管理OneButton库。

【免费下载链接】OneButton An Arduino library for using a single button for multiple purpose input. 项目地址: https://gitcode.com/gh_mirrors/on/OneButton