keyboards/converter/usb_usb/README.md

   1 USB to USB keyboard protocol converter
   2 ======================================
   3 A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable.
   4 Original code from the [TMK firmware](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat).
   5
   6 Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
   7 Hardware Supported: [Hasu's USB-USB converter](https://geekhack.org/index.php?topic=69169.0), [Pro Micro + USB Host Shield](https://geekhack.org/index.php?topic=80421.0), maybe more
   8 Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built
   9
  10 Make example for this keyboard (after setting up your build environment):
  11
  12     make converter-usb_usb-default
  13
  14 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
  15
  16 Getting the Hardware
  17 --------------------
  18 There are two options to get a converter: You can buy one from Hasu or build one yourself.
  19
  20 ### Buy a Converter
  21 You can buy a fully assembled converter from me here:
  22 https://geekhack.org/index.php?topic=69169.0
  23
  24 ### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0
  25 Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
  26 http://arduino.cc/en/Main/ArduinoBoardLeonardo
  27 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
  28
  29 Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
  30 http://arduino.cc/en/Main/ArduinoUSBHostShield
  31 https://www.sparkfun.com/products/9947
  32
  33 Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
  34 [Build guide](https://geekhack.org/index.php?topic=80421.0)
  35 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
  36 https://www.sparkfun.com/products/12587
  37 https://www.pjrc.com/teensy/td_libs_USBHostShield.html
  38
  39 Limitations
  40 ----------
  41 Only supports 'HID Boot protocol'.
  42 Note that the converter can host only USB "boot protocol" keyboard(6KRO), 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.
  43
  44 Resources
  45 --------
  46 Hasu's main thread for the converter
  47     https://geekhack.org/index.php?topic=69169.0
  48 Build guide for the Pro Micro variant
  49     https://geekhack.org/index.php?topic=80421.0
  50 Original TMK version of the converter
  51     https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb
  52 USB Host Shield 2.0
  53     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
  54     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
  55 USB Host Shield 2.0 source
  56     https://github.com/felis/USB_Host_Shield_2.0
  57 Arduino USB Host Shield (with bootst converter)
  58     http://arduino.cc/en/Main/ArduinoUSBHostShield
  59 Arduino source
  60     https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
  61 Initial release of TMK USB-USB converter
  62     https://geekhack.org/index.php?topic=33057.msg653549#msg653549
  63     http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854
  64 Arduino-based hardware keyboard remapper - Colemak forum
  65     http://forum.colemak.com/viewtopic.php?id=1561
  66 Teensy + Host Shield
  67     http://www.pjrc.com/teensy/td_libs_USBHostShield.html