Lets'split - vitamins included にデフォルトのキーマップを書き込む

QMK firmware と `avrdude` を利用して、コマンドラインで書き込む

このように自分の場合、 QMK Toolbox が使い物にならなかったのでコマンドラインでファームを書き込むことになった。 macOS 10.13 系の人で素人に毛が生えた程度の BSD/AVR 使いの方は要注意です。

参考:

QMK firmware のダウンロード

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

QMK Firmware

zip をリポジトリからダウンロードするか git clone するか、好きな方法で QMK firmware を取得する。

リポジトリこちら

qmk/qmk_firmware: keyboard controller firmware for Atmel AVR and ARM USB families

Let’s Split - Vitamins included 用のファームを作成して書き込む

Let’s Split - Vitamins included の設定ファイルだが、ここに情報があった。

For reference, this is the board specifically that I’m talking about.

https://github.com/qmk/qmk_firmware/tree/master/keyboards/vitamins_included

…

Some questions about The Let’s Split Vitamins Included : olkb

このリンク先が基本的な利用方法になっている。

EEPROM の書き込み

EEPROM

If this is the first time you’re flashing the boards, you have to flash EEPROM

If your keyboard is plugged in, unplug it

Open a terminal, and navigate to the qmk_firmware folder

Run ls /dev | grep tty Note down which ports you see

Plug the keyboard in, if it’s new, it should enter bootloader, if it’s not new, see Entering bootloader on how to enter bootloader mode

Right after entering bootloader, run ls /dev | grep tty again. There should be a new tty, this is the bootloader TTY, note it down. If nothing shows see Entering bootloader on how to enter bootloader mode

For the left hand side, run avrdude -c avr109 -p m32u4 -P /dev/ttyS1 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep":a Replace /dev/ttyS1 with the port you noted down earlier. If you’re on windows using msys2, replace /dev/ttyS1 with COM2, note that the number is one higher than the tty number.

Do the same For the right hand, but change the file to eeprom-righthand.eep

qmk_firmware/keyboards/vitamins_included at master · qmk/qmk_firmware

最初にこれをやらねばならないらしいので実行する。

左側の EEPROM を書き込む

$ avrdude -c avr109 -p m32u4 -P /dev/tty.usbmodem1451 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep":a

Connecting to programmer: .
Found programmer: Id = "CATERIN"; type = S
    Software Version = 1.0; No Hardware Version given.
Programmer supports auto addr increment.
Programmer supports buffered memory access with buffersize=128 bytes.

Programmer supports the following devices:
    Device code: 0x44

avrdude: AVR device initialized and ready to accept instructions

Reading | ################################################## | 100% 0.00s

avrdude: Device signature = 0x1e9587 (probably m32u4)
avrdude: reading input file "./quantum/split_common/eeprom-lefthand.eep"
avrdude: input file ./quantum/split_common/eeprom-lefthand.eep auto detected as Intel Hex
avrdude: writing eeprom (15 bytes):

Writing | ################################################## | 100% 0.05s

avrdude: 15 bytes of eeprom written
avrdude: verifying eeprom memory against ./quantum/split_common/eeprom-lefthand.eep:
avrdude: load data eeprom data from input file ./quantum/split_common/eeprom-lefthand.eep:
avrdude: input file ./quantum/split_common/eeprom-lefthand.eep auto detected as Intel Hex
avrdude: input file ./quantum/split_common/eeprom-lefthand.eep contains 15 bytes
avrdude: reading on-chip eeprom data:

Reading | ################################################## | 100% 0.01s

avrdude: verifying ...
avrdude: 15 bytes of eeprom verified

avrdude: safemode: Fuses OK (E:CB, H:D8, L:FF)

avrdude done.  Thank you.

/dev/tty.usbmodem1451 は人によって変化するので ls /dev/tty* などで確認する。

右側の EEPROM を書き込む

$ avrdude -c avr109 -p m32u4 -P /dev/tty.usbmodem1451 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep":a

Connecting to programmer: .
Found programmer: Id = "CATERIN"; type = S
    Software Version = 1.0; No Hardware Version given.
Programmer supports auto addr increment.
Programmer supports buffered memory access with buffersize=128 bytes.

Programmer supports the following devices:
    Device code: 0x44

avrdude: AVR device initialized and ready to accept instructions

Reading | ################################################## | 100% 0.00s

avrdude: Device signature = 0x1e9587 (probably m32u4)
avrdude: reading input file "./quantum/split_common/eeprom-righthand.eep"
avrdude: input file ./quantum/split_common/eeprom-righthand.eep auto detected as Intel Hex
avrdude: writing eeprom (15 bytes):

Writing | ################################################## | 100% 0.05s

avrdude: 15 bytes of eeprom written
avrdude: verifying eeprom memory against ./quantum/split_common/eeprom-righthand.eep:
avrdude: load data eeprom data from input file ./quantum/split_common/eeprom-righthand.eep:
avrdude: input file ./quantum/split_common/eeprom-righthand.eep auto detected as Intel Hex
avrdude: input file ./quantum/split_common/eeprom-righthand.eep contains 15 bytes
avrdude: reading on-chip eeprom data:

