Introduction

キーボードを作りたくなった。

私の仕事を抽象化すれば、キーボードを叩く毎日なのだが、ノートPCのパンタグラフ式キーボードは打鍵音が高くてうるさい。

自作キーボードには以前から興味をもっていた。ただ、回路設計が面倒くさくいから、やる気が起きなかった。
だが、転職して組み込み半導体に関する仕事をするようになったので、仕事の勉強の一環として、これを機に自作することにした。

1. 構想と勉強

1.1. キー配置

理想のキー配置を考えるが、型にはまった思考しかできないので、結局ありきたりなISO60%になった。守破離の守ってことで。

60%レイアウトは、特殊キー（矢印、page upなど）とファンクションキーが無い分、コンパクトな構成だ。ただ、矢印キーはコーディングで頻繁に使うので、スペースキーの幅を減らして、キースペースを確保した。

キー配置はkeyboard-layout-editor.com（kle）でデザインを作成した。後の基板設計でこのデータを使うので、ページ右上の[Download]からJSONファイルをダウンロードしておく。

1.2. 仕様検討と部品選定

基板設計に向けたハードウェア仕様と、ファームウェア自作に向けたソフトウェアの仕様を決める。大層な話ではないが、参考までに。

1.2.1. HW

60%レイアウトの有線キーボード。サイズはThinkPadの横幅に揃えたい。

電子部品はJLCPCBのPCBAサービスで購入できる部品の中から選定した。

  • USB: U262-161N-4BVC11
    • USB-Cのレセプタクル
    • この世の全てのケーブルをtype-Cで統一したい
  • LDO: LM3940IMPX-3.3/NOPB
    • USB電源からMCU電源を生成する低損失のLDO
    • 出力電流は1Aもいらいないと思うけど、ヒートシンク無しだから余裕をもって
  • ESD: ESD122DMXR
    • USBのデータラインのESD対策
  • Schottky Diode: SS34
    • USB電源（VBUS）への逆流防止用
  • MCU: STM32F072VBT6
    • 外付け水晶振動子（48MHz）無しでUSB機能を使える
    • ピン数が多いパッケージ（LQFP-100）なのでパターン設計が楽（←めっちゃ大事！）
    • 自作キーボード用ファームウェア QMKに対応（参考: QMK）
  • Diode: 1N1418W
    • キーマトリクス用の整流ダイオード

1.2.2. SW

ファームウェアはQMKを使って楽したい。
キー配置のjsonを作成してビルドすれば、FWが簡単に作れるらしい。最高やん！

あと、せっかくの自作キーボードだから、マクロ機能を追加したい。特定のキーを押したら、会社のシステムへのログインが一発で完了するとか、ゲームで一連の連続動作を実行するとか。
QMKは自作コードのマクロ追加も簡単にできる。（参考: QMK）

1.3. USB機器の勉強

2. ハードウェア作製

2.1. 部品入手

遊舎工房でキースイッチとキーキャップを調達する。
“LeleLab Supsup SuperX White Keycap“というスケルトンのキーキャップが気に入ったので、これに合うキースイッチを選んだ。
キースイッチとキーキャップ、スタビライザーを購入して、合計13,694円。

2.2. PCB作製

KiCADで回路図とPCBを設計して、JLCPCBで基板を作製してもらった。

KiCADを触るのは8年ぶりなので、使い方の勉強から始める。調べながらやっていくよりも体系的にまとまった資料を読んだ方が早いので、適当な入門書を借りてHands-Onした。

2.2.1. 回路設計

回路図を設計する。

キーボードの回路はシンプルなので、自作キーボード界隈の先人の回路図を読めば、必要な機能を把握できる。
私の作成した回路図もgithubにあげているので、参考になれば幸いです。

回路の主な特徴は

  • USB-Cレセプタクル
    USBの仕様で、22Ωのダンピング抵抗やCCラインのプルダウン抵抗、データ線のプルアップ抵抗が必要。（参考: STM community）
  • 電源回路
    USBのVBUS（5V）→ ショットキーバリアダイオード（SBD）→ LDO → MCU電源（3.3V）
  • ESD
    静電気対策でUSBのデータ線にはESD保護を付けている。USBでなくても、外部I/Fをもつ信号ラインにはESDは必須。
  • キーマトリクス回路
    ikejiのblogを参考にしてください

2.2.2. PCB設計

次に、PCBを設計する。

  • キースイッチのlibrary
    foostan/kbdをインポートする。
    回路設計の嫌いな作業ランキング1位「部品ライブラリの作成」を回避できます。
  • kicad-kbplacer
    kicad-kbplacerというプラグインをインストールする。
    kleで作成したキー配置のJSONファイルから、PCB上でキースイッチを自動配置してくれるツール。
    回路設計の嫌いな作業ランキング同率1位「PCBの部品配置」を回避できます。
  • デザインルール
    PCBを発注するならば、基板メーカーの設計ガイドラインに準拠する必要がある（参考: KiCad）

