keyboard/hhkb/README.md

   1 Alternative Controller for HHKB Pro
   2 ===================================
   3 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.
   4
   5 This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**.
   6
   7 See [this thread][AltController] in geekhack.org.
   8
   9 [HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
  10 [AltController]: http://geekhack.org/index.php?topic=12047.0
  11
  12
  13 ## Update
  14 * Bluetooth module RN-42 is supported.(2015/01)
  15 * V-USB and iWRAP are no longer supported now, but still it'll works with a little fix. See not_supported directory.(2015/01)
  16
  17
  18 ##Features
  19 * Customizable keymap
  20 * More keymap layers(more Fn keys)
  21 * Mouse keys
  22 * USB NKRO
  23 * Bluetooth(RN-42)
  24
  25 See README of [tmk_keyboard] for more.
  26
  27 [tmk_keyboard]: http://github.com/tmk/tmk_keyboard
  28
  29 ###Pros
  30 * No risks: Everything is all reversible
  31 * No need for PCB trace patching, case cutting or any other destructive mod
  32 * Can keep original controller intact
  33 * Can change all HHKB behavior as you like
  34
  35 ###Cons
  36 * Void your warranty
  37 * Lose USB hub function of Pro2
  38
  39 ##DISCLAIMER
  40 I'm not a professional of electronics nor MCU programming. This may damage your HHKB.
  41 And my English writing is poor, I'm not sure I can convey my notions accurately.
  42
  43
  44 ##Documents
  45 See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
  46
  47
  48 ##Build Firmware & Program
  49 See [this document](../../doc/build.md) first.
  50
  51 ### Configuration
  52 If your target is **HHKB JP** you need to set `HHKB_JP` build option in `Makefile` or use `Makefile.jp` instead of `Makefile`.
  53
  54 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.
  55
  56 ### Build
  57 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
  58
  59     $ make -f Makefile.<jp|pjrc|rn42> KEYMAP=(hasu|hhkb|spacefn|<name>)
  60
  61 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**.
  62
  63
  64 ### Program
  65 First, push reset button on board to start bootloader.
  66
  67 This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
  68
  69     $ make -f Makefile.<variant> KEYMAP=<name> dfu
  70
  71 Or you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.
  72
  73     $ make -f Makefile.<variant> KEYMAP=<name> flip
  74
  75 Use [Teensy Loader] if your controller is Teensy/Teensy++.
  76
  77
  78 ##Keymap
  79 To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../doc/keymap.md) and existent keymap files.
  80
  81
  82 ##Hardware
  83 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.
  84
  85 ###1. TMK Alt Controller Board
  86 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.
  87
  88
  89 ###2. PJRC Teensy
  90 See [this thread](http://geekhack.org/index.php?topic=57008.0).
  91
  92
  93 ###3. V-USB version
  94 See [V-USB controller for HHKB](doc/V-USB.md).
  95
  96
  97 [LUFA]: http://www.fourwalledcubicle.com/LUFA.php
  98 [PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html
  99 [dfu-programmer]: http://dfu-programmer.sourceforge.net/
 100 [FLIP]: http://www.atmel.com/tools/FLIP.aspx
 101 [Teensy Loader]: http://www.pjrc.com/teensy/loader.html
 102 [V-USB]: http://www.obdev.at/products/vusb/index.html