Shell - E-Paper 296x128 Bricklet

Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example-hello-world.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your E-Paper 296x128 Bricklet

# Use black background
tinkerforge call e-paper-296x128-bricklet $uid fill-display color-black

# Write big white "Hello World" in the middle of the screen
tinkerforge call e-paper-296x128-bricklet $uid draw-text 16 48 font-24x32 color-white orientation-horizontal "Hello World"
tinkerforge call e-paper-296x128-bricklet $uid draw

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call e-paper-296x128-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des E-Paper 296x128 Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des E-Paper 296x128 Bricklet an und endet dann
tinkerforge dispatch e-paper-296x128-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des E-Paper 296x128 Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des E-Paper 296x128 Bricklet an und endet dann
tinkerforge call e-paper-296x128-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch e-paper-296x128-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call e-paper-296x128-bricklet <uid> draw
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call e-paper-296x128-bricklet <uid> get-draw-status
Ausgabe:
  • 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:

  • draw-status-idle = 0
  • draw-status-copying = 1
  • draw-status-drawing = 2
tinkerforge call e-paper-296x128-bricklet <uid> write-black-white <x-start> <y-start> <x-end> <y-end> <pixels>
Parameter:
  • <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 Array, Länge: variabel
Ausgabe:
  • keine Ausgabe

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 draw auf das Display übertragen werden.

Die Funktion write-color kann genutzt werden um rote oder graue Pixel zu schreiben.

tinkerforge call e-paper-296x128-bricklet <uid> read-black-white <x-start> <y-start> <x-end> <y-end>
Parameter:
  • <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]
Ausgabe:
  • pixels – Typ: Bool Array, 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.

tinkerforge call e-paper-296x128-bricklet <uid> write-color <x-start> <y-start> <x-end> <y-end> <pixels>
Parameter:
  • <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 Array, Länge: variabel
Ausgabe:
  • keine Ausgabe

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 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 draw auf das Display übertragen werden.

Die Funktion write-black-white kann genutzt werden um schwarze/weiße Pixel zu schreiben.

tinkerforge call e-paper-296x128-bricklet <uid> read-color <x-start> <y-start> <x-end> <y-end>
Parameter:
  • <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]
Ausgabe:
  • pixels – Typ: Bool Array, 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.

tinkerforge call e-paper-296x128-bricklet <uid> fill-display <color>
Parameter:
  • <color> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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 draw auf das Display übertragen werden.

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

Für <color>:

  • color-black = 0
  • color-white = 1
  • color-red = 2
  • color-gray = 2
tinkerforge call e-paper-296x128-bricklet <uid> draw-text <position-x> <position-y> <font> <color> <orientation> <text>
Parameter:
  • <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
Ausgabe:
  • keine Ausgabe

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 draw auf das Display übertragen werden.

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

Für <font>:

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

Für <color>:

  • color-black = 0
  • color-white = 1
  • color-red = 2
  • color-gray = 2

Für <orientation>:

  • orientation-horizontal = 0
  • orientation-vertical = 1
tinkerforge call e-paper-296x128-bricklet <uid> draw-line <position-x-start> <position-y-start> <position-x-end> <position-y-end> <color>
Parameter:
  • <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
Ausgabe:
  • keine Ausgabe

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 draw auf das Display übertragen werden.

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

Für <color>:

  • color-black = 0
  • color-white = 1
  • color-red = 2
  • color-gray = 2
tinkerforge call e-paper-296x128-bricklet <uid> draw-box <position-x-start> <position-y-start> <position-x-end> <position-y-end> <fill> <color>
Parameter:
  • <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
Ausgabe:
  • keine Ausgabe

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 draw auf das Display übertragen werden.

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

Für <color>:

  • color-black = 0
  • color-white = 1
  • color-red = 2
  • color-gray = 2

Fortgeschrittene Funktionen

tinkerforge call e-paper-296x128-bricklet <uid> set-update-mode <update-mode>
Parameter:
  • <update-mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:
  • keine Ausgabe

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>:

  • update-mode-default = 0
  • update-mode-black-white = 1
  • update-mode-delta = 2
tinkerforge call e-paper-296x128-bricklet <uid> get-update-mode
Ausgabe:
  • update-mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den Update Mode zurück, wie von set-update-mode gesetzt.

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

Für update-mode:

  • update-mode-default = 0
  • update-mode-black-white = 1
  • update-mode-delta = 2
tinkerforge call e-paper-296x128-bricklet <uid> set-display-type <display-type>
Parameter:
  • <display-type> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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>:

  • display-type-black-white-red = 0
  • display-type-black-white-gray = 1
tinkerforge call e-paper-296x128-bricklet <uid> get-display-type
Ausgabe:
  • 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:

  • display-type-black-white-red = 0
  • display-type-black-white-gray = 1
tinkerforge call e-paper-296x128-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • 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.

tinkerforge call e-paper-296x128-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • 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-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call e-paper-296x128-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call e-paper-296x128-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call e-paper-296x128-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, Wertebereich: [0 bis 255]

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.

tinkerforge call e-paper-296x128-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call e-paper-296x128-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call e-paper-296x128-bricklet <uid> get-chip-temperature
Ausgabe:
  • 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.

tinkerforge call e-paper-296x128-bricklet <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call e-paper-296x128-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call e-paper-296x128-bricklet <uid> read-uid
Ausgabe:
  • 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.

tinkerforge call e-paper-296x128-bricklet <uid> get-identity
Ausgabe:
  • 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 Array, 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 Array, 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]

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. 

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch e-paper-296x128-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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.

tinkerforge dispatch e-paper-296x128-bricklet <uid> draw-status
Ausgabe:
  • draw-status – Typ: Int, Wertebereich: Siehe Symbole

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

Für draw-status:

  • draw-status-idle = 0
  • draw-status-copying = 1
  • draw-status-drawing = 2