SharpKey Interface Multi-HID Manuel Utilisateur

Le SharpKey

Le nom SharpKey derive de Sharp Keyboard Interface, car il est base sur l'original mz25key Sharp MZ-2500/MZ-2800 PS/2 Keyboard Interface.
Le SharpKey Multi-HID Interface est un dispositif permettant la connexion de claviers et de souris, via PS/2 ou Bluetooth, a des ordinateurs Sharp et NEC vintage. Il est loge dans un petit boitier KM-24 noir ou gris clair assorti a la couleur de la console hote et occupe un espace minimal. Il dispose de deux ports externes : un pour un clavier ou une souris PS/2 et le second pour un cable de connexion a la prise d'entree clavier ou souris de l'hote. En cas d'utilisation du Bluetooth, le port PS/2 n'est pas utilise et seul un cable hote est necessaire.
En fonctionnement, le SharpKey est alimente par l'hote, ajoutant peu de charge supplementaire a l'alimentation de l'ordinateur hote. Il consomme typiquement 30mA en mode interface actif, montant a 150mA si l'interface web IoT est activee. Le courant de demarrage instantane maximal pour le WiFi peut atteindre 250mA.
Cette section decrit les ports, interfaces, boutons et LEDs du SharpKey.

Ports

Le SharpKey est equipe de deux ports femelles mini-DIN, d'une LED et d'un interrupteur de configuration pour activer l'interface web IoT WiFi integree et l'appairage Bluetooth. L'image ci-dessous montre les emplacements.

A gauche se trouve le connecteur HOST, une prise femelle mini-DIN 8 broches dans laquelle un cable specifique a l'hote est branche. Le cable relie le SharpKey a un port souris ou clavier d'un hote particulier, par ex. Sharp MZ-2800.
A droite se trouve le connecteur PS/2, une prise femelle mini-DIN 6 broches dans laquelle un clavier ou une souris PS/2 est branche. Ce port supporte le branchement a chaud, permettant de debrancher et rebrancher un peripherique sans eteindre l'interface.
En interne, il y a un connecteur header 8 broches 2mm, utilise en cas d'echec de la mise a jour OTA du firmware ou pour le developpement et le debogage de nouvelles fonctionnalites. Consultez la documentation technique pour plus d'informations.

LEDs

La LED bleue d'activite indique le fonctionnement du dispositif et avertit des erreurs ou de l'etat du dispositif.
En fonctionnement normal, la LED s'allume pendant une seconde lors de la mise sous tension puis s'eteint. Si aucun peripherique PS/2 n'est connecte, la LED reste allumee en permanence jusqu'a ce qu'un peripherique PS/2 soit connecte (ou que le Bluetooth soit active et qu'un peripherique s'appaire). Pendant l'activite du clavier, la LED pulse a chaque touche pressee. Pendant l'activite de la souris, la LED ne s'allume que si le bouton de la molette est presse.
Etat LED Occurrence Description
Allumee Mise sous tension S’allume 1 seconde puis s’eteint. Indique un demarrage et une initialisation normaux.
  Utilisation normale Clavier ou souris PS/2 non connecte, peripherique Bluetooth non appaire.
Eteinte Mise sous tension Defaillance du dispositif.
  Utilisation normale Dispositif en fonctionnement normal.
Clignotante Utilisation normale La LED s’allume brievement a chaque touche pressee.
  Selection WiFi Clignotement 1 fois par 0,5s quand la touche WiFi est pressee plus de 2 secondes.
    Clignotement 1 fois par 0,25s quand la touche WiFi est pressee plus de 5 secondes.
  Appairage Bluetooth Clignotement 1 fois par 0,125s quand la touche WiFi est pressee plus de 10 secondes.
  Reset NVS Clignotement long 1 fois par seconde quand la touche WiFi est pressee plus de 15 secondes.

Interrupteurs