Reading | ################################################## | 100% 0.01s

avrdude: verifying ...
avrdude: 15 bytes of eeprom verified

avrdude: safemode: Fuses OK (E:CB, H:D8, L:FF)

avrdude done.  Thank you.

eeprom-righthand.eep に変更してこちらも書き込み完了。

default のファームを書き込む

Flashing

If you haven’t flashed EEPROM before, do that first.

To flash keymaps onto the keyboard, use:
make lets_split_vitamins/rev1:[KEYMAP]:avrdude
from the qmk_firmware folder. Default being the default keymap.

You can plug either half into USB and it will work. you can also remove the TRS/TRRS cable, and plug both halves in. (which is why the default layout has reset on both halves)

qmk_firmware/keyboards/vitamins_included at master · qmk/qmk_firmware

双方ともに上記のコマンドでファーム書き込みをすれば動くらしい。とりあえずデフォルトの状態でやってみる。

$ make vitamins_included/rev1:default:avrdude
Making vitamins_included/rev1 with keymap default and target avrdude

avr-gcc (GCC) 8.1.0
Copyright (C) 2018 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Size before:
   text	   data	    bss	    dec	    hex	filename
      0	  28046	      0	  28046	   6d8e	.build/vitamins_included_rev1_default.hex

Compiling: tmk_core/common/command.c                                                                [OK]
Linking: .build/vitamins_included_rev1_default.elf                                                  [OK]
Creating load file for flashing: .build/vitamins_included_rev1_default.hex                          [OK]
Checking file size of vitamins_included_rev1_default.hex                                            [OK]
 * File size is fine - 28046/28672 (626 free)
Copying vitamins_included_rev1_default.hex to qmk_firmware folder                                   [OK]
Detecting USB port, reset your controller now..................
Detected controller on USB port at /dev/tty.usbmodem1451

Connecting to programmer: .
Found programmer: Id = "CATERIN"; type = S
    Software Version = 1.0; No Hardware Version given.
Programmer supports auto addr increment.
Programmer supports buffered memory access with buffersize=128 bytes.

Programmer supports the following devices:
    Device code: 0x44

avrdude: AVR device initialized and ready to accept instructions

Reading | ################################################## | 100% 0.00s

avrdude: Device signature = 0x1e9587 (probably m32u4)
avrdude: NOTE: "flash" memory has been specified, an erase cycle will be performed
         To disable this feature, specify the -D option.
avrdude: erasing chip
avrdude: reading input file ".build/vitamins_included_rev1_default.hex"
avrdude: input file .build/vitamins_included_rev1_default.hex auto detected as Intel Hex
avrdude: writing flash (28046 bytes):

Writing | ################################################## | 100% 2.19s

avrdude: 28046 bytes of flash written
avrdude: verifying flash memory against .build/vitamins_included_rev1_default.hex:
avrdude: load data flash data from input file .build/vitamins_included_rev1_default.hex:
avrdude: input file .build/vitamins_included_rev1_default.hex auto detected as Intel Hex
avrdude: input file .build/vitamins_included_rev1_default.hex contains 28046 bytes
avrdude: reading on-chip flash data:

Reading | ################################################## | 100% 0.25s

avrdude: verifying ...
avrdude: 28046 bytes of flash verified

avrdude: safemode: Fuses OK (E:CB, H:D8, L:FF)

avrdude done.  Thank you.

Detecting USB port, reset your controller now..................

途中このタイミングで以下のことを行わねばならない。

Entering bootloader

If the keyboard isn’t new, and has been flashed before, you need to enter bootloader. To enter bootloader, either use the assigned keys on the keymap, or if none have been put in the keymap, quickly short the reset to gnd twice. (Bottom pins of programming header, see image)

qmk_firmware/keyboards/vitamins_included at master · qmk/qmk_firmware

下の画像の部分を2回すばやくショートさせる。

いつもピンセットで挟んでやってる

ショートさせるのが成功すると認識されて書き込みが行われる。既に書き込まれてキーボードになっている場合、これを行わないと EEPROM なども書き込みできない。ショートさせてから8秒間は書き込みができる。

動作確認

実際に動作させてみて動くようなら成功。書き込んで動くようになるところまで到達した。

Lets'split - vitamins included にデフォルトのキーマップを書き込む

QMK firmware と `avrdude` を利用して、コマンドラインで書き込む

QMK firmware のダウンロード

Let’s Split - Vitamins included 用のファームを作成して書き込む

EEPROM の書き込み

EEPROM

左側の EEPROM を書き込む

右側の EEPROM を書き込む

default のファームを書き込む

Flashing

Entering bootloader

動作確認

Technical Note

Keyboard Top

Tips

QMK firmware と avrdude を利用して、コマンドラインで書き込む

QMK firmware のダウンロード

Let’s Split - Vitamins included 用のファームを作成して書き込む

EEPROM の書き込み

EEPROM

左側の EEPROM を書き込む

右側の EEPROM を書き込む

default のファームを書き込む

Flashing

Entering bootloader

動作確認

Technical Note

Keyboard Top

Tips

QMK firmware と `avrdude` を利用して、コマンドラインで書き込む