History

James Young fced377ac0 2020 May 30 Breaking Changes Update (#9215 ) * Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"		2020-05-30 13:14:59 -07:00
..
ble	Trim firmware sizes from default rules.mk, part 1 (#8027 )	2020-01-29 12:51:25 -05:00
hasu	Fix hasu usb converter bootloader (#8613 )	2020-03-30 22:15:08 +01:00
keymaps	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
pro_micro	Miscellaneous rules.mk cleanups (#7212 )	2019-10-31 13:11:36 +00:00
config.h	Remove all references to "CUSTOM_MATRIX" as a diode direction (#7937 )	2020-01-19 23:05:51 -08:00
custom_matrix.cpp	[Keyboard] Backport two fixes from TMK: usb-usb converter (#6383 )	2019-07-22 02:07:28 -07:00
info.json	converter/usb_usb Refactor and Configurator support (#4345 )	2018-11-03 23:57:42 -07:00
main.c
matrix.c	wow, it builds! added empty matrix.c and moved custom matrix code to custom_matrix.cpp	2017-08-15 23:14:41 -04:00
README.md	[Keyboard] Update formatting of README for usb_usb (#7037 )	2019-10-16 01:22:28 -07:00
rules.mk	Trim firmware sizes from default rules.mk, part 1 (#8027 )	2020-01-29 12:51:25 -05:00
usb_usb.c	restructure converters (#1825 )	2017-11-08 11:11:44 -05:00
usb_usb.h	converter/usb_usb Refactor and Configurator support (#4345 )	2018-11-03 23:57:42 -07:00

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. Ported to QMK by Balz Guenat.

Keyboard Maintainer: Balz Guenat
Hardware Supported: Hasu's USB-USB converter, Pro Micro + USB Host Shield, maybe more
Hardware Availability: GH thread, self-built

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

make converter/usb_usb:default

See build environment setup then the make instructions 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.

Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.

Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.

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.