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
-controller with programmable one. For this purpose I used PJRC [Teensy++][Teensy] as alternative controller.
+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 controller with programmable one.
-[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
-[Teensy]: http://www.pjrc.com/teensy/
+This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**.
+See [this thread][AltController] in geekhack.org.
-My keyboard firmware source tree is here: http://github.com/tmk/tmk_keyboard
-See directory keyboard/hhkb to build firmware for HHKB.
+[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
+[AltController]: http://geekhack.org/index.php?topic=12047.0
##Features
* Mouse keys
* USB NKRO
+See README of [tmk_keyboard] for more.
+
+[tmk_keyboard]: http://github.com/tmk/tmk_keyboard
+
###Pros
-* Without PCB trace cutting, case mod or any destructives
+* 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 behaviour as you like
+* Can change all HHKB behavior as you like
###Cons
* Void your warranty
-* Lose USB hub function in case of Pro2
+* Lose USB hub function of Pro2
##DISCLAIMER
-I'm not a professional of electronics or MCU programming. This may damage your HHKB.
+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](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
+##Build Firmware & Program
+See [this document](../../doc/build.md) 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 Firmware
-You can choose some combination of MCU and USB protocol stack.
+### 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:
-### Teensy++(AVR USB family) with [LUFA]
-0. Edit **matrix.c** to use your pin configuration. See doc/HHKB.txt for detail.
+ $ make KEYMAP=[hasu|hhkb|spacefn|<name>]
-1. Edit **keymap.c** to use your favoirte keymap.
-2. Edit **Makefile** if you want to use other `MCU` than Teensy++ 2.0.
+### Program
+First, push reset button on board to start bootloader.
-3. Build firmware binary file:
- `$ make -f Makefile.lufa`
+This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
-4. Program MCU with PJRC [Teensy Loader] tool. If you install command line version of the loader just run:
- `$ make -f Makefile.lufa teensy`
-
-[LUFA]: http://www.fourwalledcubicle.com/LUFA.php
-[Teensy Loader]: http://www.pjrc.com/teensy/loader.html
+ $ 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.
-###AVR Mega with [V-USB]
-Follow below if you want to use AVR with V-USB as .
+ $ make flip
-0. Edit **matrix.c** to use your pin configuration. See doc/HHKB.txt for detail.
+Use [Teensy Loader] if your controller is Teensy/Teensy++.
-1. Edit **keymap.c** to use your favoirte keymap.
-2. Edit **usbconfig.h** to configure V-USB options.
+##Keymap
+To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../doc/keymap.md) and existent keymap files.
-3. Edit **Makefile.vusb** to define `MCU` and `F_CPU`.
-4. Build firmware binary file:
- `$ make -f Makefile.vusb`
+##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.
-5. Program MCU with AVR programmer like AVRISPmkII. If you already have [USBaspLoader] on MCU just run:
- `$ make -f Makefile.vusb program`
+###1. TMK Alt Controller Board
+Design files are available at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller) and see [Controller Distribution thread](http://geekhack.org/index.php?topic=56494.0) if you get an assembled one.
-[V-USB]: http://www.obdev.at/products/vusb/index.html
-[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html
+###2. PJRC Teensy
+See [this thread](http://geekhack.org/index.php?topic=57008.0).
-###How to Customize Keymap
-Later...
-See **keymap.c**.
+###3. V-USB version
+See [V-USB controller for HHKB](doc/V-USB.md).
-##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)
+[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
+[V-USB]: http://www.obdev.at/products/vusb/index.html
projects / tmk_firmware.git / blobdiff