USB-BAT Bedien-Anzeige-Terminal

Transkript

1 USB-BAT Bedien-Anzeige-Terminal USB-H Schnittstellen-Protokoll Stand: ELV-Bestell-Nr.: Firmware-Version: 1.1 ELV Elektronik AG Postfach 1000 D Leer Telefon 04 91/ Telefax 04 91/

2 Inhaltsverzeichnis 1 H-Datenrahmen Befehle vom PC zum USB-BAT senden (PC )... 3 Tabelle 1: Aufbau und Byteanzahl der Datenrahmen... 3 Tabelle 2: Unterschiedliche Datenrahmen Vom USB-BAT auf dem PC ankommende Infos (USB-BAT PC)... 5 Tabelle 4: Allgemeiner Aufbau eines Datenrahmens... 5 Tabelle 5: Mögliche Antworten vom USB-BAT... 5 Tabelle 6: Mögliche FS20-IRP-Meldungen (Error-)... 6 Tabelle 7: Beispiele zur Codierung der Firmware-Versionsnummer... 6 Tabelle 8: Tasterstatus... 6 Tabelle 9: Position des Inkrementalgeber... 6 Tabelle 10: Portpinstatus der Taster

3 1 H-Datenrahmen Die Datenrahmen werden bei H immer in voller Länge übertragen, auch wenn sie nur teilweise mit Nutzdaten gefüllt sind. Welche Byte auswertbare Daten enthalten, ist am Anfang eines Datenrahmens durch Byte-Anzahl und Befehls- bzw. die Antwort- definiert. 1.1 Befehle vom PC zum USB-BAT senden (PC ) Die Rahmengröße vom PC zum USB-BAT ist immer 64 Byte groß inkl. Der im ersten Byte übertragenen Report- 0x01, die die Datenrichtung angibt. Der Wert Byte-Anzahl ist abhängig von der Befehls- (siehe Tabelle 2). Ungenutzte Byte im Rahmen sind theoretisch beliebig, sollten aber sicherheitshalber mit 0x00 aufgefüllt werden. Das Display ist in 8 Pages eingeteilt, die separat übertragen werden. Tabelle 1: Aufbau und Byteanzahl der Datenrahmen H-Report- Byte-Anzahl* Befehls- Anweisung und Parameter 1 Byte (immer 0x01) 1 Byte (0x01 0x3E) 1 Byte Immer 61 Byte, wobei zwischen 0 und 60 Byte davon tatsächlich verwendet werden. Die restlichen Byte mit 0x00 füllen. *Bei der Byte-Anzahl zählen die beiden Byte für die H-Report- und Byte-Anzahl nicht mit. Tabelle 2: Unterschiedliche Datenrahmen H- Report- Byte- Anzahl* Befehls- Beschreibung/Bedeutung der Befehls- 0x01 0x01 0xF0 Firmware-Version ausgeben 0x01 0x02 0xF1 Displayhinterleuchtung für bestimmte Zeitdauer einschalten 0x01 0x02 0xF2 Displayhinterleuchtung Ausschalten/ Beleuchtungsmodus ändern 0x01 0x02 0xF3 Piepton mit variabler Zeitdauer Nachfolgende Parameter-Bytes Keine weiteren Parameter-Bytes 1 Byte für Zeitdauer in 10ms-Einheit Wertebereich von 0 (dauerhaft eingeschaltet) bis Byte für Beleuchtungsmodus - 1: Displayhinterleuchtung wird bei Nutzereingabe (Taster, Inkrementalgeber) automatisch für 5 Sekunden eingeschaltet - 0: Displayhinterleuchtung wird bei Nutzereingabe (Taster, Inkrementalgeber) nicht automatisch eingeschaltet 1 Byte für Zeitdauer in 10ms-Einheit Wertebereich von 0 (dauerhaft eingeschaltet) bis 255 0x01 0x01 0xF4 Piepton ausschalten Keine weiteren Parameter-Bytes 3

4 0x01 0x01 0xF5 Taster und Inkrementalgeber abfragen Keine weiteren Parameter-Bytes 0x01 0x01 0xF6 Inkrementalgeber zurücksetzen Keine weiteren Parameter-Bytes 0x01 0x02 0xF7 Benutzereingaben automatisch senden 1 Byte zum Ein oder Ausschalten - 2: eingeschaltet (Statusänderung wird gesendet) - 1: eingeschaltet (interne Tastenerkennung) - 0: ausgeschaltet 0x01 0x01 0xF8 Geräte-Reset Keine weiteren Parameter-Bytes 0x01 0x3E 0xD0 bis 0xD7 Page 0 bis 7 beschreiben Displaydaten jeweils pro Byte eine Spalte der Page.3E (keine ungenutzten Bytes) 0x01 0x18 0xD8 String anzeigen (max 20 Zeichen) 2 Byte für Zeile und Position: - Byte 1, High-Nibble: Zeile (0-3) - Byte 1 Low-Nibble: Zeichen-(0) oder Pixelposition (1) - Byte 2: Position (0-19 oder 0-121) - 20 Byte beinhalten den String - 1 Byte für Stringabschluss (0x00) 0x01 0x01 0xD9 Displayinhalt löschen Keine weiteren Parameter-Bytes 0x01 0x01 0xDA Page löschen 0 Byte zur Pageauswahl Wertebereich von 0 (Page 1) bis 7 (Page 8) 0x01 0x02 0xDB String/Zeile löschen 1 Byte für Zeilenauswahl (0-3) 0x01 0x01 0xDC Display initialisieren Keine weiteren Parameter-Bytes * Bei der Byte-Anzahl zählen die beiden Byte für die H-Report- und Byte-Anzahl nicht mit. Der Displayaufbau ist dabei wie folgt: E0 E Page 1 Page 2 Page 3 Page 4 Page 5 Page 6 31 Page 7 Page 8 4

