History

James Young a03aa301de Remove Full Bootmagic (#13846 ) * disambiguate Bootmagic rules in keymaps The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic. This commit edits the files to specify that full Bootmagic is intended. * remove BOOTMAGIC_ENABLE=full setting * unify commented BOOTMAGIC_ENABLE rules in keyboards Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;#[ \t]\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).;\1 = no # Virtual DIP switch configuration;g' {} + ``` * remove commented Bootmagic rules from keymap/user level Command: ``` find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\)./d' {} + ``` * update keyboard BOOTMAGIC_ENABLE rule formatting Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later). Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + ``` update keyboards' BOOTMAGIC_ENABLE settings Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' + ``` * update keymap/user BOOTMAGIC_ENABLE settings Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' + ``` * remove and replace inline comments in keyboards and keymap/user files Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`. Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -path '/keymaps/' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).;\1 = \2;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' + find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' + ``` * rename improperly named makefiles Some files intended to be used as makefiles had improper names causing them to not be used as intended when building. This commit corrects the filenames of the affected files. * update renamed file with new rule formatting * update QMK's template files Updates QMK's `rules.mk` templates to use the new inline comment. * update QMK Docs - remove documentation of full Bootmagic - update links to Bootmagic Lite doc - add doc for Magic Keycodes * rules.mk patch for coarse/ixora and coarse/vinta		2021-08-06 23:59:56 -07:00
..
ble	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00
hasu	Fix hasu usb converter bootloader (#8613 )	2020-03-30 22:15:08 +01:00
keymaps	[Keymap] Add narze lily58 keymap & update my other keymaps (#13110 )	2021-07-03 00:50:32 -07:00
pro_micro	Miscellaneous rules.mk cleanups (#7212 )	2019-10-31 13:11:36 +00:00
config.h	Remove `DESCRIPTION`, B-D (#11513 )	2021-01-15 05:00:04 +11: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	start working on usb-usb converter port	2017-08-15 23:14:41 -04: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	Rename keyboard-level readmes to lower-case (#10759 )	2020-10-25 15:23:42 +00:00
rules.mk	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00
usb_usb.c	restructure converters (#1825 )	2017-11-08 11:11:44 -05:00
usb_usb.h	Error log cleanup (#13349 )	2021-06-26 08:38:14 -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.