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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
e-paper-296x128-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
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 danndispatch
e-paper-296x128-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
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 danne-paper-296x128-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameter: |
|
---|
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 dannGetter-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 dieseMit 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.
e-paper-296x128-bricklet
<uid> <callback>
[<option>..]¶Parameter: |
|
---|
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)e-paper-296x128-bricklet
<uid> draw
¶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
.
e-paper-296x128-bricklet
<uid> get-draw-status
¶Ausgabe: |
|
---|
Gibt einen von drei möglichen Status zurück:
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:
e-paper-296x128-bricklet
<uid> write-black-white
<x-start> <y-start> <x-end> <y-end> <pixels>¶Parameter: |
|
---|---|
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.
e-paper-296x128-bricklet
<uid> read-black-white
<x-start> <y-start> <x-end> <y-end>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
e-paper-296x128-bricklet
<uid> write-color
<x-start> <y-start> <x-end> <y-end> <pixels>¶Parameter: |
|
---|---|
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.
e-paper-296x128-bricklet
<uid> read-color
<x-start> <y-start> <x-end> <y-end>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
e-paper-296x128-bricklet
<uid> fill-display
<color>¶Parameter: |
|
---|---|
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>:
e-paper-296x128-bricklet
<uid> draw-text
<position-x> <position-y> <font> <color> <orientation> <text>¶Parameter: |
|
---|---|
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.
Der der Zeichensatz entspricht Codepage 437.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <font>:
Für <color>:
Für <orientation>:
e-paper-296x128-bricklet
<uid> draw-line
<position-x-start> <position-y-start> <position-x-end> <position-y-end> <color>¶Parameter: |
|
---|---|
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>:
e-paper-296x128-bricklet
<uid> draw-box
<position-x-start> <position-y-start> <position-x-end> <position-y-end> <fill> <color>¶Parameter: |
|
---|---|
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>:
e-paper-296x128-bricklet
<uid> set-update-mode
<update-mode>¶Parameter: |
|
---|---|
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:
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>:
e-paper-296x128-bricklet
<uid> get-update-mode
¶Ausgabe: |
|
---|
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:
e-paper-296x128-bricklet
<uid> set-display-type
<display-type>¶Parameter: |
|
---|---|
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>:
e-paper-296x128-bricklet
<uid> get-display-type
¶Ausgabe: |
|
---|
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:
e-paper-296x128-bricklet
<uid> set-display-driver
<display-driver>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Typ des Display-Treibers. Das unterstützt aktuell SSD1675A und SSD1680. Dar korrekte Display-Treiber 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-driver>:
Neu in Version 2.0.3 (Plugin).
e-paper-296x128-bricklet
<uid> get-display-driver
¶Ausgabe: |
|
---|
Gibt den E-Paper Display-Treibers zurück.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für display-driver:
Neu in Version 2.0.3 (Plugin).
e-paper-296x128-bricklet
<uid> get-spitfp-error-count
¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
e-paper-296x128-bricklet
<uid> set-status-led-config
<config>¶Parameter: |
|
---|---|
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>:
e-paper-296x128-bricklet
<uid> get-status-led-config
¶Ausgabe: |
|
---|
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:
e-paper-296x128-bricklet
<uid> get-chip-temperature
¶Ausgabe: |
|
---|
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.
e-paper-296x128-bricklet
<uid> reset
¶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.
e-paper-296x128-bricklet
<uid> get-identity
¶Ausgabe: |
|
---|
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.
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.
e-paper-296x128-bricklet
<uid> draw-status
¶Ausgabe: |
|
---|
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:
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
e-paper-296x128-bricklet
<uid> set-bootloader-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
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>:
Für status:
e-paper-296x128-bricklet
<uid> get-bootloader-mode
¶Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
e-paper-296x128-bricklet
<uid> set-write-firmware-pointer
<pointer>¶Parameter: |
|
---|---|
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.
e-paper-296x128-bricklet
<uid> write-firmware
<data>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
e-paper-296x128-bricklet
<uid> write-uid
<uid>¶Parameter: |
|
---|---|
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.
e-paper-296x128-bricklet
<uid> read-uid
¶Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.