Modbus - E-Paper 296x128 Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das E-Paper 296x128 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des E-Paper 296x128 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletEPaper296x128.draw
Funktions ID:1
Anfrage:keine Nutzdaten
Antwort:keine Antwort

Zeichnet den aktuellen Schwarz-/Weiß- und Rot- oder Grau-Buffer auf das E-Paper-Display.

Das Bricklet nutzt kein Double-Buffering. Diese Funktion sollte daher nicht aufgerufen werden während in den Buffer geschrieben wird. Siehe get_draw_status.

BrickletEPaper296x128.get_draw_status
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • draw_status -- uint8

Gibt einen von drei möglichen Status zurück:

  • Idle
  • Copying: Daten werden vom Buffer des Bricklets in den Buffer des Displays kopiert.
  • Drawing: Das Display aktualisiert den Inhalt (während dieser Phase flackert das Display).

Der Buffer kann beschrieben werden (durch eine der write- oder draw-Funktionen) wenn der Status entweder idle oder drawing ist. Der Buffer sollte nicht beschrieben werden während er kopiert wird. Es findet kein Double-Buffering statt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: idle, für draw_status
  • 1: copying, für draw_status
  • 2: drawing, für draw_status
BrickletEPaper296x128.write_black_white_low_level
Funktions ID:

3

Anfrage:
  • x_start -- uint16
  • y_start -- uint8
  • x_end -- uint16
  • y_end -- uint8
  • pixels_length -- uint16
  • pixels_chunk_offset -- uint16
  • pixels_chunk_data -- bool[432]
Antwort:

keine Antwort

Schreibt schwarze/weiße Pixel in das angegebene Fenster in den Buffer.

Die X-Achse läuft von 0 bis 295 und die Y-Achse von 0 bis 127. Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Der Wert 0 (false) entspricht einem schwarzen Pixel und der Wert 1 (true) einem weißen Pixel.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-Buffer. Der Buffer kann auf das Display mit der Funktion draw übertragen werden.

Die Funktion write_color_low_level kann genutzt werden um rote oder graue Pixel zu schreiben.

BrickletEPaper296x128.read_black_white_low_level
Funktions ID:

4

Anfrage:
  • x_start -- uint16
  • y_start -- uint8
  • x_end -- uint16
  • y_end -- uint8
Antwort:
  • pixels_length -- uint16
  • pixels_chunk_offset -- uint16
  • pixels_chunk_data -- bool[464]

Gibt den aktuellen Inhalt des Schwarz-/Weiß-Buffers für das spezifizierte Fenster zurück.

Die X-Achse läuft von 0 bis 295 und die Y-Achse von 0 bis 127. Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Der aktuelle Inhalt des Buffers muss nicht dem aktuellen Inhalt des Displays entsprechen. Es ist möglich das der Buffer noch nicht auf das Display übertragen wurde und nach einem Neustart wird der Buffer des Bricklets als schwarz initialisiert, während das Display den Inhalt beibehält.

BrickletEPaper296x128.write_color_low_level
Funktions ID:

5

Anfrage:
  • x_start -- uint16
  • y_start -- uint8
  • x_end -- uint16
  • y_end -- uint8
  • pixels_length -- uint16
  • pixels_chunk_offset -- uint16
  • pixels_chunk_data -- bool[432]
Antwort:

keine Antwort

Das E-Paper 296x128 Bricklet ist in den Farben schwarz/weiß/rot sowie schwarz/weiß/grau verfügbar. Abhängig vom verwendeten Modell schreibt diese Funktion entweder rote oder graue Pixel in das spezifizierte Fenster des Buffers.

Die X-Achse läuft von 0 bis 295 und die Y-Achse von 0 bis 127. Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Der Wert 0 (false) bedeutet dass das Pixel keine Farbe hat. Es ist in diesem Fall entweder schwarz oder weiß (siehe write_black_white_low_level). Der Wert 1 (true) entspricht einem roten oder grauen Pixel, abhängig vom Modell des Bricklets.

Diese Funktion schreibt Pixel in den Rot- oder Grau-Buffer. Der Buffer kann auf das Display mit der Funktion draw übertragen werden.

Die Funktion write_black_white_low_level kann genutzt werden um schwarze/weiße Pixel zu schreiben.

BrickletEPaper296x128.read_color_low_level
Funktions ID:

6

