X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=keyboard%2Fhhkb%2FREADME.md;h=3959ae85a8be6f9b1df8ccb1f4422b413826942a;hb=e93188021c0b1578ffbb6e0fadcd94e1e5132dcf;hp=f7e96126bcb168c0e2b7813795bf20d00065e138;hpb=77f157943f4e083fb9f1eaa0a55078b128842458;p=max%2Ftmk_keyboard.git diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md index f7e96126..3959ae85 100644 --- a/keyboard/hhkb/README.md +++ b/keyboard/hhkb/README.md @@ -2,14 +2,12 @@ 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. For this purpose I used PJRC [Teensy++][Teensy] as alternative controller. - -[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/ -[Teensy]: http://www.pjrc.com/teensy/ +controller with programmable one. This controller can work with HHKB Professional and Professional 2 model. +See [this thread][AltController] in geekhack.org. -My keyboard firmware source tree is here: http://github.com/tmk/tmk_keyboard -See directory keyboard/hhkb to build firmware for HHKB. +[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/ +[AltController]: http://geekhack.org/index.php?topic=12047.0 ##Features @@ -18,112 +16,102 @@ See directory keyboard/hhkb to build firmware for HHKB. * Mouse keys * USB NKRO +See README of [tmk_keyboard] for more. + +[tmk_keyboard]: http://github.com/tmk/tmk_keyboard + ###Pros -* Without PCB trace cutting, case mod or any destructives +* 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 ###Cons * Void your warranty -* Lose USB hub function in case of Pro2 +* Lose USB hub function of Pro2 ##DISCLAIMER -I'm not a professional of electronics or MCU programming. This may damage your HHKB. +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 +See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller. +##Build Firmware & Program +See [this document](../../doc/build.md) first. +### Configuration +Set `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`. -##Build Firmware -You can choose some combination of MCU and USB protocol stack. - -### Teensy++(AVR USB family) with [LUFA] -0. Edit **matrix.c** to use your pin configuration. See doc/HHKB.txt for detail. - -1. Edit **keymap.c** to use your favoirte keymap. - -2. Edit **Makefile** if you want to use other `MCU` than Teensy++ 2.0. - -3. Build firmware binary file: - `$ make -f Makefile.lufa` - -4. Program MCU with PJRC [Teensy Loader] tool. If you install command line version of the loader just run: - `$ make -f Makefile.lufa teensy` +### Build +Just run make after intall tools. -[LUFA]: http://www.fourwalledcubicle.com/LUFA.php -[Teensy Loader]: http://www.pjrc.com/teensy/loader.html + $ make +Use `Makefile.pjrc` if you want to use PJRC stack instead of LUFA.(LUFA is recommended.) -###AVR Mega with [V-USB] -Follow below if you want to use AVR with V-USB as . + $ make -f Makefile.pjrc -0. Edit **matrix.c** to use your pin configuration. See doc/HHKB.txt for detail. +Use `Makefile.vusb` for [V-USB] controller.(not supported actively any more.) + $ make -f Makefile.vusb -1. Edit **keymap.c** to use your favoirte keymap. +### Program +First, push reset button on board to start bootloader. -2. Edit **usbconfig.h** to configure V-USB options. +This command programs the controller with [dfu-programmer] if the tool is intalled and configured properly. -3. Edit **Makefile.vusb** to define `MCU` and `F_CPU`. + $ make dfu -4. Build firmware binary file: - `$ make -f Makefile.vusb` +Or you can also use [FLIP] command to program. Also the tool should be intalled and configured properly. FLIP GUI app is also available. -5. Program MCU with AVR programmer like AVRISPmkII. If you already have [USBaspLoader] on MCU just run: - `$ make -f Makefile.vusb program` + $ make flip -[V-USB]: http://www.obdev.at/products/vusb/index.html -[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.html +Use [Teensy Loader] if your controller is Teensy/Teensy++. -###How to Customize Keymap -Later... -See **keymap.c**. +##How to Customize +See [tmk_keyboard] documents. ##Hardware - -###Teensy++ installation -Angled USB mini B adapter is used to install Teensy++ laterally. - -![Image of Teensy install](hhkb/doc/HHKB_img/teensy_install.jpg) - -Bread baord wires are used to connect Teensy++. - -![Image of Teensy wiring](hhkb/doc/HHKB_img/teensy_wiring.jpg) - -![Image of Connector](hhkb/doc/HHKB_img/connector_contact.jpg) - - -###PJRC Teensy++ 2.0 connection - +---------------+ - | Teensy++ | - | | - | | HHKB - | | ~~~~ - | PB0-2|------->ROW(6-8) - | PB3-5|------->COL(9-11) - | PB6|------->ENABLE(12) - | PE6|<-------KEY(4) - | PE7|------->PREV(5) - | | - | | - | | - +---------------+ - - -###V-USB circuit +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. + +###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 | | ATmega168 | + USB GND | | ATmega328p | ~~~ C3 | | - 5V <-------+--------+---|Vcc,AVCC | HHKB - R1 | | ~~~~ - D- <----+--+-----R2-----|INT1 PB2-4|------->ROW(6-8) - D+ <----|---+----R3-----|INT0 PC0-2|------->COL(9-11) - Z1 Z2 | PC3|------->ENABLE(12) - GND<----+---+-----------|GND PB0|<-------KEY(4) - | PB1|------->PREV(5) + 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 @@ -134,5 +122,17 @@ Bread baord wires are used to connect Teensy++. Z1,Z2: Zener 3.6V C1,C2: 22pF C3: 0.1uF - X1: Crystal 20MHz(16MHz/12MHz) - SW: Push Switch(Optional for bootloader) + 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. + + +[LUFA]: http://www.fourwalledcubicle.com/LUFA.php +[PJRC]: http://www.pjrc.com/teensy/usb_keyboard.html +[dfu-programmer]: http://dfu-programmer.sourceforge.net/ +[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