Qucik7のファームウェア書き込み

先日組み立てた自作キーボードキット”Quick7″のファームウェア書き込み手順について整理しておこうと思います。

Quick7には自作キーボードキットで広く使われている”QMK”というファームウェアが採用されています。ファームウェアの構造や記法がキーボード間で共通なので、1回覚えてしまえば様々な自作キーボードキットのカスタマイズを楽しめます。

基本的にはQMKの公式ドキュメントが非常に詳しいのでこれを見ていただくのが一番良いとは思いますが、情報量が非常に多いのでこのエントリではQuick7を例にWindows環境において「これだけでOK」な手順をかいつまんでまとめておきたいと思います。

ファームウェアのカスタマイズ環境構築

デフォルトのファームウェアを使う場合でもカスタマイズ環境を構築しておく必要があるので、まず環境構築を行います。

ファームウェアのカスタマイズ環境はWindowsの場合”QMK_MSYS“をインストールします。これとサクラエディタ等のプレーンテキストを編集できるテキストエディタをインストールすればカスタマイズ環境は完成です。

QMK_MSYSをインストールした後にQMKを起動し、表示されるコンソールに

[QMK]
qmk setup

と入力します。公式のドキュメントにある通り、表示されるプロンプトにyと答えていくと設定は完了です。このコマンド入力はWindowsのコマンドプロンプトで行うものではなく、QMK起動時に表示されるコンソールで行う点に注意が必要です。

続いてQuick7のデフォルトキーマップ（デフォルト設定のファームウェア）を生成します。同様にQMKのコンソールで

[QMK]
qmk compile -kb yushakobo/quick7 -km default

と入力すると生成ができます。

生成したファームウェアはQMKのインストールフォルダを変更していなければ、

[システムドライブ]:\Users\[ユーザ名]\qmk_firmware

の直下に*.hexという拡張子で保存されます。命名規則は決まっており、

[製造元]_[製品名]_[キーマップ名].hex

です。今回例に挙げているQuick7の場合は、”yushakobo_quick7_default.hex”というファイルがQuick7のデフォルトファームウェアになります。

ファームウェアの書き込みにはQMK Toolboxを使います。これを使うとGUI操作で簡単にファームウェアを書き込めます。書き込み作業の前にインストールしておきます。

書き込む際はまずキーボードをPCに接続し、キーボードをブートローダモード（ファームウェアを書き込めるモード）に移行します。ブートローダモードへの入り方はキーボードごとに違うそうですが、Quick7の場合は背面のスイッチを押すことで移行が可能です。

QMK Toolboxのウィンドウの上にファームウェアのhexファイルをドラッグ&ドロップするとファームウェアが書き込み待ちになります。その後にQMK Toolboxの”Flash”ボタンを押してしばらく待つとファームウェアが書き込まれ、キーボードがPC側にキーボードとして認識されます。

ファームウェア自体を直接操作することになるので、いわゆる”文鎮化”の可能性がチラつき緊張しますが、公式ドキュメントを読んでその通りに進めれば引っかかる部分はないと思います。

ファームウェアが書き込まれてWindowsが新しいUSBキーボードを認識した瞬間は結構新鮮な驚きがあります。緊張する作業ではありますがある意味作業全体のハイライトとも言える部分なので、あわてず楽しんで作業をして見るのが良いと思います。