ESP Rotary 使用指南

项目概述

ESPRotary 是一个专为 Arduino 和 ESP8266 平台设计的库，旨在简化旋转编码器数据读取。通过使用回调函数跟踪旋转，它大大减少了源代码的复杂性并提高了可读性。该库由 Lennart Hennigs 开发并维护，已测试兼容 Arduino 和 ESP8266 硬件。

目录结构及介绍

以下是基于提供的链接和描述构建的基本项目目录结构概览：

ESPRotary/
|-- src
|   |-- ESPRotary.cpp          // 主实现文件，包含了库的核心功能
|   |-- ESPRotary.h             // 头文件，声明了类、接口和相关函数
|-- examples                   // 示例程序目录
|   |-- BasicUsage              // 基本使用示例
|       |-- BasicUsage.ino     // 示例代码文件，演示如何初始化和使用库
|-- docs                       // 可能包含额外的文档或教程（假设存在）
|-- README.md                  // 项目的主要说明文档，介绍了安装步骤、基本用法等
|-- LICENSE                    // 许可证文件，使用MIT许可证

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

• src：核心源代码所在目录，包括 .cpp 实现文件和 .h 头文件。

  • ESPRotary.cpp：实现了旋转编码器处理逻辑。
  • ESPRotary.h：定义了库的接口和结构。

• examples：提供了一系列示例项目，帮助用户快速上手。

  • 每个子目录内通常有一个 .ino 文件，这是Arduino平台的源码文件。

• docs（可能）：存放文档和教程，尽管在实际链接中未具体提及，但一般项目会在此部分提供额外的帮助文档。

• README.md：项目入口文件，提供了安装库的方法、快速入门指导和重要信息。

• LICENSE：记录了软件的使用条款，采用MIT许可证，允许自由使用、修改和分发。

项目的启动文件介绍

在 examples 目录下的每个.ino文件可以被视为一个启动文件或示例程序。以 BasicUsage.ino 为例，这是一个典型的启动文件，展示了如何初始化ESP Rotary库，设定旋转编码器的引脚，并注册回调函数来响应旋转事件。此类文件是学习和理解库如何集成到你的项目中的起点。

#include "ESPRotary.h"

// 定义旋转编码器的引脚连接
const int rotaryPinA = 2;
const int rotaryPinB = 3;

// 创建一个ESPRotary对象实例
ESPRotary rotary(rotaryPinA, rotaryPinB);

void setup() {
  Serial.begin(115200);
  rotary.init();
  rotary.setCallback([this]() {
      // 回调函数内的代码将会在旋转时执行
      Serial.println("Rotation detected!");
  });
}

void loop() {
  rotary.loop(); // 必须在循环中调用以检测变化
}

项目的配置文件介绍

ESPRotary本身不直接指向一个传统的“配置文件”，其配置主要通过代码进行。这意味着设置如引脚分配、是否启用特定特性等，都是在.ino文件的setup()函数中完成的，或者在创建ESPRotary对象时通过构造函数参数指定。例如，你可以通过在初始化时传递不同的参数来定制行为，或通过成员函数调整配置选项。

对于更高级的配置需求，开发者可能会通过定义预处理器宏或者外部JSON/YAML配置文件来自定义，但这取决于库作者是否有这样的实现。在这个特定的项目中，配置主要是通过编程式的方式，在源代码中直接进行。