HelloWord-Keyboard 项目下载及安装教程

1. 项目介绍

HelloWord-Keyboard 是一个多功能、模块化的机械键盘项目，由 peng-zhihui 开发。该项目采用模块化设计，左侧的多功能场景交互模块可以替换成各种自定义组件，默认使用的是一个带电子墨水屏以及FOC力反馈旋钮的Dynamic组件。键盘使用基于ARM Cortex-M芯片的键盘固件以及模块固件，键盘本体使用移位寄存器方式实现优化的按键扫描电路。模块以及键盘本体可以单独使用，也可以通过串口协议进行相互通信和调用。

2. 项目下载位置

要下载 HelloWord-Keyboard 项目，请按照以下步骤操作：

1. 打开终端或命令提示符。
2. 输入以下命令以克隆项目仓库：

git clone https://github.com/peng-zhihui/HelloWord-Keyboard.git

3. 等待项目克隆完成。

3. 项目安装环境配置

在安装 HelloWord-Keyboard 项目之前，需要配置相应的开发环境。以下是所需的软件和工具：

• STM32CubeMX: 用于生成STM32的初始化代码。
• STM32CubeIDE: 用于编译和调试STM32固件。
• ST-Link 调试器: 用于烧录固件到STM32芯片。
• 立创EDA专业版: 用于查看和编辑PCB设计文件。

环境配置示例

STM32CubeMX 配置

1. 打开 STM32CubeMX 软件。
2. 选择 File -> New Project，然后选择你的STM32芯片型号。
3. 配置所需的引脚和外设，生成初始化代码。

STM32CubeIDE 配置

1. 打开 STM32CubeIDE 软件。
2. 导入 HelloWord-Keyboard 项目文件夹。
3. 配置编译选项，确保所有依赖库正确链接。

4. 项目安装方式

安装 HelloWord-Keyboard 项目的步骤如下：

1. 硬件准备: 确保你已经准备好所有必要的硬件组件，包括STM32开发板、键盘PCB、电子墨水屏、FOC力反馈旋钮等。
2. 固件编译: 使用 STM32CubeIDE 打开项目文件夹，编译固件。
3. 固件烧录: 使用 ST-Link 调试器将编译好的固件烧录到STM32芯片中。
4. 硬件组装: 按照项目文档中的说明，将所有硬件组件组装在一起。

5. 项目处理脚本

HelloWord-Keyboard 项目包含一些处理脚本，用于自动化某些任务。以下是一些常用的脚本：

• build.sh: 用于自动化编译固件。
• flash.sh: 用于自动化烧录固件到STM32芯片。
• config.sh: 用于自动化配置开发环境。

使用示例

# 编译固件
./build.sh

# 烧录固件
./flash.sh

# 配置开发环境
./config.sh

通过以上步骤，你可以成功下载、安装并配置 HelloWord-Keyboard 项目。希望这篇教程对你有所帮助！