SharpKey Multi-HID-Schnittstelle Firmware-Leitfaden

Ueberblick

Einige einfallsreiche japanische Entwickler (classicpc.org, oder Youkan) und Martin bei 8bity.cz haben Schnittstellen entwickelt, um gaengige PS/2- oder USB-PC-Tastaturen fuer diese tastaturlosen Sharp-Maschinen zu konvertieren. Fuer den X1 und X68000 funktionieren diese Schnittstellen insgesamt einwandfrei. Das MZ-2500-Interface hat jedoch einige Probleme, nicht zuletzt basiert das verfuegbare Design auf einem ST-Entwicklungsboard und die Firmware ist Closed Source. Da ich eine zuverlaessig funktionsfaehige Einheit benoetigt habe, um meine MZ-2500/MZ-2800-Maschinen unter Renovierung fertigzustellen, musste ich andere Optionen in Betracht ziehen.

MZ-2500 Tastaturprotokoll

Die Hardware-Schnittstelle umfasst 7 Signale, 5V und GND, unter Verwendung einer geschirmten 8-poligen Mini-DIN-Buchse und eines Steckers.

Es gibt zwei Hauptbetriebsmodi: einen Alle-Tasten-Test-Modus (STROBEALL), der wartet, bis eine Taste gedrueckt wird, gefolgt von einem manuellen Scan aller Zeilen, um die gedrueckte Taste zu lokalisieren.

Fuer den Datenabruf der Tasten ist das Protokoll wie folgt:

1. RTSN geht auf aktiv HIGH und bleibt fuer 1,08us aktiv. Die anfaengliche RTSN-Periode ist 1,08us aktiv HIGH und 660ns inaktiv LOW. Danach ist die Periode einheitlich 660ns aktiv HIGH und 680ns inaktiv LOW.
2. Die Hauptplatine sendet eine Scan-Zeile an die Tastatur, die 160ns nach der steigenden Flanke von RTSN gueltig wird.
3. Die Scan-Zeile wird von der Tastatur in den verbleibenden 920ns von KD[3:0] gelesen. KD4-Zustand geht der steigenden Flanke von RTSN voraus.
4. KD4 wird abgetastet; bei LOW wird das logische AND aller Tasten pro Spalte gesetzt, bei HIGH werden die tatsaechlichen Spaltendaten der ausgewaehlten Zeile gesetzt.
5. Bei der fallenden RTSN-Flanke geht MPX fuer 320ns auf HIGH und das obere Nibble wird ausgegeben. Wenn MPX auf LOW geht, wird das untere Nibble ausgegeben.
6. Das Obige wiederholt sich waehrend eine Taste gedrueckt wird.

Fuer den STROBEALL-Modus:

1. KD4 wird LOW gehalten.
2. RTSN hat eine gleichmaessige Periode, 660ns aktiv HIGH, 660ns aktiv LOW. 3-5. Wie oben, aber die Zeile wird ignoriert.

Die Signale koennen in den folgenden Logikanalysator-Diagrammen visualisiert werden:

Waehrend der Inaktivitaet sendet das Gatearray auf der Hauptplatine einen STROBEALL-Befehl.

Wenn eine Taste gedrueckt wird, wechselt KD4 auf HIGH und die Hauptplatine beginnt die Tastatur abzufragen, um die gedrueckte Taste zu ermitteln. Zuerst wird Zeile 11 abgefragt (Sondertasten: CTRL, SHIFT, LOCK, KANA, GRAPH).

Nach Zeile 11 wird Zeile 12 (japanische Transform-Tasten) gescannt, dann beginnt ein sequentieller Scan aller Zeilen ab Zeile 0.

Der sequentielle Scan wird fortgesetzt, bis die gedrueckte Taste gefunden wird (in diesem Fall ‘C’ auf Zeile 4, Spalte 3). Die Zeile wird ueber 600us gescannt, um Prellen zu erkennen.

Die vom MZ-2500 verwendete Hardware:

Dieser Schaltplan zeigt die Tastaturschaltung mit einem Gate Array und einem bidirektionalen Puffer.

Dieser Schaltplan zeigt die Schaltung der Haupteinheit mit einem Gate Array, verbunden mit dem Z-80B PIO.

