自作キーボード2 Runner3680 無線化

参考

https://github.com/sekigon-gonnoc/BLE-Micro-Pro
https://salicylic-acid3.hatenablog.com/entry/BMP-Introduction
https://log.brdr.jp/post/395
https://note.com/huaa/n/n5df773cd8707
https://github.com/sekigon-gonnoc/BLE-Micro-Pro/tree/master/CoinCellHolder#%E7%B5%84%E3%81%BF%E7%AB%8B%E3%81%A6%E4%B8%8A%E3%81%AE%E6%B3%A8%E6%84%8F%E7%82%B9
https://qiita.com/koktoh/items/1c246d56d7fa8c121b7f

注文したもの	URL	備考
BLE Micro Pro	https://yushakobo.jp/shop/ble-micro-pro/	分離型の場合は2個必要
コンスルー	https://yushakobo.jp/shop/a01mc-00/	BLE Micro Pro数 x 2。12pinで良い。
BLE Micro Pro用電池基板	https://yushakobo.jp/shop/ble-micro-pro-battery-board/	BLE Micro Proと同じ数だけ必要。別な電源を検討している場合は不要。難易度高めなので不安な場合は予備でいくつか注文しておく。

組み立て

https://github.com/sekigon-gonnoc/BLE-Micro-Pro/tree/master/CoinCellHolder#%E7%B5%84%E3%81%BF%E7%AB%8B%E3%81%A6%E4%B8%8A%E3%81%AE%E6%B3%A8%E6%84%8F%E7%82%B9
https://log.brdr.jp/post/395
に書いてある通り。

部品が小さめなのでなくさないように気をつける。

パーツ取り付け方法

スイッチ基盤上部にハンダ付け。

ダイオード x 2 黒くて小さいパーツ。向きがあるので注意。よ～～～く見るとラインが入っている。ラインがある側を基盤の「●」側にハンダ付。基盤側に少しハンダを乗せてから、ピンセットを使ってハンダ付けすると比較的楽にできる。

コンデンサ基板の裏にハンダ付けする。向きはない。ダイオード同様に基板側にハンダを乗せてから、ピンセットを使ってハンダ付けすると楽。

電池ホルダ周りのパーツと干渉しないように取り付ける。電池を出し入れする向きに注意。

電池基盤とBLE Micro Proは、

パーツ	取り付け方法
スイッチ	基盤上部にハンダ付け。
ダイオード x 2	黒くて小さいパーツ。向きがあるので注意。よ～～～く見るとラインが入っている。ラインがある側を基盤の「●」側にハンダ付。基盤側に少しハンダを乗せてから、ピンセットを使ってハンダ付けすると比較的楽にできる。
コンデンサ	基板の裏にハンダ付けする。向きはない。ダイオード同様に基板側にハンダを乗せてから、ピンセットを使ってハンダ付けすると楽。
電池ホルダ	周りのパーツと干渉しないように取り付ける。電池を出し入れする向きに注意。

電池基盤の「＋」-> BLE Micro ProのBAT
電池基盤の「－」-> BLE Micro ProのGND

につなぐ。

can't open device "/dev/ttyACM0": Device or resource busy

が出て失敗する。また、docker使う場合もModemManagerが動作していると

serial.serialutil.SerialException device reports readiness to read but returned no data

とエラーが出る。

sudo systemctl stop ModemManager

でModemManagerを停止する。

 sudo systemctl disable ModemManager

でModelManagerを無効化しておくか、削除してしまっても良い。

/dev/ttyACM0: Permission denied が出る

ttyACM0にパーミッションがなくて書き込みできないことがある。
ユーザをdialoutグループに追加する必要がある。

sudo usermod -a -G dialout <username>
sudo chmod a+rw /dev/ttyACM0

docker作成

nrfutilの環境が必要になるのでdockerで作成しておく。
Dockerfile_ble

FROM qmkfm/base_container

VOLUME /qmk_firmware
WORKDIR /qmk_firmware

ENV LC_ALL=C.UTF-8
ENV export LANG=C.UTF-8
RUN git clone https://github.com/yyuu/pyenv.git ~/.pyenv
ENV PYENV_ROOT=/root/.pyenv
ENV PATH=/root/.pyenv/bin:${PATH}
ENV PATH=/root/.pyenv/shims:${PATH}
RUN echo 'eval "$(pyenv init -)"' >> ~/.bashrc

RUN apt remove -y python3.5
RUN apt update && apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils
RUN . ~/.bashrc && pyenv install 3.7.7
RUN . ~/.bashrc && pyenv global 3.7.7
RUN . ~/.bashrc && pip3 install nrfutil

dockerビルド

docker build  ./ -t ble -f Dockerfile_ble

流れ

ファームウェアの書き込み
アプリケーションの書き込み
CONFIG.JSN編集
KEYMAP.JSN編集

ファームウェアアップデート

https://github.com/sekigon-gonnoc/BLE-Micro-Pro/releases
から4.2をダウンロードし、作成したdocker環境からnrfutilでファームウェアをアップデートする。
以下の作業を左右両方に行う。

