QMK Toolboxの使い方｜自作キーボードのファームウェア書き込み

自作キーボードは、部品を組み立てるだけでなく、動作に必要なプログラム「ファームウェア」の書き込みが必要な場合があります。

QMK Toolboxは、ファームウェアファイルをキーボードへ書き込むためのPC用アプリです。初めてファームウェアを書き込むときや、ブラウザからの書き込みがうまくいかないときなどに使用します。

この記事では、Mint60を例に、QMK Toolboxの基本的な使い方を説明します。使用するファイルやリセット操作は機種によって異なるため、お使いのキーボードの案内と併せて確認してください。

QMK Toolboxはどんなときに使う？

すでに使えているキーボードのキー割り当てを変えるだけなら、通常はファームウェアを書き直す必要はありません。 Remap対応キーボードの設定変更は、「Remapの使い方」をご覧ください。

なお、QMK Toolboxはすべての自作キーボードに対応するわけではありません。最初に、製作者・販売店の組み立てガイドなどで、QMK Toolboxを使用する機種か確認してください。

1. 作業に必要なものを用意する

• QMK Toolboxでの書き込みに対応したキーボード

• WindowsまたはMacのPC

• データ通信対応のUSBケーブル

• QMK Toolbox

• 使用するキーボード・マイコンに合ったファームウェアファイル

使用するファームウェアを確認する

ファームウェアは、キーボードの機種や基板のバージョン、使用するマイコンに合ったものが必要です。

同じ機種名でも構成によってファイルが異なる場合があります。製作者・販売店が案内している配布元から、対象を確認してダウンロードしてください。

また、ファームウェアを書き直すと、保存していたキー設定などに影響する場合があります。すでに使用中のキーボードを更新するときは、更新時の注意事項も確認してください。

2. QMK Toolboxをインストールする

次の公式配布ページを開きます。

QMK Toolboxのダウンロードページ

使用するOSに合ったファイルをダウンロードし、インストールしてください。インストーラーを使う場合は、Windowsでは「.exe」、Macでは「.pkg」のファイルを選びます。

Windowsで初回起動時に必要なドライバーのインストールを求められた場合は、案内に従ってインストールしてください。

※画像と現在の配布ページでは、バージョンやファイル名、画面の配置が異なる場合があります。

3. ファームウェアをダウンロードする

製作者・販売店が案内する配布ページから、使用するキーボード用のファームウェアをダウンロードします。

ファイルの保存先を確認し、あとからQMK Toolboxで選択できるようにしておきます。

例：Mint60の場合

この記事で使用する、ATmega32U4搭載のPro Microを使ったMint60では、次のページからファームウェアをダウンロードします。

Mint60のファームウェア配布ページ

ファームウェア一覧から「VIA,Remap対応ファーム」の「DOWNLOAD」を選び、保存してください。

この例で使用するのは、拡張子が「.hex」のファイルです。

別のキーボードを使用する場合は、Mint60用のファイルではなく、その機種に指定されたファイルを用意してください。 ファイル形式も、機種によって異なります。

4. QMK Toolboxでファイルを選ぶ

キーボードをUSBケーブルでPCへ接続し、QMK Toolboxを起動します。

Remapのファームウェア書き込み画面や、同じ機器へ接続するほかのツールは閉じておいてください。

「Local file」の「Open」から、ダウンロードしたファームウェアファイルを選択します。

選択したファイル名が画面に表示されていることを確認してください。

※使用するバージョンにマイコンの選択欄があり、機種の案内で指定されている場合は、その指定に合わせてください。

5. 書き込みを開始する

Auto-Flashを有効にする

「Auto-Flash」にチェックを入れます。

Auto-Flashは、キーボードが書き込みを受け付ける状態になったときに、自動で書き込みを始める設定です。

キーボードを書き込み待機状態にする

キーボードの案内に従って、ファームウェアを書き込むための待機状態にします。この状態を「ブートローダーモード」と呼びます。

通常のキー入力を行う状態とは異なり、PCから新しいファームウェアを受け取れる状態です。

待機状態にする方法は機種によって異なります。リセットボタンを押すものや、指定されたキーを押しながらUSB接続するものなどがあります。

