C/C++ - E-Paper 296x128 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (example_hello_world.c)

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_e_paper_296x128.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your E-Paper 296x128 Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    EPaper296x128 ep;
    e_paper_296x128_create(&ep, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Use black background
    e_paper_296x128_fill_display(&ep, E_PAPER_296X128_COLOR_BLACK);

    // Write big white "Hello World" in the middle of the screen
    e_paper_296x128_draw_text(&ep, 16, 48, E_PAPER_296X128_FONT_24X32,
                              E_PAPER_296X128_COLOR_WHITE,
                              E_PAPER_296X128_ORIENTATION_HORIZONTAL, "Hello World");
    e_paper_296x128_draw(&ep);

    printf("Press key to exit\n");
    getchar();
    e_paper_296x128_destroy(&ep);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Load Image

Download (example_load_image.c)

 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
// Tested with gcc:
// > gcc -pthread example_load_image.c ip_connection.c bricklet_e_paper_296x128.c -lgd -lm -o example

#include <stdio.h>
#include <math.h>
#include <gd.h> // https://libgd.github.io/

#include "ip_connection.h"
#include "bricklet_e_paper_296x128.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your E-Paper 296x128 Bricklet
#define WIDTH 296
#define HEIGHT 128

// Convert GD Image to matching color boolean array
void bool_array_from_image(gdImagePtr image, bool *pixels, uint8_t r, uint8_t g, uint8_t b) {
    int row, column, index;

    // Convert pixels into pages
    for (row = 0; row < HEIGHT; row++) {
        for (column = 0; column < WIDTH; column++) {
            index = gdImageGetPixel(image, column, row);
            pixels[row*WIDTH + column] = gdImageRed(image, index) == r && gdImageGreen(image, index) == g && gdImageBlue(image, index) == b;
        }
    }
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    EPaper296x128 epaper;
    e_paper_296x128_create(&epaper, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // 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
    FILE *file = fopen("tf_red.png", "rb");
    gdImagePtr image = gdImageCreateFromPng(file);
    
    bool pixels[HEIGHT * WIDTH];

    // Get black/white pixels from image and write them to the Bricklet buffer
    bool_array_from_image(image, pixels, 0xFF, 0xFF, 0xFF); 
    e_paper_296x128_write_black_white(&epaper, 0, 0, WIDTH-1, HEIGHT-1, pixels, HEIGHT*WIDTH);

    // Get red pixels from image and write them to the Bricklet buffer
    bool_array_from_image(image, pixels, 0xFF, 0, 0); 
    e_paper_296x128_write_color(&epaper, 0, 0, WIDTH-1, HEIGHT-1, pixels, HEIGHT*WIDTH);

    // Draw buffered values to the display
    e_paper_296x128_draw(&epaper);

    gdImageDestroy(image);

    printf("Press key to exit\n");
    getchar();
    e_paper_296x128_destroy(&epaper);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void e_paper_296x128_create(EPaper296x128 *e_paper_296x128, const char *uid, IPConnection *ipcon)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt e_paper_296x128 mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

EPaper296x128 e_paper_296x128;
e_paper_296x128_create(&e_paper_296x128, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void e_paper_296x128_destroy(EPaper296x128 *e_paper_296x128)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *

Entfernt das Geräteobjekt e_paper_296x128 von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int e_paper_296x128_draw(EPaper296x128 *e_paper_296x128)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Rückgabe:
  • error_code – Typ: int

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 e_paper_296x128_get_draw_status().

int e_paper_296x128_get_draw_status(EPaper296x128 *e_paper_296x128, uint8_t *ret_draw_status)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_draw_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

  • E_PAPER_296X128_DRAW_STATUS_IDLE = 0
  • E_PAPER_296X128_DRAW_STATUS_COPYING = 1
  • E_PAPER_296X128_DRAW_STATUS_DRAWING = 2
int e_paper_296x128_write_black_white(EPaper296x128 *e_paper_296x128, uint16_t x_start, uint8_t y_start, uint16_t x_end, uint8_t y_end, bool *pixels, uint16_t pixels_length)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • x_start – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_start – Typ: uint8_t, Wertebereich: [0 bis 255]
  • x_end – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_end – Typ: uint8_t, Wertebereich: [0 bis 255]
  • pixels – Typ: bool *
  • pixels_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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 e_paper_296x128_draw() übertragen werden.

Die Funktion e_paper_296x128_write_color() kann genutzt werden um rote oder graue Pixel zu schreiben.

int e_paper_296x128_read_black_white(EPaper296x128 *e_paper_296x128, uint16_t x_start, uint8_t y_start, uint16_t x_end, uint8_t y_end, bool *ret_pixels, uint16_t *ret_pixels_length)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • x_start – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_start – Typ: uint8_t, Wertebereich: [0 bis 255]
  • x_end – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_end – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_pixels – Typ: bool *
  • ret_pixels_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_write_color(EPaper296x128 *e_paper_296x128, uint16_t x_start, uint8_t y_start, uint16_t x_end, uint8_t y_end, bool *pixels, uint16_t pixels_length)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • x_start – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_start – Typ: uint8_t, Wertebereich: [0 bis 255]
  • x_end – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_end – Typ: uint8_t, Wertebereich: [0 bis 255]
  • pixels – Typ: bool *
  • pixels_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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 e_paper_296x128_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 e_paper_296x128_draw() übertragen werden.

Die Funktion e_paper_296x128_write_black_white() kann genutzt werden um schwarze/weiße Pixel zu schreiben.

int e_paper_296x128_read_color(EPaper296x128 *e_paper_296x128, uint16_t x_start, uint8_t y_start, uint16_t x_end, uint8_t y_end, bool *ret_pixels, uint16_t *ret_pixels_length)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • x_start – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_start – Typ: uint8_t, Wertebereich: [0 bis 255]
  • x_end – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • y_end – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_pixels – Typ: bool *
  • ret_pixels_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_fill_display(EPaper296x128 *e_paper_296x128, uint8_t color)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • color – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für color:

  • E_PAPER_296X128_COLOR_BLACK = 0
  • E_PAPER_296X128_COLOR_WHITE = 1
  • E_PAPER_296X128_COLOR_RED = 2
  • E_PAPER_296X128_COLOR_GRAY = 2
int e_paper_296x128_draw_text(EPaper296x128 *e_paper_296x128, uint16_t position_x, uint8_t position_y, uint8_t font, uint8_t color, uint8_t orientation, const char text[50])
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • position_x – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • position_y – Typ: uint8_t, Wertebereich: [0 bis 255]
  • font – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • color – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • orientation – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • text – Typ: const char[50]
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_FONT_6X8 = 0
  • E_PAPER_296X128_FONT_6X16 = 1
  • E_PAPER_296X128_FONT_6X24 = 2
  • E_PAPER_296X128_FONT_6X32 = 3
  • E_PAPER_296X128_FONT_12X16 = 4
  • E_PAPER_296X128_FONT_12X24 = 5
  • E_PAPER_296X128_FONT_12X32 = 6
  • E_PAPER_296X128_FONT_18X24 = 7
  • E_PAPER_296X128_FONT_18X32 = 8
  • E_PAPER_296X128_FONT_24X32 = 9

Für color:

  • E_PAPER_296X128_COLOR_BLACK = 0
  • E_PAPER_296X128_COLOR_WHITE = 1
  • E_PAPER_296X128_COLOR_RED = 2
  • E_PAPER_296X128_COLOR_GRAY = 2

Für orientation:

  • E_PAPER_296X128_ORIENTATION_HORIZONTAL = 0
  • E_PAPER_296X128_ORIENTATION_VERTICAL = 1
int e_paper_296x128_draw_line(EPaper296x128 *e_paper_296x128, uint16_t position_x_start, uint8_t position_y_start, uint16_t position_x_end, uint8_t position_y_end, uint8_t color)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • position_x_start – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • position_y_start – Typ: uint8_t, Wertebereich: [0 bis 255]
  • position_x_end – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • position_y_end – Typ: uint8_t, Wertebereich: [0 bis 255]
  • color – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_COLOR_BLACK = 0
  • E_PAPER_296X128_COLOR_WHITE = 1
  • E_PAPER_296X128_COLOR_RED = 2
  • E_PAPER_296X128_COLOR_GRAY = 2
int e_paper_296x128_draw_box(EPaper296x128 *e_paper_296x128, uint16_t position_x_start, uint8_t position_y_start, uint16_t position_x_end, uint8_t position_y_end, bool fill, uint8_t color)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • position_x_start – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • position_y_start – Typ: uint8_t, Wertebereich: [0 bis 255]
  • position_x_end – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • position_y_end – Typ: uint8_t, Wertebereich: [0 bis 255]
  • fill – Typ: bool
  • color – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_COLOR_BLACK = 0
  • E_PAPER_296X128_COLOR_WHITE = 1
  • E_PAPER_296X128_COLOR_RED = 2
  • E_PAPER_296X128_COLOR_GRAY = 2

Fortgeschrittene Funktionen

int e_paper_296x128_set_update_mode(EPaper296x128 *e_paper_296x128, uint8_t update_mode)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • update_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_UPDATE_MODE_DEFAULT = 0
  • E_PAPER_296X128_UPDATE_MODE_BLACK_WHITE = 1
  • E_PAPER_296X128_UPDATE_MODE_DELTA = 2
int e_paper_296x128_get_update_mode(EPaper296x128 *e_paper_296x128, uint8_t *ret_update_mode)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_update_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_update_mode:

  • E_PAPER_296X128_UPDATE_MODE_DEFAULT = 0
  • E_PAPER_296X128_UPDATE_MODE_BLACK_WHITE = 1
  • E_PAPER_296X128_UPDATE_MODE_DELTA = 2
int e_paper_296x128_set_display_type(EPaper296x128 *e_paper_296x128, uint8_t display_type)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • display_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • E_PAPER_296X128_DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
int e_paper_296x128_get_display_type(EPaper296x128 *e_paper_296x128, uint8_t *ret_display_type)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_display_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

  • E_PAPER_296X128_DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • E_PAPER_296X128_DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
int e_paper_296x128_get_api_version(EPaper296x128 *e_paper_296x128, uint8_t ret_api_version[3])
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_get_response_expected(EPaper296x128 *e_paper_296x128, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

  • E_PAPER_296X128_FUNCTION_DRAW = 1
  • E_PAPER_296X128_FUNCTION_WRITE_BLACK_WHITE = 3
  • E_PAPER_296X128_FUNCTION_WRITE_COLOR = 5
  • E_PAPER_296X128_FUNCTION_FILL_DISPLAY = 7
  • E_PAPER_296X128_FUNCTION_DRAW_TEXT = 8
  • E_PAPER_296X128_FUNCTION_DRAW_LINE = 9
  • E_PAPER_296X128_FUNCTION_DRAW_BOX = 10
  • E_PAPER_296X128_FUNCTION_SET_UPDATE_MODE = 12
  • E_PAPER_296X128_FUNCTION_SET_DISPLAY_TYPE = 14
  • E_PAPER_296X128_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • E_PAPER_296X128_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • E_PAPER_296X128_FUNCTION_RESET = 243
  • E_PAPER_296X128_FUNCTION_WRITE_UID = 248
int e_paper_296x128_set_response_expected(EPaper296x128 *e_paper_296x128, uint8_t function_id, bool response_expected)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

  • E_PAPER_296X128_FUNCTION_DRAW = 1
  • E_PAPER_296X128_FUNCTION_WRITE_BLACK_WHITE = 3
  • E_PAPER_296X128_FUNCTION_WRITE_COLOR = 5
  • E_PAPER_296X128_FUNCTION_FILL_DISPLAY = 7
  • E_PAPER_296X128_FUNCTION_DRAW_TEXT = 8
  • E_PAPER_296X128_FUNCTION_DRAW_LINE = 9
  • E_PAPER_296X128_FUNCTION_DRAW_BOX = 10
  • E_PAPER_296X128_FUNCTION_SET_UPDATE_MODE = 12
  • E_PAPER_296X128_FUNCTION_SET_DISPLAY_TYPE = 14
  • E_PAPER_296X128_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • E_PAPER_296X128_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • E_PAPER_296X128_FUNCTION_RESET = 243
  • E_PAPER_296X128_FUNCTION_WRITE_UID = 248
int e_paper_296x128_set_response_expected_all(EPaper296x128 *e_paper_296x128, bool response_expected)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

int e_paper_296x128_get_spitfp_error_count(EPaper296x128 *e_paper_296x128, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_set_bootloader_mode(EPaper296x128 *e_paper_296x128, uint8_t mode, uint8_t *ret_status)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_BOOTLOADER_MODE_BOOTLOADER = 0
  • E_PAPER_296X128_BOOTLOADER_MODE_FIRMWARE = 1
  • E_PAPER_296X128_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • E_PAPER_296X128_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • E_PAPER_296X128_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • E_PAPER_296X128_BOOTLOADER_STATUS_OK = 0
  • E_PAPER_296X128_BOOTLOADER_STATUS_INVALID_MODE = 1
  • E_PAPER_296X128_BOOTLOADER_STATUS_NO_CHANGE = 2
  • E_PAPER_296X128_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • E_PAPER_296X128_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • E_PAPER_296X128_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int e_paper_296x128_get_bootloader_mode(EPaper296x128 *e_paper_296x128, uint8_t *ret_mode)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • E_PAPER_296X128_BOOTLOADER_MODE_BOOTLOADER = 0
  • E_PAPER_296X128_BOOTLOADER_MODE_FIRMWARE = 1
  • E_PAPER_296X128_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • E_PAPER_296X128_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • E_PAPER_296X128_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int e_paper_296x128_set_write_firmware_pointer(EPaper296x128 *e_paper_296x128, uint32_t pointer)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • pointer – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für e_paper_296x128_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.

int e_paper_296x128_write_firmware(EPaper296x128 *e_paper_296x128, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von e_paper_296x128_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.

int e_paper_296x128_set_status_led_config(EPaper296x128 *e_paper_296x128, uint8_t config)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • E_PAPER_296X128_STATUS_LED_CONFIG_OFF = 0
  • E_PAPER_296X128_STATUS_LED_CONFIG_ON = 1
  • E_PAPER_296X128_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • E_PAPER_296X128_STATUS_LED_CONFIG_SHOW_STATUS = 3
int e_paper_296x128_get_status_led_config(EPaper296x128 *e_paper_296x128, uint8_t *ret_config)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • E_PAPER_296X128_STATUS_LED_CONFIG_OFF = 0
  • E_PAPER_296X128_STATUS_LED_CONFIG_ON = 1
  • E_PAPER_296X128_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • E_PAPER_296X128_STATUS_LED_CONFIG_SHOW_STATUS = 3
int e_paper_296x128_get_chip_temperature(EPaper296x128 *e_paper_296x128, int16_t *ret_temperature)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_reset(EPaper296x128 *e_paper_296x128)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_write_uid(EPaper296x128 *e_paper_296x128, uint32_t uid)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int e_paper_296x128_read_uid(EPaper296x128 *e_paper_296x128, uint32_t *ret_uid)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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

int e_paper_296x128_get_identity(EPaper296x128 *e_paper_296x128, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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

void e_paper_296x128_register_callback(EPaper296x128 *e_paper_296x128, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • e_paper_296x128 – Typ: EPaper296x128 *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

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 e_paper_296x128_register_callback() Funktion durchgeführt werden:

void my_callback(int p, void *user_data) {
    printf("parameter: %d\n", p);
}

e_paper_296x128_register_callback(&e_paper_296x128, E_PAPER_296X128_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen 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_CALLBACK_DRAW_STATUS
void callback(uint8_t draw_status, void *user_data)
Callback-Parameter:
  • draw_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • user_data – Typ: void *

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

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

Für draw_status:

  • E_PAPER_296X128_DRAW_STATUS_IDLE = 0
  • E_PAPER_296X128_DRAW_STATUS_COPYING = 1
  • E_PAPER_296X128_DRAW_STATUS_DRAWING = 2

Konstanten

E_PAPER_296X128_DEVICE_IDENTIFIER

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

Die e_paper_296x128_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

E_PAPER_296X128_DEVICE_DISPLAY_NAME

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