2012-11-01 05:24:21 +00:00
Alternative Controller for HHKB Pro
===================================
I wanted to add some features like vi cursor and mouse keys to my [HHKB][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
2013-07-11 07:23:53 +00:00
controller with programmable one. This controller can work with HHKB Professional and Professional 2 model.
See [this thread][AltController] in geekhack.org.
2012-11-01 05:24:21 +00:00
[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
2013-07-11 07:23:53 +00:00
[AltController]: http://geekhack.org/index.php?topic=12047.0
2012-11-01 05:24:21 +00:00
##Features
* Customizable keymap
* More keymap layers(more Fn keys)
* Mouse keys
* USB NKRO
2013-07-11 07:23:53 +00:00
See README of [tmk_keyboard] for more.
[tmk_keyboard]: http://github.com/tmk/tmk_keyboard
2012-11-01 05:24:21 +00:00
###Pros
2013-07-28 15:53:18 +00:00
* No risks: Everything is all reversible
* No need for PCB trace patching, case cutting or any other destructive mod
2012-11-01 05:24:21 +00:00
* Can keep original controller intact
* Can change all HHKB behaviour as you like
###Cons
* Void your warranty
2013-07-11 07:23:53 +00:00
* Lose USB hub function of Pro2
2012-11-01 05:24:21 +00:00
##DISCLAIMER
2013-07-11 07:23:53 +00:00
I'm not a professional of electronics nor MCU programming. This may damage your HHKB.
2012-11-01 05:24:21 +00:00
And my English writing is poor, I'm not sure I can convey my notions accurately.
2013-07-11 07:23:53 +00:00
##Documents
See [doc/HHKB.txt ](doc/HHKB.txt ) and files under [doc/ ](doc/ ) for internal of HHKB and this controller.
2012-11-01 05:24:21 +00:00
2013-07-11 07:23:53 +00:00
##Build Firmware & Program
2013-07-28 15:53:18 +00:00
See [this document ](../../doc/build.md ) first.
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
### Configuration
Set `MCU` , `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h` .
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
### Build
Just run make after intall tools.
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
$ make
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
Use `Makefile.pjrc` if you want to use PJRC stack instead of LUFA.(LUFA is recommended.)
2012-11-01 05:24:21 +00:00
2013-07-11 07:23:53 +00:00
$ make -f Makefile.pjrc
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
Use `Makefile.vusb` for [V-USB] controller.(not supported actively any more.)
$ make -f Makefile.vusb
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
### Program
First, push reset button on board to start bootloader.
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
This command programs the controller with [dfu-programmer] if the tool is intalled and configured properly.
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
$ make dfu
2012-11-01 05:40:24 +00:00
2013-07-28 15:53:18 +00:00
Or you can also use [FLIP] command to program. Also the tool should be intalled and configured properly. FLIP GUI app is also available.
2012-11-01 05:24:21 +00:00
2013-07-28 15:53:18 +00:00
$ make flip
2012-11-01 05:40:24 +00:00
2013-07-28 15:53:18 +00:00
Use [Teensy Loader] if your controller is Teensy/Teensy++.
2012-11-01 05:40:24 +00:00
2012-11-01 05:24:21 +00:00
2013-07-11 07:23:53 +00:00
##How to Customize
See [tmk_keyboard] documents.
2012-11-01 05:24:21 +00:00
2013-07-11 07:23:53 +00:00
##Hardware
2013-07-28 15:53:18 +00:00
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 cheapear option for DIY.
2013-07-11 07:23:53 +00:00
###1. TMK Alt Controller Board
TMK designed [Keyboard Controller Board for HHKB Pro2(KiCad project) ](https://github.com/tmk/HHKB_controller ).
See [this post ](http://geekhack.org/index.php?topic=12047.msg948923#msg948923 ).
###2. PJRC Teensy++ 2.0 connection
+---------------+
| 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 ](http://www.pjrc.com/teensy/ )
2012-11-01 05:24:21 +00:00
2013-07-11 07:23:53 +00:00
###3. V-USB connection
2012-11-01 05:24:21 +00:00
+---+ +---------------+
2013-07-11 07:23:53 +00:00
USB GND | | ATmega328p |
2012-11-01 05:24:21 +00:00
~~~ C3 | |
2013-07-11 07:23:53 +00:00
5V < ------- + -------- + --- | Vcc , AVCC | HHKB pro pro2
R1 | | ~~~~~~~~ ~~~~
D- < ---- + -- + -----R2----- | INT1 PB2-4 | ------- > ROW (6-8) (5-7)
D+ < ---- | --- + ----R3----- | INT0 PC0-2 | ------- > COL (9-11) (8-10)
Z1 Z2 | PC3|------->ENABLE (12) (11)
GND< ---- + --- + ----------- | GND PB0 | < -------KEY ( 4 ) ( 3 )
| PB1|------->PREV (5) (4)
2012-11-01 05:24:21 +00:00
| |
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
2013-07-11 07:23:53 +00:00
X1: Crystal 12MHz
SW: Push Switch(for bootloader)
- NOTE: See [V-USB] documentation for more detail of hardware and the USB stack.
- NOTE: [USBaspLoader] is very useful for firmware update.
2013-07-28 15:53:18 +00:00
[LUFA]: http://www.fourwalledcubicle.com/LUFA.php
[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html
[dfu-programmer]: http://dfu-programmer.sourceforge.net/
[FLIP]: http://www.atmel.com/tools/FLIP.aspx
[Teensy Loader]: http://www.pjrc.com/teensy/loader.html
2013-07-11 07:23:53 +00:00
[V-USB]: http://www.obdev.at/products/vusb/index.html
[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html