L'interrupteur de configuration WiFi/Bluetooth se trouve a l'interieur du boitier SharpKey et est accessible via un trou d'epingle sur le dessus du boitier, a cote de la LED. Une tige non conductrice doit etre utilisee.
La duree de pression sur l'interrupteur determine la fonctionnalite selectionnee.
Duree de pression LED Fonctionnalite
1 seconde Eteinte. Annuler toute fonctionnalite selectionnee.
2 pressions en 1 seconde Le SharpKey redemarre et la LED reste allumee jusqu’a ce qu’une touche soit pressee. Redemarrer le SharpKey.
2 - 4 secondes Clignote 2 fois par seconde. Selectionner le mode WiFi configure (Access Point ou Client).
5 - 9 secondes Clignote 4 fois par seconde. Selectionner le mode Access Point WiFi par defaut.
10 - 14 secondes Clignote 8 fois par seconde. Selectionner le mode d’appairage Bluetooth.
15 - 19 secondes Un clignotement long par seconde. Selectionner le mode Reset NVS (effacer tous les parametres et restaurer les valeurs d’usine).

Consultez la section correspondante pour plus d’informations.

Cables

Chaque machine hote a des specifications electriques et mecaniques differentes pour ses entrees clavier et souris. Le SharpKey gere les exigences electriques et de protocole mais l'exigence mecanique doit etre satisfaite avec un cable physique.
Cela signifie que chaque port d'entree clavier et souris de la machine hote necessite un cable unique du SharpKey vers le port clavier ou souris de l'hote. Sur les machines Sharp, le port souris est commun, un seul cable est necessaire.
Chaque cable a un connecteur mini-DIN 8 broches (le MZ-2500 en a 2) qui se branche dans le SharpKey. L'autre extremite se branche dans le port clavier ou souris de l'hote.

Connexion du SharpKey

La connexion du SharpKey est simple : procurez-vous le cable correct pour votre machine hote (clavier ou souris), branchez l'extremite mini-DIN 8 broches dans le SharpKey et l'autre extremite dans le port clavier ou souris de votre machine hote.
Si vous utilisez un clavier ou une souris PS/2, inserez le connecteur mini-DIN 6 broches dans l'autre extremite du SharpKey. Si vous utilisez le Bluetooth, aucune connexion au port PS/2 n'est necessaire.

NB. Le Bluetooth ne sera active que lorsqu'aucun peripherique PS/2 n'est connecte.

Une fois les cables connectes, allumez votre machine et utilisez le clavier/souris PS/2 ou Bluetooth normalement. Si des touches ne correspondent pas correctement, utilisez l'interface web IoT pour ajouter des correspondances.

NB. Le firmware inclut un mecanisme de nouvelle tentative pour la detection du clavier PS/2 -- l'adaptateur reessaie jusqu'a 10 fois avec des delais de 100ms avant de passer en mode Bluetooth.

NB. Les peripheriques Bluetooth necessitent un appairage et peuvent mettre quelques secondes a se connecter apres la mise sous tension. Reveillez les peripheriques Bluetooth en appuyant sur la touche Shift ou en bougeant la souris.

Appairage Bluetooth

En plus des peripheriques HID PS/2, des peripheriques Bluetooth sans fil peuvent etre connectes au SharpKey.
Pour utiliser le Bluetooth, aucun peripherique PS/2 ne doit etre connecte au SharpKey. L'emetteur-recepteur Bluetooth de l'ESP32 n'est pas tres puissant, votre peripherique doit etre a moins de 1m.
A la reception, en mode usine par defaut ou apres une suppression NVS, le SharpKey effectue un scan Bluetooth pour rechercher les peripheriques a proximite en mode appairage. Appuyez simplement sur le bouton appairage de votre clavier ou souris et en 5-10 secondes la connexion devrait s'etablir sans PIN.
Jusqu'a 5 peripheriques supplementaires peuvent etre appaires en placant le SharpKey en mode appairage. Pour entrer en mode appairage, pressez l'interrupteur WiFi/Config pendant 10-15 secondes :
  • 2-5 secondes : clignote 2 fois par seconde = mode WiFi si relache.
  • 5-10 secondes : clignote 4 fois par seconde = mode WiFi par defaut si relache.
  • 10-15 secondes : clignote 8 fois par seconde = mode appairage Bluetooth si relache.
