usb_usb: Restore LED state when plugging keyboard
[tmk_keyboard.git] / converter / usb_usb / README
CommitLineData
2a5ce5ef 1USB to USB keyboard protocol converter
2======================================
fef48a3d 3See for detail and discussion.
4https://geekhack.org/index.php?topic=69169.0
5
2a5ce5ef 6
7Hardware requirement
8--------------------
fef48a3d 9There are two options.
10
11### TMK USB-USB Converter
12You can buy a fully assembled converter from me here.
2a5ce5ef 13
fef48a3d 14 https://geekhack.org/index.php?topic=69169.0
15
16### Arduino Leonardo + Circuit@Home USB Host Shield 2.0
17Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
18
19 http://arduino.cc/en/Main/ArduinoBoardLeonardo
2e17aa2d
JW
20 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
21
fef48a3d 22Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
2e17aa2d
JW
23
24 http://arduino.cc/en/Main/ArduinoUSBHostShield
25 https://www.sparkfun.com/products/9947
26
27Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
fef48a3d 28
2e17aa2d
JW
29 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
30 https://www.sparkfun.com/products/12587
31 https://www.pjrc.com/teensy/td_libs_USBHostShield.html
32
2a5ce5ef 33
34
35Build firmware
36--------------
fef48a3d 37Build.
38
2a5ce5ef 39 $ git clone git://github.com/tmk/tmk_keyboard.git
40 $ cd tmk_keyboard
2a5ce5ef 41 $ git submodule init
42 $ git submodule update
2a5ce5ef 43 $ cd converter/usb_usb
44 $ make
45
fef48a3d 46And Program converter. Push button on TMK converter and just run this.
47
48 $ make dfu
49
50
51In case of Leonardo push reset button then run command. Serial port name(COM17) depends your system. On Linux I got /dev/ttyACM0.
9de992ba
JW
52
53 $ DEV=COM17 make program
54 or
55 $ avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:usb_usb.hex -PCOM17
2a5ce5ef 56
2a5ce5ef 57
58
59Limitation
60----------
61Only supports 'HID Boot protocol'.
9de992ba 62
e957c1c6 63Note 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.
64
65
66
67Keymap editor
68-------------
69You can editor keymap and download firmware with web brwoser.
70
71- http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?usb_usb
2e17aa2d 72
9de992ba 73
30864ea5
JW
74
75Update
76------
772014/12/11 Added Hub support(confirmed with HHKB pro2)
e957c1c6 782016/09/10 Unimap editor support
51326077 792016/10/18 Fix LED state at startup
30864ea5
JW
80
81
82
9de992ba
JW
83Resource
84--------
30864ea5
JW
85USB Host Sheild 2.0
86 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
87 https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
88USB Host Sheild 2.0 source
89 https://github.com/felis/USB_Host_Shield_2.0
90Arduino USB Host Shield(with bootst converter)
91 http://arduino.cc/en/Main/ArduinoUSBHostShield
92Arduino source
93 https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
94Initial release of TMK USB-USB converter
95 https://geekhack.org/index.php?topic=33057.msg653549#msg653549
96 http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854
97Arduino-based hardware keyboard remapper - Colemak forum
98 http://forum.colemak.com/viewtopic.php?id=1561
99Teensy + Host Shield
100 http://www.pjrc.com/teensy/td_libs_USBHostShield.html
Imprint / Impressum