Perl - E-Paper 296x128 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example_hello_world.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletEPaper296x128;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your E-Paper 296x128 Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ep = Tinkerforge::BrickletEPaper296x128->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Use black background
$ep->fill_display($ep->COLOR_BLACK);

# Write big white "Hello World" in the middle of the screen
$ep->draw_text(16, 48, $ep->FONT_24X32, $ep->COLOR_WHITE, $ep->ORIENTATION_HORIZONTAL,
               "Hello World");
$ep->draw();

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Load Image

Download (example_load_image.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#!/usr/bin/perl

use strict;
use Math::Trig;
use Term::ReadKey;
use GD;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletEPaper296x128;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your E-Paper 296x128 Bricklet
use constant WIDTH => 296;
use constant HEIGHT => 128;

# Convert GD Image to matching color bool array
sub bool_array_from_image
{
    my ($image, $cmp_r, $cmp_g, $cmp_b) = @_;
    my @pixels = ();

    foreach my $row (0..&HEIGHT - 1) {
        foreach my $column (0..&WIDTH - 1) {
            (my $r, my $g, my $b) = $image->rgb($image->getPixel($column, $row));
            $pixels[$row*&WIDTH + $column] = (($r == $cmp_r) && ($g == $cmp_g) && ($b == $cmp_b));
        }
    }

     return @pixels;
}

GD::Image->trueColor(1);

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $epaper = Tinkerforge::BrickletEPaper296x128->new(&UID, $ipcon); # Create device object
$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Download example image here:
# https://raw.githubusercontent.com/Tinkerforge/e-paper-296x128-bricklet/master/software/examples/tf_red.png
my $image = newFromPng GD::Image('tf_red.png');

# Get black/white pixels from image and write them to the Bricklet buffer
my @pixels_bw = bool_array_from_image($image, 0xFF, 0xFF, 0xFF);
$epaper->write_black_white(0, 0, &WIDTH-1, &HEIGHT-1, \@pixels_bw);

# Get red pixels from image and write them to the Bricklet buffer
my @pixels_red = bool_array_from_image($image, 0xFF, 0, 0);
$epaper->write_color(0, 0, &WIDTH-1, &HEIGHT-1, \@pixels_red);

# Draw buffered values to the display
$epaper->draw();

print "Press key to exit\n";
ReadMode(0);
$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletEPaper296x128->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $e_paper_296x128 – Typ: BrickletEPaper296x128

Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:

$e_paper_296x128 = BrickletEPaper296x128->new("YOUR_DEVICE_UID", $ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletEPaper296x128->draw()
Rückgabe:
  • undef

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()
Rückgabe:
  • $draw_status – Typ: int, Wertebereich: Siehe Konstanten

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

Für $draw_status:

  • BrickletEPaper296x128->DRAW_STATUS_IDLE = 0
  • BrickletEPaper296x128->DRAW_STATUS_COPYING = 1
  • BrickletEPaper296x128->DRAW_STATUS_DRAWING = 2
BrickletEPaper296x128->write_black_white($x_start, $y_start, $x_end, $y_end, @pixels)
Parameter:
  • $x_start – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_start – Typ: int, Wertebereich: [0 bis 255]
  • $x_end – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_end – Typ: int, Wertebereich: [0 bis 255]
  • @pixels – Typ: [bool, ...], Länge: variabel
Rückgabe:
  • undef

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() kann genutzt werden um rote oder graue Pixel zu schreiben.

BrickletEPaper296x128->read_black_white($x_start, $y_start, $x_end, $y_end)
Parameter:
  • $x_start – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_start – Typ: int, Wertebereich: [0 bis 255]
  • $x_end – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_end – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • @pixels – Typ: [bool, ...], Länge: variabel

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($x_start, $y_start, $x_end, $y_end, @pixels)
Parameter:
  • $x_start – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_start – Typ: int, Wertebereich: [0 bis 255]
  • $x_end – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_end – Typ: int, Wertebereich: [0 bis 255]
  • @pixels – Typ: [bool, ...], Länge: variabel
Rückgabe:
  • undef

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()). 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() kann genutzt werden um schwarze/weiße Pixel zu schreiben.

BrickletEPaper296x128->read_color($x_start, $y_start, $x_end, $y_end)
Parameter:
  • $x_start – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_start – Typ: int, Wertebereich: [0 bis 255]
  • $x_end – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $y_end – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • @pixels – Typ: [bool, ...], Länge: variabel

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($color)
Parameter:
  • $color – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

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

Für $color:

  • BrickletEPaper296x128->COLOR_BLACK = 0
  • BrickletEPaper296x128->COLOR_WHITE = 1
  • BrickletEPaper296x128->COLOR_RED = 2
  • BrickletEPaper296x128->COLOR_GRAY = 2
BrickletEPaper296x128->draw_text($position_x, $position_y, $font, $color, $orientation, $text)
Parameter:
  • $position_x – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $position_y – Typ: int, Wertebereich: [0 bis 255]
  • $font – Typ: int, Wertebereich: Siehe Konstanten
  • $color – Typ: int, Wertebereich: Siehe Konstanten
  • $orientation – Typ: int, Wertebereich: Siehe Konstanten
  • $text – Typ: string, Länge: bis zu 50
Rückgabe:
  • undef

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

Für $font:

  • BrickletEPaper296x128->FONT_6X8 = 0
  • BrickletEPaper296x128->FONT_6X16 = 1
  • BrickletEPaper296x128->FONT_6X24 = 2
  • BrickletEPaper296x128->FONT_6X32 = 3
  • BrickletEPaper296x128->FONT_12X16 = 4
  • BrickletEPaper296x128->FONT_12X24 = 5
  • BrickletEPaper296x128->FONT_12X32 = 6
  • BrickletEPaper296x128->FONT_18X24 = 7
  • BrickletEPaper296x128->FONT_18X32 = 8
  • BrickletEPaper296x128->FONT_24X32 = 9

Für $color:

  • BrickletEPaper296x128->COLOR_BLACK = 0
  • BrickletEPaper296x128->COLOR_WHITE = 1
  • BrickletEPaper296x128->COLOR_RED = 2
  • BrickletEPaper296x128->COLOR_GRAY = 2

Für $orientation:

  • BrickletEPaper296x128->ORIENTATION_HORIZONTAL = 0
  • BrickletEPaper296x128->ORIENTATION_VERTICAL = 1
BrickletEPaper296x128->draw_line($position_x_start, $position_y_start, $position_x_end, $position_y_end, $color)
Parameter:
  • $position_x_start – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $position_y_start – Typ: int, Wertebereich: [0 bis 255]
  • $position_x_end – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $position_y_end – Typ: int, Wertebereich: [0 bis 255]
  • $color – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

Für $color:

  • BrickletEPaper296x128->COLOR_BLACK = 0
  • BrickletEPaper296x128->COLOR_WHITE = 1
  • BrickletEPaper296x128->COLOR_RED = 2
  • BrickletEPaper296x128->COLOR_GRAY = 2
BrickletEPaper296x128->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 216 - 1]
  • $position_y_start – Typ: int, Wertebereich: [0 bis 255]
  • $position_x_end – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $position_y_end – Typ: int, Wertebereich: [0 bis 255]
  • $fill – Typ: bool
  • $color – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

