Build on VirtualBox

You can build tmk and program/flash microcontroller with Ubuntu environment on VirtualBox.

Requirement

Install VirtualBox.

• https://www.virtualbox.org/wiki/Downloads

Download VM image and import from menu File>Import Appliance...

• Ubuntu Linux VM image(2021-12 1000M)
• Arch Linux VM image(2021-12 911M)

Uncheck "import hard drives as vdi" option if you get error during import.

Login

Start VM and login in system with username tmk and password tmk. You can use console in VirtualBox window or ssh client with IP address 127.0.0.1 and port 2222. Use putty on Windows.

• http://www.putty.org/

Download tmk_keyboard

$ ./tmk_keyboard_setup.sh

How to build tmk

Compile codes.

$ cd tmk_keyboard
$ git pull
$ cd <project directory>
$ make

Plugin your keyboard or converter and turn it into bootloader mode(with pushing program button in most cases).

$ make dfu

Note that make command may vary and need options refer README of each project.

or use dfu-programmer directly like

$ dfu-programmer atmega32u4 erase --force
$ dfu-programmer atmega32u4 flash your_firmware.hex
$ dfu-programmer atmega32u4 reset

where atmega32u4(for HHKB Alt Controller) part should be atmega32u2(for TMK Converters) or something depending on your controller.

Vagrant

You can configure VM image with Vagrantfile to improve environment yourself. Not needed mostly.

• https://github.com/tmk/vagrant_tmk_build