usb_usb: update README

[max/tmk_keyboard.git] / converter / usb_usb / README

diff --git a/converter/usb_usb/README b/converter/usb_usb/README
index 985458ed013078de8dd7e8913c756d905d1f5643..30d5deb1e5817b1428a45721d82e85b145192eda 100644 (file)
--- a/converter/usb_usb/README
+++ b/converter/usb_usb/README
@@ -7,7 +7,19 @@ Arduino Leonardo
     http://arduino.cc/en/Main/ArduinoBoardLeonardo 
 
 Circuit@Home USB Host Shield 2.0
-    http://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
+    https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
+
+Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be the easiest way, you won't need even soldering iron.
+Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
+
+    http://arduino.cc/en/Main/ArduinoUSBHostShield
+    https://www.sparkfun.com/products/9947
+
+Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
+    https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
+    https://www.sparkfun.com/products/12587
+    https://www.pjrc.com/teensy/td_libs_USBHostShield.html
+
 
 
 Build firmware
@@ -32,9 +44,31 @@ Limitation
 Only supports 'HID Boot protocol'.
 Not support keyboard LED yet.
 
+Note that the converter can host only USB "boot protocol" keyboard(6KRO) and 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.
+
+
+
+Update
+------
+2014/12/11  Added Hub support(confirmed with HHKB pro2)
+
+
 
 Resource
 --------
-http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841.html
-https://github.com/felis/USB_Host_Shield_2.0
-https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
+USB Host Sheild 2.0
+    https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino
+    https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
+USB Host Sheild 2.0 source
+    https://github.com/felis/USB_Host_Shield_2.0
+Arduino USB Host Shield(with bootst converter)
+    http://arduino.cc/en/Main/ArduinoUSBHostShield
+Arduino source
+    https://github.com/arduino/Arduino/hardware/arduino/{cores,variants}
+Initial release of TMK USB-USB converter
+    https://geekhack.org/index.php?topic=33057.msg653549#msg653549
+    http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854
+Arduino-based hardware keyboard remapper - Colemak forum
+    http://forum.colemak.com/viewtopic.php?id=1561
+Teensy + Host Shield
+    http://www.pjrc.com/teensy/td_libs_USBHostShield.html