keyboards/converter/usb_usb/README.md

   1 USB to USB keyboard protocol converter
   2 ======================================
   3 Original code from Hasu's TMK firmware. Ported to QMK by Coloneljesus.
   4
   5 This port has been tested only on the Pro Micro variant described in the next section.
   6
   7 See for detail and discussion.
   8 https://geekhack.org/index.php?topic=69169.0
   9
  10
  11 Hardware requirement
  12 --------------------
  13 There are two options.
  14
  15 ### TMK USB-USB Converter
  16 You can buy a fully assembled converter from me here.
  17
  18     https://geekhack.org/index.php?topic=69169.0
  19
  20 ### Arduino Leonardo + Circuit@Home USB Host Shield 2.0
  21 Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
  22
  23     http://arduino.cc/en/Main/ArduinoBoardLeonardo
  24     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
  25
  26 Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
  27
  28     http://arduino.cc/en/Main/ArduinoUSBHostShield
  29     https://www.sparkfun.com/products/9947
  30
  31 Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
  32
  33     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
  34     https://www.sparkfun.com/products/12587
  35     https://www.pjrc.com/teensy/td_libs_USBHostShield.html
  36
  37
  38
  39 Build firmware
  40 --------------
  41 Follow normal QMK build instructions to get a binary file. Flashing depends on you hardware.
  42
  43 Limitation
  44 ----------
  45 Only supports 'HID Boot protocol'.
  46
  47 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.
  48
  49
  50
  51 Keymap editor
  52 -------------
  53 You can editor keymap and download firmware with web brwoser.
  54
  55 - http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?usb_usb
  56
  57
  58
  59 Update
  60 ------
  61 2014/12/11  Added Hub support(confirmed with HHKB pro2)
  62 2016/09/10  Unimap editor support
  63 2016/10/18  Fix LED state at startup
  64 2017/08/16  Port to QMK
  65
  66
  67 Resource
  68 --------
  69 USB Host Sheild 2.0
  70     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
  71     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
  72 USB Host Sheild 2.0 source
  73     https://github.com/felis/USB_Host_Shield_2.0
  74 Arduino USB Host Shield(with bootst converter)
  75     http://arduino.cc/en/Main/ArduinoUSBHostShield
  76 Arduino source
  77     https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
  78 Initial release of TMK USB-USB converter
  79     https://geekhack.org/index.php?topic=33057.msg653549#msg653549
  80     http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854
  81 Arduino-based hardware keyboard remapper - Colemak forum
  82     http://forum.colemak.com/viewtopic.php?id=1561
  83 Teensy + Host Shield
  84     http://www.pjrc.com/teensy/td_libs_USBHostShield.html