OS に依存しない Bluetooth キーボードのキー入れ替え (M5stack版)

WSL2 の場合、M5stack を認識させるためドライバーをインストールしてください。

USB ドライバー: <https://ftdichip.com/drivers/vcp-drivers/>

また、現時点では WSL2 から M5stack の COM に手軽にアクセスできないので (アクセスするにはカーネルのビルド等が必要)、 迂回して COM にアクセスするために hub4com を利用します。

以下から hub4com をダウンロードし、

<https://sourceforge.net/projects/com0com/files/hub4com/>

展開した com2tcp-rfc2217.bat を windows 上で実行します。

com2tcp-rfc2217.bat COM8 5555

ここで COM8 は、 Windows が認識している M5stack の COM ポートを指定します。

カーネルがよほど古くないかぎり、 USB を接続するだけで /dev/ttyUSB? (? は数字) が認識されるはずです。

$ docker exec -it bt-kbd-remapper make -C /proj/bt-kbd-remapper burn COM=/proj/dev/ttyUSB0

ここで ttyUSB0 は、環境に合せて指定してください。

$ docker exec -it bt-kbd-remapper make -C /proj/bt-kbd-remapper burn HOSTPC=???.???.???.???

ここで ???.???.???.??? には、 Windows の IP を指定してください。

$ docker exec -it bt-kbd-remapper make -C /proj/bt-kbd-remapper monitor COM=/proj/dev/ttyUSB0

$ docker exec -it bt-kbd-remapper make -C /proj/bt-kbd-remapper monitor HOSTPC=???.???.???.???

コンソールは、 Ctrl を押下しながら ] で切断されます。

bt-kbd-remapper では、 BT classic の HID keyboard と、 BLE の HID keyboard の HID モードを切り替え可能です。

接続先の PC によって、キーボード接続や不安定や接続できない場合は、 HID モードを切り替えてください。

切り替えは以下のコマンドで行ないます。

esp32> config -h hidDevMode

ここで hidDevMode は以下を指定します。

• classic の場合

esp32> config -h bt

• BLE の場合

esp32> config -h le

HID モード切り替えの反映はリブートが必要です。

以下を実行します。

esp32> bt --initdev
esp32> bt -D

この状態で PC 側でペアリングします。

ペアリング終了後は、以下を実行して discoverable 状態を停止させます。

esp32> bt -F

このコマンドは、 HID キーコードを単純に置き換えます。

old のコードを new のコードに置き換えます。

例えば キーボードの A を B にする場合は、以下を実行します。

esp32> remap -k 4,5

この HID コードの詳細は、次の USB の規格書を参照してください。

• 各キーのコード情報は、以下の資料の 「10 Keyboard/Keypad Page (0x07)」 を参照

  • https://usb.org/document-library/hid-usage-tables-122

• Ctl, Alt 等の modifier キー情報は、以下の資料の「8.3 Report Format for Array Items」を参照

  • https://www.usb.org/document-library/device-class-definition-hid-111

あるいは、ペアリングした状態でキーボードのキーを押下すると以下のようなログが出力されるので、 それも確認できます。

I (8568910) console: console_hid_packet_handler_meta_bt: 12
[02:22:48.912] LOG -- btstack_util.c.258: 0xA1, 0x01, 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x00, 
[02:22:48.924] LOG -- btstack_util.c.258: 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x00, 0x00, 
I (8568925) console: console_hid_packet_handler_meta_bt: 4
[02:22:48.936] LOG -- btstack_util.c.258: 0xA1, 0x01, 0x00, 0x00, 0x28, 0x00, 0x00, 0x00, 0x00, 0x00, 
I (8568978) console: console_hid_packet_handler_meta_bt: 12
[02:22:48.979] LOG -- btstack_util.c.258: 0xA1, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
[02:22:48.991] LOG -- btstack_util.c.258: 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
I (8568992) console: console_hid_packet_handler_meta_bt: 4
[02:22:49.003] LOG -- btstack_util.c.258: 0xA1, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

これは、 enter キーを押して離したときのログです。

前半の 5 行が押下時で、後半の 5 行が離した時です。

5行の構成は、上から順に以下になっています。

• keyboard から report を受信したことを示すログ
• 受信した report の内容のダンプログ
• キー変換後のダンプログ
• PC 側への report 送信開始を示すログ
• 送信する report のダンプログ

ここで、「受信した report の内容のダンプ」の 0x28 が enter キーの HID コードです。

なお、normal モード時は report ダンプしません

このコマンドは modifier (shift や ctrl など) とのキーの組み合わせ時の、 動作を入れ替えます。

各パラメータの意味は以下の通りです。

• code

  • 押下されるキーボードの HID コードを指定します

• mask

  • modifier のマスク値を指定します。

• result

  • modifier のマスク結果を指定します。

• newcode

  • 条件成立時の HID コードを指定します。

• xor

  • 条件成立時の modifier の XOR 値を指定します。

これは、以下のような処理を行ないます。

fn conv( modifier:int, key:int ) {
  if (modifier & mask) == mask and key == code {
     key = newcode;
     modifier = modifier ^ xor;
  }
}

例えば、 Shift を押下(modifier:2)しながら Space キー押下(HID:44) を、数字の 1 キー(HID:30)にする場合は、 以下を実行します。

esp32> remap -c 44,2,2,30,2

このコマンドは、 後述する設定変更ツールで出力されたデータを読み込ます。 入れ替えるキーが多い場合や、設定単体を保持しておきたい場合に利用します。

以下を実行すると、

esp32> remap --b64read

データ入力待ちになるので、以下を入力すると、設定が反映されます。

16
AQAAAAAAAAAAAAAAEAAAAA==

normal モードは、setup モードでペアリングされた PC/keyboard と自動で接続されます。

接続は次の順番に行ないます。

• PC
• keyboard

それぞれの接続中の状態を示すため、 LED の点滅パターンが変化します。

PC 接続待ち中は高速点滅し、 keyboard 待ち中は点滅のパターンが変化します。 keyboard との接続終了後は常時点灯します。