Merge remote-tracking branch 'tmk/master' into cub_layout

[tmk_firmware.git] / converter / sun_usb / README

diff --git a/converter/sun_usb/README b/converter/sun_usb/README
index 7b4f95ca25d55b7b122667c7b7a28f28259166b7..276f6bfff81387b2312784f0bafe2d74e1bfbf86 100644 (file)
--- a/converter/sun_usb/README
+++ b/converter/sun_usb/README
@@ -34,11 +34,11 @@ Connector
 
 Protocol
 --------
-Singnal: Asynchronous, Negative logic, 1200baud, No Flow control
+Signal: Asynchronous, Negative logic, 1200baud, No Flow control
 Frame format: 1-Start bit, 8-Data bits, No-Parity, 1-Stop bit
 
     AVR USART engine expects positive logic while Sun keyboard signal is negative.
-    To use AVR UART engine you need exteral inverter in front of RX and TX pin.
+    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.
@@ -77,3 +77,23 @@ Just use 'make'
     $ 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
+```