converter/adb_usb/README.md

   1 ADB to USB keyboard converter
   2 =============================
   3 This firmware converts Apple ADB keyboard/mouse protocol to USB, you can use it to plug old ADB keyboard/mouse into modern computer. It works on prebuilt TMK ADB-USB Converter or generic dev board with USB AVR MCU(ATMega32U4/2) like Teensy2.0.
   4
   5 Discuss about this here: http://geekhack.org/showwiki.php?title=Island:14290
   6
   7 Prebuilt TMK ADB-USB converter is available here: https://geekhack.org/index.php?topic=72052.0
   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 If you build this yourself you have to solder some wires.
  25 Connect ADB pins to controller just by 3 lines(Vcc, GND, Data) at least. By default Data line uses port PD0.
  26 This is not needed but you can connect PSW to PD1 optionally.
  27
  28 ADB female socket from the front:
  29
  30       ,--_--.
  31      / o4 3o \      1: DATA
  32     | o2   1o |     2: PSW(Power SW)
  33      -  ===  -      3: VCC
  34       `-___-'       4: GND
  35
  36 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!)
  37 https://github.com/tmk/tmk_keyboard/wiki/FAQ#pull-up-resistor
  38
  39 Pull-up resister:
  40
  41     Keyboard       AVR MCU
  42                    ,------.
  43     5V------+------|VCC   |
  44             |      |      |
  45            [R]     |      |
  46             |      |      |
  47     DATA----+------|PD0   |
  48                    |      |
  49     GND------------|GND   |
  50                    `------'
  51     R: 1K Ohm resistor
  52
  53
  54 Define following macros for ADB connection in config.h if you use other than port PD0.
  55
  56     ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
  57
  58
  59 Build firmware and Program microcontroller
  60 ------------------------------------------
  61 See [doc/build.md](../../tmk_core/doc/build.md).
  62
  63 To build firmware and program TMK ADB-USB Converter run these commands:
  64
  65     $ make -f Makefile clean
  66     $ make -f Makefile [KEYMAP=yourname]
  67     $ make -f Makefile [KEYMAP=yourname] dfu
  68
  69 You can select keymap name with optional `KEYMAP=` ('plain' is default name). Push button on the converter before running `dfu` target.
  70
  71 Use **Makefile.rev1** for old TMK Converter rev.1 and Teensy2.0 instead of **Makefile**.
  72
  73
  74
  75 Keymap
  76 ------
  77 You can change keymap by editing code of unimap_plain.c directly, or copy it to your own keymap file like unimap_yourname.c and edit the file.
  78 How to define the keymap is probably obvious. You can find key symbols in common/keycode.h. And see [doc/keymap.md](../../tmk_core/doc/keymap.md) for more detail.
  79
  80
  81 Magic command
  82 -------------
  83 To get help message in hid_listen press `h` holding Magic key. Magic key is `Power key`.
  84
  85 https://github.com/tmk/tmk_keyboard/wiki#debug
  86
  87
  88 Locking CapsLock
  89 ----------------
  90 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.
  91 https://github.com/tmk/tmk_keyboard/blob/master/README.md#mechanical-locking-support
  92
  93 Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
  94
  95
  96 Mouse support
  97 -------------
  98 ADB mouse support was added by @mek-apelsin on Apr,2015. It supports only one button as of now.
  99 https://github.com/tmk/tmk_keyboard/pull/207
 100
 101
 102 Notes
 103 -----
 104 Not-extended ADB keyboards have no discrimination between right modifier and left one,
 105 you will always see left control even if you press right control key.
 106 Apple Extended Keyboard and Apple Extended Keyboard II can discriminate both side
 107 modifiers except for GUI key(Windows/Command).
 108
 109 And most of ADB keyboards have no diodes in its matrix so they are not NKRO unfortunately,
 110 though ADB protocol itself supports it. See protocol/adb.c for more info.
 111
 112 EOF