aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--keyboards/converter/usb_usb/README.md85
1 files changed, 34 insertions, 51 deletions
diff --git a/keyboards/converter/usb_usb/README.md b/keyboards/converter/usb_usb/README.md
index 274e11956..290afc883 100644
--- a/keyboards/converter/usb_usb/README.md
+++ b/keyboards/converter/usb_usb/README.md
@@ -1,77 +1,60 @@
1USB to USB keyboard protocol converter 1USB to USB keyboard protocol converter
2====================================== 2======================================
3Original code from Hasu's TMK firmware. Ported to QMK by Coloneljesus. 3A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable.
4Original 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).
4 5
5This port has been tested only on the Pro Micro variant described in the next section. 6Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
7Hardware 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
8Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built
6 9
7See for detail and discussion. 10Make example for this keyboard (after setting up your build environment):
8https://geekhack.org/index.php?topic=69169.0
9 11
12 make converter-usb_usb-default
10 13
11Hardware requirement 14See [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.
12--------------------
13There are two options.
14 15
15### TMK USB-USB Converter 16Getting the Hardware
16You can buy a fully assembled converter from me here. 17--------------------
18There are two options to get a converter: You can buy one from Hasu or build one yourself.
17 19
18 https://geekhack.org/index.php?topic=69169.0 20### Buy a Converter
21You can buy a fully assembled converter from me here:
22https://geekhack.org/index.php?topic=69169.0
19 23
20### Arduino Leonardo + Circuit@Home USB Host Shield 2.0 24### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0
21Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron. 25Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
22 26http://arduino.cc/en/Main/ArduinoBoardLeonardo
23 http://arduino.cc/en/Main/ArduinoBoardLeonardo 27https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
24 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
25 28
26Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified. 29Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
27 30http://arduino.cc/en/Main/ArduinoUSBHostShield
28 http://arduino.cc/en/Main/ArduinoUSBHostShield 31https://www.sparkfun.com/products/9947
29 https://www.sparkfun.com/products/9947
30 32
31Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing. 33Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
34[Build guide](https://geekhack.org/index.php?topic=80421.0)
35https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
36https://www.sparkfun.com/products/12587
37https://www.pjrc.com/teensy/td_libs_USBHostShield.html
32 38
33 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini 39Limitations
34 https://www.sparkfun.com/products/12587
35 https://www.pjrc.com/teensy/td_libs_USBHostShield.html
36
37
38
39Build firmware
40--------------
41Follow normal QMK build instructions to get a binary file. Flashing depends on you hardware.
42
43Limitation
44---------- 40----------
45Only supports 'HID Boot protocol'. 41Only supports 'HID Boot protocol'.
46
47Note 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. 42Note 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.
48 43
49 44Resources
50
51Keymap editor
52-------------
53You can editor keymap and download firmware with web brwoser.
54
55- http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?usb_usb
56
57
58
59Update
60------
612014/12/11 Added Hub support(confirmed with HHKB pro2)
622016/09/10 Unimap editor support
632016/10/18 Fix LED state at startup
642017/08/16 Port to QMK
65
66
67Resource
68-------- 45--------
69USB Host Sheild 2.0 46Hasu's main thread for the converter
47 https://geekhack.org/index.php?topic=69169.0
48Build guide for the Pro Micro variant
49 https://geekhack.org/index.php?topic=80421.0
50Original TMK version of the converter
51 https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb
52USB Host Shield 2.0
70 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino 53 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
71 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini 54 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
72USB Host Sheild 2.0 source 55USB Host Shield 2.0 source
73 https://github.com/felis/USB_Host_Shield_2.0 56 https://github.com/felis/USB_Host_Shield_2.0
74Arduino USB Host Shield(with bootst converter) 57Arduino USB Host Shield (with bootst converter)
75 http://arduino.cc/en/Main/ArduinoUSBHostShield 58 http://arduino.cc/en/Main/ArduinoUSBHostShield
76Arduino source 59Arduino source
77 https://github.com/arduino/Arduino/hardware/arduino/{cores,variants} 60 https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}