Redox 键盘项目教程

1. 项目目录结构及介绍

Redox 键盘项目是一个开源的机械键盘项目，旨在提供一个符合人体工程学设计的分体式键盘。项目的目录结构如下：

redox-keyboard/
├── firmware/
│   ├── qmk_firmware/
│   └── zmk_firmware/
├── hardware/
│   ├── pcb/
│   └── case/
├── docs/
├── LICENSE
└── README.md

目录结构介绍

• firmware/: 包含键盘固件的代码，支持 QMK 和 ZMK 两种固件。

  • qmk_firmware/: QMK 固件的代码。
  • zmk_firmware/: ZMK 固件的代码。

• hardware/: 包含硬件设计文件，如 PCB 设计和外壳设计。

  • pcb/: PCB 设计文件，包括原理图和 PCB 布局。
  • case/: 键盘外壳的设计文件，通常是 3D 打印模型。

• docs/: 项目文档，包含项目的详细说明和使用指南。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的介绍文件，包含项目的基本信息和使用说明。

2. 项目的启动文件介绍

Redox 键盘项目的启动文件主要位于 firmware/ 目录下。以下是启动文件的介绍：

QMK 固件启动文件

在 firmware/qmk_firmware/ 目录下，主要的启动文件是 keymap.c 和 config.h。

• keymap.c: 定义键盘的按键映射，包括每个按键的功能和组合键的定义。
• config.h: 包含固件的配置选项，如键盘布局、按键扫描频率等。

ZMK 固件启动文件

在 firmware/zmk_firmware/ 目录下，主要的启动文件是 app/src/main.c 和 app/include/config.h。

• main.c: 定义键盘的主程序，包括按键扫描和处理逻辑。
• config.h: 包含固件的配置选项，如键盘布局、按键扫描频率等。

3. 项目的配置文件介绍

Redox 键盘项目的配置文件主要用于定义键盘的硬件和固件配置。以下是主要的配置文件介绍：

硬件配置文件

在 hardware/pcb/ 目录下，主要的配置文件是 config.json 和 schematic.pdf。

• config.json: 定义 PCB 的配置选项，如元件布局、连接方式等。
• schematic.pdf: 包含 PCB 的原理图，详细描述了电路连接和元件布局。

固件配置文件

在 firmware/ 目录下，主要的配置文件是 config.h。

• config.h: 包含固件的配置选项，如键盘布局、按键扫描频率、LED 配置等。

总结

Redox 键盘项目是一个功能强大的开源机械键盘项目，提供了详细的硬件和固件设计文件。通过本教程，您可以了解项目的目录结构、启动文件和配置文件，从而更好地理解和使用该项目。