]> git.friedersdorff.com Git - max/tmk_keyboard.git/blob - keyboard/hhkb/README.md
lufa: Update makefile for new LUFA
[max/tmk_keyboard.git] / 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 ## Quick-Start Guide for TMK Alt Controller
43 1. Build a custom keyboard layout using the online tool
44    * Use Chrome if the site does not behave as expected
45    * Make sure to generate the file using the right template
46       *  Pro2/Pro
47          * [Bluetooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_rn42)
48          * [USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb)
49
50       *  JP
51          * [Bluetooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp_rn42)
52          * [USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp)
53
54 1. Save the `.hex` file to your computer; note this is all you need to generate
55    a custom layout with most of the available features (including mouse control)
56     *  Check-out [the last third of this video](https://www.youtube.com/watch?v=TYmAb8zOPWU&t=561s)
57        to get an idea of how to build your own layout; it includes how to load to the firmware using FLIP<P>
58
59
60 1. Download and install the `dfu-programmer` (the alternative to FLIP), open-source available
61    for Windows, Linux, and Mac OS.  e.g., for Mac OS: `brew install dfu-programmer` <P>
62    _Note: This bootloader is all that is required to load/flash the firmware created
63    using the online tool. You do not need the full `avr-gcc` development stack
64    because you created the required `.hex` file using the online tool instead._
65
66 1. Please read and understand this next step in full before running the
67    following three commands
68
69    ```
70    dfu-programmer atmega32u4 erase --force
71    dfu-programmer atmega32u4 flash <your_downloaded_file>.hex
72    dfu-programmer atmega32u4 launch
73    ```
74
75    Or if your are on Unix-like shell you can use command sequence concatinated with `&&`
76
77    ```
78    sleep 20 && \
79    dfu-programmer atmega32u4 erase --force && \
80    dfu-programmer atmega32u4 flash <your_downloaded_file>.hex && \
81    dfu-programmer atmega32u4 launch
82    ```
83
84    * Run commands from the directory where you saved your `.hex` file
85    * Put controller into programmable mode(bootloader) by hitting the red button located on your controller
86    * Once in this mode, you will no longer have access to your HHKB, you need other keyboard to input the commands or mouse to copy and paste.
87    * `erase` clears existent firmware on flash memory
88    * `flash` loads new firmware you downloaded
89    * `launch` restarts keyboard
90    * See `man dfu-programmer` for details
91    * Replug controller and redo the process when you are in trouble
92
93    * `sleep 20` gives you time to switch your controller to a programmable mode
94      These commands execute automatically once the ~ 20 seconds have passed.
95
96
97 ## HHKB Internals
98 See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
99
100
101 ## Build Firmware & Program
102 See [this document](../../tmk_core/doc/build.md) and [this](https://github.com/tmk/tmk_keyboard/wiki#build-firmware) first.
103
104 ### Configuration
105 Build options and firmware settings are available in `Makefile` and `config.h` or `config_rn42.h`.
106
107
108 ### Keymap
109 To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.
110
111
112 ### Build
113 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
114
115     $ make -f Makefile.<variant> KEYMAP=<name> clean
116     $ make -f Makefile.<variant> KEYMAP=<name>
117
118 `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.
119
120
121 ### Program
122 First, push reset button on board to start bootloader.
123
124 This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
125
126     $ make -f Makefile.<variant> KEYMAP=<name> dfu
127
128 Or you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available.
129
130     $ make -f Makefile.<variant> KEYMAP=<name> flip
131
132
133
134 ## Hardware
135
136 ### TMK Alt Controller Board
137 Preassmbled controller is available from [here](https://geekhack.org/index.php?topic=71517.0).
138
139 You can find design files of the controller at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller).
140
141
142 [dfu-programmer]: http://dfu-programmer.sourceforge.net/
143 [FLIP]: http://www.atmel.com/tools/FLIP.aspx