Anfrage:
  • x_start -- uint16
  • y_start -- uint8
  • x_end -- uint16
  • y_end -- uint8
Antwort:
  • pixels_length -- uint16
  • pixels_chunk_offset -- uint16
  • pixels_chunk_data -- bool[464]

Gibt den aktuellen Inhalt des Rot- oder Grau-Buffers für das spezifizierte Fenster zurück.

Die X-Achse läuft von 0 bis 295 und die Y-Achse von 0 bis 127. Die Pixel werden zeilenweise von oben nach unten geschrieben und die Zeilen werden jeweils von links nach rechts geschrieben.

Der aktuelle Inhalt des Buffers muss nicht dem aktuellen Inhalt des Displays entsprechen. Es ist möglich das der Buffer noch nicht auf das Display übertragen wurde und nach einem Neustart wird der Buffer des Bricklets als schwarz initialisiert, während das Display den Inhalt beibehält.

BrickletEPaper296x128.fill_display
Funktions ID:

7

Anfrage:
  • color -- uint8
Antwort:

keine Antwort

Füllt den kompletten Inhalt des Displays mit der gegebenen Farbe.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: black, für color
  • 1: white, für color
  • 2: red, für color
  • 2: gray, für color
BrickletEPaper296x128.draw_text
Funktions ID:

8

Anfrage:
  • position_x -- uint16
  • position_y -- uint8
  • font -- uint8
  • color -- uint8
  • orientation -- uint8
  • text -- char[50]
Antwort:

keine Antwort

Zeichnet einen Text mit bis zu 50 Buchstaben an die Pixelposition (x, y).

Die Wertebereich für die x-Werte ist 0 bis 295 und der Wertebereich für die y-Werte ist 0 bis 127.

Es können 9 unterschiedliche Font-Größen genutzt werden und der Text kann in schwarz/weiß/rot|grau gezeichnet werden. Der Text kann horizontal oder vertikal gezeichnet werden.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: 6x8, für font
  • 1: 6x16, für font
  • 2: 6x24, für font
  • 3: 6x32, für font
  • 4: 12x16, für font
  • 5: 12x24, für font
  • 6: 12x32, für font
  • 7: 18x24, für font
  • 8: 18x32, für font
  • 9: 24x32, für font
  • 0: black, für color
  • 1: white, für color
  • 2: red, für color
  • 2: gray, für color
  • 0: horizontal, für orientation
  • 1: vertical, für orientation
BrickletEPaper296x128.draw_line
Funktions ID:

9

Anfrage:
  • position_x_start -- uint16
  • position_y_start -- uint8
  • position_x_end -- uint16
  • position_y_end -- uint8
  • color -- uint8
Antwort:

keine Antwort

Zeichnet eine Linie von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe. Der Wertebereich für die x-Werte ist 0 bis 295 und der Wertebereich für die y-Werte ist 0 bis 127.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: black, für color
  • 1: white, für color
  • 2: red, für color
  • 2: gray, für color
BrickletEPaper296x128.draw_box
Funktions ID:

10

Anfrage:
  • position_x_start -- uint16
  • position_y_start -- uint8
  • position_x_end -- uint16
  • position_y_end -- uint8
  • fill -- bool
  • color -- uint8
Antwort:

keine Antwort

Zeichnet ein Rechteck von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe. Der Wertebereich für die x-Werte ist 0 bis 295 und der Wertebereich für die y-Werte ist 0 bis 127.

Wenn fill auf true gesetzt wird, wird das Rechteck mit der angegebenen Farbe ausgefüllt. Ansonsten wird nur der Umriss gezeichnet.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: black, für color
  • 1: white, für color
  • 2: red, für color
  • 2: gray, für color

Fortgeschrittene Funktionen

BrickletEPaper296x128.set_update_mode
Funktions ID:

12

Anfrage:
  • update_mode -- uint8
Antwort:

keine Antwort

Bemerkung

Der Default Update-Modus basiert auf den Standardeinstellungen des E-Paper-Display Herstellers. Alle anderen Modi sind experimentell und es tritt mehr Ghosting sowie mögliche Langzeiteffekte auf.

Für einen Überblick über die Funktionsweise eines E-Paper-Displays können wir das exzellente Video von Ben Krasnow empfehlen: https://www.youtube.com/watch?v=MsbiO8EAsGw.

