X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=keyboard%2Fhhkb%2FREADME.md;h=da85bceb567014771bc0edc20dfd64ea860ce198;hb=39d4f923cded1dd8f46a03ed757390a77f45e2c4;hp=3959ae85a8be6f9b1df8ccb1f4422b413826942a;hpb=e7c2af78b704bfddb581559d42cc7cc31ffab0bf;p=max%2Ftmk_keyboard.git diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md index 3959ae85..da85bceb 100644 --- a/keyboard/hhkb/README.md +++ b/keyboard/hhkb/README.md @@ -1,8 +1,8 @@ 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. + +This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**. See [this thread][AltController] in geekhack.org. @@ -10,11 +10,17 @@ See [this thread][AltController] in geekhack.org. [AltController]: http://geekhack.org/index.php?topic=12047.0 +## Update +* Bluetooth module RN-42 is supported.(2015/01) +* V-USB and iWRAP are no longer supported now, but still it'll works with a little fix. See not_supported directory.(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. @@ -24,7 +30,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 @@ -40,93 +46,52 @@ See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HH ##Build Firmware & Program -See [this document](../../doc/build.md) first. +See [this document](../../tmk_core/doc/build.md) first. ### Configuration -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` or use `Makefile.jp` instead of `Makefile`. -### Build -Just run make after intall tools. +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. - $ make +### 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: -Use `Makefile.pjrc` if you want to use PJRC stack instead of LUFA.(LUFA is recommended.) + $ make -f Makefile. KEYMAP=(hasu|hhkb|spacefn|) - $ make -f Makefile.pjrc +You can omit `-f` option when you use `Makefile`. `Makefile` is used for **Pro2 and Pro**, `Makefile.jp` fits for **JP** model and `Makefile.rn42` supports Bluetooth module **RN-42**. `Makefile.pjrc` uses **PJRC** as output protocol instead of **LUFA**. -Use `Makefile.vusb` for [V-USB] controller.(not supported actively any more.) - $ make -f Makefile.vusb ### 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 + $ make -f Makefile. KEYMAP= 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 + $ make -f Makefile. KEYMAP= flip Use [Teensy Loader] if your controller is Teensy/Teensy++. -##How to Customize -See [tmk_keyboard] documents. +##Keymap +To define your own keymap create file named `keymap_.c` and see [keymap document](../../tmk_core/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 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/) - -###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) - -- NOTE: See [V-USB] documentation for more detail of hardware and the USB stack. -- NOTE: [USBaspLoader] is very useful for firmware update. +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). [LUFA]: http://www.fourwalledcubicle.com/LUFA.php @@ -135,4 +100,3 @@ See [this post](http://geekhack.org/index.php?topic=12047.msg948923#msg948923). [FLIP]: http://www.atmel.com/tools/FLIP.aspx [Teensy Loader]: http://www.pjrc.com/teensy/loader.html [V-USB]: http://www.obdev.at/products/vusb/index.html -[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html