qmk_firmware/keyboard/hhkb

Alternative Controller for HHKB Pro

I wanted to add some features like vi cursor and mouse keys to my HHKB but its controller is not programmable and firmware source code is not open, of course. This means customizing this keyboard needs to replace original controller with programmable one.

This controller can work with HHKB Professional, Professional 2, JP and Type-S.

See this thread in geekhack.org.

##Features

• Customizable keymap
• More keymap layers(more Fn keys)
• Mouse keys
• USB NKRO

See README of tmk_keyboard for more.

###Pros

• No risks: Everything is all reversible
• No need for PCB trace patching, case cutting or any other destructive mod
• Can keep original controller intact
• Can change all HHKB behavior as you like

###Cons

• Void your warranty
• Lose USB hub function of Pro2

##DISCLAIMER I'm not a professional of electronics nor MCU programming. This may damage your HHKB. And my English writing is poor, I'm not sure I can convey my notions accurately.

##Documents See doc/HHKB.txt and files under doc/ for internal of HHKB and this controller.

##Build Firmware & Program See this document first.

Configuration

Set MCU, BOOTLOADER_SIZE and other build options in Makefile and config.h. If your target is HHKB JP you need to set HHKB_JP build option in Makefile.

Build

Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just make with KEYMAP option like:

$ make KEYMAP=[hasu|hhkb|spacefn|<name>]

Program

First, push reset button on board to start bootloader.

This command programs the controller with dfu-programmer if the tool is installed and configured properly.

$ make dfu

Or you can also use FLIP command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.

$ make flip

Use Teensy Loader if your controller is Teensy/Teensy++.

##Keymap To define your own keymap create file named keymap_<name>.c and see keymap document and existent keymap files.

##Hardware You have some options for hardware. Development boards with USB AVR family(ATMega32U4, AT90USB1286) like Teensy will work while MegaAVR with V-USB library is also cheaper option for DIY.

###1. TMK Alt Controller Board Design files are available at Keyboard Controller Board for HHKB(KiCad project) and see Controller Distribution thread if you get an assembled one.

###2. PJRC Teensy See this thread.

###3. V-USB version See V-USB controller for HHKB.