Falls es nicht klar ist was diese Optionen bedeuten, empfehlen wir den Update-Modus auf Default zu belassen.

Aktuell gibt es drei unterschiedliche Update-Modi:

  • Default: Einstellungen wie vom Hersteller vorgegeben. Eine Bildschirmaktualisierung dauert ungefähr 7,5 Sekunden und während der Aktualisierung flackert der Bildschirm mehrfach.
  • Black/White: In diesem Modus werden nur die schwarzen und weißen Pixel aktualisiert. Es werden die Herstellereinstellungen für schwarz/weiß genutzt, allerdings wird der rote oder graue Buffer ignoriert. Mit diesem Modus flackert das Display bei einer Aktualisierung einmal und es dauert in etwa 2,5 Sekunden. Verglichen zu der Standardeinstellung entsteht mehr Ghosting.
  • Delta: In diesem Modus werden auch nur die schwarzen und weißen Pixel aktualisiert. Es wird eine aggressive Aktualisierungsmethode genutzt. Änderungen werden nicht auf dem kompletten Buffer angewendet, sondern nur auf dem Unterschied (Delta) zwischen dem letzten und dem nächsten Buffer. Mit diesem Modus flackert das Display nicht und eine Aktualisierung dauert 900-950ms. Verglichen zu den anderen beiden Modi gibt es mehr Ghosting. Dieser Modus ist gut geeignet um z.B. flackerfrei einen regelmäßig aktualisierten Text darzustellen.

Wenn der Black/White- oder Delta-Modus zusammen mit dem schwarz/weiß/rot-Bildschirm verwendet wird, bekommt die weiße Farbe nach mehrmaligem Wechsel zwischen schwarz und weiß einen rötlichen Stich.

Wenn der Delta-Modus mit schnell Aktualisierungen verwendet wird, empfehlen wir in regelmäßigen Abständen zurück zum Default-Modus zu wechseln um dort vollflächig zwischen den drei Farben hin und her zu wechseln. Dadurch wird das Ghosting welches durch die Verwendung des Delta-Modus entsteht wieder entfernt. Danach kann dann wieder in den Delta-Modus gewechselt werden für flackerfreie Aktualisierungen.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: default, für update_mode
  • 1: black white, für update_mode
  • 2: delta, für update_mode
BrickletEPaper296x128.get_update_mode
Funktions ID:

13

Anfrage:

keine Nutzdaten

Antwort:
  • update_mode -- uint8

Gibt den Update Mode zurück, wie von set_update_mode gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: default, für update_mode
  • 1: black white, für update_mode
  • 2: delta, für update_mode
BrickletEPaper296x128.set_display_type
Funktions ID:

14

Anfrage:
  • display_type -- uint8
Antwort:

keine Antwort

Setzt den Typ des Displays. Das E-Paper Display ist in den Farben schwarz/weiß/rot und schwarz/weiß/grau verfügbar. Das korrekte Display wird bereits werksseitig während des Flashens und Testens gesetzt. Der Wert wird in nicht-flüchtigem Speicher gespeichert und bleibt bei einem Neustart unverändert.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: black white red, für display_type
  • 1: black white gray, für display_type
BrickletEPaper296x128.get_display_type
Funktions ID:

15

Anfrage:

keine Nutzdaten

Antwort:
  • display_type -- uint8

Gibt den Typ des E-Paper Displays zurück. Der Typ kann entweder schwarz/weiß/rot oder schwarz/weiß/grau sein.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: black white red, für display_type
  • 1: black white gray, für display_type
BrickletEPaper296x128.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletEPaper296x128.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletEPaper296x128.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletEPaper296x128.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

Setzt den Firmware-Pointer für write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletEPaper296x128.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletEPaper296x128.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletEPaper296x128.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

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

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletEPaper296x128.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletEPaper296x128.reset
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletEPaper296x128.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
Antwort:

keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletEPaper296x128.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletEPaper296x128.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Callbacks

BrickletEPaper296x128.CALLBACK_DRAW_STATUS
Funktions ID:

11

Antwort:
  • draw_status -- uint8

Callback für den aktuellen Draw Status. Diese Callback wird jedes mal ausgelöst, wenn sich der Draw Status ändert (siehe get_draw_status).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: idle, für draw_status
  • 1: copying, für draw_status
  • 2: drawing, für draw_status