RubyKaigiで手に入れた HHKB Studioのための HIDRawドライバ

[Fukuoka.rb #397 〜RubyKaigi 2025の機運〜](https://fukuokarb.connpass.com/event/345164/) のLTで発表した内容です。

- HHKB Studio
- https://happyhackingkb.com/jp/products/studio/

- Fusuma
- https://github.com/iberianpig/fusuma
- fusuma-plugin-thumbsense
- https://github.com/iberianpig/fusuma-plugin-thumbsense

Transcript

1. RubyKaigiで手に入れた HHKB Studioのための HIDRawドライバ 2025/03/20 Fukuoka.rb #397 RubyKaigi 2025の機運 Kohei Yamada @iberianpig
2. About Me Kohei Yamada GitHub @iberianpig Twitter @nukumaro22 自己紹介 最近の趣味はkamal2です。
3. ちょっと前までは外部キーボードやマウスは使わない硬派なタッチパッド勢でした Fusuma • タッチパッドのマルチタッチジェスチャ用 Linux向けツール • Yamlで設定して実行するとジェスチャが使える • キーボードと連携できたりするプラグインの仕組みがある
4. fusuma-plugin-thumbsense タッチ中にキーリマップできるプラグイン • タッチパッドのタッチ状態を取得 • キーボードのキーをリマップ • タッチ中のみFキーでクリックに変換 Thumbsenseのついでにタップしてクリックする機能をオフにすると、誤タップ減ってめちゃくちゃ快適になります
5. fusuma-plugin-thumbsense 動作のイメージはこんなかんじ クリックとポインタ操作は同じ指で行うよりも違う指を使えたほうがやりやすいんですよね • (タッチ中に)Fでクリック • 楽々ドラッグ・アンド・ドロップ
6. この辺、RubyKaigi 2023で話しました
7. ところで今日の話は
8. キーボード
11. RubyKaigi 2024にて ガラガラポンまさかの当選 Techouseさん、本当にありがとうございます🙇 大変便利に使わせていただいております。
12. HHKB Studioを手に馴染ませる
13. HHKB Studioを手に馴染ませたい • HHKB Studioの親指クリックがしっくりこなかった • タッチパッド + ThumbSenseに慣れすぎていた • 手癖で F でクリックしようとして誤爆 スペースキーの下にある正規クリックボタンはやたらといい位置にあるので ALTキー と SHIFT キーになりました
14. ポインティングスティックのタッチイベントがほしい • 汎用デバイスドライバからだと取得できない ◦ マウス扱いなので/dev/input/eventX からevdevのレベルの情報はとれる ◦ ただしポインタが移動しているときのみ • 軽く指で触れたくらいだとイベントは取れない ▪ さらに低いレイヤーを見てみることに • /dev/hidrawX から取れないか見てみることに FusumaはLibinputに依存、リマップ処理はEvdevに依存、今回はHIDRawに…
15. ターミナルでデバイスのイベントを観察 ポインティングスティック上に軽く指を置いてテスト ポインタ移動時は取れてるみたい。残りはフィルタされていそう 軽く指置いたときも、空でイベントが飛んでる。使えそう HIDRaw evdev
16. HIDRaw • 生のHIDイベントをユーザー空間で扱える ◦ デバイスから産地直送イベント • 汎用のデバイスドライバでカバーされないもの ◦ 高機能なジョイスティックやマイナーなデバイスなど • アプリケーション側でHIDを喋る必要がある Steamで高機能コントローラ使ったり、汎用ドライバ未対応の加速度センサー扱ったり
17. イベントの流れ • 汎用デバイスドライバ経由 ◦ カーネル側でデコード ◦ evdev I/F ▪ /dev/input/eventX ◦ Libinput ▪ Wayland Compositor ▪ Fusuma ◦ Application ▪ Terminal, Browser… • HIDRaw経由 ◦ HIDRaw I/F ▪ /dev/hidrawX ◦ Application側に実装 ▪ HID Reportのデコード ▪ Evdev相当のイベント
18. HIDRawを読む 一般ユーザーは /dev/hidrawX や /dev/input/eventX へのアクセス権がないので、udev rule が必要です デバイスパスの取得(/dev/input/eventX -> /dev/hidrawX) レポートディスクリプタを取得(HIDIOCGRDESC) report_id, 構造体定義に沿ってHIDレポートをデコード 2 3 1
19. HIDRawを読む レポートディスクリプタを元にデコード Report Descriptor ↑Report Descriptorをデバイスから取得 HID Report • Report Descriptorでバイト列の区切りが決まる ◦ HID Usage Tables に仕様が記載 https://usb.org/sites/default/files/hut1_6.pdf • この場合は8ボタン同時押しを検知できることがわかる hidapiバインディングをいくつか試したけど動かなかったのでPure Rubyで書きました BluetoothはUSB接続時と違ってデバイスが統合されるのでレポート構造が違ってハマりました
20. HIDRawを読む レポートディスクリプタを元にデコード このへんHIDRawを使って頑張るよりもeBPFでフィルタとかリマップ処理をカーネル側に移譲できるととても良さそうな気がしています HID Report RubyでHIDレポートをデコードできた！ マウスのレポートをタッチ状態として検知できたので、 あとはFusumaから仮想キーボードのレイヤーを変更するRPC を呼ぶだけ(Fをクリックに変換させるレイヤーに切り替える) 1 2 3
21. fusuma-plugin-thumbsenseに機能追加 ポインティングスティックでもFでクリック
22. まとめ • RubyKaigiで貰ったキーボードのおかげでより便利な環境になった • RubyでCライブラリ使わずに書けるところ、意外とある。楽しい • 道具がより手に馴染むようになって最高