TMCStepper 开源项目使用教程

TMCStepper 开源项目使用教程

TMCStepper 项目地址: https://gitcode.com/gh_mirrors/tm/TMCStepper

1. 项目目录结构及介绍

TMCStepper 项目是一个为 Trinamic TMC 步进电机驱动器提供的 Arduino 库。项目目录结构如下：

TMCStepper/
├── docs/               # 项目文档目录
├── examples/           # 示例代码目录
├── extras/             # 额外资源目录
├── src/                # 源代码目录
├── .nojekyll           # 禁用 GitHub Pages 的 Jekyll 处理
├── Doxyfile            # Doxygen 文档配置文件
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├── keywords.txt        # 关键字文件
├── library.json        # Arduino 库配置文件
└── library.properties  # Arduino 库属性文件

目录详细介绍：

• docs/: 包含项目的文档，如 Doxygen 生成的文档等。
• examples/: 包含使用 TMCStepper 库的示例代码。
• extras/: 包含一些额外的资源，如初始化脚本或辅助工具。
• src/: 包含库的源代码，是项目的主要开发区域。
• .nojekyll: 确保在 GitHub Pages 上发布时不会使用 Jekyll 进行渲染。
• Doxyfile: Doxygen 文档生成配置文件，用于生成项目的文档。
• LICENSE: 项目使用 MIT 许可证。
• README.md: 项目说明文件，介绍了项目的基本信息和用途。
• keywords.txt: 定义库的关键字，用于在 Arduino IDE 中搜索库。
• library.json 和 library.properties: 定义 Arduino 库的元数据。

2. 项目的启动文件介绍

项目的启动文件主要指 src/TMCStepper.h，这是库的主头文件，包含了库的接口和类的声明。在使用 TMCStepper 库时，需要在 Arduino 的 .ino 文件中包含这个头文件：

#include <TMCStepper.h>

然后，可以通过创建 TMCStepper 类的实例来使用不同的电机驱动器。例如，创建一个用于 TMC2130 驱动器的实例：

TMCStepper stepper(TMC2130, 0);

3. 项目的配置文件介绍

配置文件主要包括 library.json 和 library.properties。

• library.json: 这是一个 JSON 格式的文件，用于定义 Arduino IDE 中的库元数据。它包含了库的名称、版本、作者、许可和依赖等信息。例如：

{
  "name": "TMCStepper",
  "version": "0.7.3",
  "author": "Teemu Luke",
  "sentence": "Arduino library for Trinamic TMC stepper motor drivers.",
  "url": "https://github.com/teemuatlut/TMCStepper",
  "license": "MIT",
  "keywords": "driver, tmc2130, tmc2208, stepper, trinamic, tmc5130, tmc2660, tmc5160, tmc5161"
}

• library.properties: 这是一个属性文件，用于定义库的 Arduino IDE 设置，如菜单中显示的库名称和版本号。例如：

name=TMCStepper
version=0.7.3
author=Teemu Luke
sentence=Arduino library for Trinamic TMC stepper motor drivers.
url=https://github.com/teemuatlut/TMCStepper
license=MIT

这些配置文件确保了库在 Arduino IDE 中正确地展示和安装。

TMCStepper 项目地址: https://gitcode.com/gh_mirrors/tm/TMCStepper