自作日本語キーボードのススメ 4th key

2020年7月29日

自作キーボードの日本語化

前回まででようやく物理的には日本語配列のキーボードができました

ただ、このままではもともと海外で生産されたPCBに無理やり日本語配列通りにキースイッチをくっつけて、キートップをつけただけです。
実際に打ってみるとわかりますが、思ったように文字が入力できません
そこで今回は、DZ60(今回使用したPCB)のファームウェアを書き換えて、真の意味でのオリジナル自作日本語キーボードを完成させましょう!!

そう「オリジナル自作日本語キーボード」を!!

【以下余談】
なぜ2回言ったのかというと、会社の先輩方にも
😤「日本語配列は情弱の極み、英語配列キーボードこそ最適化されたキーボードで仕事も捗る!!」
と煽られるですが、キーボードを自作するようなちょっと変わった方々も同じなのか、情報が少量しかないんですよね。
それでも邪教(日本語配列)を崇拝する同志の手助けになるべく記録を残したいと思います。
おや…誰か来たようだ。誰だろう、こんな夜中なのに…

理想の配列を具現化しよう

キースイッチの配置が同じでも、各キースイッチに何を割り当てるかは完全に個人の自由です!!
まず自分の理想とするキー配置を一旦整理しましょう。

そこでオススメのツールはkeyboard-layout-editor.com
ここで自分の追い求める理想のキーマップを形にしていきましょう。

使い方は簡単
上のpresetからISO60%を読み込んで、DeleteKeyとAddKeyを駆使して形にしていくだけ!

今回、私が目指すキーマップはこんな感じ
(かの名機BLACK PAWNを参考にした配列になってます)

キー配列構成図
Layer 1
キー配列構成図
Layer2

突然レイヤーという概念が出てきましたが、難しいことはなにもありません。
基本的にはLayer1はそのまま押したときの動作。
その他のレイヤーは指定したキーを押しながら入力した際の動作を示してます。
ちなみにShiftキーの機能(「Shiftキー+1キー」で「!」)はレイヤーではなく標準で決まっています。

今回はFnキーを押しながらの時の動作をLayer2にまとめてます。
ファンクションキーとプリントスクリーンキー、LEDの調光機能を実現しています。
RGB関係のキーはリファレンスを参照

Layerはいくつでも設定できますのでここはお好みでどうぞ。

意外と書き出してみると、あーでもないこーでもないと思案しますが、それがいい…
キーボードを作る時はね、誰にも邪魔されず 自由でなんというか救われてなきゃあダメなんだ 独りで静かで豊かで・・・

ファームウェアの書き換え

ではゴールが決まったので、早速設定を作り込んでいきましょう!!

環境構築

実際にキーボードへの書き込みにはqmk_firmwareというツールを使います。

私はMac OS Catalina で実施しました。
Windowsの方はWSLを利用すると同様の手順で実施できるかと思います。

それなりに時間がかかるので、終わるまでのんびり待ちましょう。
これで環境構築は終わりです。

キーマップの定義ファイル

実行が終わると、様々なPCB用の定義ファイルなどがダウロードされています。
その中にあるDZ60用のプロファイルに、先程決めたキーマップを定義していきます。

今回はDZ60を使っているので
keyboards/dz60/dz60.hの最終行の
#endif
の手前に下記コードを追加してくだい。
これによって今回のキースイッチの配列をPCBに宣言することができます。

(KC_NOはキースイッチが接続されていないことを意味します)

キーの役割を決める

前項でPCBに「どこに何という名前のキースイッチが接続されているか」を教えてあげたので
次はPCBに「各名前のキースイッチの役割」を教えてあげます。
その定義ファイルはqmk_firmware/keyboards/dz60/keymaps 配下にあります。
過去の偉人達のテンプレートを見ることができます。
結構勉強になりますし、思わぬキーボードの使い方も発見できるので、一度見てみると楽しいです。

しかし、今回はこれらのテンプレートを使うことなく、新たに作っていきます。
まずは過去の偉人たちに仲間入りすべくディレクトリを作成。

その中に下記の2ファイルを追加していきます。

各コードの意味や役割はドキュメントを参照してください。
また関数名やレイヤー名は自由に変更しても大丈夫です。
これで、準備は完了です!

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

さぁいよいよ書き込みです。
キーボードをパソコンと接続して、下記コマンドを実行してください。

すると、実際にPCBに認識されているキースイッチの数と設定ファイルに書き込まれているキーの数に相違がなければ、5回[OK]という表記が出た後
ERROR: Bootloader not found. Trying again in 5s.
というエラーが出ます。
このエラーが出たら、キーボードをひっくり返して…

リセットボタン
リセットボタン

このリセットボタンをポチッと押しましょう。
すると、キーボード内のメモリに残っていた設定が消され、今回の設定が記録されます!!

完成!!

最後に入力テストを行って、問題がなければ…
これで名実ともに邪教(日本語配列)の自作キーボードの完成です!
お疲れ様でした!!

また、今更になりますが今回のコードはあくまでも一例です。
この通りにしなければいけないわけではなく、自由に書き換えて自分だけのキーマップを実現してください!

基本的にはこれが日本語キーボードの全てですが、実は細かい微調整もあるのでそのヒントは次回解説したいと思います。