]> git.gir.st - tmk_keyboard.git/blob - hhkb/README
added HHKB/README and clean some codes.
[tmk_keyboard.git] / hhkb / README
1 Alternative Controller for HHKB
2 ===============================
3
4 Feature
5 -------
6 - Mouse Keys
7 - NKRO on USB
8 - Keymap Layers
9
10
11 Customize Keymap
12 ----------------
13 see keymap.c.
14
15
16 Build for Teensy
17 ----------------
18 0. Edit matrix.c.
19 adjust scan code to your pin configuration.(see doc/HHKB.txt for pinouts)
20 1. Define macros in config_pjrc.h.(Optional)
21 VENDOR_ID, PRODUCT_ID and string descriptor.
22 IS_COMMAND
23 2. Edit Makefile for MCU setting and build options.
24 MCU, F_CPU
25 MOUSEKEY_ENABLE, USB_EXTRA_ENABLE, USB_NKRO_ENABLE
26 3. Build hex file.
27 $ make
28 4. Program MCU.
29 $ make program
30
31
32 Build for V-USB
33 ---------------
34 0. Edit matrix.c and usbconfig.h.
35 adjust scan code to your pin configuration.(see doc/HHKB.txt for pinouts)
36 define macros for V-USB in usbconfig.h.
37 1. Define macros in config_vusb.h.(Optional)
38 IS_COMMAND
39 2. Edit Makefile.vusb for MCU setting and build options.
40 MCU, F_CPU
41 MOUSEKEY_ENABLE, USB_EXTRA_ENABLE, USB_NKRO_ENABLE
42 3. Build hex file.
43 $ make -f Makefile.vusb
44 4. Program MCU.
45 $ make -f Makefile.vusb program
46
47 Using a bootloader to program for convenience is recommended.
48 Once program this V-USB bootloader at first, you can program MCU without
49 extra programmer. You should have reset switch to start up as bootloader
50 mode in this case.
51 USBaspLoader:
52 http://www.obdev.at/products/vusb/usbasploader.html
53
54
55 V-USB Circuit
56 -------------
57 +---+ +---------------+
58 USB GND | | ATmega168 |
59 === C3 | |
60 5V <-------+--------+---|Vcc,AVCC | HHKB
61 R1 | | ====
62 D- <----+--+-----R2-----|INT1 PB0-2|------->ROW
63 D+ <----|---+----R3-----|INT0 PB3-5|------->COL
64 Z1 Z2 | PB6|------->ENABLE
65 GND<----+---+--+--+-----|GND PE6|------->KEY
66 | | | PE7|------->PREV
67 | C2-+--|XTAL1 | (see doc/HHKB.txt for pinouts)
68 | X1 | |
69 +--C3-+--|XTAL2 RST|---SW--+GND
70 +---------------+
71 R1: 1.5K Ohm
72 R2,R3: 68 Ohm
73 Z1,Z2: Zener 3.6V
74 C1,C2: 22pF
75 C3: 0.1uF
76 X1: Crystal 20MHz(16MHz/12MHz)
77 SW: Push Switch(Optional for bootloader)
78
79
80 EOF
Imprint / Impressum