X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;ds=inline;f=keyboard%2Fhhkb%2FREADME.md;h=d4a2cd0223959846a0d54a6f08f8c3980cdeb90b;hb=5a8dbc63ea29eb454ad5f36de5c6c33172230f88;hp=9213648237b6a3b5aea49e6fda3d68e8b66b499d;hpb=0b917d4f109637f7e2d584d04396a0d6396fad33;p=max%2Ftmk_keyboard.git diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md index 92136482..d4a2cd02 100644 --- a/keyboard/hhkb/README.md +++ b/keyboard/hhkb/README.md @@ -2,7 +2,7 @@ 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**, **Professional** 2 and **Type-S**. +This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**. See [this thread][AltController] in geekhack.org. @@ -24,7 +24,7 @@ See README of [tmk_keyboard] for more. * 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 * Void your warranty @@ -43,7 +43,7 @@ See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HH See [this document](../../doc/build.md) first. ### Configuration -Set `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`. +Set `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`. If your target is **HHKB JP** you need to set `HHKB_JP` build option in `Makefile`. ### 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: @@ -54,11 +54,11 @@ Several version of keymap are available in advance but you are recommended to de ### Program First, push reset button on board to start bootloader. -This command programs the controller with [dfu-programmer] if the tool is intalled and configured properly. +This command programs the controller with [dfu-programmer] if the tool is installed and configured properly. $ make dfu -Or you can also use [FLIP] command to program. Also the tool should be intalled and configured properly. FLIP GUI app is also available. +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 flip @@ -66,37 +66,22 @@ Use [Teensy Loader] if your controller is Teensy/Teensy++. ##Keymap -To define your own keymap create file named `keymap_.c` and see keymap document(you can find in top README.md) and existent keymap files. +To define your own keymap create file named `keymap_.c` and see [keymap document](../../doc/keymap.md) and existent keymap files. ##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. +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. ###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 version - +---------------+ - | 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/) +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. + + +###2. PJRC Teensy +See [this thread](http://geekhack.org/index.php?topic=57008.0). + ###3. V-USB version -See [V-USB controller for HHKB](doc/V-USB.md) +See [V-USB controller for HHKB](doc/V-USB.md). [LUFA]: http://www.fourwalledcubicle.com/LUFA.php