History

tmk 00e9a342df Fix 'Shift Parentheses' example		11 years ago
..
doc	Fix README.md of hhkb	11 years ago
Makefile	Change LUFA build options	11 years ago
Makefile.iwrap	Add support of iWRAP5	12 years ago
Makefile.nodebug	Add new keymap framework	11 years ago
Makefile.pjrc	Add new keymap framework	11 years ago
Makefile.vusb	Changed Makefile and config.h for new options	12 years ago
README.md	Spellchecking keyboard README files.	11 years ago
config.h	Add timeout option to MODS_ONESHOT #66	11 years ago
config_iwrap.h	Delete MOUSEKEY_DELAY_TIME in config.h	11 years ago
config_vusb.h	Delete MOUSEKEY_DELAY_TIME in config.h	11 years ago
iwrap.txt	Improve documentation	12 years ago
keymap_common.c	Add new keymap framework	11 years ago
keymap_common.h	Add new keymap framework	11 years ago
keymap_hasu.c	Fix 'Shift Parentheses' example	11 years ago
keymap_hhkb.c	Add new keymap framework	11 years ago
keymap_spacefn.c	Add SpaceFN layout for HHKB	11 years ago
led.c	Add Caps Lock LED on PD6	12 years ago
matrix.c	Add power control of keyswitch board and tweak scan wait	12 years ago
usbconfig.h	Made directories for keyboard and converter projects.	13 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 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.

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(you can find in top README.md) 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 TMK designed Keyboard Controller Board for HHKB Pro2(KiCad project). See this post.

###2. PJRC Teensy++ 2.0 version +---------------+ | Teensy++ | | | | | HHKB pro HHKB pro2 | | ~~~~~~~~ ~~~~~~~~~ | PB0-2|------->ROW (6-8) (5-7) | PB3-5|------->COL (9-11) (8-10) | PB6|------->ENABLE (12) (11) | PE6|<-------KEY (4) (3) | PE7|------->PREV (5) (4) | | | | 5V--- (1-3) (1-2) | | GND--- (13-14) (12-13) +---------------+

NOTE: PJRC Teensy

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