History

Joel Challis 831deac212 Migrate build target markers to keyboard.json (#23293 )		2024-03-30 11:31:50 +00:00
..
ble	Bluetooth: driver naming cleanups (#21624 )	2023-07-29 15:16:14 +10:00
hasu	Migrate build target markers to keyboard.json (#23293 )	2024-03-30 11:31:50 +00:00
keymaps/default	Remove obvious user keymaps, `keyboards/{b,c}*` edition. (#22693 )	2023-12-18 16:05:50 +11:00
leonardo	Migrate build target markers to keyboard.json (#23293 )	2024-03-30 11:31:50 +00:00
pro_micro	Remove useless "ifdef KEYBOARD_*" (#20078 )	2023-03-16 20:18:33 +11:00
config.h	Remove usages of config_common.h from config.h files. (#19714 )	2023-01-31 06:03:30 +11:00
custom_matrix.cpp	Remove matrix_init_quantum/matrix_scan_quantum (#19806 )	2023-02-11 03:47:17 +00:00
info.json	Add 'JIS' form factor layouts (#21220 )	2023-07-08 00:36:34 +10:00
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	Add leonardo build target for leonardo + usb2.0 shield based projects (#22243 )	2023-11-15 15:23:03 +00:00
rules.mk	Migrate `MCU` and `BOOTLOADER` to data-driven (#19529 )	2023-02-08 18:41:46 +11: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

If you use Arduino Leonardo with a USB Host Shield:

make converter/usb_usb/leonardo: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

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.