Skip to content

Latest commit

 

History

History
124 lines (82 loc) · 5.9 KB

README_zh.md

File metadata and controls

124 lines (82 loc) · 5.9 KB
Raw

RMK

Crates.io Docs Build Discord

该文档暂时是机翻+人工修改，后续会更新，欢迎PR！

特性

  • 支持范围广：基于 embassy，RMK 支持非常多的MCU系列，例如 stm32/nrf/rp2040/esp32等。
  • 实时键位编辑：使用 vial 进行实时键位编辑，可以在编译时定制键盘布局。
  • 高级键盘功能：RMK 默认提供许多高级键盘功能，如层切换、媒体控制、系统控制、鼠标控制等。
  • 无线支持：（实验性功能）RMK 支持 BLE 无线功能，包括自动重新连接和多设备功能，已经在 nrf52840 和 esp32c3 上进行了测试。
  • 易于配置：RMK提供了一个非常简单的配置你的键盘的方法，你只需要一个keyboard.toml文件，就可以构建起你的键盘固件！当然，对于 Rust 开发者来说，你仍然可以使用代码方式来使用 RMK

新闻

  • [2024.05.01] RMK的全新配置化固件生成已经在主分支可用了！使用这个特性，你可以编写一个keyboard.toml配置文件，然后让RMK来帮助你生成Rust代码然后编译固件。这里是相关文档，你也可以在 examples 目录下查看示例。示例包含使用配置文件和使用Rust代码两种方式。

  • [2024.04.07] 现在esp32c3和esp32s3的蓝牙支持已经在主分支上可用，示例可以参考 examples/use_rust/esp32c3_ble 和 examples/use_rust/esp32s3_ble

  • [2024.03.07] RMK 添加了对 nrf52840/nrf52832 的 BLE 支持，包括自动重新连接和多设备功能！具体用法可以参考 examples/use_rust/nrf52840_ble 和 examples/use_rust/nrf52832_ble 下的示例

点击查看更多

[2024.02.18] 版本 0.1.4 发布了！这个版本加入了一个自动生成 vial 配置的构建脚本，一点点 API 更新以及全新的用户文档。

  • 下面懒得翻译了，就酱

  • [2024.01.26] 🎉rmk-template is released! Now you can create your own keyboard firmware with a single command: cargo generate --git https://github.com/HaoboGu/rmk-template

  • [2024.01.18] RMK just released version 0.1.0! By migrating to Embassy, RMK now has better async support, more supported MCUs and much easier usages than before. For examples, check examples folder!

用户文档（英文）

API 文档

使用 RMK

选项 1：从模板初始化

你可以使用RMK提供的模板仓库 rmk-template 来初始化你的固件工程

cargo install cargo-generate
cargo generate --git https://github.com/HaoboGu/rmk-template

生成固件工程之后，按照README.md中的步骤进行操作。有关详细信息，请查看 RMK 的 用户指南。

选项 2：尝试内置的例子

RMK 内置了一些常见MCU的示例，这些示例可以在 examples 中找到。下面是 rp2040 和 stm32h7 的示例的简单说明：

rp2040

  1. 安装 probe-rs

    cargo install probe-rs --features cli

  2. 构建固件

    cd examples/use_rust/rp2040
cargo build

  3. 烧录固件

    如果你的 rp2040 已经通过调试器连接，那么可以使用下面的命令把RMK固件烧录到开发板上：

    cd examples/use_rust/rp2040
cargo run

  4. 通过USB烧录

    如果你没有调试器，那么可以使用 elf2uf2-rs 通过 USB 烧录固件，但是这种方式需要一些额外的步骤：

    1. 安装 elf2uf2-rs: cargo install elf2uf2-rs
    2. 更新 examples/use_rust/rp2040/.cargo/config.toml文件，使用 elf2uf2作为默认的烧录命令 
      - runner = "probe-rs run --chip RP2040"
+ runner = "elf2uf2-rs -d"
    3. 按住BOOTSEL的同时插上你的rp2040的USB线，然后应该有一个叫rp的U盘出现
    4. 使用下面的命令烧录 
      cd examples/use_rust/rp2040
cargo run
      如果你看到下面这样的日志，那说明烧录成功了 
      Finished release [optimized + debuginfo] target(s) in 0.21s
Running `elf2uf2-rs -d 'target\thumbv6m-none-eabi\release\rmk-rp2040'`
Found pico uf2 disk G:\
Transfering program to pico
173.00 KB / 173.00 KB [=======================] 100.00 % 193.64 KB/s

Roadmap

RMK 现在的roadmap在这里.

最小支持的 Rust 版本（MSRV）

RMK 需要 Rust 1.77 稳定版本及以上。

许可证

RMK 根据以下任一许可证许可：

你可以自由选择.