MQTT - E-Paper 296x128 Bricklet

Dies ist die Beschreibung der MQTT API Bindings 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.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example-hello-world.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your E-Paper 296x128 Bricklet

setup:
    # Use black background
    publish '{"color": "black"}' to tinkerforge/request/e_paper_296x128_bricklet/XYZ/fill_display 
    
    # Write big white "Hello World" in the middle of the screen
    publish '{"position_x": 16, "position_y": 48, "font": "24x32", "color": "white", "orientation": "horizontal", "text": "Hello World"}' to tinkerforge/request/e_paper_296x128_bricklet/XYZ/draw_text 
    
    publish '' to tinkerforge/request/e_paper_296x128_bricklet/XYZ/draw 

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/e_paper_296x128_bricklet/<UID>/draw
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 request/e_paper_296x128_bricklet/<UID>/get_draw_status.

request/e_paper_296x128_bricklet/<UID>/get_draw_status
Anfrage:
  • keine Nutzdaten
Antwort:
  • draw_status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für draw_status:

  • "idle" = 0
  • "copying" = 1
  • "drawing" = 2
request/e_paper_296x128_bricklet/<UID>/write_black_white
Anfrage:
  • x_start – Typ: int, Wertebereich: [0 bis 295]
  • y_start – Typ: int, Wertebereich: [0 bis 127]
  • x_end – Typ: int, Wertebereich: [0 bis 295]
  • y_end – Typ: int, Wertebereich: [0 bis 127]
  • pixels – Typ: [bool, ...], Länge: variabel
Antwort:
  • keine Antwort

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

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 mit der Funktion request/e_paper_296x128_bricklet/<UID>/draw auf das Display übertragen werden.

Die Funktion request/e_paper_296x128_bricklet/<UID>/write_color kann genutzt werden um rote oder graue Pixel zu schreiben.

request/e_paper_296x128_bricklet/<UID>/read_black_white
Anfrage:
  • x_start – Typ: int, Wertebereich: [0 bis 295]
  • y_start – Typ: int, Wertebereich: [0 bis 127]
  • x_end – Typ: int, Wertebereich: [0 bis 295]
  • y_end – Typ: int, Wertebereich: [0 bis 127]
Antwort:
  • pixels – Typ: [bool, ...], Länge: variabel

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

Die Pixel werden zeilenweise von oben nach unten gelesen und die Zeilen werden jeweils von links nach rechts gelesen.

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.

request/e_paper_296x128_bricklet/<UID>/write_color
Anfrage:
  • x_start – Typ: int, Wertebereich: [0 bis 295]
  • y_start – Typ: int, Wertebereich: [0 bis 127]
  • x_end – Typ: int, Wertebereich: [0 bis 295]
  • y_end – Typ: int, Wertebereich: [0 bis 127]
  • pixels – Typ: [bool, ...], Länge: variabel
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 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 request/e_paper_296x128_bricklet/<UID>/write_black_white). 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 mit der Funktion request/e_paper_296x128_bricklet/<UID>/draw auf das Display übertragen werden.

Die Funktion request/e_paper_296x128_bricklet/<UID>/write_black_white kann genutzt werden um schwarze/weiße Pixel zu schreiben.

request/e_paper_296x128_bricklet/<UID>/read_color
Anfrage:
  • x_start – Typ: int, Wertebereich: [0 bis 295]
  • y_start – Typ: int, Wertebereich: [0 bis 127]
  • x_end – Typ: int, Wertebereich: [0 bis 295]
  • y_end – Typ: int, Wertebereich: [0 bis 127]
Antwort:
  • pixels – Typ: [bool, ...], Länge: variabel

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

Die Pixel werden zeilenweise von oben nach unten gelesen und die Zeilen werden jeweils von links nach rechts gelesen.

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.

request/e_paper_296x128_bricklet/<UID>/fill_display
Anfrage:
  • color – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

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

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion request/e_paper_296x128_bricklet/<UID>/draw auf das Display übertragen werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für color:

  • "black" = 0
  • "white" = 1
  • "red" = 2
  • "gray" = 2
request/e_paper_296x128_bricklet/<UID>/draw_text
Anfrage:
  • position_x – Typ: int, Wertebereich: [0 bis 295]
  • position_y – Typ: int, Wertebereich: [0 bis 127]
  • font – Typ: int, Wertebereich: Siehe Symbole
  • color – Typ: int, Wertebereich: Siehe Symbole
  • orientation – Typ: int, Wertebereich: Siehe Symbole
  • text – Typ: string, Länge: bis zu 50