Relachez apres 10 secondes et le SharpKey entrera en mode appairage pendant 60 secondes.
L'authentification par PIN est desactivee. Si votre peripherique necessite un PIN, apres 10 secondes la LED bleue clignotera avec 3 longs pulses. Entrez le code PIN '1234' sur votre clavier et appuyez sur ENTER.
Lors des redemarrages futurs, reveillez votre peripherique Bluetooth en appuyant sur Shift ou en bougeant la souris.

Acces a l'interface web IoT

Le SharpKey dispose de plusieurs cartes de correspondance preconfigures, par defaut en disposition UK. Les dispositions supportees sont :
  • Wyse KB-3926 UK Layout
  • Generic OADG109 Japanese Layout
  • Sanwa SKB-L1 Japanese Layout
  • Perixx Periboard 810 UK Layout
  • OMOTON K8508 UK Layout
Le SharpKey peut etre configure pour mapper tout code PS/2 ou combinaison de codes dans une sequence de touches attendue par l'hote actif. Les scancodes Bluetooth sont mappes en interne sur des scancodes PS/2.
Le SharpKey est equipe d'un serveur web integre utilisant la technologie WiFi, configurable en mode Access Point ou Client.
Pour acceder a l'interface web, activez le transceiver WiFi via l'interrupteur WiFi/BT Config.
Deux modes WiFi sont disponibles :
  • Access Point : le SharpKey agit comme routeur WiFi. Recherchez le reseau sharpkey et connectez-vous avec le mot de passe sharpkey.
  • Client : le SharpKey se connecte a votre reseau domestique avec des identifiants pre-entres.
Mode Acces Description
Mode Access Point.
Configuration initiale.
Configuration usine : presser l’interrupteur WiFi 5-10 secondes. Recherchez le reseau sharpkey, mot de passe sharpkey. Ouvrez http://192.168.4.1
Mode Access Point. Apres configuration, presser l’interrupteur WiFi 2-5 secondes. Mode Access Point configure avec vos parametres.
Mode Client (Station). Apres configuration en Client, presser l’interrupteur WiFi 2-5 secondes. Le SharpKey se connecte a votre routeur avec les identifiants fournis.

Configuration du mode Access Point

Le SharpKey demarre automatiquement en mode Access Point en etat usine. Les parametres par defaut sont :
Parametre Valeur
SSID (nom du reseau) sharpkey
Mot de passe sharpkey
Adresse IP Access Point 192.168.4.1
Adresse du routeur 192.168.4.1
Plage IP DHCP 192.168.4.2 - 192.168.4.254
Accedez au menu WiFi de votre ordinateur, selectionnez le reseau sharpkey et entrez le mot de passe. Puis ouvrez http://192.168.4.1 dans un navigateur.
Cliquez sur WiFi Manager dans le menu lateral gauche pour configurer le WiFi.

Option Description
WiFi Mode Selectionnez Access Point.
SSID Nom du reseau visible sur votre ordinateur.
Password Mot de passe pour rejoindre le reseau.
IP Address Plage d’adresses IP pour le serveur DHCP. Doit se terminer par .1.
Netmask Toujours 255.255.255.0 sauf si vous etes expert reseau.
Gateway Identique a l’adresse IP.

Configuration du mode Client

Pour le mode Client, cliquez sur Client et entrez vos identifiants reseau. Deux sous-modes : DHCP Active ou DHCP Desactive.
Option Description
WiFi Mode Client.
SSID Nom du reseau a rejoindre.
Password Mot de passe de votre routeur.
DHCP Mode Active (le routeur fournit les infos) ou Desactive (vous les specifiez).

Mises a jour OTA

Le SharpKey permet la mise a jour de son firmware ou de son systeme de fichiers via OTA. Cliquez sur OTA Update dans le menu lateral.

L'ecran OTA affiche 4 panneaux : informations de version, partitions ESP32, upload firmware et upload filepack. Le SharpKey utilise un systeme de mise a jour tolerant aux pannes en round robin entre les partitions ota_0 et ota_1.

