Fix typo 'keyobard' #166
[tmk_keyboard.git] / converter / adb_usb / README.md
1 ADB to USB keyboard converter
2 =============================
3 This firmware converts ADB keyboard protocol to USB.
4 You can use PJRC Teensy for this converter, though, other USB AVR(ATMega32U4, AT90USB64/128 or etc) should work.
5 But binary size is about 10KB or more it doesn't fit into 8K flash like ATMega8U2.
6
7 Discuss: http://geekhack.org/showwiki.php?title=Island:14290
8
9
10 Wiring
11 ------
12 0. Connect ADB keyboard to Teensy by 3 lines(Vcc, GND, Data). By default Data line uses port PD0.
13 This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable.
14 The external pull-up resistor(1K-10K Ohm) on Data is strongly recommended.
15 1. Define following macros for ADB connection in config.h if you use other than port PD0.
16 ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
17 2. make
18 3. program Teensy
19
20
21 Build
22 -----
23 Just make
24
25 $ make clean
26 $ make
27
28 If your keyboard is ISO layout
29
30 $ make KEYMAP=iso
31
32
33 LOCKING CAPSLOCK
34 ----------------
35 Many of old ADB keyboards have mechanical push-lock switch for Capslock key and this converter supports the locking Capslock key by default. See README in top directory for more detail about this feature.
36
37 Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
38 http://www.youtube.com/watch?v=9wqnt2mGJ2Y
39
40
41 Keymap
42 ------
43 You can change a keymap by editing code of keymap.c like following.
44 This is a keymap for AEK, however, also used for other keyboards.
45 How to define the keymap is probably obvious. You can find key symbols in keycode.h.
46 If you want to define some keymaps than just one, see hhkb/keymap.c and
47 macway/keymap.c as examples. Keymap(layer) switching may needs a bit of
48 effort at this time.
49
50 /* Default Layer: plain keymap
51 * ,---. ,---------------. ,---------------. ,---------------. ,-----------. ,---.
52 * |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau| |Pwr|
53 * `---' `---------------' `---------------' `---------------' `-----------' `---'
54 * ,-----------------------------------------------------------. ,-----------. ,---------------.
55 * | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backspa| |Ins|Hom|PgU| |NmL| =| /| *|
56 * |-----------------------------------------------------------| |-----------| |---------------|
57 * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD| | 7| 8| 9| -|
58 * |-----------------------------------------------------------| `-----------' |---------------|
59 * |CapsLo| A| S| D| F| G| H| J| K| L| ;| '|Return | | 4| 5| 6| +|
60 * |-----------------------------------------------------------| ,---. |---------------|
61 * |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shift | |Up | | 1| 2| 3| |
62 * |-----------------------------------------------------------| ,-----------. |-----------|Ent|
63 * |Ctrl |Alt |Gui | Space |Gui |Alt |Ctrl | |Lef|Dow|Rig| | 0| .| |
64 * `-----------------------------------------------------------' `-----------' `---------------'
65 */
66 KEYMAP(
67 ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, PSCR,SLCK,BRK, PWR,
68 GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, INS, HOME,PGUP, NLCK,EQL, PSLS,PAST,
69 TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSLS, DEL, END, PGDN, P7, P8, P9, PMNS,
70 LCAP,A, S, D, F, G, H, J, K, L, SCLN,QUOT, ENT, P4, P5, P6, PPLS,
71 LSFT,Z, X, C, V, B, N, M, COMM,DOT, SLSH, RSFT, UP, P1, P2, P3,
72 LCTL,LGUI,LALT, SPC, LEFT,DOWN,RGHT, P0, PDOT,PENT
73 ),
74
75
76 Magic command
77 -------------
78 To get help press `h` holding Magic key. Magic key is `Power key`.
79
80
81 Notes
82 -----
83 Not-extended ADB keyboards have no discrimination between right modifier and left one,
84 you will always see left control even if you press right control key.
85 Apple Extended Keyboard and Apple Extended Keyboard II can discriminate both side
86 modifiers except for GUI key(Windows/Command).
87
88 And most ADB keyboard has no diodes in its matrix so they are not NKRO,
89 though ADB protocol itself supports it. See protocol/adb.c for more info.
90
91 If keyboard has ISO layout you need to use ISO keymap with `make KEYMAP=iso`. With ANSI
92 keymap you will suffer from swapped keys problem.
93
94 https://github.com/tmk/tmk_keyboard/issues/35
95
96 EOF
Imprint / Impressum