Build on VirtualBox - mcaple/tmk_keyboard GitHub Wiki

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

Requirement

Install VirtualBox.

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

Import VM image from menu File>Import Appliance...

• ubuntu16.04 VM image

Login

Start VM and login in system with username ubuntu and password ubuntu. 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/

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