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 TMK Converter, PJRC Teensy2.0 and other USB AVR MCU(ATMega32U4, AT90USB64/128 or etc) for this. But binary size is probably more than 10KB and it won't fit into 8K flash.
   5
   6 Discuss: http://geekhack.org/showwiki.php?title=Island:14290
   7
   8
   9
  10 README FIRST
  11 ------------
  12 https://github.com/tmk/tmk_keyboard
  13 https://github.com/tmk/tmk_keyboard/tree/master/converter/adb_usb
  14
  15 Also check these when you are in trouble.
  16
  17 https://github.com/tmk/tmk_keyboard/wiki
  18 https://github.com/tmk/tmk_keyboard/labels/NOTE
  19
  20
  21 Wiring
  22 ------
  23 Connect ADB pins to controller just by 3 lines(Vcc, GND, Data). By default Data line uses port PD0.
  24
  25 ADB female socket from the front:
  26
  27       ,--_--.
  28      / o4 3o \      1: DATA
  29     | o2   1o |     2: Power SW
  30      -  ===  -      3: VCC
  31       `-___-'       4: GND
  32
  33 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!)
  34 https://github.com/tmk/tmk_keyboard/wiki/FAQ#pull-up-resistor
  35
  36 Pull-up resister:
  37
  38     Keyboard       Conveter
  39                    ,------.
  40     5V------+------|VCC   |
  41             |      |      |
  42            [R]     |      |
  43             |      |      |
  44     Signal--+------|PD0   |
  45                    |      |
  46     GND------------|GND   |
  47                    `------'
  48     R: 1K Ohm resistor
  49
  50
  51 Define following macros for ADB connection in config.h if you use other than port PD0.
  52
  53     ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
  54
  55
  56 Build firmware and Program microcontroller
  57 ------------------------------------------
  58 See [doc/build.md](../../tmk_core/doc/build.md).
  59
  60 To build firmware:
  61
  62     $ make -f Makefile clean
  63     $ make -f Makefile
  64
  65 You can select keymap(ansi is default) like this:
  66
  67     $ make -f Makefile KEYMAP=[ansi|iso|hasu]
  68
  69 To program TMK Converter:
  70
  71     $ make -f Makefile dfu
  72
  73 To program Teensy2.0:
  74
  75     $ make -f Makefile.teensy teensy
  76
  77 Use **Makefile.rev1** for TMK Converter rev.1 and **Makefile.teensy** for Teensy2.0 instead of **Makefile**. For TMK Converter rev.2 just use **Makefile**.
  78
  79
  80 Keymap
  81 ------
  82 You can change a keymap by editing code of keymap_[ansi|iso|hasu|yours].c.
  83 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.
  84
  85
  86 Magic command
  87 -------------
  88 To get help press `h` holding Magic key. Magic key is `Power key`.
  89
  90
  91 Locking CapsLock
  92 ----------------
  93 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.
  94 https://github.com/tmk/tmk_keyboard/blob/master/README.md#mechanical-locking-support
  95
  96 Also you may want to remove locking pin from the push-lock switch to use capslock as a normal momentary switch.
  97
  98
  99 Mouse support
 100 -------------
 101 ADB mouse support was added by @mek-apelsin on Apr,2015. It supports only one button as of now.
 102 https://github.com/tmk/tmk_keyboard/pull/207
 103
 104
 105 Notes
 106 -----
 107 Not-extended ADB keyboards have no discrimination between right modifier and left one,
 108 you will always see left control even if you press right control key.
 109 Apple Extended Keyboard and Apple Extended Keyboard II can discriminate both side
 110 modifiers except for GUI key(Windows/Command).
 111
 112 And most ADB keyboard has no diodes in its matrix so they are not NKRO,
 113 though ADB protocol itself supports it. See protocol/adb.c for more info.
 114
 115 If keyboard has ISO layout you need to use ISO keymap with `make KEYMAP=iso`. With ANSI
 116 keymap you will suffer from swapped keys problem.
 117
 118 https://github.com/tmk/tmk_keyboard/issues/35
 119
 120 EOF