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)
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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD20x4;
public class ExampleHelloWorld {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your LCD 20x4 Bricklet
private static final String UID = "XYZ";
// Note: To make the example code cleaner we do not handle exceptions. Exceptions
// you might normally want to catch are described in the documentation
public static void main(String args[]) throws Exception {
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Turn backlight on
lcd.backlightOn();
// Write "Hello World"
lcd.writeLine((short)0, (short)0, "Hello World");
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleButtonCallback.java)
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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD20x4;
public class ExampleButtonCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your LCD 20x4 Bricklet
private static final String UID = "XYZ";
// Note: To make the example code cleaner we do not handle exceptions. Exceptions
// you might normally want to catch are described in the documentation
public static void main(String args[]) throws Exception {
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add button pressed listener
lcd.addButtonPressedListener(new BrickletLCD20x4.ButtonPressedListener() {
public void buttonPressed(short button) {
System.out.println("Button Pressed: " + button);
}
});
// Add button released listener
lcd.addButtonReleasedListener(new BrickletLCD20x4.ButtonReleasedListener() {
public void buttonReleased(short button) {
System.out.println("Button Released: " + button);
}
});
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleUnicode.java)
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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD20x4;
public class ExampleUnicode {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your LCD 20x4 Bricklet
private static final String UID = "XYZ";
// Maps a normal UTF-16 encoded string to the LCD charset
static String utf16ToKS0066U(String utf16)
{
String ks0066u = "";
char c;
for (int i = 0; i < utf16.length(); i++) {
int codePoint = utf16.codePointAt(i);
if (Character.isHighSurrogate(utf16.charAt(i))) {
// Skip low surrogate
i++;
}
// ASCII subset from JIS X 0201
if (codePoint >= 0x0020 && codePoint <= 0x007e) {
// The LCD charset doesn't include '\' and '~', use similar characters instead
switch (codePoint) {
case 0x005c: c = (char)0xa4; break; // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
case 0x007e: c = (char)0x2d; break; // TILDE maps to HYPHEN-MINUS
default: c = (char)codePoint; break;
}
}
// Katakana subset from JIS X 0201
else if (codePoint >= 0xff61 && codePoint <= 0xff9f) {
c = (char)(codePoint - 0xfec0);
}
// Special characters
else {
switch (codePoint) {
case 0x00a5: c = (char)0x5c; break; // YEN SIGN
case 0x2192: c = (char)0x7e; break; // RIGHTWARDS ARROW
case 0x2190: c = (char)0x7f; break; // LEFTWARDS ARROW
case 0x00b0: c = (char)0xdf; break; // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
case 0x03b1: c = (char)0xe0; break; // GREEK SMALL LETTER ALPHA
case 0x00c4: c = (char)0xe1; break; // LATIN CAPITAL LETTER A WITH DIAERESIS
case 0x00e4: c = (char)0xe1; break; // LATIN SMALL LETTER A WITH DIAERESIS
case 0x00df: c = (char)0xe2; break; // LATIN SMALL LETTER SHARP S
case 0x03b5: c = (char)0xe3; break; // GREEK SMALL LETTER EPSILON
case 0x00b5: c = (char)0xe4; break; // MICRO SIGN
case 0x03bc: c = (char)0xe4; break; // GREEK SMALL LETTER MU
case 0x03c2: c = (char)0xe5; break; // GREEK SMALL LETTER FINAL SIGMA
case 0x03c1: c = (char)0xe6; break; // GREEK SMALL LETTER RHO
case 0x221a: c = (char)0xe8; break; // SQUARE ROOT
case 0x00b9: c = (char)0xe9; break; // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
case 0x00a4: c = (char)0xeb; break; // CURRENCY SIGN
case 0x00a2: c = (char)0xec; break; // CENT SIGN
case 0x2c60: c = (char)0xed; break; // LATIN CAPITAL LETTER L WITH DOUBLE BAR
case 0x00f1: c = (char)0xee; break; // LATIN SMALL LETTER N WITH TILDE
case 0x00d6: c = (char)0xef; break; // LATIN CAPITAL LETTER O WITH DIAERESIS
case 0x00f6: c = (char)0xef; break; // LATIN SMALL LETTER O WITH DIAERESIS
case 0x03f4: c = (char)0xf2; break; // GREEK CAPITAL THETA SYMBOL
case 0x221e: c = (char)0xf3; break; // INFINITY
case 0x03a9: c = (char)0xf4; break; // GREEK CAPITAL LETTER OMEGA
case 0x00dc: c = (char)0xf5; break; // LATIN CAPITAL LETTER U WITH DIAERESIS
case 0x00fc: c = (char)0xf5; break; // LATIN SMALL LETTER U WITH DIAERESIS
case 0x03a3: c = (char)0xf6; break; // GREEK CAPITAL LETTER SIGMA
case 0x03c0: c = (char)0xf7; break; // GREEK SMALL LETTER PI
case 0x0304: c = (char)0xf8; break; // COMBINING MACRON
case 0x00f7: c = (char)0xfd; break; // DIVISION SIGN
default:
case 0x25a0: c = (char)0xff; break; // BLACK SQUARE
}
}
// Special handling for 'x' followed by COMBINING MACRON
if (c == (char)0xf8) {
if (!ks0066u.endsWith("x")) {
c = (char)0xff; // BLACK SQUARE
}
if (ks0066u.length() > 0) {
ks0066u = ks0066u.substring(0, ks0066u.length() - 1);
}
}
ks0066u += c;
}
return ks0066u;
}
// Note: To make the example code cleaner we do not handle exceptions. Exceptions
// you might normally want to catch are described in the documentation
public static void main(String args[]) throws Exception {
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletLCD20x4 lcd = new BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Turn backlight on
lcd.backlightOn();
// Write some strings using the utf16ToKS0066U function to map to the LCD charset
lcd.writeLine((short)0, (short)0, utf16ToKS0066U("Stromstärke: 17µA"));
lcd.writeLine((short)1, (short)0, utf16ToKS0066U("Temperatur: 23°C"));
// Write a string directly including characters from the LCD charset
lcd.writeLine((short)2, (short)0, "Drehzahl: 750min\u00e9");
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.
BrickletLCD20x4
(String uid, IPConnection ipcon)¶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.
BrickletLCD20x4.
writeLine
(short line, short position, String text)¶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.
BrickletLCD20x4.
clearDisplay
()¶Löscht alle Zeichen auf dem Display.
BrickletLCD20x4.
backlightOn
()¶Aktiviert die Hintergrundbeleuchtung.
BrickletLCD20x4.
backlightOff
()¶Deaktiviert die Hintergrundbeleuchtung.
BrickletLCD20x4.
isBacklightOn
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
BrickletLCD20x4.
setConfig
(boolean cursor, boolean blinking)¶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.
BrickletLCD20x4.
getConfig
()¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von setConfig()
gesetzt.
BrickletLCD20x4.
isButtonPressed
(short button)¶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.
BrickletLCD20x4.
setCustomCharacter
(short index, short[] character)¶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.
Neu in Version 2.0.1 (Plugin).
BrickletLCD20x4.
getCustomCharacter
(short index)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von setCustomCharacter()
gesetzt.
Neu in Version 2.0.1 (Plugin).
BrickletLCD20x4.
setDefaultText
(short line, String text)¶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()
.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
getDefaultText
(short line)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von
setDefaultText()
gesetzt.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
setDefaultTextCounter
(int counter)¶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.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
getDefaultTextCounter
()¶Rückgabe: |
|
---|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
getIdentity
()¶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.
BrickletLCD20x4.
ButtonPressedListener
()¶Dieser Listener kann mit der Funktion addButtonPressedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeButtonPressedListener()
wieder
entfernt werden.
buttonPressed
(short button)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).
BrickletLCD20x4.
ButtonReleasedListener
()¶Dieser Listener kann mit der Funktion addButtonReleasedListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeButtonReleasedListener()
wieder
entfernt werden.
buttonReleased
(short button)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.
BrickletLCD20x4.
getAPIVersion
()¶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.
BrickletLCD20x4.
getResponseExpected
(byte functionId)¶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.
setResponseExpected
(byte functionId, boolean responseExpected)¶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.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
BrickletLCD20x4.
DEVICE_IDENTIFIER
¶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.
BrickletLCD20x4.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.