converter/usb_usb/README

   1 USB to USB keyboard protocol converter
   2 ======================================
   3
   4 Hardware requirement
   5 --------------------
   6 Arduino Leonardo
   7     http://arduino.cc/en/Main/ArduinoBoardLeonardo
   8
   9 Circuit@Home USB Host Shield 2.0
  10     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
  11
  12 Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be the easiest way, you won't need even soldering iron.
  13 Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
  14
  15     http://arduino.cc/en/Main/ArduinoUSBHostShield
  16     https://www.sparkfun.com/products/9947
  17
  18 Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
  19     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
  20     https://www.sparkfun.com/products/12587
  21     https://www.pjrc.com/teensy/td_libs_USBHostShield.html
  22
  23
  24
  25 Build firmware
  26 --------------
  27     $ git clone git://github.com/tmk/tmk_keyboard.git
  28     $ cd tmk_keyboard
  29     $ git submodule init
  30     $ git submodule update
  31     $ cd converter/usb_usb
  32     $ make
  33
  34 Program converter. Push reset button on Leonardo before run this command. Serial port name(COM17) depends your system. On Linux I got /dev/ttyACM0.
  35
  36     $ DEV=COM17 make program
  37     or
  38     $ avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:usb_usb.hex -PCOM17
  39
  40
  41
  42 Limitation
  43 ----------
  44 Only supports 'HID Boot protocol'.
  45 Not support keyboard LED yet.
  46
  47 Note that the converter can host only USB "boot protocol" keyboard(6KRO) and not NKRO, it is possible to support NKRO keyboard but you will need to write HID report parser for that. Every NKRO keyboard can have different HID report and it is difficult to support all kind of NKRO keyboards in the market.
  48
  49
  50
  51 Update
  52 ------
  53 2014/12/11  Added Hub support(confirmed with HHKB pro2)
  54
  55
  56
  57 Resource
  58 --------
  59 USB Host Sheild 2.0
  60     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
  61     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
  62 USB Host Sheild 2.0 source
  63     https://github.com/felis/USB_Host_Shield_2.0
  64 Arduino USB Host Shield(with bootst converter)
  65     http://arduino.cc/en/Main/ArduinoUSBHostShield
  66 Arduino source
  67     https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
  68 Initial release of TMK USB-USB converter
  69     https://geekhack.org/index.php?topic=33057.msg653549#msg653549
  70     http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854
  71 Arduino-based hardware keyboard remapper - Colemak forum
  72     http://forum.colemak.com/viewtopic.php?id=1561
  73 Teensy + Host Shield
  74     http://www.pjrc.com/teensy/td_libs_USBHostShield.html