Antwort:
  • keine Antwort

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

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.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion request/e_paper_296x128_bricklet/<UID>/draw auf das Display übertragen werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für font:

  • "6x8" = 0
  • "6x16" = 1
  • "6x24" = 2
  • "6x32" = 3
  • "12x16" = 4
  • "12x24" = 5
  • "12x32" = 6
  • "18x24" = 7
  • "18x32" = 8
  • "24x32" = 9

Für color:

  • "black" = 0
  • "white" = 1
  • "red" = 2
  • "gray" = 2

Für orientation:

  • "horizontal" = 0
  • "vertical" = 1
request/e_paper_296x128_bricklet/<UID>/draw_line
Anfrage:
  • position_x_start – Typ: int, Wertebereich: [0 bis 295]
  • position_y_start – Typ: int, Wertebereich: [0 bis 127]
  • position_x_end – Typ: int, Wertebereich: [0 bis 295]
  • position_y_end – Typ: int, Wertebereich: [0 bis 127]
  • color – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Zeichnet eine Linie von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe.

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion request/e_paper_296x128_bricklet/<UID>/draw auf das Display übertragen werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für color:

  • "black" = 0
  • "white" = 1
  • "red" = 2
  • "gray" = 2
request/e_paper_296x128_bricklet/<UID>/draw_box
Anfrage:
  • position_x_start – Typ: int, Wertebereich: [0 bis 295]
  • position_y_start – Typ: int, Wertebereich: [0 bis 127]
  • position_x_end – Typ: int, Wertebereich: [0 bis 295]
  • position_y_end – Typ: int, Wertebereich: [0 bis 127]
  • fill – Typ: bool
  • color – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Zeichnet ein Rechteck von (x, y)-Start nach (x, y)-Ende in der eingestellten Farbe.

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

Diese Funktion schreibt Pixel in den Schwarz-/Weiß-/Grau|Rot-Buffer. Der Buffer kann mit der Funktion request/e_paper_296x128_bricklet/<UID>/draw auf das Display übertragen werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für color:

  • "black" = 0
  • "white" = 1
  • "red" = 2
  • "gray" = 2

Fortgeschrittene Funktionen

request/e_paper_296x128_bricklet/<UID>/set_update_mode
Anfrage:
  • update_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
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 Symbole sind für diese Funktion verfügbar:

Für update_mode:

  • "default" = 0
  • "black_white" = 1
  • "delta" = 2
request/e_paper_296x128_bricklet/<UID>/get_update_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • update_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den Update Mode zurück, wie von request/e_paper_296x128_bricklet/<UID>/set_update_mode gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für update_mode:

  • "default" = 0
  • "black_white" = 1
  • "delta" = 2
request/e_paper_296x128_bricklet/<UID>/set_display_type
Anfrage:
  • display_type – Typ: int, Wertebereich: Siehe Symbole
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 Symbole sind für diese Funktion verfügbar:

Für display_type:

  • "black_white_red" = 0
  • "black_white_gray" = 1
request/e_paper_296x128_bricklet/<UID>/get_display_type
Anfrage:
  • keine Nutzdaten
Antwort:
  • display_type – Typ: int, Wertebereich: Siehe Symbole

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

Die folgenden Symbole sind für diese Funktion verfügbar:

Für display_type:

  • "black_white_red" = 0
  • "black_white_gray" = 1
request/e_paper_296x128_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

request/e_paper_296x128_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

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 Bootloader- 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 Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/e_paper_296x128_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/e_paper_296x128_bricklet/<UID>/set_bootloader_mode.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/e_paper_296x128_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/e_paper_296x128_bricklet/<UID>/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.

request/e_paper_296x128_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/e_paper_296x128_bricklet/<UID>/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.

request/e_paper_296x128_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
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 Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/e_paper_296x128_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/e_paper_296x128_bricklet/<UID>/set_status_led_config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/e_paper_296x128_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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.

request/e_paper_296x128_bricklet/<UID>/reset
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.

request/e_paper_296x128_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
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.

request/e_paper_296x128_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

request/e_paper_296x128_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des E-Paper 296x128.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

register/e_paper_296x128_bricklet/<UID>/draw_status
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • draw_status – Typ: int, Wertebereich: Siehe Symbole

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/e_paper_296x128_bricklet/<UID>/draw_status[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/e_paper_296x128_bricklet/<UID>/draw_status[/<SUFFIX>]-Topic veröffentlicht.

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

Die folgenden Symbole sind für diese Funktion verfügbar:

Für draw_status:

  • "idle" = 0
  • "copying" = 1
  • "drawing" = 2