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