Modbus - OLED 128x64 Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das OLED 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletOLED128x64.write
Funktions-ID:
  • 1
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Fügt 64 Byte Daten zu dem mit new_window gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn new_window mit Spalte (Column) von 0 bis 127 und Zeile (Row) von 0 bis 7 (das ganze Display) aufgerufen wird, schreibt jedes write (roter Pfeil) eine halbe Zeile.

Display Pixel Reihenfolge

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von write schreibt die zweite Hälfte der erste Zeile, und die nächsten beiden Aufrufe die zweite Zeile usw. Um das ganze Display zu füllen muss write 16 mal aufgerufen werden.

BrickletOLED128x64.new_window
Funktions-ID:
  • 2
Anfrage:
  • column_from – Typ: uint8, Wertebereich: [0 bis 127]
  • column_to – Typ: uint8, Wertebereich: [0 bis 127]
  • row_from – Typ: uint8, Wertebereich: [0 bis 7]
  • row_to – Typ: uint8, Wertebereich: [0 bis 7]
Antwort:
  • keine Antwort

Setzt das Fenster in welches mit write geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

BrickletOLED128x64.clear_display
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Löscht den aktuellen Inhalt des mit new_window gesetztem Fensters.

BrickletOLED128x64.write_line
Funktions-ID:
  • 6
Anfrage:
  • line – Typ: uint8, Wertebereich: [0 bis 7]
  • position – Typ: uint8, Wertebereich: [0 bis 25]
  • text – Typ: char[26]
Antwort:
  • keine Antwort

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 25). Der Text kann maximal 26 Zeichen lang sein.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Es ist möglich zuerst auf das Display mit write zu malen und danach Text hinzuzufügen.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Der der Zeichensatz entspricht Codepage 437.

Fortgeschrittene Funktionen

BrickletOLED128x64.set_display_configuration
Funktions-ID:
  • 4
Anfrage:
  • contrast – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

BrickletOLED128x64.get_display_configuration
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • contrast – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 143
  • invert – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set_display_configuration gesetzt.

BrickletOLED128x64.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden.