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 Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues.
  17
  18 Troubleshooting & Known Issues
  19 ------------------------------
  20 If something doesn't work, it's probably because of the CPU clock.
  21 Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware.
  22 If you are sure you have this correct, try changeing the default in `usb_usb/rules.mk` or overriding the value in the `rules.mk` of your keymap.
  23
  24 The Pro Micro variant uses a 3.3V Pro Micro and thus runs at 8MHz, hence the following line in `usb_usb/pro_micro/rules.mk`:
  25 `F_CPU = 8000000`
  26 The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is:
  27 `F_CPU = 16000000`
  28
  29 Getting the Hardware
  30 --------------------
  31 There are two options to get a converter: You can buy one from Hasu or build one yourself.
  32
  33 ### Buy a Converter
  34 You can buy a fully assembled converter from me here:
  35 https://geekhack.org/index.php?topic=69169.0
  36
  37 ### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0
  38 Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
  39 http://arduino.cc/en/Main/ArduinoBoardLeonardo
  40 https://www.circuitsathome.com/arduino_usb_host_shield_projects/
  41
  42 Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
  43 http://arduino.cc/en/Main/ArduinoUSBHostShield
  44 https://www.sparkfun.com/products/9947
  45
  46 Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
  47 [Build guide](https://geekhack.org/index.php?topic=80421.0)
  48 https://www.circuitsathome.com/arduino_usb_host_shield_projects/
  49 https://www.sparkfun.com/products/12587
  50 https://www.pjrc.com/teensy/td_libs_USBHostShield.html
  51
  52 Limitations
  53 ----------
  54 Only supports 'HID Boot protocol'.
  55 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.
  56
  57 Resources
  58 --------
  59 Hasu's main thread for the converter
  60     https://geekhack.org/index.php?topic=69169.0
  61 Build guide for the Pro Micro variant
  62     https://geekhack.org/index.php?topic=80421.0
  63 Original TMK version of the converter
  64     https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb
  65 USB Host Shield 2.0
  66     https://www.circuitsathome.com/arduino_usb_host_shield_projects/
  67 USB Host Shield 2.0 source
  68     https://github.com/felis/USB_Host_Shield_2.0
  69 Arduino USB Host Shield (with bootst converter)
  70     http://arduino.cc/en/Main/ArduinoUSBHostShield
  71 Arduino source
  72     https://github.com/arduino/Arduino
  73 Initial release of TMK USB-USB converter
  74     https://geekhack.org/index.php?topic=33057.msg653549#msg653549
  75     http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854
  76 Arduino-based hardware keyboard remapper - Colemak forum
  77     http://forum.colemak.com/viewtopic.php?id=1561
  78 Teensy + Host Shield
  79     http://www.pjrc.com/teensy/td_libs_USBHostShield.html