Configuration hote

La page de configuration hote permet de remplacer la detection automatique de la machine hote. Modes disponibles :
  • Auto (defaut) -- detection automatique au demarrage.
  • Sharp MZ-2500
  • Sharp MZ-2800
  • Sharp X1 / X1 Turbo
  • Sharp X68000
  • Sharp MZ-5500 / MZ-5600 / MZ-6500
  • NEC PC-9801
  • Mouse -- mode souris uniquement.

Editeur de correspondance de touches

Le SharpKey permet l'edition des correspondances de touches via l'editeur integre ou via une procedure locale de sauvegarde-edition-upload. L'editeur de base est une table d'entree hexadecimale avec priorite de haut en bas.

Sharp MZ-2500 / MZ-2800 Correspondance de touches

Les modeles MZ-2500 et MZ-2800 partagent une table de correspondance commune. Ces machines utilisent une matrice clavier 13x8 ou 14x8.
    MZ-2500 Keyboard Map.
    
     Row     D7        D6        D5        D4        D3        D2        D1        D0
    ----------------------------------------------------------------------------------
      0      F8        F7        F6        F5        F4        F3        F2        F1
      1      KP -      KP +      KP .      KP ,      KP 9      KP 8      F1O       F9
      2      KP 7      KP 6      KP 5      KP 4      KP 3      KP 2      KP 1      KP 0
      3      BREAK     RIGHT     LEFT      DOWN      UP        RETURN    SPACE     TAB
      4       G         F         E        D         C         B         A         / ?
      5       O         N         M        L         K         J         I         H
      6       W         V         U        T         S         R         Q         P
      7       , <       . >       _        YEN |     ^         Z         Y         X  
      8       7 '       6 &       5 %      4 $       3 #       2 "       1 !       0
      9                 [ {       @ `      - =       ; +       : *       9 )       8 (
     10       KP /      KP *      ESC      BACKSPACE INST/DEL  CLR/HOME  COPY      ] }
     11                                    CTRL      KANA      SHIFT     LOCK      GRAPH
     12                                                                  KJ2       KJ1 
     13                                                                  HELP      ARGO 

Parametre Description
PS/2 KeyCode Code brut PS/2 sans modificateurs E0/E1 ou Break.
PS/2 Control Key Touches de controle : SHIFT, CTRL, CAPS, ALT, ALTGR, GUI, FUNC et BREAK.
For Keyboard Indicateur pour un modele de clavier specifique.
For Host Model Indicateur pour un modele ou un ensemble de modeles de machine.
Make Row 1 Ligne dans la matrice clavier a activer.
Make Key 1 Colonne dans la matrice clavier a activer.
Make Row 2 Deuxieme ligne (0xFF = desactive).
Make Key 2 Comme Make Key 1.
Make Row 3 Troisieme ligne (0xFF = desactive).
Make Key 3 Comme Make Key 1.
Break Row 1 Ligne a desactiver.
Break Key 1 Colonne a desactiver.
Break Row 2 Deuxieme ligne a desactiver (0xFF = desactive).
Break Key 2 Comme Break Key 1.

Sharp X1 Correspondance de touches

La serie Sharp X1 comprend le X1, X1 Turbo et X1 Turbo Z. La correspondance est plus conventionnelle : un scancode PS/2 correspond a un scancode X1. Le X1 Turbo/Turbo Z a un commutateur de mode : Mode A (original) et Mode B (jeu, 24 bits).

7 6 5 4 3 2 1 0
TENKEY KIN REP GRPH CAPS KANA SFT CTRL
  7 6 5 4 3 2 1 0
BYTE1 Q W E A D Z X C
BYTE2 7 4 1 8 2 9 6 3
BYTE3 ESC 1 - + * HTAB SP RET

Sharp X68000 Correspondance de touches

La serie Sharp X68000 comprend les modeles Original, ACE, Expert, Super, Pro, XVI, Compact et 68030. La correspondance est conventionnelle, similaire au protocole PS/2.

X68000 Scan Codes
,---. ,---.    ,-------------------,    ,-------------------.  ,-----------. ,---------------.
| 61| | 62|    | 63| 64| 65| 66| 67|    | 68| 69| 6A| 6B| 6C|  | 5A| 5B| 5C| | 5D| 52| 53| 54|
`---' `---'    `-------------------'    `-------------------'  `-----------' `---------------'
,-----------------------------------------------------------.  ,-----------. ,---------------.
| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0A| 0B| 0C| 0D| 0E| 0F|  | 36| 5E| 37| | 3F| 40| 41| 42|
|-----------------------------------------------------------|  |------------ |---------------|
|  10 | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1A| 1B| 1C|     |  | 38| 39| 3A| | 43| 44| 45| 46|
|------------------------------------------------------. 1D |  `---=====---' |---------------|
|  71  | 1E| 1F| 20| 21| 2l| 23| 24| 25| 26| 27| 28| 29|    |   ___| 3C|___  | 47| 48| 49| 4A|
|-----------------------------------------------------------|  | 3B|---| 3D| |-----------|---|
|  70    | 2A| 2B| 2C| 2D| 2E| 2F| 30| 31| 32| 33| 34|   70 |  `---| 3E|---' | 4B| 4C| 4D|   |
`-----------------------------------------------------------|  .---=====---. |-----------| 4E|
       | 5F| 55 | 56 |     35     | 57 | 58 | 59 | 60|         |  72 |  73 | | 4F| 50| 51|   |
       `---------------------------------------------'         `-----------' `---------------'

Raccourcis clavier

Les raccourcis clavier sont des combinaisons speciales pour activer/desactiver des fonctionnalites. Les parametres sont enregistres en memoire permanente.
Hote actif Raccourci Persistant Fonctionnalite
All SHIFT+CTRL+ESC+ 1 Yes Select Keyboard Model UK KB-3926
All SHIFT+CTRL+ESC+ 2 Yes Select Keyboard Model JAPAN OADG109
All SHIFT+CTRL+ESC+ 3 Yes Select Keyboard Model JAPAN Sanwa SKB-L1
All SHIFT+CTRL+ESC+ 0 Yes Select STANDARD Map Keyboard
MZ-2500 SHIFT+CTRL+ESC+KeyPad 1 Yes Correspondance MZ-2500
MZ-2800 SHIFT+CTRL+ESC+KeyPad 1 Yes Correspondance MZ-2800
X1 SHIFT+CTRL+ESC+KeyPad 1-3 Yes Correspondance Original/Turbo/TurboZ
X1 SHIFT+CTRL+ESC+KeyPad 7/9 No Mode clavier A/B
X68000 SHIFT+CTRL+ESC+KeyPad 1-8 Yes Correspondance par modele

Configuration de la souris

Le SharpKey, en mode interface souris, permet de configurer les parametres de la souris. La configuration de base se fait avec la molette de la souris.

  • PS/2 Mouse Scaling - Mise a l'echelle des donnees de mouvement.
  • PS/2 Mouse Resolution - Precision des donnees de la souris par mm.
  • PS/2 Mouse Sampling Rate - Frequence d'echantillonnage. Le protocole Sharp necessite 50/s, donc 60/s est optimal.

Remerciements

L'environnement de developpement Espressif IDF et les materiaux de reference ESP-32S ont ete utilises dans la conception de cette interface.

Licences

Cette conception est sous licence GNU Public Licence v3. Aucune utilisation commerciale sans autorisation expresse de l'auteur.

Avis de reglementation sans fil

Cet appareil incorpore un module sans fil ESP32-S pre-certifie (AI Thinker) emettant dans la bande ISM 2,4 GHz.
Les certifications au niveau du module ne s'etendent pas automatiquement au produit fini. L'exemption des modules pre-certifies permet aux bricoleurs individuels de construire un nombre limite d'appareils pour un usage personnel, experimental ou educatif.
Responsabilite du constructeur
Il est de la seule responsabilite du constructeur de s'assurer de la conformite aux reglementations applicables.