X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=keyboard%2Fhhkb%2FREADME.md;h=1eb1b426e29cd32aa948ff1187e8df1efa54b321;hb=d987783c1a28274a2bb35ce59f1de71f143dc0c0;hp=f7e96126bcb168c0e2b7813795bf20d00065e138;hpb=77f157943f4e083fb9f1eaa0a55078b128842458;p=max%2Ftmk_keyboard.git
diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md
index f7e96126..1eb1b426 100644
--- a/keyboard/hhkb/README.md
+++ b/keyboard/hhkb/README.md
@@ -1,138 +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. For this purpose I used PJRC [Teensy++][Teensy] as alternative controller.
+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 for details.
[HHKB]: http://www.pfu.fujitsu.com/hhkeyboard/
-[Teensy]: http://www.pjrc.com/teensy/
+[AltController]: http://geekhack.org/index.php?topic=12047.0
-My keyboard firmware source tree is here: http://github.com/tmk/tmk_keyboard
-See directory keyboard/hhkb to build firmware for HHKB.
+## Update
+* Bluetooth module RN-42 is supported.(2015/01)
-##Features
+## Features
* Customizable keymap
* More keymap layers(more Fn keys)
* Mouse keys
* USB NKRO
+* Bluetooth(RN-42)
+
+See README of [tmk_keyboard] for more.
-###Pros
-* Without PCB trace cutting, case mod or any destructives
+[tmk_keyboard]: http://github.com/tmk/tmk_keyboard
+
+### 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 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.
+## 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.
+## 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
-##Build Firmware
-You can choose some combination of MCU and USB protocol stack.
+ ```
+ dfu-programmer atmega32u4 erase --force
+ dfu-programmer atmega32u4 flash .hex
+ dfu-programmer atmega32u4 launch
+ ```
-### Teensy++(AVR USB family) with [LUFA]
-0. Edit **matrix.c** to use your pin configuration. See doc/HHKB.txt for detail.
+ Or if your are on Unix-like shell you can use command sequence concatinated with `&&`
-1. Edit **keymap.c** to use your favoirte keymap.
+ ```
+ sleep 20 && \
+ dfu-programmer atmega32u4 erase --force && \
+ dfu-programmer atmega32u4 flash .hex && \
+ dfu-programmer atmega32u4 launch
+ ```
-2. Edit **Makefile** if you want to use other `MCU` than Teensy++ 2.0.
+ * 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
-3. Build firmware binary file:
- `$ make -f Makefile.lufa`
+ * `sleep 20` gives you time to switch your controller to a programmable mode
+ These commands execute automatically once the ~ 20 seconds have passed.
-4. Program MCU with PJRC [Teensy Loader] tool. If you install command line version of the loader just run:
- `$ make -f Makefile.lufa teensy`
-[LUFA]: http://www.fourwalledcubicle.com/LUFA.php
-[Teensy Loader]: http://www.pjrc.com/teensy/loader.html
+## HHKB Internals
+See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HHKB and this controller.
-###AVR Mega with [V-USB]
-Follow below if you want to use AVR with V-USB as .
+## Build Firmware & Program
+See [this document](../../tmk_core/doc/build.md) and [this](https://github.com/tmk/tmk_keyboard/wiki#build-firmware) first.
-0. Edit **matrix.c** to use your pin configuration. See doc/HHKB.txt for detail.
+### Configuration
+Build options and firmware settings are available in `Makefile` and `config.h` or `config_rn42.h`.
-1. Edit **keymap.c** to use your favoirte keymap.
-2. Edit **usbconfig.h** to configure V-USB options.
+### Keymap
+To define your own keymap create file named `keymap_.c` and see [keymap document](../../tmk_core/doc/keymap.md) and existent keymap files.
-3. Edit **Makefile.vusb** to define `MCU` and `F_CPU`.
-4. Build firmware binary file:
- `$ make -f Makefile.vusb`
+### 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:
-5. Program MCU with AVR programmer like AVRISPmkII. If you already have [USBaspLoader] on MCU just run:
- `$ make -f Makefile.vusb program`
+ $ make -f Makefile. KEYMAP= clean
+ $ make -f Makefile. KEYMAP=
-[V-USB]: http://www.obdev.at/products/vusb/index.html
-[USBaspLoader]: http://www.obdev.at/products/vusb/usbasploader.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.
-###How to Customize Keymap
-Later...
-See **keymap.c**.
+### Program
+First, push reset button on board to start bootloader.
+This command programs the controller with [dfu-programmer] if the tool is installed and configured properly.
-##Hardware
+ $ make -f Makefile. KEYMAP= dfu
-###Teensy++ installation
-Angled USB mini B adapter is used to install Teensy++ laterally.
+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
-Bread baord wires are used to connect Teensy++.
-
-
+## Hardware
+### TMK Alt Controller Board
+Preassmbled controller is available from [here](https://geekhack.org/index.php?topic=71517.0).
-###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)
- | |
- | |
- | |
- +---------------+
+You can find design files of the controller at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller).
-###V-USB circuit
- +---+ +---------------+
- USB GND | | ATmega168 |
- ~~~ 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)
- | |
- 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 20MHz(16MHz/12MHz)
- SW: Push Switch(Optional for bootloader)
+[dfu-programmer]: http://dfu-programmer.sourceforge.net/
+[FLIP]: http://www.atmel.com/tools/FLIP.aspx