converter/usb_usb/README.md

   1 USB to USB keyboard protocol converter
   2 ======================================
   3 See for detail and discussion here.
   4
   5 - https://geekhack.org/index.php?topic=69169.0
   6
   7
   8 Hardware requirement
   9 --------------------
  10 There are two options.
  11
  12 ### TMK USB-USB Converter
  13 You can buy a fully preassembled converter from me here.
  14
  15 - https://geekhack.org/index.php?topic=72052.0
  16
  17 ### Arduino Leonardo + USB Host Shield
  18 Buying Arduino Leonardo and USB Host Shield.
  19
  20 - https://store.arduino.cc/usa/leonardo
  21 - https://store.arduino.cc/usa/arduino-usb-host-shield
  22 - https://www.sparkfun.com/products/9947
  23
  24
  25 Build firmware
  26 --------------
  27 Build.
  28
  29     $ git clone https://github.com/tmk/tmk_keyboard.git
  30     $ cd tmk_keyboard
  31     $ git submodule init
  32     $ git submodule update
  33     $ cd converter/usb_usb
  34     $ make
  35
  36 And Program converter. Push button on TMK converter and just run this.
  37
  38     $ make dfu
  39
  40
  41 In case of Leonardo push reset button then run command. Serial port name(COM17) depends your system. On Linux I got /dev/ttyACM0.
  42
  43     $ DEV=COM17 make program
  44     or
  45     $ avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:usb_usb.hex -PCOM17
  46
  47
  48
  49 Limitation
  50 ----------
  51 Only supports 'HID Boot protocol'.
  52
  53 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.
  54
  55
  56
  57 Keymap editor
  58 -------------
  59 You can editor keymap and download firmware with web brwoser.
  60
  61 - http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?usb_usb
  62
  63
  64
  65 Update
  66 ------
  67 - 2014/12/11  Added Hub support(confirmed with HHKB pro2)
  68 - 2016/09/10  Unimap editor support
  69 - 2016/10/18  Fix LED state at startup
  70 - 2017/05/xx  Fix startup code for FC660C(3eae475)
  71 - 2018/02/xx  Add Korean and Brazilian specific keys(ab6ddac,b2fa0ffa)
  72 - 2018/07/xx  Fix startup issue(c2ce617)
  73 - 2018/10/xx  Use fixed LUFA stack and update USB_Host_Shield_2.0
  74 - 2019/09/18  Add BTLD(bootlader jump) key to unimap
  75
  76
  77
  78 Resource
  79 --------
  80 ### USB Host Sheild 2.0
  81 - https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
  82
  83 ### USB Host Sheild 2.0 source
  84 - https://github.com/felis/USB_Host_Shield_2.0
  85
  86 ### Arduino USB Host Shield(with bootst converter)
  87 - http://arduino.cc/en/Main/ArduinoUSBHostShield
  88
  89 ### Arduino source
  90 - https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
  91
  92 ### Arduino-based hardware keyboard remapper - Colemak forum
  93 - http://forum.colemak.com/viewtopic.php?id=1561
  94
  95 ### Teensy + Host Shield
  96 - http://www.pjrc.com/teensy/td_libs_USBHostShield.html