OpenFFBoard 项目使用教程

1. 项目目录结构及介绍

OpenFFBoard 项目的目录结构如下：

OpenFFBoard/
├── Configurator/
│   ├── ...
│   └── ...
├── Firmware/
│   ├── ...
│   └── ...
├── Hardware/
│   ├── ...
│   └── ...
├── doc/
│   ├── ...
│   └── ...
├── .gitmodules
├── CHANGELOG.md
├── LICENSE
└── README.md

目录介绍

• Configurator/: 包含配置工具的源代码和相关文件。
• Firmware/: 包含 OpenFFBoard 的固件源代码。
• Hardware/: 包含硬件设计的相关文件，如电路板设计文件。
• doc/: 包含项目的文档文件。
• .gitmodules: Git 子模块配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和基本使用说明。

2. 项目的启动文件介绍

OpenFFBoard 项目的启动文件主要位于 Firmware/ 目录下。以下是一些关键的启动文件：

• main.cpp: 这是固件的主启动文件，包含了初始化代码和主循环。
• FFBoardMain.cpp: 这是 OpenFFBoard 的主类文件，负责处理 USB 通信、力反馈和其他核心功能。
• ExampleMain.cpp: 这是一个示例主类文件，展示了如何扩展和自定义 OpenFFBoard 的功能。

启动流程

1. 初始化: main.cpp 文件首先进行系统初始化，包括硬件初始化和 USB 设备的初始化。
2. 主循环: 初始化完成后，进入主循环，处理 USB 数据、力反馈计算和其他任务。
3. 扩展功能: 用户可以通过继承 FFBoardMain 类并重写相关方法来扩展功能。

3. 项目的配置文件介绍

OpenFFBoard 的配置文件主要用于设置硬件参数和用户自定义选项。以下是一些关键的配置文件：

• config.h: 这是一个头文件，包含了硬件配置和用户自定义选项的宏定义。
• settings.json: 这是一个 JSON 格式的配置文件，用于存储用户设置和参数。

配置文件内容

• config.h:

  • #define USE_TMC4671: 定义是否使用 TMC4671 电机驱动。
  • #define USB_DEVICE_VID: 定义 USB 设备的 VID（Vendor ID）。
  • #define USB_DEVICE_PID: 定义 USB 设备的 PID（Product ID）。

• settings.json:

  • "motor_driver": "TMC4671": 设置使用的电机驱动类型。
  • "encoder_type": "ABN": 设置使用的编码器类型。
  • "steering_angle": 900: 设置方向盘的最大角度。

配置流程

1. 编辑配置文件: 用户可以根据需要编辑 config.h 和 settings.json 文件。
2. 编译固件: 修改配置文件后，重新编译固件以应用新的配置。
3. 上传固件: 将编译好的固件上传到 OpenFFBoard 硬件中。

通过以上步骤，用户可以自定义 OpenFFBoard 的功能和参数，以满足不同的应用需求。