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
  11 README FIRST
  12 ------------
  13 https://github.com/tmk/tmk_keyboard
  14 https://github.com/tmk/tmk_keyboard/tree/master/converter/adb_usb
  15
  16 Also check these when you are in trouble.
  17
  18 https://github.com/tmk/tmk_keyboard/wiki
  19 https://github.com/tmk/tmk_keyboard/labels/NOTE
  20
  21
  22 Wiring
  23 ------
  24 Connect ADB pins to controller just by 3 lines(Vcc, GND, Data). By default Data line uses port PD0.
  25
  26 ADB female socket from the front:
  27
  28       ,--_--.
  29      / o4 3o \      1: DATA
  30     | o2   1o |     2: Power SW
  31      -  ===  -      3: VCC
  32       `-___-'       4: GND
  33
  34 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!)
  35 https://github.com/tmk/tmk_keyboard/wiki/FAQ#pull-up-resistor
  36
  37 Pull-up resister:
  38
  39     Keyboard       Conveter
  40                    ,------.
  41     5V------+------|VCC   |
  42             |      |      |
  43            [R]     |      |
  44             |      |      |
  45     Signal--+------|PD0   |
  46                    |      |
  47     GND------------|GND   |
  48                    `------'
  49     R: 1K Ohm resistor
  50
  51
  52 Define following macros for ADB connection in config.h if you use other than port PD0.
  53
  54     ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
  55
  56
  57 Build
  58 -----
  59 See doc/build.md. In short,
  60
  61     $ make clean
  62     $ make
  63
  64 You can select keymap(ansi is default) like this:
  65
  66     $ make KEYMAP=[ansi|iso|hasu]
  67
  68
  69 Keymap
  70 ------
  71 You can change a keymap by editing code of keymap_[ansi|iso|hasu|yours].c.
  72 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.
  73
  74
  75 Magic command
  76 -------------
  77 To get help press `h` holding Magic key. Magic key is `Power key`.
  78
  79
  80 Locking CapsLock
  81 ----------------
  82 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.
  83 https://github.com/tmk/tmk_keyboard/blob/master/README.md#mechanical-locking-support
  84
  85 Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
  86
  87
  88 Notes
  89 -----
  90 Not-extended ADB keyboards have no discrimination between right modifier and left one,
  91 you will always see left control even if you press right control key.
  92 Apple Extended Keyboard and Apple Extended Keyboard II can discriminate both side
  93 modifiers except for GUI key(Windows/Command).
  94
  95 And most ADB keyboard has no diodes in its matrix so they are not NKRO,
  96 though ADB protocol itself supports it. See protocol/adb.c for more info.
  97
  98 If keyboard has ISO layout you need to use ISO keymap with `make KEYMAP=iso`. With ANSI
  99 keymap you will suffer from swapped keys problem.
 100
 101 https://github.com/tmk/tmk_keyboard/issues/35
 102
 103 EOF