History

tmk 77f157943f Fix image link 3 :(		2012-11-01 14:40:24 +09:00
..
doc	Improve documentation	2012-11-01 14:24:21 +09:00
config.h	Fix build option MOUSEKEY_ENABLE.	2012-10-17 15:55:37 +09:00
config_iwrap.h	Fix HHKB iWRAP build	2012-10-17 15:55:38 +09:00
config_vusb.h	Fix build option MOUSEKEY_ENABLE.	2012-10-17 15:55:37 +09:00
iwrap.txt	Improve documentation	2012-11-01 14:24:21 +09:00
keymap.c	Fix HHKB keymap	2012-10-17 15:55:37 +09:00
led.c	Made directories for keyboard and converter projects.	2012-06-08 13:32:38 +09:00
Makefile.iwrap	Fix HHKB iWRAP build	2012-10-17 15:55:38 +09:00
Makefile.lufa	Add CONSOLE_ENABLE build option to LUFA.	2012-07-20 13:08:18 +09:00
Makefile.pjrc	Add Makefile.lufa to keyboard/hhkb and hbkb.	2012-06-30 13:26:09 +09:00
Makefile.vusb	Fix: Makefile	2012-10-17 15:53:20 +09:00
matrix.c	Fix projects for new keycodes	2012-10-17 21:43:44 +09:00
README.md	Fix image link 3 :(	2012-11-01 14:40:24 +09:00
usbconfig.h	Made directories for keyboard and converter projects.	2012-06-08 13:32:38 +09:00

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. For this purpose I used PJRC Teensy++ as alternative controller.

My keyboard firmware source tree is here: http://github.com/tmk/tmk_keyboard See directory keyboard/hhkb to build firmware for HHKB.

##Features

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

###Pros

Without PCB trace cutting, case mod or any destructives
Can keep original controller intact
Can change all HHKB behaviour as you like

###Cons

Void your warranty
Lose USB hub function in case of Pro2

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

##Build Firmware You can choose some combination of MCU and USB protocol stack.

Teensy++(AVR USB family) with LUFA

Edit matrix.c to use your pin configuration. See doc/HHKB.txt for detail.
Edit keymap.c to use your favoirte keymap.
Edit Makefile if you want to use other MCU than Teensy++ 2.0.
Build firmware binary file: $ make -f Makefile.lufa
Program MCU with PJRC Teensy Loader tool. If you install command line version of the loader just run: $ make -f Makefile.lufa teensy

###AVR Mega with V-USB Follow below if you want to use AVR with V-USB as .

Edit matrix.c to use your pin configuration. See doc/HHKB.txt for detail.
Edit keymap.c to use your favoirte keymap.
Edit usbconfig.h to configure V-USB options.
Edit Makefile.vusb to define MCU and F_CPU.
Build firmware binary file: $ make -f Makefile.vusb
Program MCU with AVR programmer like AVRISPmkII. If you already have USBaspLoader on MCU just run: $ make -f Makefile.vusb program

###How to Customize Keymap Later... See keymap.c.

##Hardware

###Teensy++ installation Angled USB mini B adapter is used to install Teensy++ laterally.

Bread baord wires are used to connect Teensy++.

###PJRC Teensy++ 2.0 connection +---------------+ | Teensy++ | | | | | HHKB | | ~~~~ | PB0-2|------->ROW(6-8) | PB3-5|------->COL(9-11) | PB6|------->ENABLE(12) | PE6|<-------KEY(4) | PE7|------->PREV(5) | | | | | | +---------------+

###V-USB circuit +---+ +---------------+ USB GND | | ATmega168 | ~~~ C3 | | 5V <-------+--------+---|Vcc,AVCC | HHKB R1 | | ~~~~ D- <----+--+-----R2-----|INT1 PB2-4|------->ROW(6-8) D+ <----|---+----R3-----|INT0 PC0-2|------->COL(9-11) Z1 Z2 | PC3|------->ENABLE(12) GND<----+---+-----------|GND PB0|<-------KEY(4) | PB1|------->PREV(5) | | GND+-C2--+--|XTAL1 RXD|------->Debug Console X1 | TXD|<-------Debug Console GND+-C3--+--|XTAL2 RST|---SW--+GND +---------------+ R1: 1.5K Ohm R2,R3: 68 Ohm Z1,Z2: Zener 3.6V C1,C2: 22pF C3: 0.1uF X1: Crystal 20MHz(16MHz/12MHz) SW: Push Switch(Optional for bootloader)