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 for details.
   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
  16
  17 ## Features
  18 * Customizable keymap
  19 * More keymap layers(more Fn keys)
  20 * Mouse keys
  21 * USB NKRO
  22 * Bluetooth(RN-42)
  23
  24 See README of [tmk_keyboard] for more.
  25
  26 [tmk_keyboard]: http://github.com/tmk/tmk_keyboard
  27
  28 ### Pros
  29 * No risks: Everything is all reversible
  30 * No need for PCB trace patching, case cutting or any other destructive mod
  31 * Can keep original controller intact
  32 * Can change all HHKB behavior as you like
  33
  34 ### Cons
  35 * Void your warranty
  36 * Lose USB hub function of Pro2
  37
  38 ## DISCLAIMER
  39 I'm not a professional of electronics nor MCU programming. This may damage your HHKB.
  40 And my English writing is poor, I'm not sure I can convey my notions accurately.
  41
  42
  43 ## HHKB Internals
  44 See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
  45
  46
  47 ## Build Firmware & Program
  48 See [this document](../../tmk_core/doc/build.md) and [this](https://github.com/tmk/tmk_keyboard/wiki#build-firmware) first.
  49
  50 ### Configuration
  51 Build options and firmware settings are available in `Makefile` and `config.h` or `config_rn42.h`.
  52
  53
  54 ### Keymap
  55 To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.
  56
  57
  58 ### Build
  59 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
  60
  61     $ make -f Makefile.<variant> KEYMAP=<name> clean
  62     $ make -f Makefile.<variant> KEYMAP=<name>
  63
  64 `Makefile` can be used for **Pro2 and Pro** USB controller, `Makefile.jp` for **JP**, `Makefile.rn42` for **Pro2** Bluetooth and `Makefile.rn42.jp` for **JP** Bluetooth.
  65
  66
  67 ### Program
  68 First, push reset button on board to start bootloader.
  69
  70 This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
  71
  72     $ make -f Makefile.<variant> KEYMAP=<name> dfu
  73
  74 Or you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.
  75
  76     $ make -f Makefile.<variant> KEYMAP=<name> flip
  77
  78
  79
  80 ## Hardware
  81
  82 ### TMK Alt Controller Board
  83 Preassmbled controller is available from [here](https://geekhack.org/index.php?topic=71517.0).
  84
  85 You can find design files of the controller at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller).
  86
  87
  88 [dfu-programmer]: http://dfu-programmer.sourceforge.net/
  89 [FLIP]: http://www.atmel.com/tools/FLIP.aspx