qmk_firmware/keyboards/converter/usb_usb/readme.md

USB to USB keyboard protocol converter
======================================
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).

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

Make example for this keyboard (after setting up your build environment):

    make converter/usb_usb:default

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.

Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues.

Troubleshooting & Known Issues
------------------------------
If something doesn't work, it's probably because of the CPU clock. 
Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware. 
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.

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`:
`F_CPU = 8000000`
The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is:
`F_CPU = 16000000`

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

### Build one yourself using 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.
- http://arduino.cc/en/Main/ArduinoBoardLeonardo
- https://www.circuitsathome.com/arduino_usb_host_shield_projects/

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
- 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.
- [Build guide](https://geekhack.org/index.php?topic=80421.0)
- https://www.circuitsathome.com/arduino_usb_host_shield_projects/
- https://www.sparkfun.com/products/12587
- https://www.pjrc.com/teensy/td_libs_USBHostShield.html

Limitations
----------
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.

Resources
--------
- [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/arduino_usb_host_shield_projects/)
- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0)
- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield)
- [Arduino source](https://github.com/arduino/Arduino)
- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549)
- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854)
- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561)
- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html)
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00			`USB to USB keyboard protocol converter`
			`======================================`
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`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).`
cleanup usb-usb converter code 2017-08-15 23:34:46 +00:00
add linebreaks to "Keyboard Maintainer:..." blocks where missing (#3763) 2018-08-26 18:59:52 +00:00			`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`
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built`
cleanup usb-usb converter code 2017-08-15 23:34:46 +00:00
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`Make example for this keyboard (after setting up your build environment):`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
Make arguments redo, subproject elimination (#1784) * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now 2017-10-14 21:32:19 +00:00			`make converter/usb_usb:default`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
Modified URLs to point to new locations 2019-01-13 00:51:21 +00:00			`See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
restructure converters (#1825) * restructure converters each converter is its own keyboard and different hardware variants are different subprojects. remove (seemingly) old method of loading layouts from main Makefile * call led_set_kb() from overridden led_set() * put converter back into one folder * revert some structure changes to bring in line with #1784. Also attempt to get the BLE thing more properly integrated. Also also fix led_set() to call led_set_kb(). 2017-11-08 16:11:44 +00:00			`Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues.`

remove dead links, add troubleshooting section 2017-08-18 23:00:02 +00:00			`Troubleshooting & Known Issues`
			`------------------------------`
restructure converters (#1825) * restructure converters each converter is its own keyboard and different hardware variants are different subprojects. remove (seemingly) old method of loading layouts from main Makefile * call led_set_kb() from overridden led_set() * put converter back into one folder * revert some structure changes to bring in line with #1784. Also attempt to get the BLE thing more properly integrated. Also also fix led_set() to call led_set_kb(). 2017-11-08 16:11:44 +00:00			`If something doesn't work, it's probably because of the CPU clock.`
			Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware.
			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.

			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`:
			`F_CPU = 8000000`
			The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is:
			`F_CPU = 16000000`
remove dead links, add troubleshooting section 2017-08-18 23:00:02 +00:00
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`Getting the Hardware`
			`--------------------`
			`There are two options to get a converter: You can buy one from Hasu or build one yourself.`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`### Buy a Converter`
			`You can buy a fully assembled converter from me here:`
			`https://geekhack.org/index.php?topic=69169.0`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00			`Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.`
[Keyboard] Update formatting of README for usb_usb (#7037) Minor updates to make the README a little more readable. 2019-10-16 08:22:28 +00:00			`- http://arduino.cc/en/Main/ArduinoBoardLeonardo`
			`- https://www.circuitsathome.com/arduino_usb_host_shield_projects/`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
			`Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.`
[Keyboard] Update formatting of README for usb_usb (#7037) Minor updates to make the README a little more readable. 2019-10-16 08:22:28 +00:00			`- http://arduino.cc/en/Main/ArduinoUSBHostShield`
			`- https://www.sparkfun.com/products/9947`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
			`Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.`
[Keyboard] Update formatting of README for usb_usb (#7037) Minor updates to make the README a little more readable. 2019-10-16 08:22:28 +00:00			`- [Build guide](https://geekhack.org/index.php?topic=80421.0)`
			`- https://www.circuitsathome.com/arduino_usb_host_shield_projects/`
			`- https://www.sparkfun.com/products/12587`
			`- https://www.pjrc.com/teensy/td_libs_USBHostShield.html`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00
Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`Limitations`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00			`----------`
			`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.`

Update USB-USB converter README according to #1588 2017-08-18 22:49:26 +00:00			`Resources`
start working on usb-usb converter port 2017-06-20 00:19:15 +00:00			`--------`
[Keyboard] Update formatting of README for usb_usb (#7037) Minor updates to make the README a little more readable. 2019-10-16 08:22:28 +00:00			`- [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/arduino_usb_host_shield_projects/)`
			`- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0)`
			`- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield)`
			`- [Arduino source](https://github.com/arduino/Arduino)`
			`- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549)`
			`- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854)`
			`- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561)`
			`- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html)`