C/C++ - LCD 20x4 Bricklet

Dies ist die Beschreibung der C/C++ API Bindings für das LCD 20x4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 20x4 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_lcd_20x4.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 20x4 Bricklet

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

    // Create device object
    LCD20x4 lcd;
    lcd_20x4_create(&lcd, 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

    // Turn backlight on
    lcd_20x4_backlight_on(&lcd);

    // Write "Hello World"
    lcd_20x4_write_line(&lcd, 0, 0, "Hello World");

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

Button Callback

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

#include "ip_connection.h"
#include "bricklet_lcd_20x4.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 20x4 Bricklet

// Callback function for button pressed callback
void cb_button_pressed(uint8_t button, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Button Pressed: %u\n", button);
}

// Callback function for button released callback
void cb_button_released(uint8_t button, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Button Released: %u\n", button);
}

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

    // Create device object
    LCD20x4 lcd;
    lcd_20x4_create(&lcd, 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

    // Register button pressed callback to function cb_button_pressed
    lcd_20x4_register_callback(&lcd,
                               LCD_20X4_CALLBACK_BUTTON_PRESSED,
                               (void (*)(void))cb_button_pressed,
                               NULL);

    // Register button released callback to function cb_button_released
    lcd_20x4_register_callback(&lcd,
                               LCD_20X4_CALLBACK_BUTTON_RELEASED,
                               (void (*)(void))cb_button_released,
                               NULL);

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

Unicode

Download (example_unicode.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
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#include <stdio.h>
#include <wchar.h>

#include "ip_connection.h"
#include "bricklet_lcd_20x4.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your LCD 20x4 Bricklet

// Maps a wchar_t string to the LCD charset
static void wchar_to_ks0066u(const wchar_t *wchar, char *ks0066u, int ks0066u_length)
{
    const wchar_t *s = wchar;
    char *d = ks0066u;
    char *e = ks0066u + ks0066u_length;
    char c;
    uint32_t code_point;

    while (*s != '\0' && d < e) {
        // If wchar_t is UTF-16 then handle surrogates
        if (sizeof(wchar_t) == 2 && *s >= 0xd800 && *s <= 0xdbff) {
            code_point = 0x10000 + (*s - 0xd800) * 0x400 + (*(s + 1) - 0xdc00);
            s += 2;
        } else {
            code_point = *s++;
        }

        // ASCII subset from JIS X 0201
        if (code_point >= 0x0020 && code_point <= 0x007e) {
            // The LCD charset doesn't include '\' and '~', use similar characters instead
            switch (code_point) {
            case 0x005c: c = 0xa4; break; // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
            case 0x007e: c = 0x2d; break; // TILDE maps to HYPHEN-MINUS
            default: c = code_point; break;
            }
        }
        // Katakana subset from JIS X 0201
        else if (code_point >= 0xff61 && code_point <= 0xff9f) {
            c = code_point - 0xfec0;
        }
        // Special characters
        else {
            switch (code_point) {
            case 0x00a5: c = 0x5c; break; // YEN SIGN
            case 0x2192: c = 0x7e; break; // RIGHTWARDS ARROW
            case 0x2190: c = 0x7f; break; // LEFTWARDS ARROW
            case 0x00b0: c = 0xdf; break; // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
            case 0x03b1: c = 0xe0; break; // GREEK SMALL LETTER ALPHA
            case 0x00c4: c = 0xe1; break; // LATIN CAPITAL LETTER A WITH DIAERESIS
            case 0x00e4: c = 0xe1; break; // LATIN SMALL LETTER A WITH DIAERESIS
            case 0x00df: c = 0xe2; break; // LATIN SMALL LETTER SHARP S
            case 0x03b5: c = 0xe3; break; // GREEK SMALL LETTER EPSILON
            case 0x00b5: c = 0xe4; break; // MICRO SIGN
            case 0x03bc: c = 0xe4; break; // GREEK SMALL LETTER MU
            case 0x03c2: c = 0xe5; break; // GREEK SMALL LETTER FINAL SIGMA
            case 0x03c1: c = 0xe6; break; // GREEK SMALL LETTER RHO
            case 0x221a: c = 0xe8; break; // SQUARE ROOT
            case 0x00b9: c = 0xe9; break; // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
            case 0x00a4: c = 0xeb; break; // CURRENCY SIGN
            case 0x00a2: c = 0xec; break; // CENT SIGN
            case 0x2c60: c = 0xed; break; // LATIN CAPITAL LETTER L WITH DOUBLE BAR
            case 0x00f1: c = 0xee; break; // LATIN SMALL LETTER N WITH TILDE
            case 0x00d6: c = 0xef; break; // LATIN CAPITAL LETTER O WITH DIAERESIS
            case 0x00f6: c = 0xef; break; // LATIN SMALL LETTER O WITH DIAERESIS
            case 0x03f4: c = 0xf2; break; // GREEK CAPITAL THETA SYMBOL
            case 0x221e: c = 0xf3; break; // INFINITY
            case 0x03a9: c = 0xf4; break; // GREEK CAPITAL LETTER OMEGA
            case 0x00dc: c = 0xf5; break; // LATIN CAPITAL LETTER U WITH DIAERESIS
            case 0x00fc: c = 0xf5; break; // LATIN SMALL LETTER U WITH DIAERESIS
            case 0x03a3: c = 0xf6; break; // GREEK CAPITAL LETTER SIGMA
            case 0x03c0: c = 0xf7; break; // GREEK SMALL LETTER PI
            case 0x0304: c = 0xf8; break; // COMBINING MACRON
            case 0x00f7: c = 0xfd; break; // DIVISION SIGN

            default:
            case 0x25a0: c = 0xff; break; // BLACK SQUARE
            }
        }

        // Special handling for 'x' followed by COMBINING MACRON
        if (c == (char)0xf8) {
            if (d == ks0066u || (d > ks0066u && *(d - 1) != 'x')) {
                c = 0xff; // BLACK SQUARE
            }

            if (d > ks0066u) {
                --d;
            }
        }

        *d++ = c;
    }

    while (d < e) {
        *d++ = '\0';
    }
}

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

    // Create device object
    LCD20x4 lcd;
    lcd_20x4_create(&lcd, 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

    // Turn backlight on
    lcd_20x4_backlight_on(&lcd);

    // Write some strings using the wchar_to_ks0066u function to map to the LCD charset
    char ks0066u[20];

    wchar_to_ks0066u(L"Stromstärke: 17µA", ks0066u, sizeof(ks0066u));
    lcd_20x4_write_line(&lcd, 0, 0, ks0066u);

    wchar_to_ks0066u(L"Temperatur:  23°C", ks0066u, sizeof(ks0066u));
    lcd_20x4_write_line(&lcd, 1, 0, ks0066u);

    // Write a string directly including characters from the LCD charset
    lcd_20x4_write_line(&lcd, 2, 0, "Drehzahl:   750min\xe9");

    printf("Press key to exit\n");
    getchar();
    lcd_20x4_destroy(&lcd);
    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 lcd_20x4_create(LCD20x4 *lcd_20x4, const char *uid, IPConnection *ipcon)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

LCD20x4 lcd_20x4;
lcd_20x4_create(&lcd_20x4, "YOUR_DEVICE_UID", &ipcon);

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

void lcd_20x4_destroy(LCD20x4 *lcd_20x4)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *

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

int lcd_20x4_write_line(LCD20x4 *lcd_20x4, uint8_t line, uint8_t position, const char text[20])
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • line – Typ: uint8_t, Wertebereich: [0 bis 3]
  • position – Typ: uint8_t, Wertebereich: [0 bis 19]
  • text – Typ: const char[20]
Rückgabe:
  • error_code – Typ: int

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

Beispiel: (0, 7, "Hallo") schreibt Hallo in die Mitte der ersten Zeile des Display.

Das Display nutzt einen speziellen Zeichensatz der alle ASCII Zeichen beinhaltet außer Backslash und Tilde. Der Zeichensatz des LCD beinhaltet weiterhin einige Nicht-ASCII Zeichen, siehe die Zeichensatzspezifikation für Details. Das gezeigte Unicode Beispiel verdeutlicht die Verwendung von Nicht-ASCII Zeichen und wie die Wandlung von Unicode in den LCD Zeichensatz möglich ist.

int lcd_20x4_clear_display(LCD20x4 *lcd_20x4)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
Rückgabe:
  • error_code – Typ: int

Löscht alle Zeichen auf dem Display.

int lcd_20x4_backlight_on(LCD20x4 *lcd_20x4)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
Rückgabe:
  • error_code – Typ: int

Aktiviert die Hintergrundbeleuchtung.

int lcd_20x4_backlight_off(LCD20x4 *lcd_20x4)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
Rückgabe:
  • error_code – Typ: int

Deaktiviert die Hintergrundbeleuchtung.

int lcd_20x4_is_backlight_on(LCD20x4 *lcd_20x4, bool *ret_backlight)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
Ausgabeparameter:
  • ret_backlight – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.

Fortgeschrittene Funktionen

int lcd_20x4_set_config(LCD20x4 *lcd_20x4, bool cursor, bool blinking)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • cursor – Typ: bool, Standardwert: false
  • blinking – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Konfiguriert ob der Cursor (angezeigt als "_") sichtbar ist und ob er blinkt (angezeigt als blinkender Block). Die Cursor Position ist ein Zeichen hinter dem zuletzt mit lcd_20x4_write_line() geschriebenen Text.

int lcd_20x4_get_config(LCD20x4 *lcd_20x4, bool *ret_cursor, bool *ret_blinking)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
Ausgabeparameter:
  • ret_cursor – Typ: bool, Standardwert: false
  • ret_blinking – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

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

int lcd_20x4_is_button_pressed(LCD20x4 *lcd_20x4, uint8_t button, bool *ret_pressed)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • button – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:
  • ret_pressed – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt true zurück wenn die Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2) gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die LCD_20X4_CALLBACK_BUTTON_PRESSED und LCD_20X4_CALLBACK_BUTTON_RELEASED Callbacks zu nutzen.

int lcd_20x4_set_custom_character(LCD20x4 *lcd_20x4, uint8_t index, uint8_t character[8])
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 7]
  • character – Typ: uint8_t[8], Wertebereich: [0 bis 31]
Rückgabe:
  • error_code – Typ: int

Das LCD 20x4 Bricklet kann bis zu 8 benutzerdefinierte Buchstaben speichern. Die Buchstaben bestehen aus 5x8 Pixel und sie können über den Index 0-7 adressiert werden. Um die Pixel zu beschreiben, werden die ersten 5 Bit von 8 Bytes verwenden. Zum Beispiel, um den Buchstaben "H" zu erzeugen, sollte das folgende Array gesendet werden:

  • character[0] = 0b00010001 (Dezimalwert 17)
  • character[1] = 0b00010001 (Dezimalwert 17)
  • character[2] = 0b00010001 (Dezimalwert 17)
  • character[3] = 0b00011111 (Dezimalwert 31)
  • character[4] = 0b00010001 (Dezimalwert 17)
  • character[5] = 0b00010001 (Dezimalwert 17)
  • character[6] = 0b00010001 (Dezimalwert 17)
  • character[7] = 0b00000000 (Dezimalwert 0)

Die Buchstaben können später mit lcd_20x4_write_line() mit den chars mit den Byterepräsentationen 8 ("x08") bis 15 ("x0F") geschrieben werden.

Es ist möglich die benutzerdefinierten Buchstaben im Brick Viewer ab Version 2.0.1 einzustellen.

Benutzerdefinierte Buchstaben werden vom LCD im RAM gespeichert, daher müssen sie nach jedem Start des LCD 20x4 Bricklets gesetzt werden.

Neu in Version 2.0.1 (Plugin).

int lcd_20x4_get_custom_character(LCD20x4 *lcd_20x4, uint8_t index, uint8_t ret_character[8])
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • index – Typ: uint8_t, Wertebereich: [0 bis 7]
Ausgabeparameter:
  • ret_character – Typ: uint8_t[8], Wertebereich: [0 bis 31]
Rückgabe:
  • error_code – Typ: int

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von lcd_20x4_set_custom_character() gesetzt.

Neu in Version 2.0.1 (Plugin).

int lcd_20x4_set_default_text(LCD20x4 *lcd_20x4, uint8_t line, const char text[20])
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • line – Typ: uint8_t, Wertebereich: [0 bis 3]
  • text – Typ: const char[20]
Rückgabe:
  • error_code – Typ: int

Setzt den Standard-Text für die Zeilen 0-3. Die maximale Anzahl an Buchstaben pro Zeile ist 20.

Der Standard-Text wird auf dem LCD angezeigt, wenn der Standard-Text-Zähler ausläuft, siehe lcd_20x4_set_default_text_counter().

Neu in Version 2.0.2 (Plugin).

int lcd_20x4_get_default_text(LCD20x4 *lcd_20x4, uint8_t line, char ret_text[20])
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • line – Typ: uint8_t, Wertebereich: [0 bis 3]
Ausgabeparameter:
  • ret_text – Typ: char[20]
Rückgabe:
  • error_code – Typ: int

Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von lcd_20x4_set_default_text() gesetzt.

Neu in Version 2.0.2 (Plugin).

int lcd_20x4_set_default_text_counter(LCD20x4 *lcd_20x4, int32_t counter)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • counter – Typ: int32_t, Einheit: 1 ms, Wertebereich: [-231 bis 231 - 1], Standardwert: -1
Rückgabe:
  • error_code – Typ: int

Setzt den Standard-Text-Zähler. Der Zähler wird von der LCD Firmware einmal pro ms dekrementiert. Wenn der Zähler 0 erreicht wird der Standard-Text auf dem LCD angezeigt (siehe lcd_20x4_set_default_text()).

Diese Funktionalität kann genutzt werden um auf dem LCD einen Text anzuzeigen falls das kontrollierende Programm abstürzt oder die Verbindung unterbrochen wird.

Ein möglicher Ansatz dafür ist lcd_20x4_set_default_text_counter() einmal pro Minute mit dem Parameter 1000*60*2 (zwei Minuten) aufzurufen. In diesem Fall wird dann der Standard-Text nach spätestens zwei Minuten angezeigt wenn das kontrollierende Programm abstürzt.

Ein negativer Zählerwert stellt die Standard-Text Funktionalität aus.

Neu in Version 2.0.2 (Plugin).

int lcd_20x4_get_default_text_counter(LCD20x4 *lcd_20x4, int32_t *ret_counter)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
Ausgabeparameter:
  • ret_counter – Typ: int32_t, Einheit: 1 ms, Wertebereich: [-231 bis 231 - 1], Standardwert: -1
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Wert des Standard-Text-Zählers zurück.

Neu in Version 2.0.2 (Plugin).

int lcd_20x4_get_identity(LCD20x4 *lcd_20x4, 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:
  • lcd_20x4 – Typ: LCD20x4 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', '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 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

void lcd_20x4_register_callback(LCD20x4 *lcd_20x4, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • 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 lcd_20x4_register_callback() Funktion durchgeführt werden:

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

lcd_20x4_register_callback(&lcd_20x4,
                           LCD_20X4_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.

LCD_20X4_CALLBACK_BUTTON_PRESSED
void callback(uint8_t button, void *user_data)
Callback-Parameter:
  • button – Typ: uint8_t, Wertebereich: [0 bis 3]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).

LCD_20X4_CALLBACK_BUTTON_RELEASED
void callback(uint8_t button, void *user_data)
Callback-Parameter:
  • button – Typ: uint8_t, Wertebereich: [0 bis 3]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste (0 bis 2 oder 0 bis 3 seit Hardware Version 1.2).

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 lcd_20x4_get_api_version(LCD20x4 *lcd_20x4, uint8_t ret_api_version[3])
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
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:
  • error_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 lcd_20x4_get_response_expected(LCD20x4 *lcd_20x4, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • 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 lcd_20x4_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:

  • LCD_20X4_FUNCTION_WRITE_LINE = 1
  • LCD_20X4_FUNCTION_CLEAR_DISPLAY = 2
  • LCD_20X4_FUNCTION_BACKLIGHT_ON = 3
  • LCD_20X4_FUNCTION_BACKLIGHT_OFF = 4
  • LCD_20X4_FUNCTION_SET_CONFIG = 6
  • LCD_20X4_FUNCTION_SET_CUSTOM_CHARACTER = 11
  • LCD_20X4_FUNCTION_SET_DEFAULT_TEXT = 13
  • LCD_20X4_FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15
int lcd_20x4_set_response_expected(LCD20x4 *lcd_20x4, uint8_t function_id, bool response_expected)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • 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:

  • LCD_20X4_FUNCTION_WRITE_LINE = 1
  • LCD_20X4_FUNCTION_CLEAR_DISPLAY = 2
  • LCD_20X4_FUNCTION_BACKLIGHT_ON = 3
  • LCD_20X4_FUNCTION_BACKLIGHT_OFF = 4
  • LCD_20X4_FUNCTION_SET_CONFIG = 6
  • LCD_20X4_FUNCTION_SET_CUSTOM_CHARACTER = 11
  • LCD_20X4_FUNCTION_SET_DEFAULT_TEXT = 13
  • LCD_20X4_FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15
int lcd_20x4_set_response_expected_all(LCD20x4 *lcd_20x4, bool response_expected)
Parameter:
  • lcd_20x4 – Typ: LCD20x4 *
  • 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.

Konstanten

LCD_20X4_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LCD 20x4 Bricklet zu identifizieren.

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

LCD_20X4_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.