From ad86894ae7d5fbb7aed697d9f576cd186bfd1c9c Mon Sep 17 00:00:00 2001 From: Erovia Date: Sun, 25 Oct 2020 15:23:42 +0000 Subject: Rename keyboard-level readmes to lower-case (#10759) This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc. --- keyboards/converter/adb_usb/README.md | 84 ------------------------------- keyboards/converter/adb_usb/readme.md | 84 +++++++++++++++++++++++++++++++ keyboards/converter/m0110_usb/README.md | 51 ------------------- keyboards/converter/m0110_usb/readme.md | 51 +++++++++++++++++++ keyboards/converter/usb_usb/README.md | 69 ------------------------- keyboards/converter/usb_usb/ble/README.md | 30 ----------- keyboards/converter/usb_usb/ble/readme.md | 30 +++++++++++ keyboards/converter/usb_usb/readme.md | 69 +++++++++++++++++++++++++ keyboards/converter/xt_usb/README.md | 17 ------- keyboards/converter/xt_usb/readme.md | 17 +++++++ 10 files changed, 251 insertions(+), 251 deletions(-) delete mode 100644 keyboards/converter/adb_usb/README.md create mode 100644 keyboards/converter/adb_usb/readme.md delete mode 100644 keyboards/converter/m0110_usb/README.md create mode 100644 keyboards/converter/m0110_usb/readme.md delete mode 100644 keyboards/converter/usb_usb/README.md delete mode 100644 keyboards/converter/usb_usb/ble/README.md create mode 100644 keyboards/converter/usb_usb/ble/readme.md create mode 100644 keyboards/converter/usb_usb/readme.md delete mode 100644 keyboards/converter/xt_usb/README.md create mode 100644 keyboards/converter/xt_usb/readme.md (limited to 'keyboards/converter') diff --git a/keyboards/converter/adb_usb/README.md b/keyboards/converter/adb_usb/README.md deleted file mode 100644 index 8de9b9ad46..0000000000 --- a/keyboards/converter/adb_usb/README.md +++ /dev/null @@ -1,84 +0,0 @@ -ADB-to-USB Keyboard Converter -============================= -This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory. - - -This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following: -https://github.com/qmk/qmk_firmware -https://docs.qmk.fm - - -Wiring ------- -Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter. - -ADB female socket from the front: - - ,--_--. - / o4 3o \ 1: DATA - | o2 1o | 2: Power SW - - === - 3: VCC - `-___-' 4: GND - -This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended. - -Pull-up resistor: - - Keyboard Converter - ,------. - 5V------+------|VCC | - | | | - [R] | | - | | | - Signal--+------|PD0 | - | | - GND------------|GND | - `------' - R: 1K Ohm resistor - - -Define following macros for ADB connection in config.h if you use other than port PD0. - - ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT - - -Building the Firmware ------------------------------------------- -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - - -Keymap ------- -To build the default keymap run this command: - - $ make converter/adb_usb:default - -You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard. - -To build your custom keymap, change the build command to: - - $ make converter/adb_usb:my_keymap - -Where 'my_keymap' is the name of your custom keymap directory. - - -Locking Caps Lock ----------------- -Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default. - - -Notes ------ -Non-extended ADB keyboards make no distinction between the left and right modifiers, -i.e. the keycode for the left modifier will be sent even if the right modifier - -The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command). - -Most ADB keyboards have no diodes in its matrix so they are not NKRO, -though the ADB protocol itself supports it. See protocol/adb.c for more info. - - -QMK Port Changelog ---------- -- 2018/09/16 - Initial release. -- 2018/12/23 - Fixed lock LED support. diff --git a/keyboards/converter/adb_usb/readme.md b/keyboards/converter/adb_usb/readme.md new file mode 100644 index 0000000000..8de9b9ad46 --- /dev/null +++ b/keyboards/converter/adb_usb/readme.md @@ -0,0 +1,84 @@ +ADB-to-USB Keyboard Converter +============================= +This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory. + + +This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following: +https://github.com/qmk/qmk_firmware +https://docs.qmk.fm + + +Wiring +------ +Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter. + +ADB female socket from the front: + + ,--_--. + / o4 3o \ 1: DATA + | o2 1o | 2: Power SW + - === - 3: VCC + `-___-' 4: GND + +This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended. + +Pull-up resistor: + + Keyboard Converter + ,------. + 5V------+------|VCC | + | | | + [R] | | + | | | + Signal--+------|PD0 | + | | + GND------------|GND | + `------' + R: 1K Ohm resistor + + +Define following macros for ADB connection in config.h if you use other than port PD0. + + ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT + + +Building the Firmware +------------------------------------------ +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + + +Keymap +------ +To build the default keymap run this command: + + $ make converter/adb_usb:default + +You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard. + +To build your custom keymap, change the build command to: + + $ make converter/adb_usb:my_keymap + +Where 'my_keymap' is the name of your custom keymap directory. + + +Locking Caps Lock +---------------- +Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default. + + +Notes +----- +Non-extended ADB keyboards make no distinction between the left and right modifiers, +i.e. the keycode for the left modifier will be sent even if the right modifier + +The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command). + +Most ADB keyboards have no diodes in its matrix so they are not NKRO, +though the ADB protocol itself supports it. See protocol/adb.c for more info. + + +QMK Port Changelog +--------- +- 2018/09/16 - Initial release. +- 2018/12/23 - Fixed lock LED support. diff --git a/keyboards/converter/m0110_usb/README.md b/keyboards/converter/m0110_usb/README.md deleted file mode 100644 index 2e8a2eaef1..0000000000 --- a/keyboards/converter/m0110_usb/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# M0110(A) keyboard converter - -This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le). - - -## Enabling Bluetooth for the Adafruit Feather 32U4 BLE - -Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name. - - -## Pins - -This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`. - - -## Other important hardware notes from the original TMK converter Readme: ->### Hardware ->-------- ->You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy]. -> ->Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`. -> ->[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg) -> ->#### 4P4C phone handset cable ->Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. -> -> -> ->[Teensy]: http://www.pjrc.com/teensy/ ->[TMK converter]: https://geekhack.org/index.php?topic=72052.0 -> -> ->#### Socket Pinout ->- -> ->![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) -> -> ->#### Pull-up Resistor ->You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors. -> - -[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\ -[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb) - - -## QMK Port Changelog - -- 2018/08/01 - Original Release - diff --git a/keyboards/converter/m0110_usb/readme.md b/keyboards/converter/m0110_usb/readme.md new file mode 100644 index 0000000000..2e8a2eaef1 --- /dev/null +++ b/keyboards/converter/m0110_usb/readme.md @@ -0,0 +1,51 @@ +# M0110(A) keyboard converter + +This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le). + + +## Enabling Bluetooth for the Adafruit Feather 32U4 BLE + +Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name. + + +## Pins + +This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`. + + +## Other important hardware notes from the original TMK converter Readme: +>### Hardware +>-------- +>You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy]. +> +>Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`. +> +>[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg) +> +>#### 4P4C phone handset cable +>Note that original cable used with Mac is **straight** while phone handset cable is **crossover**. +> +> +> +>[Teensy]: http://www.pjrc.com/teensy/ +>[TMK converter]: https://geekhack.org/index.php?topic=72052.0 +> +> +>#### Socket Pinout +>- +> +>![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png) +> +> +>#### Pull-up Resistor +>You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors. +> + +[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\ +[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb) + + +## QMK Port Changelog + +- 2018/08/01 - Original Release + diff --git a/keyboards/converter/usb_usb/README.md b/keyboards/converter/usb_usb/README.md deleted file mode 100644 index 594a9be877..0000000000 --- a/keyboards/converter/usb_usb/README.md +++ /dev/null @@ -1,69 +0,0 @@ -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](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat). - -Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) -Hardware 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 -Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built - -Make example for this keyboard (after setting up your build environment): - - make converter/usb_usb:default - -See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) 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. -- http://arduino.cc/en/Main/ArduinoBoardLeonardo -- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ - -Other compatible boards like 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. -- [Build guide](https://geekhack.org/index.php?topic=80421.0) -- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ -- https://www.sparkfun.com/products/12587 -- https://www.pjrc.com/teensy/td_libs_USBHostShield.html - -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. - -Resources --------- -- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0) -- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0) -- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb) -- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) -- [USB Host Shield 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) -- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549) -- [Teensy/Arduino + Host Shield](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) diff --git a/keyboards/converter/usb_usb/ble/README.md b/keyboards/converter/usb_usb/ble/README.md deleted file mode 100644 index 0ee7223fd4..0000000000 --- a/keyboards/converter/usb_usb/ble/README.md +++ /dev/null @@ -1,30 +0,0 @@ -QMK BLE Adapter -=============== -A small device that reads USB keyboard input and passes it on over Bluetooth LE HID. - -![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png) - -Hardware --------- -The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg). - -Schematic: -![Schematic](https://i.imgur.com/s1Ia9We.png) - -Part list: -* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) -* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) -* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115) -* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011) -* Some sort of switch to be able to turn it off - -Building and Flashing ---------------------- - -``` -make converter-usb_usb-ble -``` - -``` -make converter-usb_usb-ble-avrdude -``` \ No newline at end of file diff --git a/keyboards/converter/usb_usb/ble/readme.md b/keyboards/converter/usb_usb/ble/readme.md new file mode 100644 index 0000000000..0ee7223fd4 --- /dev/null +++ b/keyboards/converter/usb_usb/ble/readme.md @@ -0,0 +1,30 @@ +QMK BLE Adapter +=============== +A small device that reads USB keyboard input and passes it on over Bluetooth LE HID. + +![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png) + +Hardware +-------- +The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg). + +Schematic: +![Schematic](https://i.imgur.com/s1Ia9We.png) + +Part list: +* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) +* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) +* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115) +* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011) +* Some sort of switch to be able to turn it off + +Building and Flashing +--------------------- + +``` +make converter-usb_usb-ble +``` + +``` +make converter-usb_usb-ble-avrdude +``` \ No newline at end of file diff --git a/keyboards/converter/usb_usb/readme.md b/keyboards/converter/usb_usb/readme.md new file mode 100644 index 0000000000..594a9be877 --- /dev/null +++ b/keyboards/converter/usb_usb/readme.md @@ -0,0 +1,69 @@ +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](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat). + +Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat) +Hardware 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 +Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built + +Make example for this keyboard (after setting up your build environment): + + make converter/usb_usb:default + +See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) 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. +- http://arduino.cc/en/Main/ArduinoBoardLeonardo +- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ + +Other compatible boards like 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. +- [Build guide](https://geekhack.org/index.php?topic=80421.0) +- https://www.circuitsathome.com/arduino_usb_host_shield_projects/ +- https://www.sparkfun.com/products/12587 +- https://www.pjrc.com/teensy/td_libs_USBHostShield.html + +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. + +Resources +-------- +- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0) +- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0) +- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb) +- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/) +- [USB Host Shield 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) +- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549) +- [Teensy/Arduino + Host Shield](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) diff --git a/keyboards/converter/xt_usb/README.md b/keyboards/converter/xt_usb/README.md deleted file mode 100644 index 40b265a189..0000000000 --- a/keyboards/converter/xt_usb/README.md +++ /dev/null @@ -1,17 +0,0 @@ -XT to USB keyboard converter -============================== -This is a port of TMK's converter/xt_usb to QMK. - -This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.) - - -Connect Wires -------------- -1. Connect **Vcc** and **GND**. -2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`. -3. You need pull-up resistor. **1K-10K Ohm** will be OK. - - -XT keyboard protocol resource ------------------------------- -https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol diff --git a/keyboards/converter/xt_usb/readme.md b/keyboards/converter/xt_usb/readme.md new file mode 100644 index 0000000000..40b265a189 --- /dev/null +++ b/keyboards/converter/xt_usb/readme.md @@ -0,0 +1,17 @@ +XT to USB keyboard converter +============================== +This is a port of TMK's converter/xt_usb to QMK. + +This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.) + + +Connect Wires +------------- +1. Connect **Vcc** and **GND**. +2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`. +3. You need pull-up resistor. **1K-10K Ohm** will be OK. + + +XT keyboard protocol resource +------------------------------ +https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol -- cgit v1.2.3