Für $color:

  • BrickletEPaper296x128->COLOR_BLACK = 0
  • BrickletEPaper296x128->COLOR_WHITE = 1
  • BrickletEPaper296x128->COLOR_RED = 2
  • BrickletEPaper296x128->COLOR_GRAY = 2

Fortgeschrittene Funktionen

BrickletEPaper296x128->set_update_mode($update_mode)
Parameter:
  • $update_mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

Für $update_mode:

  • BrickletEPaper296x128->UPDATE_MODE_DEFAULT = 0
  • BrickletEPaper296x128->UPDATE_MODE_BLACK_WHITE = 1
  • BrickletEPaper296x128->UPDATE_MODE_DELTA = 2
BrickletEPaper296x128->get_update_mode()
Rückgabe:
  • $update_mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $update_mode:

  • BrickletEPaper296x128->UPDATE_MODE_DEFAULT = 0
  • BrickletEPaper296x128->UPDATE_MODE_BLACK_WHITE = 1
  • BrickletEPaper296x128->UPDATE_MODE_DELTA = 2
BrickletEPaper296x128->set_display_type($display_type)
Parameter:
  • $display_type – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

Für $display_type:

  • BrickletEPaper296x128->DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • BrickletEPaper296x128->DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
BrickletEPaper296x128->get_display_type()
Rückgabe:
  • $display_type – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $display_type:

  • BrickletEPaper296x128->DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • BrickletEPaper296x128->DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
