キーボード関係ブログ

自作キーボードの話題を中心に

QMK firmware ファームウェアの初歩の初歩 7

さて"Getting Started"がここまでで終了しており、次は自分のプロファイルを編集する手順になっているが、ここではそれを省略して"Flashing firmware"すなわちファームウェアの書き込みの手順を先に述べる。

既に我々はXD60のdefaultのキーマップを記録したファームウェアコンパイルしており、それを用いることができる。ここでは、前回コンパイルしたファイルの実体を確認していなかったので、そこから始めることにする。

 

まずはwindowsエクスプローラーから、msys2をインストールしたフォルダにアクセスする

f:id:hukimijirantan:20180515233252p:plain

これはあくまで私の例である。

画像中では上から3つ目のhomeフォルダをクリックすると、ユーザー名のフォルダを1つ挟んでqmk_firmwareフォルダが確認できる

f:id:hukimijirantan:20180515233623p:plain

コンパイルしたファイルの実体はこの中にある。.hexという拡張子が付与されたファイルがそれである。

f:id:hukimijirantan:20180515233945p:plain

私の場合は既に何個かのコンパイル済みファイルがあるが、ファイル名はxd60_default.hexとなっており間違うことは無い。このファイルはQMK Toolboxで使用するので、場所はメモするなりショートカットを作るなりしておくと便利だろう。

 

ここまでできたら公式ページ左側のメニューバーから"Flashing firmware"をクリックし、次の手順を確認する。前回までで"Getting Started"の内容は終了している。

f:id:hukimijirantan:20180515232421p:plain

このページの目次部分が省略されているので、そこはきちんと確認しておくことをお勧めする。

 

Flashing Your Keyboard with QMK Toolbox  ←必要な手順はここだけ
  Load The File Into QMK Toolbox
  Put Your Keyboard Into DFU (Bootloader) Mode
  Flash Your Keyboard
Flash your Keyboard from the Command Line
  DFU
  Caterina
HalfKay
Test It Out!

 

目次を見ればこのページも半分くらい読めば十分だと分かる。また英語ばかりだと辟易してしまう前に、ページの最初のあたりだけでも読んでおけば労力も最小限で済む場合がある。ここで諦めてはならない。

それでも嫌な人のために解説すると、書き込みの方法が大きく分けて2つあることが目次から示されている。

以上の2種類である。当然我々は前者を選択する。

 

そういうわけで"Flashing Your Keyboard with QMK Toolbox"の項目から確認する。

f:id:hukimijirantan:20180516004746p:plain

"Simplest way"と自信満々に述べているので、それを信頼することにしよう。実際のところ、ここは導入部なので読み飛ばしても問題は無い。

他にはwindows環境の人だけがこのツールを使える旨を述べている。

 

そのまま下に読み進めれば、QMK Toolboxの使い方の説明が始まる。

f:id:hukimijirantan:20180516005444p:plain

まずはコンパイルしたファームウェアのファイルを確かめろと書いてあるが、それは冒頭で既に実施した。次に書いてあるのはそのファイルの探し方である。我々には関係ない。

さらに下に読み進めていく。

f:id:hukimijirantan:20180516022545p:plain

 コンパイルにより生成されたファイル名のフォーマット(命名規則)についての説明があるが、この記述法は今後プログラミング関連の情報を参照する場合に役立つので慣れておいて損は無い。

 

<キーボードの名前(型番)>_<キーマップの名前(キーマップを記載したファイルの名前)>.{binまたはhexの拡張子}

 コンパイル済みのファイル名を確認すると、確かにそうなっていることが確認できる。

 

さてその次の赤線で囲った文章が、ここで最も重要な操作について述べている。すなわちコンパイルして生成されたファイルをドラッグしてQMK Toolboxに突っ込めと書いてある。そして実際にそうするとこうなる。

f:id:hukimijirantan:20180516214836p:plain

 

まるで重要なことを記載していない気がするが、長くなったので一旦ここで切りたい。

 

 

QMK firmware ファームウェアの初歩の初歩 6

QMK firmware本体もインストールでき、いよいよプロファイルの変更となる前に、defaultのキーマップ設定ファイルが正しくコンパイルできることを確かめておく必要がある。これを怠って、プロファイルを色々弄った後にコンパイルできないことが判明してしまうと、原因究明のために無駄な時間を要してしまう場合がある。

 

defaultとは言っても、QMK firmwareは様々なキーボードに対応しており、それぞれの配列に対して別々のdefault配列用のファイルがある。ここでは、最も入手しやすく配列もスタンダードなものに近いXD60(XD64)を例として説明する。

 

 

まずは公式の解説ページを確認しよう。

 

f:id:hukimijirantan:20180514000552p:plain

 

コマンドライン上からmakeコマンドコンパイルを実行し、成功すると定型文が表示されるから、それを確認しろということである。*1

 

まずmsys2を立ち上げて、QMK firmwareをインストールしたフォルダに移動する。

前回までの手順から一度シャットダウンしている場合は、フォルダに移動するところから始める必要がある。すなわち一番最初に前回のインストール手順で入力したcd qmk_firmwareをもう一度実行する。

f:id:hukimijirantan:20180514013418p:plain

f:id:hukimijirantan:20180514013557p:plain

これで準備ができたので、次のように入力して実行する

 

make xd60:default

 

大文字と小文字は区別されるので、正確に入力すること。もし"XD60"と大文字にしてしまうとこのようになる。

f:id:hukimijirantan:20180514020739p:plain

簡単に言うと「そんなファイルは存在しない」というメッセージが出ている。

 

一度ミスしたあとでも、正しく入力し直すだけでコンパイルを再実行できる。あとはずらずらと文字が出力されるので、それを眺めていればよい。

f:id:hukimijirantan:20180514021104p:plain

f:id:hukimijirantan:20180514021149p:plain

[OK]がずらっと並び、最後までエラーが出なければコンパイルは完了である。初回コンパイル時は画像のものよりももっと様々な文言が表示されるだろう。

 

さて、ここまで終わると今度はデータを基盤に書き込むわけだが、そのためにはコンパイルしたファイルがどこにあるかを確認しておく必要がある。

それについてはまた次回。

 

 

 

 

*1:windows界隈ではではネットワークのテストにpingコマンドを用いることこそよくあるが、結果の意味を理解できている人がどれだけいるのかは不明である