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 Troubleshooting & Known Issues
  17 ------------------------------
  18 The Pro Micro variant runs at 8MHz, hence the following line in `usb_usb/rules.mk`:
  19 `F_CPU ?= 8000000`
  20 If the firmware doesn't work, try changing that line to
  21 `F_CPU ?= 16000000`
  22 or override the `F_CPU` variable in the `rules.mk` of your keymap.
  23
  24 Getting the Hardware
  25 --------------------
  26 There are two options to get a converter: You can buy one from Hasu or build one yourself.
  27
  28 ### Buy a Converter
  29 You can buy a fully assembled converter from me here:
  30 https://geekhack.org/index.php?topic=69169.0
  31
  32 ### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0
  33 Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
  34 http://arduino.cc/en/Main/ArduinoBoardLeonardo
  35 https://www.circuitsathome.com/arduino_usb_host_shield_projects/
  36
  37 Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
  38 http://arduino.cc/en/Main/ArduinoUSBHostShield
  39 https://www.sparkfun.com/products/9947
  40
  41 Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
  42 [Build guide](https://geekhack.org/index.php?topic=80421.0)
  43 https://www.circuitsathome.com/arduino_usb_host_shield_projects/
  44 https://www.sparkfun.com/products/12587
  45 https://www.pjrc.com/teensy/td_libs_USBHostShield.html
  46
  47 Limitations
  48 ----------
  49 Only supports 'HID Boot protocol'.
  50 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.
  51
  52 Resources
  53 --------
  54 Hasu's main thread for the converter
  55     https://geekhack.org/index.php?topic=69169.0
  56 Build guide for the Pro Micro variant
  57     https://geekhack.org/index.php?topic=80421.0
  58 Original TMK version of the converter
  59     https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb
  60 USB Host Shield 2.0
  61     https://www.circuitsathome.com/arduino_usb_host_shield_projects/
  62 USB Host Shield 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
  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