History

James Young 4b453dca92 Remove MIDI Configuration boilerplate (#11151 ) * remove keyboard-level instances of `MIDI_ENABLE = no` Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e '/^[ #]MIDI_ENABLE[ \t]=[ \t]no/d' {} + ``` Co-Authored-By: Nick Brassel <nick@tzarc.org> fix case-sensitivity issues on MIDI_ENABLE Change instances of `MIDI_ENABLE = YES` to `MIDI_ENABLE = yes`. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;MIDI_ENABLE[ \t]=[ \t][Yy][Ee][Ss];MIDI_ENABLE = yes;g' {} + ``` * replace `# MIDI controls` with `# MIDI support` Replace `# MIDI controls` with `# MIDI support` in keyboard-level `rules.mk` files. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;#[ \t]MIDI[ \t]\(controls\\|support\).;# MIDI support;g' {} + ``` align inline comments Aligns the inline comments to the length used by the QMK AVR rules.mk template. Command: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;MIDI_ENABLE = yes.;MIDI_ENABLE = yes # MIDI support;g' {} + ``` remove commented instances of `MIDI_ENABLE` from keyboard `rules.mk` files Commands: ``` find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;#\([ \t]MIDI_ENABLE\) = yes; \1 = no ;' {} + find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e 's;^\([ \t]\)\(MIDI_ENABLE = no\);\2\1;' {} + find keyboards/ -type f -name 'rules.mk' -and -not -path '/keymaps/' -exec sed -i -e '/^[ #]\+MIDI_ENABLE = no/d' {} + ``` * remove MIDI configuration boilerplate from keyboard config.h files Co-authored-by: Nick Brassel <nick@tzarc.org>		2021-08-16 06:51:13 +10:00
..
type3	remove keyboard_folder from info.json	2021-02-27 16:17:12 -08:00
type5	remove keyboard_folder from info.json	2021-02-27 16:17:12 -08:00
.noci	Initial list of keyboards to exclude from CI (#11213 )	2020-12-21 15:38:39 +01:00
command_extra.c	port sun_usb converter from tmk	2018-10-12 10:26:58 -07:00
config.h	Remove `DESCRIPTION`, B-D (#11513 )	2021-01-15 05:00:04 +11:00
led.c	port sun_usb converter from tmk	2018-10-12 10:26:58 -07:00
matrix.c	Remove legacy print backward compatiblitly (#11805 )	2021-02-06 16:56:13 +00:00
readme.md	Modified URLs to point to new locations	2019-01-13 09:11:18 -08:00
rules.mk	Remove MIDI Configuration boilerplate (#11151 )	2021-08-16 06:51:13 +10:00

readme.md

Sun to USB keyboard protocol converter

A converter for using non-USB Sun keyboards.

Original code from the TMK firmware. Ported to QMK by Yann Hodique.

Keyboard Maintainer: Yann Hodique
Hardware Supported: See hardware section below
Hardware Availability: self-built

Make example for this keyboard (after setting up your build environment):

make converter/sun_usb/type5:default

See build environment setup then the make instructions for more information.

Hardware

Target MCU is ATMega32u4 but other USB capable AVR will also work. The maintainer mostly uses Teensy 2.0 boards. Supported keyboards: Sun Type 3 and 5 Keyboards,

Connector

8Pin mini DIN

   ___ ___
  /  |_|  \
 / 8  7  6 \
| 5    4  3 |
 \_ 2   1 _/
   \_____/
(receptacle)

Wiring:

Pin mini DIN        MCU
----------------------------------
1   GND             GND
2   GND             GND
3   5V
4   RX/TX(Mouse)
5   RX              PD3
6   TX              PD2
7   GND             GND
8   5V              VCC

Protocol

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 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.

Commands From System To Keyboard

0x01 Reset
        Keyboard responds with following byte sequence:
        Success: 0xFF 0x04 0x7F
        Fail:    0x7E 0x01 0x7F
0x02 Bell On
0x03 Bell Off
0x0A Click On
0x0B Click Off
0x0E LED
        followed by LED status byte:
        bit: 3       2       1       0
        LED: CapsLk  ScrLk   Compose NumLk
0x0F Layout
        Keyboard responds with 'Layout Response' 0xFE 0xXX

Commands From Keyboard To System

0x7F Idle
        means no keys pressed.
0xFE Layout Response
0xFF Reset Response(followed by 0x04)

References