docker run --rm -it --privileged -v /dev:/dev -w /qmk_firmware -v /home/centos/data/source/qmk_firmware_bmp:/qmk_firmware -e ALT_GET_KEYBOARDS=true -e SKIP_GIT= -e MAKEFLAGS= ble bash
nrfutil dfu usb-serial -pkg ble_micro_pro_bootloader_0_4_2.zip -p /dev/ttyACM0

アプリケーションアップデート(独自キーの定義や自分でプログラムをしていない場合)

https://github.com/sekigon-gonnoc/qmk_firmware/releases
から4.2をダウンロードし、作成したdocker環境からnrfutilでアプリケーションをアップデートする。
以下の作業を左右両方に行う。

 docker run --rm -it --privileged -v /dev:/dev -w /qmk_firmware -v /home/centos/data/source/qmk_firmware_bmp:/qmk_firmware -e ALT_GET_KEYBOARDS=true -e SKIP_GIT= -e MAKEFLAGS= ble bash
nrfutil dfu usb-serial -pkg ble_micro_pro_default_0_4_2.zip -p /dev/ttyACM0

アプリケーションアップデート(独自キーの定義や自分でプログラムをする場合)

https://github.com/sekigon-gonnoc/BLE-Micro-Pro/blob/v0.4.2/AboutDefaultFirmware/doc/define_new_keyboard.md

新しいキーボードを定義する
1. ./util/new_keyboard.sh
qmk_firmware同様にプログラムを組む
1. 通常のqmk_firmwareと違う点があるので注意
  1. custom_keys_userの定義
  2. custom_keycodesの開始が、SAFE_RANGEではなく、BMP_SAFE_RANGE
  3. 参考(keymap.c(153))
  4. キーマップは、後述のKEYMAP.JSNで変更するのでkeymap.cは適当な内容で良い。
  5. 右手用、左手用の設定は後述するCONFIG.JSNで設定するのでconfig.hは気にしなくて良い。同じ設定を左右に書き込んで問題ない。
  6. レイアウトは最大6つまでしか登録できないので注意。
コンパイルとnrfutilで転送
1. docker run --rm -it --privileged -v /dev:/dev -w /qmk_firmware -v /home/centos/data/source/qmk_firmware_bmp:/qmk_firmware -e ALT_GET_KEYBOARDS=true -e SKIP_GIT= -e MAKEFLAGS= ble make runner3680_ble:default:nrfutil

CONFIG.JSN編集

アプリケーションをアップデート後、USBケーブルで接続するとストレージとして認識され

CONFIG.JSN
KEYMAP.JSN

などのファイルなどが見える。
CONFIG.JSNを以下のように編集する。

左手

 {"config":{"version":2,
 "device_info":{"vid":"0xfeed","pid":"0x0000","name":"runner3680_ble","manufacture":"funatake","description":"A custom keyboard"},
 "matrix":{"rows":10,"cols":8,"device_rows":5,"device_cols":8,"debounce":1,"is_left_hand":1,"diode_direction":0,"row_pins":[7,8,9,10,11],"col_pins":[20,19,18,17,16,15,14,13],
 "layout":[
   1,  2,  3,  4,  5,  6,  7,  8, 48, 47, 46, 45, 44, 43, 42, 41,  0,
   9, 10, 11, 12, 13, 14, 15, 16, 56, 55, 54, 53, 52, 51, 50, 49,  0,
  17, 18, 19, 20, 21, 22, 23, 24, 64, 63, 62, 61, 60, 59, 58, 57,  0,
  25, 26, 27, 28, 29, 30, 31, 32, 72, 71, 70, 69, 68, 67, 66, 65,  0,
  33, 34, 35, 36, 37, 38, 39, 40, 80, 79, 78, 77, 76, 75, 74, 73]},
 "mode":"SPLIT_MASTER","startup":1,
 "peripheral":{"max_interval":50,"min_interval":20,"slave_latency":7},
 "central":{"max_interval":50,"min_interval":20,"slave_latency":0},
 "led":{"pin":1,"num":80},
 "keymap":{"locale":"US","use_ascii":0},
 "reserved":[0,0,0,0,0,0,0,0]}}

右手

 {"config":{"version":2,
 "device_info":{"vid":"0xfeed","pid":"0x0000","name":"runner3680_ble","manufacture":"funatake","description":"A custom keyboard"},
 "matrix":{"rows":10,"cols":8,"device_rows":5,"device_cols":8,"debounce":1,"is_left_hand":0,"diode_direction":0,"row_pins":[7,8,9,10,11],"col_pins":[20,19,18,17,16,15,14,13],
 "layout":[
   1,  2,  3,  4,  5,  6,  7,  8, 48, 47, 46, 45, 44, 43, 42, 41,  0,
   9, 10, 11, 12, 13, 14, 15, 16, 56, 55, 54, 53, 52, 51, 50, 49,  0,
  17, 18, 19, 20, 21, 22, 23, 24, 64, 63, 62, 61, 60, 59, 58, 57,  0,
  25, 26, 27, 28, 29, 30, 31, 32, 72, 71, 70, 69, 68, 67, 66, 65,  0,
  33, 34, 35, 36, 37, 38, 39, 40, 80, 79, 78, 77, 76, 75, 74, 73]},
 "mode":"SPLIT_SLAVE","startup":1,
 "peripheral":{"max_interval":50,"min_interval":20,"slave_latency":7},
 "central":{"max_interval":50,"min_interval":20,"slave_latency":0},
 "led":{"pin":1,"num":80},
 "keymap":{"locale":"US","use_ascii":0},
 "reserved":[0,0,0,0,0,0,0,0]}}

