Dies ist die Beschreibung der C/C++ API Bindings für das LCD 16x2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 16x2 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_hello_world.c)
1#include <stdio.h>
2
3#include "ip_connection.h"
4#include "bricklet_lcd_16x2.h"
5
6#define HOST "localhost"
7#define PORT 4223
8#define UID "XYZ" // Change XYZ to the UID of your LCD 16x2 Bricklet
9
10int main(void) {
11 // Create IP connection
12 IPConnection ipcon;
13 ipcon_create(&ipcon);
14
15 // Create device object
16 LCD16x2 lcd;
17 lcd_16x2_create(&lcd, UID, &ipcon);
18
19 // Connect to brickd
20 if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
21 fprintf(stderr, "Could not connect\n");
22 return 1;
23 }
24 // Don't use device before ipcon is connected
25
26 // Turn backlight on
27 lcd_16x2_backlight_on(&lcd);
28
29 // Write "Hello World"
30 lcd_16x2_write_line(&lcd, 0, 0, "Hello World");
31
32 printf("Press key to exit\n");
33 getchar();
34 lcd_16x2_destroy(&lcd);
35 ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
36 return 0;
37}
1#include <stdio.h>
2#include <wchar.h>
3
4#include "ip_connection.h"
5#include "bricklet_lcd_16x2.h"
6
7#define HOST "localhost"
8#define PORT 4223
9#define UID "XYZ" // Change XYZ to the UID of your LCD 16x2 Bricklet
10
11// Maps a wchar_t string to the LCD charset
12static void wchar_to_ks0066u(const wchar_t *wchar, char *ks0066u, int ks0066u_length)
13{
14 const wchar_t *s = wchar;
15 char *d = ks0066u;
16 char *e = ks0066u + ks0066u_length;
17 char c;
18 uint32_t code_point;
19
20 while (*s != '\0' && d < e) {
21 // If wchar_t is UTF-16 then handle surrogates
22 if (sizeof(wchar_t) == 2 && *s >= 0xd800 && *s <= 0xdbff) {
23 code_point = 0x10000 + (*s - 0xd800) * 0x400 + (*(s + 1) - 0xdc00);
24 s += 2;
25 } else {
26 code_point = *s++;
27 }
28
29 // ASCII subset from JIS X 0201
30 if (code_point >= 0x0020 && code_point <= 0x007e) {
31 // The LCD charset doesn't include '\' and '~', use similar characters instead
32 switch (code_point) {
33 case 0x005c: c = 0xa4; break; // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
34 case 0x007e: c = 0x2d; break; // TILDE maps to HYPHEN-MINUS
35 default: c = code_point; break;
36 }
37 }
38 // Katakana subset from JIS X 0201
39 else if (code_point >= 0xff61 && code_point <= 0xff9f) {
40 c = code_point - 0xfec0;
41 }
42 // Special characters
43 else {
44 switch (code_point) {
45 case 0x00a5: c = 0x5c; break; // YEN SIGN
46 case 0x2192: c = 0x7e; break; // RIGHTWARDS ARROW
47 case 0x2190: c = 0x7f; break; // LEFTWARDS ARROW
48 case 0x00b0: c = 0xdf; break; // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
49 case 0x03b1: c = 0xe0; break; // GREEK SMALL LETTER ALPHA
50 case 0x00c4: c = 0xe1; break; // LATIN CAPITAL LETTER A WITH DIAERESIS
51 case 0x00e4: c = 0xe1; break; // LATIN SMALL LETTER A WITH DIAERESIS
52 case 0x00df: c = 0xe2; break; // LATIN SMALL LETTER SHARP S
53 case 0x03b5: c = 0xe3; break; // GREEK SMALL LETTER EPSILON
54 case 0x00b5: c = 0xe4; break; // MICRO SIGN
55 case 0x03bc: c = 0xe4; break; // GREEK SMALL LETTER MU
56 case 0x03c2: c = 0xe5; break; // GREEK SMALL LETTER FINAL SIGMA
57 case 0x03c1: c = 0xe6; break; // GREEK SMALL LETTER RHO
58 case 0x221a: c = 0xe8; break; // SQUARE ROOT
59 case 0x00b9: c = 0xe9; break; // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
60 case 0x00a4: c = 0xeb; break; // CURRENCY SIGN
61 case 0x00a2: c = 0xec; break; // CENT SIGN
62 case 0x2c60: c = 0xed; break; // LATIN CAPITAL LETTER L WITH DOUBLE BAR
63 case 0x00f1: c = 0xee; break; // LATIN SMALL LETTER N WITH TILDE
64 case 0x00d6: c = 0xef; break; // LATIN CAPITAL LETTER O WITH DIAERESIS
65 case 0x00f6: c = 0xef; break; // LATIN SMALL LETTER O WITH DIAERESIS
66 case 0x03f4: c = 0xf2; break; // GREEK CAPITAL THETA SYMBOL
67 case 0x221e: c = 0xf3; break; // INFINITY
68 case 0x03a9: c = 0xf4; break; // GREEK CAPITAL LETTER OMEGA
69 case 0x00dc: c = 0xf5; break; // LATIN CAPITAL LETTER U WITH DIAERESIS
70 case 0x00fc: c = 0xf5; break; // LATIN SMALL LETTER U WITH DIAERESIS
71 case 0x03a3: c = 0xf6; break; // GREEK CAPITAL LETTER SIGMA
72 case 0x03c0: c = 0xf7; break; // GREEK SMALL LETTER PI
73 case 0x0304: c = 0xf8; break; // COMBINING MACRON
74 case 0x00f7: c = 0xfd; break; // DIVISION SIGN
75
76 default:
77 case 0x25a0: c = 0xff; break; // BLACK SQUARE
78 }
79 }
80
81 // Special handling for 'x' followed by COMBINING MACRON
82 if (c == (char)0xf8) {
83 if (d == ks0066u || (d > ks0066u && *(d - 1) != 'x')) {
84 c = 0xff; // BLACK SQUARE
85 }
86
87 if (d > ks0066u) {
88 --d;
89 }
90 }
91
92 *d++ = c;
93 }
94
95 while (d < e) {
96 *d++ = '\0';
97 }
98}
99
100int main(void) {
101 // Create IP connection
102 IPConnection ipcon;
103 ipcon_create(&ipcon);
104
105 // Create device object
106 LCD16x2 lcd;
107 lcd_16x2_create(&lcd, UID, &ipcon);
108
109 // Connect to brickd
110 if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
111 fprintf(stderr, "Could not connect\n");
112 return 1;
113 }
114 // Don't use device before ipcon is connected
115
116 // Turn backlight on
117 lcd_16x2_backlight_on(&lcd);
118
119 // Write a string using the wchar_to_ks0066u function to map to the LCD charset
120 char ks0066u[16];
121
122 wchar_to_ks0066u(L"Stromstärke: 5µA", ks0066u, sizeof(ks0066u));
123 lcd_16x2_write_line(&lcd, 0, 0, ks0066u);
124
125 // Write a string directly including characters from the LCD charset
126 lcd_16x2_write_line(&lcd, 1, 0, "Drehzahl: 1000s\xe9");
127
128 printf("Press key to exit\n");
129 getchar();
130 lcd_16x2_destroy(&lcd);
131 ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
132 return 0;
133}
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.
| Parameter: |
|
|---|
Erzeugt ein Geräteobjekt lcd_16x2 mit der eindeutigen Geräte ID uid und
fügt es der IP Connection ipcon hinzu:
LCD16x2 lcd_16x2;
lcd_16x2_create(&lcd_16x2, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
| Parameter: |
|
|---|
Entfernt das Geräteobjekt lcd_16x2 von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 16 Zeichen lang sein.
Beispiel: (0, 5, "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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Löscht alle Zeichen auf dem Display.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Aktiviert die Hintergrundbeleuchtung.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Deaktiviert die Hintergrundbeleuchtung.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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_16x2_write_line() geschriebenen Text.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt die Konfiguration zurück, wie von lcd_16x2_set_config() gesetzt.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt true zurück wenn die Taste gedrückt ist.
Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die
LCD_16X2_CALLBACK_BUTTON_PRESSED und LCD_16X2_CALLBACK_BUTTON_RELEASED Callbacks zu nutzen.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Das LCD 16x2 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_16x2_write_line() mit den chars mit
den Byterepräsentationen 8 ("\x08" oder "\u0008") bis 15 ("\x0F" oder
"\u000F") 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 16x2 Bricklets gesetzt werden.
Added in version 2.0.1$nbsp;(Plugin).
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von lcd_16x2_get_custom_character() gesetzt.
Added in version 2.0.1$nbsp;(Plugin).
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
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.
| Parameter: |
|
|---|
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 können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der lcd_16x2_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } lcd_16x2_register_callback(&lcd_16x2, LCD_16X2_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.
void callback(uint8_t button, void *user_data)
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste.
void callback(uint8_t button, void *user_data)
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste.
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.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
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.
| Parameter: |
|
|---|---|
| Ausgabeparameter: |
|
| Rückgabe: |
|
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_16x2_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_16X2_FUNCTION_WRITE_LINE = 1
LCD_16X2_FUNCTION_CLEAR_DISPLAY = 2
LCD_16X2_FUNCTION_BACKLIGHT_ON = 3
LCD_16X2_FUNCTION_BACKLIGHT_OFF = 4
LCD_16X2_FUNCTION_SET_CONFIG = 6
LCD_16X2_FUNCTION_SET_CUSTOM_CHARACTER = 11
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ä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_16X2_FUNCTION_WRITE_LINE = 1
LCD_16X2_FUNCTION_CLEAR_DISPLAY = 2
LCD_16X2_FUNCTION_BACKLIGHT_ON = 3
LCD_16X2_FUNCTION_BACKLIGHT_OFF = 4
LCD_16X2_FUNCTION_SET_CONFIG = 6
LCD_16X2_FUNCTION_SET_CUSTOM_CHARACTER = 11
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein LCD 16x2 Bricklet zu identifizieren.
Die lcd_16x2_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.
Diese Konstante stellt den Anzeigenamen eines LCD 16x2 Bricklet dar.