adb_usb: Change README
This commit is contained in:
tmk
parent
a8822a16b4
commit
1ed54a5dc9
1 changed files with 56 additions and 49 deletions
|
|
@ -7,70 +7,69 @@ But binary size is about 10KB or more it doesn't fit into 8K flash like ATMega8U
|
||||||
Discuss: http://geekhack.org/showwiki.php?title=Island:14290
|
Discuss: http://geekhack.org/showwiki.php?title=Island:14290
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
README FIRST
|
||||||
|
------------
|
||||||
|
https://github.com/tmk/tmk_keyboard
|
||||||
|
https://github.com/tmk/tmk_keyboard/tree/master/converter/adb_usb
|
||||||
|
|
||||||
|
Also check these when you are in trouble.
|
||||||
|
|
||||||
|
https://github.com/tmk/tmk_keyboard/wiki
|
||||||
|
https://github.com/tmk/tmk_keyboard/labels/NOTE
|
||||||
|
|
||||||
|
|
||||||
Wiring
|
Wiring
|
||||||
------
|
------
|
||||||
0. Connect ADB keyboard to Teensy by 3 lines(Vcc, GND, Data). By default Data line uses port PD0.
|
Connect ADB pins to controller just by 3 lines(Vcc, GND, Data). By default Data line uses port PD0.
|
||||||
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.
|
|
||||||
The external pull-up resistor(1K-10K Ohm) on Data is strongly recommended.
|
ADB female socket from the front:
|
||||||
1. Define following macros for ADB connection in config.h if you use other than port PD0.
|
|
||||||
|
,--_--.
|
||||||
|
/ o4 3o \ 1: DATA
|
||||||
|
| o2 1o | 2: Power SW
|
||||||
|
- === - 3: VCC
|
||||||
|
`-___-' 4: GND
|
||||||
|
|
||||||
|
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. The external pull-up resistor(1K-10K Ohm) on Data is strongly recommended.(It is almost must!)
|
||||||
|
https://github.com/tmk/tmk_keyboard/wiki/FAQ#pull-up-resistor
|
||||||
|
|
||||||
|
Pull-up resister:
|
||||||
|
|
||||||
|
Keyboard Conveter
|
||||||
|
,------.
|
||||||
|
5V------+------|VCC |
|
||||||
|
| | |
|
||||||
|
[R] | |
|
||||||
|
| | |
|
||||||
|
Signal--+------|PD0 |
|
||||||
|
| |
|
||||||
|
GND------------|GND |
|
||||||
|
`------'
|
||||||
|
R: 1K Ohm resistor
|
||||||
|
|
||||||
|
|
||||||
|
Define following macros for ADB connection in config.h if you use other than port PD0.
|
||||||
|
|
||||||
ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
|
ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
|
||||||
2. make
|
|
||||||
3. program Teensy
|
|
||||||
|
|
||||||
|
|
||||||
Build
|
Build
|
||||||
-----
|
-----
|
||||||
Just make
|
See doc/build.md. In short,
|
||||||
|
|
||||||
$ make clean
|
$ make clean
|
||||||
$ make
|
$ make
|
||||||
|
|
||||||
If your keyboard is ISO layout
|
You can select keymap(ansi is default) like this:
|
||||||
|
|
||||||
$ make KEYMAP=iso
|
$ make KEYMAP=[ansi|iso|hasu]
|
||||||
|
|
||||||
|
|
||||||
LOCKING CAPSLOCK
|
|
||||||
----------------
|
|
||||||
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.
|
|
||||||
|
|
||||||
Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
|
|
||||||
http://www.youtube.com/watch?v=9wqnt2mGJ2Y
|
|
||||||
|
|
||||||
|
|
||||||
Keymap
|
Keymap
|
||||||
------
|
------
|
||||||
You can change a keymap by editing code of keymap.c like following.
|
You can change a keymap by editing code of keymap_[ansi|iso|hasu|yours].c.
|
||||||
This is a keymap for AEK, however, also used for other keyboards.
|
How to define the keymap is probably obvious. You can find key symbols in common/keycode.h. And see doc/keymap.md for more detail.
|
||||||
How to define the keymap is probably obvious. You can find key symbols in keycode.h.
|
|
||||||
If you want to define some keymaps than just one, see hhkb/keymap.c and
|
|
||||||
macway/keymap.c as examples. Keymap(layer) switching may needs a bit of
|
|
||||||
effort at this time.
|
|
||||||
|
|
||||||
/* Default Layer: plain keymap
|
|
||||||
* ,---. ,---------------. ,---------------. ,---------------. ,-----------. ,---.
|
|
||||||
* |Esc| |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau| |Pwr|
|
|
||||||
* `---' `---------------' `---------------' `---------------' `-----------' `---'
|
|
||||||
* ,-----------------------------------------------------------. ,-----------. ,---------------.
|
|
||||||
* | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backspa| |Ins|Hom|PgU| |NmL| =| /| *|
|
|
||||||
* |-----------------------------------------------------------| |-----------| |---------------|
|
|
||||||
* |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \| |Del|End|PgD| | 7| 8| 9| -|
|
|
||||||
* |-----------------------------------------------------------| `-----------' |---------------|
|
|
||||||
* |CapsLo| A| S| D| F| G| H| J| K| L| ;| '|Return | | 4| 5| 6| +|
|
|
||||||
* |-----------------------------------------------------------| ,---. |---------------|
|
|
||||||
* |Shift | Z| X| C| V| B| N| M| ,| ,| /|Shift | |Up | | 1| 2| 3| |
|
|
||||||
* |-----------------------------------------------------------| ,-----------. |-----------|Ent|
|
|
||||||
* |Ctrl |Alt |Gui | Space |Gui |Alt |Ctrl | |Lef|Dow|Rig| | 0| .| |
|
|
||||||
* `-----------------------------------------------------------' `-----------' `---------------'
|
|
||||||
*/
|
|
||||||
KEYMAP(
|
|
||||||
ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, PSCR,SLCK,BRK, PWR,
|
|
||||||
GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, INS, HOME,PGUP, NLCK,EQL, PSLS,PAST,
|
|
||||||
TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSLS, DEL, END, PGDN, P7, P8, P9, PMNS,
|
|
||||||
LCAP,A, S, D, F, G, H, J, K, L, SCLN,QUOT, ENT, P4, P5, P6, PPLS,
|
|
||||||
LSFT,Z, X, C, V, B, N, M, COMM,DOT, SLSH, RSFT, UP, P1, P2, P3,
|
|
||||||
LCTL,LGUI,LALT, SPC, LEFT,DOWN,RGHT, P0, PDOT,PENT
|
|
||||||
),
|
|
||||||
|
|
||||||
|
|
||||||
Magic command
|
Magic command
|
||||||
|
|
@ -78,6 +77,14 @@ Magic command
|
||||||
To get help press `h` holding Magic key. Magic key is `Power key`.
|
To get help press `h` holding Magic key. Magic key is `Power key`.
|
||||||
|
|
||||||
|
|
||||||
|
Locking CapsLock
|
||||||
|
----------------
|
||||||
|
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.
|
||||||
|
https://github.com/tmk/tmk_keyboard/blob/master/README.md#mechanical-locking-support
|
||||||
|
|
||||||
|
Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
|
||||||
|
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
-----
|
-----
|
||||||
Not-extended ADB keyboards have no discrimination between right modifier and left one,
|
Not-extended ADB keyboards have no discrimination between right modifier and left one,
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue