/rktk-keyball-rs

Keyball firmware made with rust and embassy

Primary LanguageRust

rktk-keyball-rs

拙作のrktkというフレームワークを用いたRust製のKeyballファームウェアです。現在Keyball61のみをサポートしています。

動作のためにはRP2040を搭載したProMicroが必要です。AliExpressなどで互換品がお安く買えます。通常のAVR ProMicroでは動かないので注意してください。

また、BLEに対応しておりnRF52840を搭載ボードでも動作しますが、BLE Micro Proでの動作は現状確認していません。 ピンの設定を適切に変更すれば動作するはずですが、本ファームウェアでは過去フラッシュの書き込みにバグがあり書き換えてはいけない領域を書き換えてブートローダが起動しなくなることがあったため自己責任でお願いします。

機能

詳しくはrktkのページを参照してください。キーマップについてはQMKの機能のメジャーな所は大体実装してありますが、ディスプレイ、バックライトなどは現状カスタマイズすることができません。

既知の不具合

  • 左右間の通信が安定しない
  • フラッシュの書き込み・読み込みがうまくいかないことがある

ビルド

依存

ビルドには以下のツールが必要です。予めインストールしておいてください。

  • Nightly Rust: Rustupからインストール可能
  • flip-link: cargo install flip-link
  • rktk-cli: cargo +nightly install --git https://github.com/nazo6/rktk rktk-cli
  • arm-none-eabi-objcopy (uf2生成に必要)
  • Python (uf2生成に必要)

手順

  1. このリポジトリをクローンします。

    git clone https://github.com/nazo6/keyball-rs

  2. rktkをクローンします。現在rktkは絶賛開発中のためkeyball-rs内でpath dependencyとして指定されており、keyball-rsの隣に置く必要があります。

    git clone https://github.com/nazo6/rktk

  3. ビルドするディレクトリに移動してビルドします。cargo build -pは機能しないので注意してください。

    cd keyball-rs/keyball61/keyball61-rp2040
rktk-cli build

  4. ビルドが完了するとtarget/thumbv6m-none-eabi/min-sizeにuf2ファイルが生成されているはずです。ProMicroをブートローダーモードで起動(BOOTを押しながらリセット)し、表れたドライブにuf2ファイルをコピーすれば書き込み完了です。

カスタマイズ

キーマップ

キーマップはkeymap.rsで定義されています。これを編集することでキーマップを変更することができます。

Remapper

rktkは上のようにソースコードでキーを変更する以外にも、以下のWebアプリを使うことでキーマップや設定を変更することができます。

https://rrpc.nazo6.dev/

昔のコード

Zennの記事で紹介した際のkeyball-rsのコードはlegacyブランチにあります。 このコードをライブラリ化したものがrktkです。