C/C++ - OLED 128x64 Bricklet¶

Dies ist die Beschreibung der C/C++ API Bindings für das OLED 128x64 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 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)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_oled_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your OLED 128x64 Bricklet

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

    // Create device object
    OLED128x64 oled;
    oled_128x64_create(&oled, 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

    // Clear display
    oled_128x64_clear_display(&oled);

    // Write "Hello World" starting from upper left corner of the screen
    oled_128x64_write_line(&oled, 0, 0, "Hello World");

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

Pixel Matrix¶

Download (example_pixel_matrix.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_oled_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your OLED 128x64 Bricklet
#define WIDTH 128
#define HEIGHT 64

void draw_matrix(OLED128x64 *oled, bool pixels[HEIGHT][WIDTH]) {
    uint8_t pages[HEIGHT / 8][WIDTH];
    int row, column, bit;

    // Convert pixels into pages
    for (row = 0; row < HEIGHT / 8; row++) {
        for (column = 0; column < WIDTH; column++) {
            pages[row][column] = 0;

            for (bit = 0; bit < 8; bit++) {
                if (pixels[(row * 8) + bit][column]) {
                    pages[row][column] |= 1 << bit;
                }
            }
        }
    }

    // Write all pages
    oled_128x64_new_window(oled, 0, WIDTH - 1, 0, HEIGHT / 8 - 1);

    for (row = 0; row < HEIGHT / 8; row++) {
        for (column = 0; column < WIDTH; column += 64) {
            oled_128x64_write(oled, &pages[row][column]);
        }
    }
}

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

    // Create device object
    OLED128x64 oled;
    oled_128x64_create(&oled, 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

    // Clear display
    oled_128x64_clear_display(&oled);

    // Draw checkerboard pattern
    int row, column;
    bool pixels[HEIGHT][WIDTH];

    for (row = 0; row < HEIGHT; row++) {
        for (column = 0; column < WIDTH; column++) {
            pixels[row][column] = (row / 8) % 2 == (column / 8) % 2;
        }
    }

    draw_matrix(&oled, pixels);

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

Scribble¶

Download (example_scribble.c)

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

#define IPCON_EXPOSE_MILLISLEEP

#include "ip_connection.h"
#include "bricklet_oled_128x64.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your OLED 128x64 Bricklet
#define WIDTH 128
#define HEIGHT 64

void draw_image(OLED128x64 *oled, gdImagePtr image) {
    uint8_t pages[HEIGHT / 8][WIDTH];
    int row, column, bit, index;

    // Convert pixels into pages
    for (row = 0; row < HEIGHT / 8; row++) {
        for (column = 0; column < WIDTH; column++) {
            pages[row][column] = 0;

            for (bit = 0; bit < 8; bit++) {
                index = gdImageGetPixel(image, column, (row * 8) + bit);

                if (gdImageRed(image, index) > 0) {
                    pages[row][column] |= 1 << bit;
                }
            }
        }
    }

    // Write all pages
    oled_128x64_new_window(oled, 0, WIDTH - 1, 0, HEIGHT / 8 - 1);

    for (row = 0; row < HEIGHT / 8; row++) {
        for (column = 0; column < WIDTH; column += 64) {
            oled_128x64_write(oled, &pages[row][column]);
        }
    }
}

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

    // Create device object
    OLED128x64 oled;
    oled_128x64_create(&oled, 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

    // Clear display
    oled_128x64_clear_display(&oled);

    // Draw rotating line
    gdImagePtr image = gdImageCreate(WIDTH, HEIGHT);
    int black = gdImageColorAllocate(image, 0, 0, 0);
    int white = gdImageColorAllocate(image, 255, 255, 255);
    int origin_x = WIDTH / 2;
    int origin_y = HEIGHT / 2;
    int length = HEIGHT / 2 - 2;
    int angle = 0;

    printf("Press ctrl+c exit\n");

    while (true) {
        double radians = M_PI * angle / 180.0;
        int x = (int)(origin_x + length * cos(radians));
        int y = (int)(origin_y + length * sin(radians));

        gdImageFilledRectangle(image, 0, 0, WIDTH, HEIGHT, black);
        gdImageLine(image, origin_x, origin_y, x, y, white);

        draw_image(&oled, image);
        millisleep(25);

        angle++;
    }

    gdImageDestroy(image);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void oled_128x64_create(OLED128x64 *oled_128x64, const char *uid, IPConnection *ipcon)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

OLED128x64 oled_128x64;
oled_128x64_create(&oled_128x64, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void oled_128x64_destroy(OLED128x64 *oled_128x64)¶

Parameter:	oled_128x64 – Typ: OLED128x64 *

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

int oled_128x64_write(OLED128x64 *oled_128x64, uint8_t data[64])¶

Parameter:	oled_128x64 – Typ: OLED128x64 * data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Fügt 64 Byte Daten zu dem mit oled_128x64_new_window() gesetztem Fenster hinzu.

Jede Zeile hat eine Höhe von 8 Pixeln welche einem Byte Daten entsprechen.

Beispiel: Wenn oled_128x64_new_window() mit Spalte (Column) von 0 bis 127 und Zeile (Row) von 0 bis 7 (das ganze Display) aufgerufen wird, schreibt jedes oled_128x64_write() (roter Pfeil) eine halbe Zeile.

Das LSB (D0) von jedem Daten-Byte ist in der Zeile oben und das MSB (D7) ist in der Zeile unten.

Der nächste Aufruf von oled_128x64_write() schreibt die zweite Hälfte der erste Zeile, und die nächsten beiden Aufrufe die zweite Zeile usw. Um das ganze Display zu füllen muss oled_128x64_write() 16 mal aufgerufen werden.

int oled_128x64_new_window(OLED128x64 *oled_128x64, uint8_t column_from, uint8_t column_to, uint8_t row_from, uint8_t row_to)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * column_from – Typ: uint8_t, Wertebereich: [0 bis 127] column_to – Typ: uint8_t, Wertebereich: [0 bis 127] row_from – Typ: uint8_t, Wertebereich: [0 bis 7] row_to – Typ: uint8_t, Wertebereich: [0 bis 7]
Rückgabe:	e_code – Typ: int

Setzt das Fenster in welches mit oled_128x64_write() geschrieben werden kann. Eine Zeile (Row) hat eine Höhe von 8 Pixel.

int oled_128x64_clear_display(OLED128x64 *oled_128x64)¶

Parameter:	oled_128x64 – Typ: OLED128x64 *
Rückgabe:	e_code – Typ: int

Löscht den aktuellen Inhalt des mit oled_128x64_new_window() gesetztem Fensters.

int oled_128x64_write_line(OLED128x64 *oled_128x64, uint8_t line, uint8_t position, const char *text)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * line – Typ: uint8_t, Wertebereich: [0 bis 7] position – Typ: uint8_t, Wertebereich: [0 bis 25] text – Typ: const char[26]
Rückgabe:	e_code – Typ: int

Schreibt einen Text in die angegebene Zeile (0 bis 7) mit einer vorgegebenen Position (0 bis 25). Der Text kann maximal 26 Zeichen lang sein.

Beispiel: (1, 10, "Hallo") schreibt Hallo in die Mitte der zweiten Zeile des Displays.

Es ist möglich zuerst auf das Display mit oled_128x64_write() zu malen und danach Text hinzuzufügen.

Das Display nutzt einen speziellen 5x7 Pixel Zeichensatz. Der Zeichensatz kann mit Hilfe von Brick Viewer angezeigt werden.

Der der Zeichensatz entspricht Codepage 437.

Fortgeschrittene Funktionen¶

int oled_128x64_set_display_configuration(OLED128x64 *oled_128x64, uint8_t contrast, bool invert)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * contrast – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 143 invert – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration des Displays

Es können der Kontrast mit einem Wertebereich von 0 bis 255 gesetzt, sowie die Farben (schwarz/weiß) des Displays invertiert werden.

int oled_128x64_get_display_configuration(OLED128x64 *oled_128x64, uint8_t *ret_contrast, bool *ret_invert)¶

Parameter:	oled_128x64 – Typ: OLED128x64 *
Ausgabeparameter:	ret_contrast – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 143 ret_invert – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

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

int oled_128x64_get_identity(OLED128x64 *oled_128x64, 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:	oled_128x64 – Typ: OLED128x64 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_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 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int oled_128x64_get_api_version(OLED128x64 *oled_128x64, uint8_t ret_api_version[3])¶

Parameter:	oled_128x64 – Typ: OLED128x64 *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Gibt die Version der API Definition 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 oled_128x64_get_response_expected(OLED128x64 *oled_128x64, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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 oled_128x64_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:

OLED_128X64_FUNCTION_WRITE = 1
OLED_128X64_FUNCTION_NEW_WINDOW = 2
OLED_128X64_FUNCTION_CLEAR_DISPLAY = 3
OLED_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
OLED_128X64_FUNCTION_WRITE_LINE = 6

int oled_128x64_set_response_expected(OLED128x64 *oled_128x64, uint8_t function_id, bool response_expected)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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.

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

Für function_id:

OLED_128X64_FUNCTION_WRITE = 1
OLED_128X64_FUNCTION_NEW_WINDOW = 2
OLED_128X64_FUNCTION_CLEAR_DISPLAY = 3
OLED_128X64_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
OLED_128X64_FUNCTION_WRITE_LINE = 6

int oled_128x64_set_response_expected_all(OLED128x64 *oled_128x64, bool response_expected)¶

Parameter:	oled_128x64 – Typ: OLED128x64 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Konstanten¶

OLED_128X64_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein OLED 128x64 Bricklet zu identifizieren.

Die oled_128x64_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.

OLED_128X64_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines OLED 128x64 Bricklet dar.