MZ-2800 Tastaturprotokoll

Der MZ-2800 ist der Nachfolger des MZ-2500. Sein Design enthaelt einen 8-Bit Z80-basierten MZ-2500-Modus und einen 16-Bit 80286-Modus. Er verwendet dieselbe Hardware-Schnittstelle aber ein anderes Protokoll mit unterschiedlichem Timing.

Das Protokoll ist aehnlich dem MZ-2500, mit Unterschieden im Timing und in der Art, wie Tasten abgefragt werden.

Ein Unterschied zum MZ-2500 ist die Hinzufuegung einer 14. Zeile. Im MZ-2500-Modus wird Zeile 14 nicht gescannt.

Die Hardware des MZ-2800:

ESP-32S AI Thinker

Schaltplan

Leiterplatte

Zusammengebautes Interface

Die Bilder unten zeigen das fertiggestellte, zusammengebaute und funktionsfaehige Interface.

Zusammengebautes MZ-2800 Interface

Firmware

Die Firmware ist unter dem Espressif IDF Build-System geschrieben, bestehend aus gcc(++), git, CMake und Ninja. Die Firmware ist in einer Mischung aus C und C++ geschrieben, wobei C++ die primaere Sprache ist.

Automatisiertes Setup und Build (empfohlen)

macOS / Linux / WSL — setup_SharpKey.sh

chmod +x setup_SharpKey.sh
./setup_SharpKey.sh

Windows 10 / 11 — setup_SharpKey_windows.ps1 (nativ — kein WSL, kein Docker). In einer PowerShell-Eingabeaufforderung (eine normale Benutzer-Eingabeaufforderung genuegt; winget fragt evtl. nach Erhoehung):

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\setup_SharpKey_windows.ps1

Fragen, die das Setup stellt, und was zu tun ist. Jede Eingabeaufforderung hat einen sicheren Standardwert in Klammern — der Grossbuchstabe ist der Standard, sodass Druecken von Enter ihn uebernimmt.

macOS / Linux / WSL (setup_SharpKey.sh):

Windows (setup_SharpKey_windows.ps1):

Ausgabe und Neu-Bauen. Ein erfolgreicher Build schreibt die Firmware nach build/main.bin (mit einer versionierten Kopie unter release/ unter macOS/Linux). Um spaeter neu zu bauen, ohne das Setup-Skript erneut auszufuehren:

# Docker (macOS / Linux / WSL)
docker run --rm -it -v "$PWD":/project -w /project espressif/idf:v4.4 idf.py build

# Native ESP-IDF (macOS / Linux)
. "$IDF_PATH/export.sh" && idf.py build

# Windows (native ESP-IDF, from a new PowerShell)
& "$HOME\esp\esp-idf-v4.4\export.ps1"; idf.py build

Build mit Docker

# Docker installieren
sudo apt update && sudo apt install -y docker.io
sudo systemctl enable docker && sudo systemctl start docker

# Repository klonen
git clone https://git.eaw.app/eaw/SharpKey.git
cd SharpKey
git submodule update --init --recursive

# Web-Dateisystem bauen
chmod +x build_webfs.sh && ./build_webfs.sh

# Firmware mit Docker bauen
docker run --rm -v $PWD:/project -w /project espressif/idf:v4.4 idf.py build

# Flashen und ueberwachen
docker run --rm --privileged \
    --volume /dev:/dev --volume /sys:/sys:ro --volume /dev/bus/usb:/dev/bus/usb \
    -v $PWD:/project -w /project \
    espressif/idf:v4.4 \
    idf.py -p /dev/ttyUSB0 build flash monitor

Kontinuierliche Integration (Jenkins)

Verwendung

Eine Tastatur ist eine Tastatur, richtig? Nun, nicht ganz, besonders wenn eine Tastatur eine andere imitiert!

Zuordnungstabelle – siehe englische Version fuer vollstaendige Tabelle.

Beim Einschalten ist die Standardzuordnung auf MZ-2500 eingestellt.

Preise

Die Preistabellen finden Sie in der englischen Version – Stuecklistenpreise sind international einheitlich in GBP angegeben.

Danksagungen

Lizenzen

Hinweis zur Funkregulierung