5 Eine Page besteht aus 61 Bytes die jeweils 8 übereinander liegenden Pixeln entsprechen: Bit 0 Bit 1 Bit 2 Bit 3 Bit 4 Bit 5 Bit 6 Bit 7 Byte 0... Byte Vom USB-BAT auf dem PC ankommende Infos (USB-BAT PC) Die Rahmengröße vom USB-BAT zum PC ist immer 8 Byte groß inkl. der im ersten Byte übertragenen Report- 0x02, die die Datenrichtung angibt. Der Wert Byte-Anzahl ist abhängig von der Antwort- (siehe Tabelle 5). Ungenutzte Byte im Rahmen sind theoretisch beliebig, sollten aber sicherheitshalber mit 0x00 aufgefüllt werden. Tabelle 4: Allgemeiner Aufbau eines Datenrahmens Report- Byte-Anzahl* Antwort- Anweisung und Parameter 1 Byte 0x03 1 Byte 2 Byte * Bei der Byte-Anzahl zählen die beiden Byte für die Report- und die Byte-Anzahl nicht mit. Tabelle 5: Mögliche Antworten vom USB-BAT H- Report- Byte- Anzahl* Antwort- Bedeutung der Antwort- 0x02 0x03 0xA0 Hinweis/Fehler- Rückmeldung 0x02 0x05 0xF5 Rückgabe des Tastenstatus und der Position des Inkrementalgebers Nachfolgende Parameter-Byte 2 Byte: Error- (siehe Tabelle 6), FW-Version (siehe Tabelle 7), 3 Byte: - Byte 1: Tasterstatus (siehe Tabelle 8); null, wenn Benutzereingaben automatisch senden im Modus 2 betrieben wird - Byte 2: absolute Position des Inkrementalgebers (siehe Tabelle 9) - Byte 3: Positionsänderung des Inkrementalgebers seit der letzten Abfrage(siehe Tabelle 9) - Byte 4: aktueller Portpin- Status der Taster (siehe Tabelle 5

6 10); null, wenn Benutzereingaben automatisch senden im Modus 1 betrieben wird * Bei der Byte-Anzahl zählen die beiden Byte für die H-Report- und die Byte-Anzahl nicht mit. Tabelle 6: Mögliche FS20-IRP-Meldungen (Error-) Error- Beschreibung der Hinweis/Fehler-Rückmeldung: 0x00 PC-Anweisung wurde erfolgreich ausgeführt 0x01 Firmware-Versionsnummer steht in dem nachfolgenden Byte 0x02 Unbekannte Befehls- (die gültigen Befehls-s stehen in Tabelle 2) 0x03 Falsch angegebene Byte-Anzahl (in Kombination mit der Befehls-) 0x05 Unbekannter Parameter Tabelle 7: Beispiele zur Codierung der Firmware-Versionsnummer FW-Ver. Bedeutung: 0x01 Firmware-Version v0.1 0x10 Firmware-Version v1.0 0x29 Firmware-Version v usw. Tabelle 8: Tasterstatus Tasterstatus 0x01 0x02 0x04 0x10 0x20 0x40 Bedeutung: Dieses Bit ist gesetzt, wenn der Taster des Inkrementalgebers gedrückt wurde Dieses Bit ist gesetzt, wenn der Taster A gedrückt wurde Dieses Bit ist gesetzt, wenn der Taster B gedrückt wurde Dieses Bit ist gesetzt, wenn der Taster des Inkrementalgebers lange gedrückt wurde Dieses Bit ist gesetzt, wenn der Taster A lange gedrückt wurde Dieses Bit ist gesetzt, wenn der Taster B lange gedrückt wurde Tabelle 9: Position des Inkrementalgeber Position Bedeutung: -128 bis 127 Position des Inkrementalgebers (negativ links, positiv rechts, null Ausgangsposition) Tabelle 10: Portpinstatus der Taster Taster- Bedeutung: 6

7 status 0x01 0x02 0x04 Dieses Bit ist gesetzt, wenn der Taster des Inkrementalgebers nicht gedrückt wird Dieses Bit ist gesetzt, wenn der Taster A nicht gedrückt wird Dieses Bit ist gesetzt, wenn der Taster B nicht gedrückt wird 7