KEYMAP.JSN

 {"keyboard":"runner3680_ble",
 "keymap":"",
 "layout":"LAYOUT",
 "layers":
 [["KC_TRNS","KC_ESC","KC_1","KC_2","KC_3","KC_4","KC_5","KC_6","KC_7","KC_8","KC_9","KC_0","KC_MINS","KC_EQL","KC_JYEN","KC_BSPC",
 "KC_TRNS","KC_TAB","KC_LSFT","KC_Q","KC_W","KC_E","KC_R","KC_T","KC_Y","KC_U","KC_I","KC_O","KC_P","KC_LBRC","KC_RBRC","KC_DEL",
 "KC_TRNS","KC_LCTL","KC_LCTL","KC_A","KC_S","KC_D","KC_F","KC_G","KC_H","KC_J","KC_K","KC_L","KC_SCLN","KC_QUOT","KC_NUHS","KC_ENT",
 "KC_TRNS","KC_LSFT","KC_LSFT","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_RO","KC_RSFT","KC_RCTL",
 "KC_TRNS","KC_LCTL","KC_LCTL","KC_LGUI","KC_LALT","KC_LALT","CK_WMH","KC_SPC","KC_RSFT","CK_WHN","KC_RALT","KC_APP","KC_LEFT","KC_DOWN","KC_UP","KC_RGHT"],
 
 ["KC_TRNS","KC_ESC","KC_1","KC_2","KC_3","KC_4","KC_5","KC_6","KC_7","KC_8","KC_9","KC_0","KC_MINS","KC_EQL","KC_JYEN","KC_BSPC",
 "KC_TRNS","KC_TAB","KC_LSFT","KC_Q","KC_W","KC_E","KC_R","KC_T","KC_Y","KC_U","KC_I","KC_O","KC_P","KC_LBRC","KC_RBRC","KC_DEL",
 "KC_TRNS","KC_LGUI","KC_LCTL","KC_A","KC_S","KC_D","KC_F","KC_G","KC_H","KC_J","KC_K","KC_L","KC_SCLN","KC_QUOT","KC_NUHS","KC_ENT",
 "KC_TRNS","KC_LSFT","KC_LSFT","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_RO","KC_RSFT","KC_RGUI",
 "KC_TRNS","KC_LGUI","KC_LCTL","KC_LALT","KC_LCTL","KC_LCTL","CK_MMH","KC_SPC","KC_RSFT","CK_MHN","KC_RCTL","KC_APP","KC_LEFT","KC_DOWN","KC_UP","KC_RGHT"],
 
 ["KC_TRNS","KC_GRV","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_BSPC","KC_DEL","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_F2","KC_UP","KC_PGUP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_ESC","KC_LEFT","KC_DOWN","KC_RGHT","KC_HOME","KC_END","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PGDN","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(5)","KC_TRNS","KC_TRNS","KC_HOME","KC_PGDN","KC_PGUP","KC_END"],
 
 ["KC_TRNS","KC_GRV","KC_F1","KC_F2","KC_F3","KC_F4","KC_F5","KC_F6","KC_F7","KC_F8","KC_F9","KC_F10","KC_F11","KC_F12","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_F2","KC_UP","KC_PGUP","KC_TRNS","KC_PSCR","KC_SLCK","KC_PAUS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_ESC","KC_LEFT","KC_DOWN","KC_RGHT","KC_HOME","KC_END","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PGDN","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(4)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_HOME","KC_PGDN","KC_PGUP","KC_END"],
 
 ["KC_TRNS","KC_MUTE","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PSLS","KC_PAST","KC_BSPC",
 "KC_TRNS","KC_VOLU","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_PSCR","KC_SLCK","KC_PAUS","KC_P7","KC_P8","KC_P9","KC_PMNS",
 "KC_TRNS","KC_VOLD","KC_TRNS","KC_TRNS","KC_MPLY","KC_MPRV","KC_MNXT","KC_TRNS","KC_TRNS","KC_INS","KC_HOME","KC_PGUP","KC_P4","KC_P5","KC_P6","KC_PPLS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_DEL","KC_END","KC_PGDN","KC_P1","KC_P2","KC_P3","KC_PENT",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(4)","KC_TRNS","KC_TRNS","MO(4)","KC_TRNS","KC_TRNS","KC_P0","KC_P0","KC_PDOT","KC_PENT"],
 
 ["KC_TRNS","KC_TRNS","TO(0)","KC_TRNS","TO(1)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","RESET",
 "KC_TRNS","KC_TRNS","TO(0)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","TO(1)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS",
 "KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(5)","KC_TRNS","KC_TRNS","MO(5)","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS"]]}