Dies ist die Beschreibung der Java 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 Java API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleHelloWorld.java)
1import com.tinkerforge.IPConnection;
2import com.tinkerforge.BrickletLCD20x4;
3
4public class ExampleHelloWorld {
5 private static final String HOST = "localhost";
6 private static final int PORT = 4223;
7
8 // Change XYZ to the UID of your LCD 20x4 Bricklet
9 private static final String UID = "XYZ";
10
11 // Note: To make the example code cleaner we do not handle exceptions. Exceptions
12 // you might normally want to catch are described in the documentation
13 public static void main(String args[]) throws Exception {
14 IPConnection ipcon = new IPConnection(); // Create IP connection
15 BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object
16
17 ipcon.connect(HOST, PORT); // Connect to brickd
18 // Don't use device before ipcon is connected
19
20 // Turn backlight on
21 lcd.backlightOn();
22
23 // Write "Hello World"
24 lcd.writeLine((short)0, (short)0, "Hello World");
25
26 System.out.println("Press key to exit"); System.in.read();
27 ipcon.disconnect();
28 }
29}
Download (ExampleUnicode.java)
1import com.tinkerforge.IPConnection;
2import com.tinkerforge.BrickletLCD20x4;
3
4public class ExampleUnicode {
5 private static final String HOST = "localhost";
6 private static final int PORT = 4223;
7
8 // Change XYZ to the UID of your LCD 20x4 Bricklet
9 private static final String UID = "XYZ";
10
11 // Maps a normal UTF-16 encoded string to the LCD charset
12 static String utf16ToKS0066U(String utf16)
13 {
14 String ks0066u = "";
15 char c;
16
17 for (int i = 0; i < utf16.length(); i++) {
18 int codePoint = utf16.codePointAt(i);
19
20 if (Character.isHighSurrogate(utf16.charAt(i))) {
21 // Skip low surrogate
22 i++;
23 }
24
25 // ASCII subset from JIS X 0201
26 if (codePoint >= 0x0020 && codePoint <= 0x007e) {
27 // The LCD charset doesn't include '\' and '~', use similar characters instead
28 switch (codePoint) {
29 case 0x005c: c = (char)0xa4; break; // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
30 case 0x007e: c = (char)0x2d; break; // TILDE maps to HYPHEN-MINUS
31 default: c = (char)codePoint; break;
32 }
33 }
34 // Katakana subset from JIS X 0201
35 else if (codePoint >= 0xff61 && codePoint <= 0xff9f) {
36 c = (char)(codePoint - 0xfec0);
37 }
38 // Special characters
39 else {
40 switch (codePoint) {
41 case 0x00a5: c = (char)0x5c; break; // YEN SIGN
42 case 0x2192: c = (char)0x7e; break; // RIGHTWARDS ARROW
43 case 0x2190: c = (char)0x7f; break; // LEFTWARDS ARROW
44 case 0x00b0: c = (char)0xdf; break; // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
45 case 0x03b1: c = (char)0xe0; break; // GREEK SMALL LETTER ALPHA
46 case 0x00c4: c = (char)0xe1; break; // LATIN CAPITAL LETTER A WITH DIAERESIS
47 case 0x00e4: c = (char)0xe1; break; // LATIN SMALL LETTER A WITH DIAERESIS
48 case 0x00df: c = (char)0xe2; break; // LATIN SMALL LETTER SHARP S
49 case 0x03b5: c = (char)0xe3; break; // GREEK SMALL LETTER EPSILON
50 case 0x00b5: c = (char)0xe4; break; // MICRO SIGN
51 case 0x03bc: c = (char)0xe4; break; // GREEK SMALL LETTER MU
52 case 0x03c2: c = (char)0xe5; break; // GREEK SMALL LETTER FINAL SIGMA
53 case 0x03c1: c = (char)0xe6; break; // GREEK SMALL LETTER RHO
54 case 0x221a: c = (char)0xe8; break; // SQUARE ROOT
55 case 0x00b9: c = (char)0xe9; break; // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
56 case 0x00a4: c = (char)0xeb; break; // CURRENCY SIGN
57 case 0x00a2: c = (char)0xec; break; // CENT SIGN
58 case 0x2c60: c = (char)0xed; break; // LATIN CAPITAL LETTER L WITH DOUBLE BAR
59 case 0x00f1: c = (char)0xee; break; // LATIN SMALL LETTER N WITH TILDE
60 case 0x00d6: c = (char)0xef; break; // LATIN CAPITAL LETTER O WITH DIAERESIS
61 case 0x00f6: c = (char)0xef; break; // LATIN SMALL LETTER O WITH DIAERESIS
62 case 0x03f4: c = (char)0xf2; break; // GREEK CAPITAL THETA SYMBOL
63 case 0x221e: c = (char)0xf3; break; // INFINITY
64 case 0x03a9: c = (char)0xf4; break; // GREEK CAPITAL LETTER OMEGA
65 case 0x00dc: c = (char)0xf5; break; // LATIN CAPITAL LETTER U WITH DIAERESIS
66 case 0x00fc: c = (char)0xf5; break; // LATIN SMALL LETTER U WITH DIAERESIS
67 case 0x03a3: c = (char)0xf6; break; // GREEK CAPITAL LETTER SIGMA
68 case 0x03c0: c = (char)0xf7; break; // GREEK SMALL LETTER PI
69 case 0x0304: c = (char)0xf8; break; // COMBINING MACRON
70 case 0x00f7: c = (char)0xfd; break; // DIVISION SIGN
71
72 default:
73 case 0x25a0: c = (char)0xff; break; // BLACK SQUARE
74 }
75 }
76
77 // Special handling for 'x' followed by COMBINING MACRON
78 if (c == (char)0xf8) {
79 if (!ks0066u.endsWith("x")) {
80 c = (char)0xff; // BLACK SQUARE
81 }
82
83 if (ks0066u.length() > 0) {
84 ks0066u = ks0066u.substring(0, ks0066u.length() - 1);
85 }
86 }
87
88 ks0066u += c;
89 }
90
91 return ks0066u;
92 }
93
94 // Note: To make the example code cleaner we do not handle exceptions. Exceptions
95 // you might normally want to catch are described in the documentation
96 public static void main(String args[]) throws Exception {
97 IPConnection ipcon = new IPConnection(); // Create IP connection
98 BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object
99
100 ipcon.connect(HOST, PORT); // Connect to brickd
101 // Don't use device before ipcon is connected
102
103 // Turn backlight on
104 lcd.backlightOn();
105
106 // Write some strings using the utf16ToKS0066U function to map to the LCD charset
107 lcd.writeLine((short)0, (short)0, utf16ToKS0066U("Stromstärke: 17µA"));
108 lcd.writeLine((short)1, (short)0, utf16ToKS0066U("Temperatur: 23°C"));
109
110 // Write a string directly including characters from the LCD charset
111 lcd.writeLine((short)2, (short)0, "Drehzahl: 750min\u00e9");
112
113 System.out.println("Press key to exit"); System.in.read();
114 ipcon.disconnect();
115 }
116}
Prinzipiell kann jede Methode der Java Bindings eine TimeoutException
werfen. Diese Exception wird
geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt
wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der
Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung
können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu
groß wird.
Neben der TimeoutException kann auch noch eine NotConnectedException
geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu
kommunizieren, aber die IP Connection nicht verbunden ist.
Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.
Das Package für alle Brick/Bricklet Bindings und die IP Connection ist
com.tinkerforge.*
Alle folgend aufgelisteten Methoden sind Thread-sicher.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
BrickletLCD20x4 lcd20x4 = new BrickletLCD20x4("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Parameter: |
|
|---|
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.
Löscht alle Zeichen auf dem Display.
Aktiviert die Hintergrundbeleuchtung.
Deaktiviert die Hintergrundbeleuchtung.
| Rückgabe: |
|
|---|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
| Parameter: |
|
|---|
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 writeLine() geschriebenen Text.
| Rückgabeobjekt: |
|
|---|
Gibt die Konfiguration zurück, wie von setConfig() gesetzt.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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
ButtonPressedListener und ButtonReleasedListener Listeners zu nutzen.
| Parameter: |
|
|---|
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 writeLine() 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 20x4 Bricklets gesetzt werden.
Added in version 2.0.1$nbsp;(Plugin).
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von setCustomCharacter() gesetzt.
Added in version 2.0.1$nbsp;(Plugin).
| Parameter: |
|
|---|
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 setDefaultTextCounter().
Added in version 2.0.2$nbsp;(Plugin).
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von
setDefaultText() gesetzt.
Added in version 2.0.2$nbsp;(Plugin).
| Parameter: |
|
|---|
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 setDefaultText()).
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 setDefaultTextCounter() 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.
Added in version 2.0.2$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Added in version 2.0.2$nbsp;(Plugin).
| Rückgabeobjekt: |
|
|---|
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.
Listener können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.
Der Parameter ist ein Listener Klassen Objekt, z.B.:
device.addExampleListener(new BrickletLCD20x4.ExampleListener() {
public void property(int value) {
System.out.println("Value: " + value);
}
});
Die verfügbaren Listener Klassen mit den Methoden welche überschrieben
werden können werden unterhalb beschrieben. Es ist möglich mehrere
Listener hinzuzufügen und auch mit einem korrespondierenden
remove*Listener() wieder zu entfernen.
Bemerkung
Listener 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.
Dieser Listener kann mit der Funktion addButtonPressedListener() hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeButtonPressedListener() wieder
entfernt werden.
| Parameter: |
|
|---|
Dieser Listener 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).
Dieser Listener kann mit der Funktion addButtonReleasedListener() hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeButtonReleasedListener() wieder
entfernt werden.
| Parameter: |
|
|---|
Dieser Listener 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 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.
| Rückgabeobjekt: |
|
|---|
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: |
|
|---|---|
| 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 Listeners ist es standardmäßig gesetzt, kann aber
entfernt werden mittels setResponseExpected(). 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 functionId:
BrickletLCD20x4.FUNCTION_WRITE_LINE = 1
BrickletLCD20x4.FUNCTION_CLEAR_DISPLAY = 2
BrickletLCD20x4.FUNCTION_BACKLIGHT_ON = 3
BrickletLCD20x4.FUNCTION_BACKLIGHT_OFF = 4
BrickletLCD20x4.FUNCTION_SET_CONFIG = 6
BrickletLCD20x4.FUNCTION_SET_CUSTOM_CHARACTER = 11
BrickletLCD20x4.FUNCTION_SET_DEFAULT_TEXT = 13
BrickletLCD20x4.FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15
| Parameter: |
|
|---|
Ä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 Listeners (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 functionId:
BrickletLCD20x4.FUNCTION_WRITE_LINE = 1
BrickletLCD20x4.FUNCTION_CLEAR_DISPLAY = 2
BrickletLCD20x4.FUNCTION_BACKLIGHT_ON = 3
BrickletLCD20x4.FUNCTION_BACKLIGHT_OFF = 4
BrickletLCD20x4.FUNCTION_SET_CONFIG = 6
BrickletLCD20x4.FUNCTION_SET_CUSTOM_CHARACTER = 11
BrickletLCD20x4.FUNCTION_SET_DEFAULT_TEXT = 13
BrickletLCD20x4.FUNCTION_SET_DEFAULT_TEXT_COUNTER = 15
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
Diese Konstante wird verwendet um ein LCD 20x4 Bricklet zu identifizieren.
Die getIdentity() Funktion und der
IPConnection.EnumerateListener
Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ
des Bricks oder Bricklets anzugeben.
Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.