回路設計の嫌いな作業ランキング同率1位「パターン設計」は回避できません。数が多いから面倒くさい。


2.2.3. PCB発注

KiCADの設計データをもとに、JLCPCBへ発注する。

JLCPCBはPCBを作るだけでなくて、そのPCBに電子部品をはんだ付けしてくれるPCBAサービスをやっている。
自分でチップコンデンサやICを購入して、はんだ付けするコストを考えると、JLCPCBに任せる方が安上がりなので、今回はPCBAサービスを利用する。

PCBAサービスの利用方法は、JH4VAJさんのブログを参考にしてください。
KiCADでガーバデータとBOMを作成したら、JLCPCBの注文画面でアップロードするだけ。

参考までに、PCBの作成が$20.6、PCBアセンブリサービスが$101.34で、送料とクーポンを合わせて$126.14（=20,725円）だった。（財布が）厳しいって。

注文して2日で出荷。仕事が早すぎる。

届いたPCBにキースイッチと電解コンデンサをはんだ付けして、ハードウェアの回路部分は完成。

2.3. ケース作製

Fusion360で設計して、JLC3DPで3Dプリントしてもらった。

画像のようなキーボードの土台となる部分を印刷してもらう。金欠だから、上側のカバーは無い。

印刷方式はSLAで材料は9600 Resin、値段は$24.75。送料と割引クーポンを合わせて$35.28（=5,737円）だった。

注文時期がLunar New Yearとかぶってしまったので、2週間ほどかかったが、平常時であれば1週間で出荷するらしい。便利な世の中になったな～。

そして、完成したキーボードがこちら。



3. ソフトウェア作成

QMKを使いたい。

3.1. QMK

  • 開発環境: Ubuntu 22.04
  • Debugger Probe: ST-LINK v2
    • MCUへのFW書き込み・デバッグ用

3.2. 自作ファームウェア

  • 開発環境: Windows 11
  • IDE: STM32cubeIDE v1.18.1
    • 最新バージョンではGUIのコンフィグツールSW4STM32がIDEと別々になって、使いにくいので昔のバージョン
  • Debugger Probe: ST-LINK v2

👷‍♂️👷‍♂️👷‍♂️ 気が向いたら書きます 👷‍♂️👷‍♂️👷‍♂️

4. つまづき

いろいろ多分、思うようにはならへん。

— 岡林風穂『キャットファイト』

Ubuntu PCに挿して使おうとすると、なぜかキー入力をできない。何回も挿しなおしたら、たまに入力できるけど。
ターミナルでlsusbコマンドを使って、PCに接続されているUSB機器一覧を表示すると、確かに表示されている。キーボードの電源LEDも光ってるから、USBコネクタの接触不良ではなさそう。なぜだろう。
試しに、別のWindows PCへ接続すると、キーボードが認識されない。デバイスドライバに表示されてないじゃん。

FWの問題かもしれないと考えて、QMKから自作ファームウェアに変更した。しかし、状況は変わらず。

ようやく「ハード側に問題があるかもしれない」と気づき、USB周辺の回路図を見直す。

CCやMCUとの接続は問題がなさそうなので、クロックに問題があるかもしれない。
「crystal-lessの力を過信したな」と言われてる気がした。（百錬三郎）

ただ、PCBにテストピンを付けていないので、オシロスコープでクロック波形を観察するのが面倒だった。この検証は後回しにしよう。

回路の問題の99%は設計者による技術資料の確認不足が原因（ソース不明）なので、STM32F072のデータシートとリファレンス・マニュアルのUSBに関する内容を読み直す。

データシートの3.21 Universal serial bus (USB)を読むと、

The STM32F072x8/xB embeds a full-speed USB device peripheral compliant with the USB specification version 2.0. The internal USB PHY supports USB FS signaling, embedded DP pull-up and also battery charging detection according to Battery Charging Specification Revision 1.2. The USB interface implements a full-speed (12 Mbit/s) function interface with added support for USB 2.0 Link Power Management.

と書いてある。
データラインのプルアップ抵抗は内蔵されていて、転送速度はFSに設定されてるんかい！

キーボードはLSが一般的なので、USB_DMへプルアップ抵抗を接続していた。（下図の赤枠）
しかし、そのせいで、データラインが両方プルアップされてしまい、ホスト側で転送速度が分からなくなっていたらしい。


プルアップ抵抗R5を基板から外して、無事解決しました。
ちなみに、Ubuntuでたまに動く理由は、OSのUSBスタックが転送速度が異常でも寛容だから。

Summary

「スコスコ」とした打鍵音が良い。
IKEA効果も相まって、気に入っている。

…総額40,156円。あれ？HHKBを購入できる金額では？
これが、大量生産の妙か。