Helix RemixはMakotoKurauchi氏によって開発された、自作キーボードキット「Helix」に最適化された、ＴＮＫソフトウェアが独自に開発したQMKベースのカスタムファームウェアです。


QMKはPro Microとよばれる、Arduino Leonardoと互換性のあるマイコンで動作する、USB HIDキーボードを制御することに特化したファームウェアです。国内外の多くの自作キーボードキットでは、マイコンの制御にこのプログラムが採用されています。

Helixは日本における自作キーボードの先駆けであるとともに、最も人気のあるキットのひとつです。そのため、日本語の技術情報や、制作に必要な電子部品が手に入りやすく、開発難易度が低いのも特徴です。

Helix Remixはソースコードをすべて公開しているため、学習用としてもお使いいただけます。ソースコードの転載や、自作キーボードに直接組み込んでの販売も自由に認めています。強制ではありませんが、コードを採用されたのであれば「開発にはHelix Remixが参考になりました」などの紹介文を入れていただければ幸いです。


技術情報
プロジェクトはGithubに公開しています。Git clone、もしくはzipファイルとしてファイル一式をダウンロードしてください。

"build"フォルダーにはコンパイル済みのバイナリファイルが収録されています。このファイルをQML Toolboxを介してPro Microに直接書き込めば、基本的な動作を確認することができます。

ファームウェアのコンパイルには統合ツールであるQMK MSYSを利用しています。QMK MSYSを起動したら、始めに「qmk setup」コマンドにて開発ツールをセットアップし、完了した後に以下のコマンドでコンパイルを実行してください。

qmk compile -kb helix_remix -km default

Helix Remixは以下の機能を提供しています。

• Helixのオリジナルファームウェアに依存しない、最新のQMK APIに対応。
• LEDレイヤーAPIによるキーごとのライトアップ変更。
• OLEDへのビットマップ表示。
• 分割キーボード間のデータ同期。
• 右側のキーボードを片手キーボードとして使う例(Clip Studioモード)。

"tools"フォルダーにはファームウェア開発を支援するためのスクリプトコードが収録されています。これらのスクリプトを実行するにはPython3が必要です。

• hex2hsv.py : CSVファイルに記述した、名称とHTMLカラーのリストを、QMKのカラー記法に従ったC言語のdefine文に変換します。
• img2hex.py : ビットマップ画像ファイルをOLED向けのバイナリ―テキストに変換します。

自作キーボードに関する、より詳しい解説はこちらの記事でまとめています。