qmk_firmware/keyboard/hhkb/README.md

103 lines
4.0 KiB
Markdown
Raw Normal View History

2012-11-01 05:24:21 +00:00
Alternative Controller for HHKB Pro
===================================
2013-11-30 03:32:47 +00:00
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.
2014-07-10 06:28:36 +00:00
This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**.
2013-07-11 07:23:53 +00:00
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
## 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)
2012-11-01 05:24:21 +00:00
##Features
* Customizable keymap
* More keymap layers(more Fn keys)
* Mouse keys
* USB NKRO
* Bluetooth(RN-42)
2012-11-01 05:24:21 +00:00
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
* 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
2014-01-05 03:52:19 +00:00
* Can change all HHKB behavior as you like
2012-11-01 05:24:21 +00:00
###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
See [this document](../../doc/build.md) first.
2012-11-01 05:24:21 +00:00
### Configuration
2015-01-10 16:54:17 +00:00
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.
2012-11-01 05:24:21 +00:00
### Build
2013-11-30 03:32:47 +00:00
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
2012-11-01 05:24:21 +00:00
$ 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**.
2012-11-01 05:24:21 +00:00
### Program
First, push reset button on board to start bootloader.
2012-11-01 05:24:21 +00:00
2014-01-05 03:52:19 +00:00
This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
2012-11-01 05:24:21 +00:00
$ make -f Makefile.<variant> KEYMAP=<name> dfu
2012-11-01 05:40:24 +00:00
2014-01-05 03:52:19 +00:00
Or you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.
2012-11-01 05:24:21 +00:00
$ make -f Makefile.<variant> KEYMAP=<name> flip
2012-11-01 05:40:24 +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-11-30 03:32:47 +00:00
##Keymap
2014-07-10 06:28:36 +00:00
To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../doc/keymap.md) and existent keymap files.
2012-11-01 05:24:21 +00:00
2013-07-11 07:23:53 +00:00
##Hardware
2014-01-05 03:52:19 +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 cheaper option for DIY.
2013-07-11 07:23:53 +00:00
###1. TMK Alt Controller Board
2014-07-10 06:28:36 +00:00
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.
###2. PJRC Teensy
See [this thread](http://geekhack.org/index.php?topic=57008.0).
2012-11-01 05:24:21 +00:00
2013-11-30 03:32:47 +00:00
###3. V-USB version
2014-07-10 06:28:36 +00:00
See [V-USB controller for HHKB](doc/V-USB.md).
2013-07-11 07:23:53 +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