Added terminal_usb adapter for IBM Terminal keyboard.

[max/tmk_keyboard.git] / hhkb / README

diff --git a/hhkb/README b/hhkb/README
index 2a441810161e59747b9fe67bea22a586c583a392..65f7dcab5a8c58d41d8af88fa47eb20fffe6f002 100644 (file)
--- a/hhkb/README
+++ b/hhkb/README
@@ -4,7 +4,7 @@ Alternative Controller for HHKB
 Feature
 -------
 - Mouse Keys
-- NKRO on USB
+- NKRO on USB(PJRC Tennsy only)
 - Keymap Layers
 
 
@@ -13,8 +13,11 @@ Customize Keymap
 see keymap.c.
 
 
-Build for Teensy
-----------------
+
+Build
+=====
+PJRC Teensy
+-----------
 0. Edit matrix.c.
     adjust scan code to your pin configuration.(see doc/HHKB.txt for pinouts)
 1. Define macros in config_pjrc.h.(Optional)
@@ -22,15 +25,15 @@ Build for Teensy
     IS_COMMAND
 2. Edit Makefile for MCU setting and build options.
     MCU, F_CPU
-    MOUSEKEY_ENABLE, USB_EXTRA_ENABLE, USB_NKRO_ENABLE
+    MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, NKRO_ENABLE
 3. Build hex file.
-    $ make
+    $ make -f Makefile.pjrc
 4. Program MCU.
-    $  make program
+    $  make -f Makefile.pjrc program
 
 
-Build for V-USB
----------------
+V-USB
+-----
 0. Edit matrix.c and usbconfig.h.
     adjust scan code to your pin configuration.(see doc/HHKB.txt for pinouts)
     define macros for V-USB in usbconfig.h.
@@ -38,7 +41,7 @@ Build for V-USB
     IS_COMMAND
 2. Edit Makefile.vusb for MCU setting and build options.
     MCU, F_CPU
-    MOUSEKEY_ENABLE, USB_EXTRA_ENABLE, USB_NKRO_ENABLE
+    MOUSEKEY_ENABLE, EXTRAKEY_ENABLE
 3. Build hex file.
     $ make -f Makefile.vusb
 4. Program MCU.
@@ -52,21 +55,59 @@ Build for V-USB
     http://www.obdev.at/products/vusb/usbasploader.html
 
 
-V-USB Circuit
--------------
+iWRAP
+-----
+0. Edit matrix.c and usbconfig.h.
+    adjust scan code to your pin configuration.(see doc/HHKB.txt for pinouts)
+    define macros for V-USB in usbconfig.h.
+1. Define macros in config_iwrap.h.(Optional)
+    IS_COMMAND
+2. Edit Makefile.iwrap for MCU setting and build options.
+    MCU, F_CPU
+    MOUSEKEY_ENABLE, EXTRAKEY_ENABLE
+3. Build hex file.
+    $ make -f Makefile.iwrap
+4. Program MCU.
+    $  make -f Makefile.iwrap program
+
+
+
+Hardware
+========
+PJRC Teensy
+-----------
+                        +---------------+
+                        |   Teensy++    |
+                        |               |
+                        |               |        HHKB
+                        |               |        ~~~~
+                        |          PB0-2|------->ROW(6-8)
+                        |          PB3-5|------->COL(9-11)
+                        |            PB6|------->ENABLE(12)
+                        |            PE6|<-------KEY(4)
+                        |            PE7|------->PREV(5)
+                        |               |
+                        |               |
+                        |               |
+                        +---------------+
+
+
+V-USB
+-----
                 +---+   +---------------+
 USB            GND  |   |   ATmega168   |
-===                 C3  |               |
+~~~                 C3  |               |
 5V <-------+--------+---|Vcc,AVCC       |        HHKB
-           R1           |               |        ====
-D- <----+--+-----R2-----|INT1      PB0-2|------->ROW
-D+ <----|---+----R3-----|INT0      PB3-5|------->COL
-        Z1  Z2          |            PB6|------->ENABLE
-GND<----+---+--+--+-----|GND         PE6|------->KEY
-               |  |     |            PE7|------->PREV
-               |  C2-+--|XTAL1          |        (see doc/HHKB.txt for pinouts)
-               |     X1 |               |
-               +--C3-+--|XTAL2       RST|---SW--+GND
+           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
@@ -77,4 +118,34 @@ X1:     Crystal 20MHz(16MHz/12MHz)
 SW:     Push Switch(Optional for bootloader)
 
 
+iWRAP
+-----
+                        +---------------+        WT12
+              5V        |   ATmega168   | 5V/3.3V~~~~
+              +-----+---|Vcc,AVCC    PC4|---/--->iWRAP(RxD)
+USB           |     C3  |            PC5|<--/----iWRAP(TxD)
+~~~           |     +   |               | 
+5V <--BATT    +    GND  |               |        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 12MHz
+SW:     Push Switch(Optional)
+BATT:   Li-Po Battery, Battery Charger and Voltage Regulator(5V and 3.3V).
+
+
 EOF