BrickletEPaper296x128->get_api_version()
Rückgabe:
  • @api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletEPaper296x128->get_response_expected($function_id)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für $function_id:

  • BrickletEPaper296x128->FUNCTION_DRAW = 1
  • BrickletEPaper296x128->FUNCTION_WRITE_BLACK_WHITE = 3
  • BrickletEPaper296x128->FUNCTION_WRITE_COLOR = 5
  • BrickletEPaper296x128->FUNCTION_FILL_DISPLAY = 7
  • BrickletEPaper296x128->FUNCTION_DRAW_TEXT = 8
  • BrickletEPaper296x128->FUNCTION_DRAW_LINE = 9
  • BrickletEPaper296x128->FUNCTION_DRAW_BOX = 10
  • BrickletEPaper296x128->FUNCTION_SET_UPDATE_MODE = 12
  • BrickletEPaper296x128->FUNCTION_SET_DISPLAY_TYPE = 14
  • BrickletEPaper296x128->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEPaper296x128->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEPaper296x128->FUNCTION_RESET = 243
  • BrickletEPaper296x128->FUNCTION_WRITE_UID = 248
BrickletEPaper296x128->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für $function_id:

  • BrickletEPaper296x128->FUNCTION_DRAW = 1
  • BrickletEPaper296x128->FUNCTION_WRITE_BLACK_WHITE = 3
  • BrickletEPaper296x128->FUNCTION_WRITE_COLOR = 5
  • BrickletEPaper296x128->FUNCTION_FILL_DISPLAY = 7
  • BrickletEPaper296x128->FUNCTION_DRAW_TEXT = 8
  • BrickletEPaper296x128->FUNCTION_DRAW_LINE = 9
  • BrickletEPaper296x128->FUNCTION_DRAW_BOX = 10
  • BrickletEPaper296x128->FUNCTION_SET_UPDATE_MODE = 12
  • BrickletEPaper296x128->FUNCTION_SET_DISPLAY_TYPE = 14
  • BrickletEPaper296x128->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEPaper296x128->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEPaper296x128->FUNCTION_RESET = 243
  • BrickletEPaper296x128->FUNCTION_WRITE_UID = 248
BrickletEPaper296x128->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickletEPaper296x128->get_spitfp_error_count()
Rückgabe-Array:
  • 0: $error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: $error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: $error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: $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.

BrickletEPaper296x128->set_bootloader_mode($mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $status – Typ: int, Wertebereich: Siehe Konstanten

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

Für $mode:

  • BrickletEPaper296x128->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletEPaper296x128->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletEPaper296x128->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletEPaper296x128->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletEPaper296x128->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

  • BrickletEPaper296x128->BOOTLOADER_STATUS_OK = 0
  • BrickletEPaper296x128->BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletEPaper296x128->BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletEPaper296x128->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletEPaper296x128->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletEPaper296x128->BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletEPaper296x128->get_bootloader_mode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $mode:

  • BrickletEPaper296x128->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletEPaper296x128->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletEPaper296x128->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletEPaper296x128->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletEPaper296x128->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletEPaper296x128->set_write_firmware_pointer($pointer)
Parameter:
  • $pointer – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

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(@data)
Parameter:
  • @data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • $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.

BrickletEPaper296x128->set_status_led_config($config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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

Für $config:

  • BrickletEPaper296x128->STATUS_LED_CONFIG_OFF = 0
  • BrickletEPaper296x128->STATUS_LED_CONFIG_ON = 1
  • BrickletEPaper296x128->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletEPaper296x128->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletEPaper296x128->get_status_led_config()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletEPaper296x128->STATUS_LED_CONFIG_OFF = 0
  • BrickletEPaper296x128->STATUS_LED_CONFIG_ON = 1
  • BrickletEPaper296x128->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletEPaper296x128->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletEPaper296x128->get_chip_temperature()
Rückgabe:
  • $temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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()
Rückgabe:
  • undef

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($uid)
Parameter:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

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()
Rückgabe:
  • $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.

BrickletEPaper296x128->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char
  • 3: @hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: @firmware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 5: $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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletEPaper296x128->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$e_paper_296x128->register_callback(BrickletEPaper296x128->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletEPaper296x128->CALLBACK_DRAW_STATUS
Callback-Parameter:
  • $draw_status – Typ: int, Wertebereich: Siehe Konstanten

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

Für $draw_status:

  • BrickletEPaper296x128->DRAW_STATUS_IDLE = 0
  • BrickletEPaper296x128->DRAW_STATUS_COPYING = 1
  • BrickletEPaper296x128->DRAW_STATUS_DRAWING = 2

Konstanten

BrickletEPaper296x128->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein E-Paper 296x128 Bricklet zu identifizieren.

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletEPaper296x128->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines E-Paper 296x128 Bricklet dar.