keyballのための はじめてのQMK firmware環境構築 Mac編
公式ファームウェアが更新されています(2023/10/08 追記)
keyball公式のファームウェアが最新QMKに対応したので、0.18系のQMK firmwareを利用する必要はなくなりました。
それに伴い、この記事も一部修正しています。
Windows編はこちら
想定読者
この記事は下記のような人を対象に、とりあえず最速でqmk firmwareによるkeyballのファームウェア作成環境を整えることを目的としています。
ターミナルでコマンドの入力も必要ですが、書いてある通り入力(コピペ)するだけで大丈夫だから怖くないよ。
keyballで初めて自作キーボードに触れた
GitHub/Gitを使ったことがない
ターミナルコワイ
キーマップ変更方法はREMAPしか使ったことがない
Git/GitHubの使い方やソースコードの管理については完全に無視して、qmkによるファームウェア作成ができれば細けぇこたぁいいんだよ! というスタンスでいきます。
そのへんもっと詳しく知りたい人は、私の大親友を紹介しておきますね。Googleっていうんですけど。
全体の流れ
前提環境の確認と構築
0.18系QMK firmwareのclonekeyballリポジトリのclone
keyballをqmk_firmwareに組み込む
自分のkeymapフォルダを作る
ファームウェアをコンパイルする
前提環境の確認
はい。では早速はじめて参りましょう。
Macの場合、使うのはターミナルだけです。
まず、必要な環境が揃っているかを確認します。
次のコマンドを入力してみてください。
確認コマンド①
git —-version確認コマンド②
brew —-version前提環境の構築
Case A: ①でバージョンが表示された
クリアです。QMKの入手に進んでください。
Case B: ①は怒られて、②はバージョンが表示された
次のコマンドを実行してから、もう一度①を実行してみましょう。
brew install gitCase C: ①も②も怒られた
homebrewをインストールしましょう。
公式ページの”Install Homebrew”という見出しの下にあるコマンドをコピペして実行するだけです。
brewがインストールできたら、Case Bの場合と同じようにgitをインストールします。
QMK firmwareを入手する
qmk公式のガイドに沿って、homebrewを使ってqmkをインストールします。すればQMKを使ってファームウェアを作ることはできるのですが、最新版なのでREMAPで使えません。
なので、REMAPとkeyball公式が対応しているうちで最新となる0.18.17を導入します。
HomeBrewでQMKをインストール
ターミナルで↓のコマンドを実行します。
brew install qmk/qmk/qmkGitHubからqmk_firmwareをクローンする
git clone --recursive git@github.com:qmk/qmk_firmware.gitしばらく待つと、qmk_firmwareと同じフォルダ(デフォルトでは ユーザー/自分のユーザー名 )にqmk_018というフォルダができているはずです。
これで、0.18.17のQMK firmwareをクローンすることができました。
keyballのリポジトリをクローンする
続いて、keyballのコードを入手します。
そのまま↓このコマンドを実行します。
git clone https://github.com/Yowkees/keyball.git keyballこれで、qmk_firmwareとkeyballのフォルダが揃いました。
ここからこの2つを繋いでいきます。
keyballをqmk_firmwareに組み込む
方法1. フォルダごと移動
※この方法は簡単ですが、後々管理が面倒になりがちです。
keyball/qmk_firmware/keyboards にある keyball フォルダを、qmk_firmware/keyboards フォルダの中に移動(またはコピー)します。
それだけ。
方法2. シンボリックリンクを作る
↓のコマンドを実行します。
ln -s ~/keyball/qmk_firmware/keyboards/keyball ~/qmk_firmware/keyboards/keyballqmk_firmware/keyboardsフォルダの中にkeyballのエイリアスようなアイコンができていればOKです。
試しにコンパイルしてみる
一旦、ちゃんとコンパイルできるか試してみましょう。
ターミナルでQMKのディレクトリに移動します。
cd qmk_firmware移動したら、keyball公式のviaファームウェアをコンパイルしてみましょう。
make keyball/keyball39:viaqmk_firmwareフォルダに新しい.hexファイルが作られていればOKです。
自分のキーマップ用のファイルを用意する
ここまでで、keyballのファームウェアを作る準備はできました。
ここから自分のキーマップを設定していきましょう。
まず、Finderでここに行きます。
~/keyball/qmk_firmware/keyboards/keyball/keyball39/keymapsviaというフォルダがあるので複製します。
フォルダの名前を自分の好きなように変更します。スペースを含まない名前にしてください。
この記事ではとりあえず your_keymap とします。
いざコンパイル！
まだ何も変更していないですが、コンパイルしてみましょう。
試しにviaをコンパイルした時と同じですね。
makeコマンドの最後を your_keymap に変更して実行します。
make keyball/keyball39:your_keymapちなみにこっちのコマンドでも同じ結果を得られます。
qmk compile -kb keyball/keyball39 -km your_keymapキーマップを編集する
自分のファームウェアの設定やキーマップを、好みに応じて編集しましょう。
詳しくは別の記事にまとめました。
いざコンパイル！
キーマップを編集したら、コンパイルしてみましょう。
試しにviaをコンパイルした時と同じですね。
makeコマンドの最後を your_keymap に変更して実行します。
make keyball/keyball39:your_keymapちなみにこっちのコマンドでも同じ結果を得られます。
qmk compile -kb keyball/keyball39 -km your_keymapコンパイルしたファームウェアを書き込む
いくつかやり方がありますが、ブラウザだけで書き込みができるPro Micro Web Updaterを使うのが手軽でわかりやすいでしょう。
https://sekigon-gonnoc.github.io/promicro-web-updater/index.html
使い方は遊舎工房さんのこちら↓が詳しいです。
hexファイルはあるので、手順の2から進めます。