1
0
Fork 0

Update USB-USB converter README according to #1588

This commit is contained in:
Balz Guenat 2017-08-19 00:49:26 +02:00 committed by Jack Humbert
parent 1132646b2f
commit 6ea408da10

View file

@ -1,77 +1,60 @@
USB to USB keyboard protocol converter USB to USB keyboard protocol converter
====================================== ======================================
Original code from Hasu's TMK firmware. Ported to QMK by Coloneljesus. A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable.
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).
This port has been tested only on the Pro Micro variant described in the next section. Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
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
Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built
See for detail and discussion. Make example for this keyboard (after setting up your build environment):
make converter-usb_usb-default
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.
Getting the Hardware
--------------------
There are two options to get a converter: You can buy one from Hasu or build one yourself.
### Buy a Converter
You can buy a fully assembled converter from me here:
https://geekhack.org/index.php?topic=69169.0 https://geekhack.org/index.php?topic=69169.0
### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0
Hardware requirement
--------------------
There are two options.
### TMK USB-USB Converter
You can buy a fully assembled converter from me here.
https://geekhack.org/index.php?topic=69169.0
### Arduino Leonardo + Circuit@Home USB Host Shield 2.0
Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron. Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
http://arduino.cc/en/Main/ArduinoBoardLeonardo
http://arduino.cc/en/Main/ArduinoBoardLeonardo https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified. Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
http://arduino.cc/en/Main/ArduinoUSBHostShield
http://arduino.cc/en/Main/ArduinoUSBHostShield https://www.sparkfun.com/products/9947
https://www.sparkfun.com/products/9947
Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing. Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
[Build guide](https://geekhack.org/index.php?topic=80421.0)
https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
https://www.sparkfun.com/products/12587
https://www.pjrc.com/teensy/td_libs_USBHostShield.html
https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini Limitations
https://www.sparkfun.com/products/12587
https://www.pjrc.com/teensy/td_libs_USBHostShield.html
Build firmware
--------------
Follow normal QMK build instructions to get a binary file. Flashing depends on you hardware.
Limitation
---------- ----------
Only supports 'HID Boot protocol'. Only supports 'HID Boot protocol'.
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. 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.
Resources
Keymap editor
-------------
You can editor keymap and download firmware with web brwoser.
- http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?usb_usb
Update
------
2014/12/11 Added Hub support(confirmed with HHKB pro2)
2016/09/10 Unimap editor support
2016/10/18 Fix LED state at startup
2017/08/16 Port to QMK
Resource
-------- --------
USB Host Sheild 2.0 Hasu's main thread for the converter
https://geekhack.org/index.php?topic=69169.0
Build guide for the Pro Micro variant
https://geekhack.org/index.php?topic=80421.0
Original TMK version of the converter
https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb
USB Host Shield 2.0
https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
USB Host Sheild 2.0 source USB Host Shield 2.0 source
https://github.com/felis/USB_Host_Shield_2.0 https://github.com/felis/USB_Host_Shield_2.0
Arduino USB Host Shield(with bootst converter) Arduino USB Host Shield (with bootst converter)
http://arduino.cc/en/Main/ArduinoUSBHostShield http://arduino.cc/en/Main/ArduinoUSBHostShield
Arduino source Arduino source
https://github.com/arduino/Arduino/hardware/arduino/{cores,variants} https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}