QMKであそぼ。②（コンパイル編）

はじめに

一日で一番手に触れているものはキーボードという思い込みから、不便さを克服することにより得られる快楽を毎日満喫するために小さなキーボードの導入を思い立ち、2022年12月にClaw44の購入を決意。プログラミングと自作キーボードの知識ゼロから始めた自作キーボード素人によるカスタマイズの奮闘記を綴っていきたいと思います。

コンパイルの実行

いざ、QMKのビルド環境を構築してもコンパイルを実行してキーボードに書き込み可能なファイルを作成しないと宝の持ち腐れになってしまう。コンパイルというと高度なプログラミング用語に聞こえるかもしれない。何を隠そう猫山王もそんなひとりであった。Vial信者を増やすべくコンパイルの方法をメモ書き程度の記録として残しておく。また、コンパイルの方法については、みんな大好きPlanck v7を例にVialと一般的なQMKの場合分けて記載しておくので、修行僧のお好みで修行されたし。

１．Vialの場合
Vial環境の構築が完了したら、デスクトップのQMK  MSYSのショートカットをクリックして暗黒画面で

cd vial-qmk　エンター
make planck/rev7:vial　エンター

で、お待ちかねPlanck v7のファームウェアをコンパイルがスタートする。暗黒画面で緑の[OK]、[OK]とコンパイルがどんどん進んで途中エラーなくコンパイルが完了するとCドライブ内のvial-qmkフォルダ直下に"planck_rev7_vial.bin"ファイルが作成される。これがファームウェアである。
如何でしたでしょうか。今までハードルが高いと思っていたコンパイルは簡単でしたね。Vialの公式サイトにもコンパイルの方法の記載があるのでこの機会に参照されたし。

ちなみに上記コマンドのAI翻訳は下記の通りとなる。

cd vial-qmk
\vial-qmkフォルダに移動

make planck/rev7:vial
\keyboards\planck\rev7フォルダ内のファイル一式をコンパイル
またキーマップは\keyboards\planck\rev7\keymaps\vialフォルダ内のkeymap.cファイルをコンパイル
make以降の呪文をkeyboardsフォルダ内のお好みのキーボードフォルダ名に変えることで他のキーボードのファームウェアもコンパイルできる。vialの場合はkeymap.cはvialフォルダ内に格納する法律となっている。ちなみにkeyboardsフォルダはCドライブ内のvial-qmkフォルダ直下にある。

２．QMKの場合（VIA/Remapなど）
QMKのビルド環境の構築が完了したら、まずは最新版もしくはお気に入りのバージョンのQMKのフォルダをコピーしよう。ここで最新版のバージョンが分かるかもしれない。
例えば、version 0.27.3をコピーするには、デスクトップのQMK  MSYSのショートカットをクリックして暗黒画面で

git clone https://github.com/qmk/qmk_firmware.git --depth 1 --recurse-submodules --shallow-submodules -b 0.27.3 qmk_027.3　エンター

で、Cドライブ内にqmk_027.3フォルダが作成され、その中にversion 0.27.3のファイル一式がコピーされる。

Planck v7のファームウェアをコンパイルするには、デスクトップのQMK  MSYSのショートカットをクリックして暗黒画面で

cd qmk_027.3　エンター
cd keyboards　エンター
qmk compile -kb planck/rev7 -km default　エンター

で、お待ちかねファームウェアのコンパイルがスタートする。暗黒画面で緑の[OK]、[OK]とコンパイルがどんどん進んで途中エラーなくコンパイルが完了するとCドライブ内のqmk_027.3フォルダ直下に"planck_rev7_default.bin"ファイルが作成される。これがファームウェアである。
如何でしたでしょうか。今までハードルが高いと思っていたコンパイルは簡単でしたね。

ちなみに上記コマンドのAI翻訳は下記の通りとなる。

cd qmk_027.3
\qmk_027.3フォルダに移動

cd keyboards
\keyboardsフォルダに移動

qmk compile -kb planck/rev7 -km default
\keyboards\planck\rev7フォルダ内のファイル一式をコンパイル
またキーマップは\keyboards\planck\rev7\keymaps\defaultフォルダ内のkeymap.cファイルをコンパイル
-kb以降の呪文をkeyboardsフォルダの中お好みのキーボードフォルダ名に変えることで他のキーボードのファームウェアもコンパイルできる。-km以降の呪文はキーマップが保存されているフォルダを指定するので、キーボードによってはviaの場合やそれ以外の場合もあるので事前にお好みのキーボードのフォルダ構成の確認が必要である。ちなみにkeyboardsフォルダは上記の例であればCドライブ内のqmk_027.3フォルダ直下にある。

おわりに

今回はコンパイルの方法をお届けした。コンパイルの呪文は意外なほど簡単で、ソースコードのコンパイルは敷居が高いと思われている方にとって、不便さを克服することにより得られる快楽の世界への入門のための勇気づけとなれば幸いです。