Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / OLED 128x64 Bricklet 2.0

C/C++ für Mikrocontroller - OLED 128x64 Bricklet 2.0¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das OLED 128x64 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des OLED 128x64 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World¶

Download (example_hello_world.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_oled_128x64_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_OLED128x64V2 oled;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_oled_128x64_v2_create(&oled, NULL, hal), "create device object");

    // Clear display
    check(tf_oled_128x64_v2_clear_display(&oled), "call clear_display");

    // Write "Hello World" starting from upper left corner of the screen
    check(tf_oled_128x64_v2_write_line(&oled, 0, 0, "Hello World"), "call write_line");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_oled_128x64_v2_create(TF_OLED128x64V2 *oled_128x64_v2, const char *uid, TF_HAL *hal)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt oled_128x64_v2 mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_OLED128x64V2 oled_128x64_v2;
tf_oled_128x64_v2_create(&oled_128x64_v2, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_oled_128x64_v2_destroy(TF_OLED128x64V2 *oled_128x64_v2)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Rückgabe:	e_code – Typ: int

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

int tf_oled_128x64_v2_write_pixels(TF_OLED128x64V2 *oled_128x64_v2, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, const bool *pixels, uint16_t pixels_length)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * x_start – Typ: uint8_t, Wertebereich: [0 bis 127] y_start – Typ: uint8_t, Wertebereich: [0 bis 63] x_end – Typ: uint8_t, Wertebereich: [0 bis 127] y_end – Typ: uint8_t, Wertebereich: [0 bis 63] pixels – Typ: const bool * pixels_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Schreibt Pixel in das angegebene Fenster.

Die Pixel werden zeilenweise von oben nach unten die Zeilen werden jeweils von links nach rechts geschrieben.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel in einen internen Buffer geschrieben der dann durch einen Aufruf von tf_oled_128x64_v2_draw_buffered_frame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die tf_oled_128x64_v2_set_display_configuration() Funktion eingestellt werden.

int tf_oled_128x64_v2_read_pixels(TF_OLED128x64V2 *oled_128x64_v2, uint8_t x_start, uint8_t y_start, uint8_t x_end, uint8_t y_end, bool *ret_pixels, uint16_t *ret_pixels_length)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * x_start – Typ: uint8_t, Wertebereich: [0 bis 127] y_start – Typ: uint8_t, Wertebereich: [0 bis 63] x_end – Typ: uint8_t, Wertebereich: [0 bis 127] y_end – Typ: uint8_t, Wertebereich: [0 bis 63]
Ausgabeparameter:	ret_pixels – Typ: bool * ret_pixels_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Liest Pixel aus dem angegebenen Fenster.

Die X-Achse läuft von 0 bis 127 und die Y-Achse von 0 bis 63. Die Pixel werden zeilenweise von oben nach unten und die Zeilen werden jeweils von links nach rechts gelesen.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt vom Display gelesen.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel aus einen internen Buffer gelesen (siehe tf_oled_128x64_v2_draw_buffered_frame()).

Automatic Draw kann über die tf_oled_128x64_v2_set_display_configuration() Funktion eingestellt werden.

int tf_oled_128x64_v2_clear_display(TF_OLED128x64V2 *oled_128x64_v2)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Rückgabe:	e_code – Typ: int

Löscht den kompletten aktuellen Inhalt des Displays.

Wenn Automatic Draw aktiviert ist (Standard), dann werden die Pixel direkt gelöscht.

Wenn Automatic Draw deaktiviert ist, dann werden die Pixel im internen Buffer gelöscht der dann durch einen Aufruf von tf_oled_128x64_v2_draw_buffered_frame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die tf_oled_128x64_v2_set_display_configuration() Funktion eingestellt werden.

int tf_oled_128x64_v2_write_line(TF_OLED128x64V2 *oled_128x64_v2, uint8_t line, uint8_t position, const char *text)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * line – Typ: uint8_t, Wertebereich: [0 bis 7] position – Typ: uint8_t, Wertebereich: [0 bis 21] text – Typ: const char[22]
Rückgabe:	e_code – Typ: int

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 22 Zeichen lang sein.

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

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

Wenn Automatic Draw aktiviert ist (Standard), dann wird der Text direkt auf den Display geschrieben. Nur Pixel die sich wirklich verändert haben werden auf dem Display aktualisiert.

Wenn Automatic Draw deaktiviert ist, dann wird der Text in einen internen Buffer geschrieben der dann durch einen Aufruf von tf_oled_128x64_v2_draw_buffered_frame() auf dem Display angezeigt werden kann. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Automatic Draw kann über die tf_oled_128x64_v2_set_display_configuration() Funktion eingestellt werden.

Der der Zeichensatz entspricht Codepage 437.

int tf_oled_128x64_v2_draw_buffered_frame(TF_OLED128x64V2 *oled_128x64_v2, bool force_complete_redraw)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * force_complete_redraw – Typ: bool
Rückgabe:	e_code – Typ: int

Stellt den aktuell Inhalt des internen Buffers auf dem Display dar. Normalerweise schreibt jeder Aufruf von tf_oled_128x64_v2_write_pixels() und tf_oled_128x64_v2_write_line() direkt auf den Display. Wenn jedoch Automatic Draw deaktiviert ist (tf_oled_128x64_v2_set_display_configuration()), dann werden Änderungen in einen internen Buffer anstatt auf den Display geschrieben. Der internen Buffer kann dann durch einen Aufruf dieser Funktion auf den Display geschrieben werden. Dadurch kann Flicker vermieden werden, wenn ein komplexes Bild in mehreren Schritten aufgebaut wird.

Wenn Force Complete Redraw auf true gesetzt ist, dann wird der gesamte Display aktualisiert, anstatt nur die Pixel die sich wirklich verändert haben. Normalerweise sollte dies nicht notwendig sein, außer bei hängenden Pixeln bedingt durch Fehler.

Fortgeschrittene Funktionen¶

int tf_oled_128x64_v2_set_display_configuration(TF_OLED128x64V2 *oled_128x64_v2, uint8_t contrast, bool invert, bool automatic_draw)¶

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

Setzt die Konfiguration des Displays.

Der Kontrast kann zwischen 0 und 255 und das Farbschema invertiert (weiß/schwarz) eingestellt werden.

Wenn Automatic Draw aktiviert (true) ist dann wird das Display bei jedem Aufruf von tf_oled_128x64_v2_write_pixels() und tf_oled_128x64_v2_write_line() aktualisiert. Wenn Automatic Draw deaktiviert (false) ist, dann werden Änderungen in einen internen Buffer geschrieben, der dann bei bei einem Aufruf von tf_oled_128x64_v2_draw_buffered_frame() auf dem Display angezeigt wird.

int tf_oled_128x64_v2_get_display_configuration(TF_OLED128x64V2 *oled_128x64_v2, uint8_t *ret_contrast, bool *ret_invert, bool *ret_automatic_draw)¶

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

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

int tf_oled_128x64_v2_get_spitfp_error_count(TF_OLED128x64V2 *oled_128x64_v2, 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:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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 tf_oled_128x64_v2_set_status_led_config(TF_OLED128x64V2 *oled_128x64_v2, uint8_t config)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_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:

TF_OLED_128X64_V2_STATUS_LED_CONFIG_OFF = 0
TF_OLED_128X64_V2_STATUS_LED_CONFIG_ON = 1
TF_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_oled_128x64_v2_get_status_led_config(TF_OLED128x64V2 *oled_128x64_v2, uint8_t *ret_config)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_OLED_128X64_V2_STATUS_LED_CONFIG_OFF = 0
TF_OLED_128X64_V2_STATUS_LED_CONFIG_ON = 1
TF_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_OLED_128X64_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_oled_128x64_v2_get_chip_temperature(TF_OLED128x64V2 *oled_128x64_v2, int16_t *ret_temperature)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_oled_128x64_v2_reset(TF_OLED128x64V2 *oled_128x64_v2)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Rückgabe:	e_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 tf_oled_128x64_v2_get_identity(TF_OLED128x64V2 *oled_128x64_v2, 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_v2 – Typ: TF_OLED128x64V2 *
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.

int tf_oled_128x64_v2_get_response_expected(TF_OLED128x64V2 *oled_128x64_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * 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 tf_oled_128x64_v2_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:

TF_OLED_128X64_V2_FUNCTION_WRITE_PIXELS = 1
TF_OLED_128X64_V2_FUNCTION_CLEAR_DISPLAY = 3
TF_OLED_128X64_V2_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
TF_OLED_128X64_V2_FUNCTION_WRITE_LINE = 6
TF_OLED_128X64_V2_FUNCTION_DRAW_BUFFERED_FRAME = 7
TF_OLED_128X64_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_OLED_128X64_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_OLED_128X64_V2_FUNCTION_RESET = 243
TF_OLED_128X64_V2_FUNCTION_WRITE_UID = 248

int tf_oled_128x64_v2_set_response_expected(TF_OLED128x64V2 *oled_128x64_v2, uint8_t function_id, bool response_expected)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * 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:

TF_OLED_128X64_V2_FUNCTION_WRITE_PIXELS = 1
TF_OLED_128X64_V2_FUNCTION_CLEAR_DISPLAY = 3
TF_OLED_128X64_V2_FUNCTION_SET_DISPLAY_CONFIGURATION = 4
TF_OLED_128X64_V2_FUNCTION_WRITE_LINE = 6
TF_OLED_128X64_V2_FUNCTION_DRAW_BUFFERED_FRAME = 7
TF_OLED_128X64_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_OLED_128X64_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_OLED_128X64_V2_FUNCTION_RESET = 243
TF_OLED_128X64_V2_FUNCTION_WRITE_UID = 248

int tf_oled_128x64_v2_set_response_expected_all(TF_OLED128x64V2 *oled_128x64_v2, bool response_expected)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * 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.

Interne Funktionen¶

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.

int tf_oled_128x64_v2_set_bootloader_mode(TF_OLED128x64V2 *oled_128x64_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_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 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 Konstanten sind für diese Funktion verfügbar:

Für mode:

TF_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_OLED_128X64_V2_BOOTLOADER_STATUS_OK = 0
TF_OLED_128X64_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_OLED_128X64_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_OLED_128X64_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_OLED_128X64_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_OLED_128X64_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_oled_128x64_v2_get_bootloader_mode(TF_OLED128x64V2 *oled_128x64_v2, uint8_t *ret_mode)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

TF_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_OLED_128X64_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_OLED_128X64_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_oled_128x64_v2_set_write_firmware_pointer(TF_OLED128x64V2 *oled_128x64_v2, uint32_t pointer)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_oled_128x64_v2_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 tf_oled_128x64_v2_write_firmware(TF_OLED128x64V2 *oled_128x64_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_oled_128x64_v2_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 tf_oled_128x64_v2_write_uid(TF_OLED128x64V2 *oled_128x64_v2, uint32_t uid)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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 tf_oled_128x64_v2_read_uid(TF_OLED128x64V2 *oled_128x64_v2, uint32_t *ret_uid)¶

Parameter:	oled_128x64_v2 – Typ: TF_OLED128x64V2 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_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.

Konstanten¶

TF_OLED_128X64_V2_DEVICE_IDENTIFIER¶

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

Die Funktionen tf_oled_128x64_v2_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

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