Merge branch 'lockkey_fix'(Fix issue #46)
[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 Build
11 -----
12 0. Connect ADB keyboard to Teensy by 3 lines(Vcc, GND, Data). By default Data line uses port D0.
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 D0.
16 ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
17 2. make
18 3. program Teensy
19
20
21 LOCKING CAPSLOCK
22 ----------------
23 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.
24
25 Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
26 http://www.youtube.com/watch?v=9wqnt2mGJ2Y
27
28
29 Keymap
30 ------
31 You can change a keymap by editing code of keymap.c like following.
32 This is a keymap for AEK, however, also used for other keyboards.
33 How to define the keymap is probably obvious. You can find key symbols in keycode.h.
34 If you want to define some keymaps than just one, see hhkb/keymap.c and
35 macway/keymap.c as examples. Keymap(layer) switching may needs a bit of
36 effort at this time.
37
38 /* Default Layer: plain keymap
39 * ,---. ,---------------. ,---------------. ,---------------. ,-----------. ,---.
40 * |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau| |Pwr|
41 * `---' `---------------' `---------------' `---------------' `-----------' `---'
42 * ,-----------------------------------------------------------. ,-----------. ,---------------.
43 * | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backspa| |Ins|Hom|PgU| |NmL| =| /| *|
44 * |-----------------------------------------------------------| |-----------| |---------------|
45 * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD| | 7| 8| 9| -|
46 * |-----------------------------------------------------------| `-----------' |---------------|
47 * |CapsLo| A| S| D| F| G| H| J| K| L| ;| '|Return | | 4| 5| 6| +|
48 * |-----------------------------------------------------------| ,---. |---------------|
49 * |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shift | |Up | | 1| 2| 3| |
50 * |-----------------------------------------------------------| ,-----------. |-----------|Ent|
51 * |Ctrl |Gui |Alt | Space | | | | |Lef|Dow|Rig| | 0| .| |
52 * `-----------------------------------------------------------' `-----------' `---------------'
53 */
54 KEYMAP(
55 ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, PSCR,SLCK,BRK, PWR,
56 GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, INS, HOME,PGUP, NLCK,EQL, PSLS,PAST,
57 TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSLS, DEL, END, PGDN, P7, P8, P9, PMNS,
58 LCAP,A, S, D, F, G, H, J, K, L, SCLN,QUOT, ENT, P4, P5, P6, PPLS,
59 LSFT,Z, X, C, V, B, N, M, COMM,DOT, SLSH, RSFT, UP, P1, P2, P3,
60 LCTL,LGUI,LALT, SPC, LEFT,DOWN,RGHT, P0, PDOT,PENT
61 ),
62
63
64 Magic command
65 -------------
66 To get help press `h` holding Magic key. Magic key is `Power key`.
67
68
69 Notes
70 -----
71 Many ADB keyboards has no discrimination between right modifier and left one,
72 you will always see left control even if you press right control key.
73 Apple Extended Keyboard and Apple Extended Keyboard II are the examples.
74 Though ADB protocol itsef has the ability of distinction between right and left.
75 And most ADB keyboard has no NKRO functionality, though ADB protocol itsef has that.
76 See protocol/adb.c for more info.
77
78 EOF
Imprint / Impressum