X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=keyboard%2Fhhkb%2FREADME.md;h=1eb1b426e29cd32aa948ff1187e8df1efa54b321;hb=9ddc33cfdb2068236ba4f212e90f5deb2e54b3bd;hp=b9e0b534a2128909abcf1faa294c87052865b0ea;hpb=d2ea9e80a07ced7c2b6a420ad2bd43a8c6220eac;p=max%2Ftmk_keyboard.git diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md index b9e0b534..1eb1b426 100644 --- a/keyboard/hhkb/README.md +++ b/keyboard/hhkb/README.md @@ -1,160 +1,143 @@ Alternative Controller for HHKB Pro =================================== -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. This controller can work with HHKB Professional and Professional 2 model. +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. -See [this thread][AltController] in geekhack.org. +This controller can work with HHKB **Professional**, **Professional 2**, **JP** and **Type-S**. + +See [this thread][AltController] in geekhack.org for details. [HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/ [AltController]: http://geekhack.org/index.php?topic=12047.0 -[Teensy]: http://www.pjrc.com/teensy/ -##Features +## Update +* Bluetooth module RN-42 is supported.(2015/01) + + +## Features * Customizable keymap * More keymap layers(more Fn keys) * Mouse keys * USB NKRO +* Bluetooth(RN-42) See README of [tmk_keyboard] for more. [tmk_keyboard]: http://github.com/tmk/tmk_keyboard - -###Pros -* No risk: Everything is all reversible -* Without PCB trace cutting, case mod or any destructives + +### Pros +* No risks: Everything is all reversible +* No need for PCB trace patching, case cutting or any other destructive mod * Can keep original controller intact -* Can change all HHKB behaviour as you like +* Can change all HHKB behavior as you like -###Cons +### Cons * Void your warranty * Lose USB hub function of Pro2 -##DISCLAIMER +## DISCLAIMER I'm not a professional of electronics nor MCU programming. This may damage your HHKB. And my English writing is poor, I'm not sure I can convey my notions accurately. - -##Documents +## Quick-Start Guide for TMK Alt Controller +1. Build a custom keyboard layout using the online tool + * Use Chrome if the site does not behave as expected + * Make sure to generate the file using the right template + * Pro2/Pro + * [Bluetooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_rn42) + * [USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb) + + * JP + * [Bluetooth](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp_rn42) + * [USB-only](http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?hhkb_jp) + +1. Save the `.hex` file to your computer; note this is all you need to generate + a custom layout with most of the available features (including mouse control) + * Check-out [the last third of this video](https://www.youtube.com/watch?v=TYmAb8zOPWU&t=561s) + to get an idea of how to build your own layout; it includes how to load to the firmware using FLIP

+ + +1. Download and install the `dfu-programmer` (the alternative to FLIP), open-source available + for Windows, Linux, and Mac OS. e.g., for Mac OS: `brew install dfu-programmer`

+ _Note: This bootloader is all that is required to load/flash the firmware created + using the online tool. You do not need the full `avr-gcc` development stack + because you created the required `.hex` file using the online tool instead._ + +1. Please read and understand this next step in full before running the + following three commands + + ``` + dfu-programmer atmega32u4 erase --force + dfu-programmer atmega32u4 flash .hex + dfu-programmer atmega32u4 launch + ``` + + Or if your are on Unix-like shell you can use command sequence concatinated with `&&` + + ``` + sleep 20 && \ + dfu-programmer atmega32u4 erase --force && \ + dfu-programmer atmega32u4 flash .hex && \ + dfu-programmer atmega32u4 launch + ``` + + * Run commands from the directory where you saved your `.hex` file + * Put controller into programmable mode(bootloader) by hitting the red button located on your controller + * 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. + * `erase` clears existent firmware on flash memory + * `flash` loads new firmware you downloaded + * `launch` restarts keyboard + * See `man dfu-programmer` for details + * Replug controller and redo the process when you are in trouble + + * `sleep 20` gives you time to switch your controller to a programmable mode + These commands execute automatically once the ~ 20 seconds have passed. + + +## HHKB Internals See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller. -##Build Firmware & Program -You can choose some combination of hardware and USB protocol stack([LUFA], [PJRC]). - -### Install Tools -See [this document](../../doc/build.md). - -### TMK Alt Controller Board - $ make -f Makefile.tmk - -This programs the controller with [dfu-programmer] if the tool is intalled and configured properly. - - $ make -f Makefile.tmk dfu - -Push reset button and program with [FLIP]. The tool should be intalled and configured properly. - - $ make -f Makefile.tmk flip +## Build Firmware & Program +See [this document](../../tmk_core/doc/build.md) and [this](https://github.com/tmk/tmk_keyboard/wiki#build-firmware) first. -Or you can also program with FLIP GUI. +### Configuration +Build options and firmware settings are available in `Makefile` and `config.h` or `config_rn42.h`. -[dfu-programmer]: http://dfu-programmer.sourceforge.net/ -[FLIP]: http://www.atmel.com/tools/FLIP.aspx - - -### PJRC Teensy++ -Build with [LUFA] USB stack: - - $ make -f Makefile.lufa - -or with [PJRC] USB stack: - $ make -f Makefile.pjrc +### Keymap +To define your own keymap create file named `keymap_.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files. -Push reset button and program with [Teensy Loader(command line)]. The tool should be intalled and configured properly. - $ make -f Makefile.lufa teensy - $ make -f Makefile.pjrc teensy +### Build +Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like: -Or you can also program with [Teensy Loader(GUI)]. + $ make -f Makefile. KEYMAP= clean + $ make -f Makefile. KEYMAP= -[LUFA]: http://www.fourwalledcubicle.com/LUFA.php -[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html -[Teensy Loader(command line)]: http://www.pjrc.com/teensy/loader_cli.html -[Teensy Loader(GUI)]: http://www.pjrc.com/teensy/loader.html +`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. -###AVR Mega with [V-USB] -Build: - $ make -f Makefile.vusb +### Program +First, push reset button on board to start bootloader. -Program [USBaspLoader] on MCU with AVR programmer like [AVRISPmkII] and tool like [avrdude]. +This command programs the controller with [dfu-programmer] if the tool is installed and configured properly. -You can programs with [avrdude] once you have programmed [USBaspLoader] on MCU. - $ make -f Makefile.vusb program + $ make -f Makefile. KEYMAP= dfu -[AVRISPmkII]: http://www.atmel.com/tools/AVRISPMKII.aspx -[avrdude]: http://www.nongnu.org/avrdude/ +Or you can also use [FLIP] command to program. Also the tool should be installed and configured properly. FLIP GUI application is also available. + $ make -f Makefile. KEYMAP= flip -##How to Customize -See [tmk_keyboard] documents. -##Hardware -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 cheapear option for DIY. +## Hardware -###1. TMK Alt Controller Board -TMK designed [Keyboard Controller Board for HHKB Pro2(KiCad project)](https://github.com/tmk/HHKB_controller). -See [this post](http://geekhack.org/index.php?topic=12047.msg948923#msg948923). - - -###2. PJRC Teensy++ 2.0 connection - +---------------+ - | Teensy++ | - | | - | | HHKB pro HHKB pro2 - | | ~~~~~~~~ ~~~~~~~~~ - | PB0-2|------->ROW (6-8) (5-7) - | PB3-5|------->COL (9-11) (8-10) - | PB6|------->ENABLE (12) (11) - | PE6|<-------KEY (4) (3) - | PE7|------->PREV (5) (4) - | | - | | 5V--- (1-3) (1-2) - | | GND--- (13-14) (12-13) - +---------------+ - -- NOTE: PJRC [Teensy](http://www.pjrc.com/teensy/) -[Teensy Loader]: http://www.pjrc.com/teensy/loader.html +### TMK Alt Controller Board +Preassmbled controller is available from [here](https://geekhack.org/index.php?topic=71517.0). -###3. V-USB connection - +---+ +---------------+ - USB GND | | ATmega328p | - ~~~ C3 | | - 5V <-------+--------+---|Vcc,AVCC | HHKB pro pro2 - R1 | | ~~~~~~~~ ~~~~ - D- <----+--+-----R2-----|INT1 PB2-4|------->ROW (6-8) (5-7) - D+ <----|---+----R3-----|INT0 PC0-2|------->COL (9-11) (8-10) - Z1 Z2 | PC3|------->ENABLE (12) (11) - GND<----+---+-----------|GND PB0|<-------KEY (4) (3) - | PB1|------->PREV (5) (4) - | | - GND+-C2--+--|XTAL1 RXD|------->Debug Console - X1 | TXD|<-------Debug Console - GND+-C3--+--|XTAL2 RST|---SW--+GND - +---------------+ - R1: 1.5K Ohm - R2,R3: 68 Ohm - Z1,Z2: Zener 3.6V - C1,C2: 22pF - C3: 0.1uF - X1: Crystal 12MHz - SW: Push Switch(for bootloader) +You can find design files of the controller at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller). -- NOTE: See [V-USB] documentation for more detail of hardware and the USB stack. -- NOTE: [USBaspLoader] is very useful for firmware update. -[V-USB]: http://www.obdev.at/products/vusb/index.html -[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html +[dfu-programmer]: http://dfu-programmer.sourceforge.net/ +[FLIP]: http://www.atmel.com/tools/FLIP.aspx