key-ripper 项目安装与使用教程

1. 项目目录结构及介绍

key-ripper 项目的目录结构如下：

key-ripper/
├── firmware/
│   ├── src/
│   ├── Cargo.toml
│   └── ...
├── pcb/
│   ├── gerber/
│   ├── kicad/
│   └── ...
├── README.md
├── LICENSE-APACHE
├── LICENSE-MIT
├── LICENSE-ZLIB
└── ...

目录介绍

• firmware/: 包含键盘固件的源代码，主要使用 Rust 语言编写。

  • src/: 固件的源代码文件。
  • Cargo.toml: Rust 项目的配置文件，定义了项目的依赖和构建配置。

• pcb/: 包含 PCB 设计文件，使用 KiCad 进行设计。

  • gerber/: 用于 PCB 制造的 Gerber 文件。
  • kicad/: KiCad 项目文件，包括原理图和 PCB 布局文件。

• README.md: 项目的主文档，包含项目的介绍、功能、使用方法等。

• LICENSE-APACHE, LICENSE-MIT, LICENSE-ZLIB: 项目的开源许可证文件。

2. 项目的启动文件介绍

key-ripper 项目的启动文件主要位于 firmware/src/ 目录下。以下是主要的启动文件：

• main.rs: 这是固件的主入口文件，包含了键盘的主要逻辑和初始化代码。

// firmware/src/main.rs
fn main() {
    // 初始化硬件
    let peripherals = Peripherals::take().unwrap();
    let mut delay = Delay::new();

    // 初始化 USB
    let usb_bus = UsbBusAllocator::new(peripherals.USB);
    let mut usb_dev = UsbDeviceBuilder::new(&usb_bus, UsbVidPid(0x16c0, 0x27dd))
        .manufacturer("bschwind")
        .product("key-ripper")
        .serial_number("123456")
        .build();

    // 初始化键盘矩阵
    let mut matrix = KeyMatrix::new(peripherals.GPIO, &mut delay);

    loop {
        // 处理键盘扫描
        matrix.scan();

        // 处理 USB 事件
        usb_dev.poll(&mut [&mut usb_bus]);
    }
}

3. 项目的配置文件介绍

key-ripper 项目的配置文件主要有两个：

3.1 Cargo.toml

Cargo.toml 是 Rust 项目的配置文件，定义了项目的依赖和构建配置。

# firmware/Cargo.toml
[package]
name = "key-ripper"
version = "0.1.0"
edition = "2018"

[dependencies]
cortex-m = "0.7.3"
cortex-m-rt = "0.7.0"
embedded-hal = "0.2.6"
usb-device = "0.2.7"

3.2 kitspace.yaml

kitspace.yaml 是用于 KiCad 项目的配置文件，定义了 PCB 制造的相关配置。

# kitspace.yaml
version: 1
name: key-ripper
description: A keyboard personalized for myself, designed in KiCad, with custom firmware written in Rust.
site: https://github.com/bschwind/key-ripper
bom:
  - name: BOM
    file: bom.csv
  - name: Position
    file: position.csv
gerbers:
  - name: Gerbers
    file: gerbers.zip

通过以上配置文件，用户可以了解项目的依赖关系、构建方式以及 PCB 制造的相关信息。