例：Mint60の場合

Mint60では、PCへUSB接続した側の基板にあるリセットボタンを押します。組み立て時に裏面へ取り付けた、小さなタクトスイッチです。

指が届かない場合は、周囲の部品や端子を傷つけないよう、先の細い樹脂製の棒などで押してください。

QMK Toolboxが書き込み待機状態のPro Microを検出すると、自動で書き込みが始まります。

Pro Microによっては、リセットボタンを素早く2回押す操作が必要です。また、書き込み待機状態は短時間で終了するため、ファイルの選択とAuto-Flashの設定を済ませてから操作してください。

書き込み中は、USBケーブルを抜いたり、リセット操作をしたりせず、完了するまで待ってください。

6. 書き込み結果を確認する

QMK Toolboxのログで、書き込みと検証がエラーなく完了したことを確認します。

Mint60の例では、Windowsで処理の最後に次のような表示が出る場合があります。

avrdude.exe done. Thank you.

ただし、この行だけで判断せず、その前にエラーが出ていないことも確認してください。使用するマイコンやOS、QMK Toolboxのバージョンによって表示内容は異なります。

分割キーボードの場合は、続いて反対側への書き込みが必要か確認します。次の「7. 分割キーボードは、反対側への書き込みも確認する」へ進んでください。

反対側への書き込みが不要な場合は、Auto-Flashのチェックを外し、QMK Toolboxを終了します。

7. 分割キーボードは、反対側への書き込みも確認する

左右に分かれたキーボードでは、両側へ個別にファームウェアを書き込む場合があります。

機種によって、左右で同じファイルを使うものと、別々のファイルを使うものがあります。必ず、その機種の案内を確認してください。

例：Mint60の場合

この記事のMint60では、左側と右側それぞれに、同じファームウェアを書き込みます。

片側への書き込みが完了したらUSBケーブルを抜き、反対側をPCへUSB接続して、同じ手順を繰り返してください。

左右をつなぐケーブルだけでは、両方へまとめて書き込めません。それぞれをPCへUSB接続して作業します。

左右の接続ケーブルを抜き差しするときは、先にPCとのUSB接続を外してください。

8. キー入力を確認する

書き込みが完了したら、キーボードの案内に従って通常の使用状態へ戻します。

分割キーボードでは、PCからUSBケーブルを抜いた状態で左右をつなぎ、そのあとPCへ接続してください。

テキストエディターなどを開き、文字キーが反応するか確認します。分割キーボードの場合は、左右両方の入力を確認してください。

一部のキーだけ反応しない場合は、書き込み以外に、スイッチの取り付けやはんだ付け、左右の接続に原因がある場合もあります。

Remap対応ファームウェアを書き込んだ場合は、続いて「Remapの使い方」を参考に、キー割り当てを設定できます。

うまく書き込めないとき

リセット操作をしても書き込みが始まらない

次の点を確認してください。

• USBケーブルがデータ通信に対応している

• 使用する機種・マイコンに合ったファイルを選んでいる

• Auto-Flashにチェックが入っている

• 機種に指定された方法で、書き込み待機状態にしている

• Windowsの場合、必要なドライバーがインストールされている

分割キーボードでは、PCへUSB接続している側を操作しているかも確認してください。

「Access is denied」などのエラーが出る

接続先を、ほかのアプリが使用している可能性があります。

Remapの書き込み画面や、Arduino IDEのシリアルモニターなど、同じ機器へ接続するツールを閉じてから、もう一度試してください。

改善しない場合は、USBケーブルや接続ポートを変えて試します。USBハブを使用している場合は、PCへ直接接続してください。

PCを再起動すると、アプリや接続ポートが使用中のままになっている状態が解消する場合もあります。

何度試しても失敗する

QMK Toolboxのログに表示されたエラーメッセージを確認してください。

製作者・販売店へ問い合わせる際は、次の情報があると状況を確認しやすくなります。

• キーボードの機種名

• 使用しているマイコン

• Windows・MacなどのOSとバージョン

• 選択したファームウェアのファイル名

• エラーが表示されたQMK Toolboxの画面