ibmpc: Fix comments

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

diff --git a/converter/sun_usb/README b/converter/sun_usb/README
index ee59fc757c5982d7b592c04780de9e02384afe46..405a86ba2db940cc649c4fb5cc0e01b2986eb786 100644 (file)
--- a/converter/sun_usb/README
+++ b/converter/sun_usb/README
@@ -1,11 +1,18 @@
 Sun to USB keyboard protocol converter
 ======================================
 Target MCU is ATMega32u4 but other USB capable AVR will also work.
 Sun to USB keyboard protocol converter
 ======================================
 Target MCU is ATMega32u4 but other USB capable AVR will also work.

-Supported keyboards: Sun Type 5 Keyboard, CTCSP SHORT TYPE KEYBOARD(CKUB)

 
 

-CTCSP SHORT TYPE KEYBOARD: http://imgur.com/a/QIv6p
+This converter will work with Sun Type 2-5 Keyboards.

 
 
 
 

+Tested on:
+Sun Type 3 Keyboard: http://blog.daveastels.com.s3-website-us-west-2.amazonaws.com/2014/12/27/type-3-keyboard.html
+CTCSP SHORT TYPE KEYBOARD(Type 5): http://imgur.com/a/QIv6p
+
+
+Keymap of Type 3(keymap_sun3.c) were impoted from dastels's repository.
+https://github.com/dastels/tmk_keyboard/tree/master/converter/sun3_usb
+

 
 
 Connector
 
 
 Connector


@@ -41,7 +48,9 @@ Frame format: 1-Start bit, 8-Data bits, No-Parity, 1-Stop bit
     To use AVR UART engine you need external inverter in front of RX and TX pin.
     Otherwise you can software serial routine to communicate the keyboard.
 
     To use AVR UART engine you need external inverter in front of RX and TX pin.
     Otherwise you can software serial routine to communicate the keyboard.
 

-This converter uses software method, you doesn't need any inverter part.
+This converter uses software method by default, so you don't need any inverter part.  But
+it can also be built with 'make HARDWARE_SERIAL=y' to enable hardware serial if there
+is an inverter present.  Good results have been obtained using a 74LS04 and hardware serial.

 
 
 Commands From System To Keyboard
 
 
 Commands From System To Keyboard


@@ -77,3 +86,23 @@ Just use 'make'
     $ cd sun_usb
     $ make
 Then, load the binary to MCU with your favorite programmer.
     $ cd sun_usb
     $ make
 Then, load the binary to MCU with your favorite programmer.

+
+
+Sun commands
+------------
+You can send Sun protocol commands with TMK `Magic` key combo. By default `Magic` key is `LShift` + `RShift`, `LAlt` + `RAlt' or `LMeta` + `RMeta`.
+https://github.com/tmk/tmk_keyboard#magic-commands
+
+Following Sun specific commands are available. For example, to send 'Bell On' you can press `LShift` + `RShift` + `Up` keys simultaneously.
+
+```
+----- Sun converter Help -----
+Up:     Bell On
+Down:   Bell Off
+Left:   Click On
+Right:  Click Off
+PgUp:   LED all On
+PgDown: LED all On
+Insert: Layout
+Delete: Reset
+```