Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tmk 0de581ee82 hhkb: Fix startup of rn42 #407 5 years ago
..
binary hhkb: Fix startup of rn42 #407 5 years ago
doc Add doc of HHKB original keycodes 6 years ago
not_supported hhkb: Organize Makefiles for unimap 5 years ago
rn42 hhkb: Fix startup of rn42 #407 5 years ago
Makefile hhkb: Fix startup of rn42 #407 5 years ago
Makefile.editor hhkb: Organize Makefiles for unimap 5 years ago
Makefile.editor.rn42 hhkb: Organize Makefiles for unimap 5 years ago
Makefile.jp hhkb: Enable NKRO for jp 5 years ago
Makefile.rn42 hhkb: Organize Makefiles for unimap 5 years ago
Makefile.rn42.jp hhkb: Organize Makefiles for unimap 5 years ago
Makefile.unimap hhkb: Add unimap for hhkb 5 years ago
Makefile.unimap.jp hhkb: Enable NKRO for jp 5 years ago
Makefile.unimap.rn42 hhkb: Organize Makefiles for unimap 5 years ago
Makefile.unimap.rn42.jp hhkb: Organize Makefiles for unimap 5 years ago
README.md hhkb: Fix links in README.md. Close #358 6 years ago
config.h hhkb: Change keymap and bootmagic salt key 7 years ago
config_rn42.h hhkb: fix for keymap editor 6 years ago
hhkb_avr.h hhkb: Pin setting for power saving 5 years ago
keymap_common.h Remove keymap read code from project directories 5 years ago
keymap_hasu.c Fix: Use action_t in keymap files 5 years ago
keymap_hhkb.c Fix: Use action_t in keymap files 5 years ago
keymap_jp.c Fix: Use action_t in keymap files 5 years ago
keymap_spacefn.c Fix: Use action_t in keymap files 5 years ago
led.c Add Caps Lock LED on PD6 8 years ago
matrix.c Fix matrix.c to use new default impl. 5 years ago
rn42.mk hhkb: Integrate RN-42 support, remove hhkb_rn42 7 years ago
unimap_hasu.c hhkb: Change unimap files 5 years ago
unimap_hhkb.c hhkb: Change unimap files 5 years ago
unimap_jp.c hhkb: Change unimap files 5 years ago
unimap_trans.h hhkb: Change unimap files 5 years ago

README.md

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.

Update

  • Bluetooth module RN-42 is supported.(2015/01)
  • V-USB and iWRAP are no longer supported now, but still it’ll works with a little fix. See not_supported directory.(2015/01)

Features

  • Customizable keymap
  • More keymap layers(more Fn keys)
  • Mouse keys
  • USB NKRO
  • Bluetooth(RN-42)

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

If your target is HHKB JP you need to set HHKB_JP build option in Makefile or use Makefile.jp instead of Makefile.

If you use other than TMK Alt Controller Board set proper MCU, BOOTLOADER_SIZE and other build options in Makefile and config.h. At least PJRC Teensy requires changing BOOTLOADER_SIZE to 512.

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 -f Makefile.<jp|pjrc|rn42> KEYMAP=(hasu|hhkb|spacefn|<name>)

You can omit -f option when you use Makefile. Makefile is used for Pro2 and Pro, Makefile.jp fits for JP model and Makefile.rn42 supports Bluetooth module RN-42. Makefile.pjrc uses PJRC as output protocol instead of LUFA.

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 -f Makefile.<variant> KEYMAP=<name> 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 -f Makefile.<variant> KEYMAP=<name> 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.