Dies ist die Beschreibung der JavaScript 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 JavaScript API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleHelloWorld.js)
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 | var Tinkerforge = require('tinkerforge');
var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your LCD 20x4 Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lcd = new Tinkerforge.BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT,
function (error) {
console.log('Error: ' + error);
}
); // Connect to brickd
// Don't use device before ipcon is connected
ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
function (connectReason) {
// Turn backlight on
lcd.backlightOn();
// Write "Hello World"
lcd.writeLine(0, 0, 'Hello World');
}
);
console.log('Press key to exit');
process.stdin.on('data',
function (data) {
ipcon.disconnect();
process.exit(0);
}
);
|
Download (ExampleButtonCallback.js)
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 | var Tinkerforge = require('tinkerforge');
var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your LCD 20x4 Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lcd = new Tinkerforge.BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT,
function (error) {
console.log('Error: ' + error);
}
); // Connect to brickd
// Don't use device before ipcon is connected
// Register button pressed callback
lcd.on(Tinkerforge.BrickletLCD20x4.CALLBACK_BUTTON_PRESSED,
// Callback function for button pressed callback
function (button) {
console.log('Button Pressed: ' + button);
}
);
// Register button released callback
lcd.on(Tinkerforge.BrickletLCD20x4.CALLBACK_BUTTON_RELEASED,
// Callback function for button released callback
function (button) {
console.log('Button Released: ' + button);
}
);
console.log('Press key to exit');
process.stdin.on('data',
function (data) {
ipcon.disconnect();
process.exit(0);
}
);
|
Download (ExampleHelloWorld.html), Test (ExampleHelloWorld.html)
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 | <!DOCTYPE html>
<html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<head>
<title>Tinkerforge | JavaScript Example</title>
</head>
<body>
<div style="text-align:center;">
<h1>LCD 20x4 Bricklet Hello World Example</h1>
<p>
<input value="localhost" id="host" type="text" size="20">:
<input value="4280" id="port" type="text" size="5">,
<input value="uid" id="uid" type="text" size="5">
<input value="Start Example" id="start" type="button" onclick="startExample();">
</p>
<p>
<textarea readonly id="text" cols="80" rows="24" style="resize:none;"
>Press "Start Example" to begin ...</textarea>
</p>
</div>
<script src="./Tinkerforge.js" type='text/javascript'></script>
<script type='text/javascript'>
var ipcon;
var textArea = document.getElementById("text");
function startExample() {
textArea.value = "";
var HOST = document.getElementById("host").value;
var PORT = parseInt(document.getElementById("port").value);
var UID = document.getElementById("uid").value;
if(ipcon !== undefined) {
ipcon.disconnect();
}
ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lcd = new Tinkerforge.BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT,
function(error) {
textArea.value += 'Error: ' + error + '\n';
}
); // Connect to brickd
// Don't use device before ipcon is connected
ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
function (connectReason) {
// Turn backlight on
lcd.backlightOn();
// Write "Hello World"
lcd.writeLine(0, 0, 'Hello World');
}
);
}
</script>
</body>
</html>
|
Download (ExampleButtonCallback.html), Test (ExampleButtonCallback.html)
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 | <!DOCTYPE html>
<html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<head>
<title>Tinkerforge | JavaScript Example</title>
</head>
<body>
<div style="text-align:center;">
<h1>LCD 20x4 Bricklet Button Callback Example</h1>
<p>
<input value="localhost" id="host" type="text" size="20">:
<input value="4280" id="port" type="text" size="5">,
<input value="uid" id="uid" type="text" size="5">
<input value="Start Example" id="start" type="button" onclick="startExample();">
</p>
<p>
<textarea readonly id="text" cols="80" rows="24" style="resize:none;"
>Press "Start Example" to begin ...</textarea>
</p>
</div>
<script src="./Tinkerforge.js" type='text/javascript'></script>
<script type='text/javascript'>
var ipcon;
var textArea = document.getElementById("text");
function startExample() {
textArea.value = "";
var HOST = document.getElementById("host").value;
var PORT = parseInt(document.getElementById("port").value);
var UID = document.getElementById("uid").value;
if(ipcon !== undefined) {
ipcon.disconnect();
}
ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lcd = new Tinkerforge.BrickletLCD20x4(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT,
function(error) {
textArea.value += 'Error: ' + error + '\n';
}
); // Connect to brickd
// Don't use device before ipcon is connected
// Register button pressed callback
lcd.on(Tinkerforge.BrickletLCD20x4.CALLBACK_BUTTON_PRESSED,
// Callback function for button pressed callback
function (button) {
textArea.value += 'Button Pressed: ' + button + '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
// Register button released callback
lcd.on(Tinkerforge.BrickletLCD20x4.CALLBACK_BUTTON_RELEASED,
// Callback function for button released callback
function (button) {
textArea.value += 'Button Released: ' + button + '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
}
</script>
</body>
</html>
|
Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter
haben, returnCallback
und errorCallback
. Dies sind benutzerdefinierte
Callback-Funktionen. Die returnCallback
-Funktion wird mit dem Ergebnissen
der Funktion als Argumente aufgerufen, falls die Funktion ihre
Ergebnisse asynchron zurückgibt. Die errorCallback
-Funktion wird im
Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der
folgenden Werte sein:
Der Namespace der JavaScript Bindings ist Tinkerforge.*
.
BrickletLCD20x4
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
var lcd20x4 = new BrickletLCD20x4("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletLCD20x4.
writeLine
(line, position, text[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
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
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Löscht alle Zeichen auf dem Display.
BrickletLCD20x4.
backlightOn
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert die Hintergrundbeleuchtung.
BrickletLCD20x4.
backlightOff
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Deaktiviert die Hintergrundbeleuchtung.
BrickletLCD20x4.
isBacklightOn
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
BrickletLCD20x4.
setConfig
(cursor, blinking[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-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 writeLine()
geschriebenen Text.
BrickletLCD20x4.
getConfig
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von setConfig()
gesetzt.
BrickletLCD20x4.
isButtonPressed
(button[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-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
CALLBACK_BUTTON_PRESSED
und CALLBACK_BUTTON_RELEASED
Callbacks zu nutzen.
BrickletLCD20x4.
setCustomCharacter
(index, character[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
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
(index[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-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
(line, text[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
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
(line[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-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
(counter[, returnCallback][, errorCallback])¶Parameter: |
|
---|---|
Callback-Parameter: |
|
Rückgabe: |
|
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
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
getIdentity
([returnCallback][, errorCallback])¶Callback-Parameter: |
|
---|---|
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.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion on()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter die Callback-Funktion:
lcd20x4.on(BrickletLCD20x4.CALLBACK_EXAMPLE,
function (param) {
console.log(param);
}
);
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.
BrickletLCD20x4.
CALLBACK_BUTTON_PRESSED
¶Callback-Parameter: |
|
---|
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).
BrickletLCD20x4.
CALLBACK_BUTTON_RELEASED
¶Callback-Parameter: |
|
---|
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 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ü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.
BrickletLCD20x4.
getResponseExpected
(functionId[, errorCallback])¶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 Callbacks 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 function_id:
BrickletLCD20x4.
setResponseExpected
(functionId, responseExpected[, errorCallback])¶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:
BrickletLCD20x4.
setResponseExpectedAll
(responseExpected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletLCD20x4.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein LCD 20x4 Bricklet zu identifizieren.
Die getIdentity()
Funktion und der
IPConnection.CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletLCD20x4.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.