Shell - LCD 20x4 Bricklet¶

Hello World¶

Download (example-hello-world.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 20x4 Bricklet

# Turn backlight on
tinkerforge call lcd-20x4-bricklet $uid backlight-on

# Write "Hello World"
tinkerforge call lcd-20x4-bricklet $uid write-line 0 0 "Hello World"

Button Callback¶

Download (example-button-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 20x4 Bricklet

# Handle incoming button pressed callbacks
tinkerforge dispatch lcd-20x4-bricklet $uid button-pressed &

# Handle incoming button released callbacks
tinkerforge dispatch lcd-20x4-bricklet $uid button-released &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Unicode¶

Download (example-unicode.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LCD 20x4 Bricklet

# Turn backlight on
tinkerforge call lcd-20x4-bricklet $uid backlight-on

# Write some strings using sed to map to the LCD charset
# Note: This assumes that the shell supports UTF-8
tinkerforge call lcd-20x4-bricklet $uid write-line 0 0\
 "`echo 'Stromstärke: 17µA' | sed 'y/\o134~¥→←°αÄäßεµςρ√¹¤¢ⱠñÖöϴ∞ΩÜüΣπ÷■/\o244\o55\o134\o176\o177\o337\o340\o341\o341\o342\o343\o344\o345\o346\o350\o351\o353\o354\o355\o356\o357\o357\o362\o363\o364\o365\o365\o366\o367\o375\o377/'`"
tinkerforge call lcd-20x4-bricklet $uid write-line 1 0\
 "`echo 'Temperatur:  23°C' | sed 'y/\o134~¥→←°αÄäßεµςρ√¹¤¢ⱠñÖöϴ∞ΩÜüΣπ÷■/\o244\o55\o134\o176\o177\o337\o340\o341\o341\o342\o343\o344\o345\o346\o350\o351\o353\o354\o355\o356\o357\o357\o362\o363\o364\o365\o365\o366\o367\o375\o377/'`"

# Write a string directly including characters from the LCD charset
tinkerforge call lcd-20x4-bricklet $uid write-line 2 0\
 "`printf 'Drehzahl:   750min\xe9'`"

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call lcd-20x4-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des LCD 20x4 Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des LCD 20x4 Bricklet an und endet dann

tinkerforge dispatch lcd-20x4-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des LCD 20x4 Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des LCD 20x4 Bricklet an und endet dann

tinkerforge call lcd-20x4-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch lcd-20x4-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call lcd-20x4-bricklet <uid> write-line <line> <position> <text>¶

Parameter:	<line> – Typ: Int, Wertebereich: [0 bis 3] <position> – Typ: Int, Wertebereich: [0 bis 19] <text> – Typ: String, Länge: bis zu 20
Ausgabe:	keine Ausgabe

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.

tinkerforge call lcd-20x4-bricklet <uid> clear-display¶

Ausgabe:	keine Ausgabe

Löscht alle Zeichen auf dem Display.

tinkerforge call lcd-20x4-bricklet <uid> backlight-on¶

Ausgabe:	keine Ausgabe

Aktiviert die Hintergrundbeleuchtung.

tinkerforge call lcd-20x4-bricklet <uid> backlight-off¶

Ausgabe:	keine Ausgabe

Deaktiviert die Hintergrundbeleuchtung.

tinkerforge call lcd-20x4-bricklet <uid> is-backlight-on¶

Ausgabe:	backlight – Typ: Bool

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

Fortgeschrittene Funktionen¶

tinkerforge call lcd-20x4-bricklet <uid> set-config <cursor> <blinking>¶

Parameter:	<cursor> – Typ: Bool, Standardwert: false <blinking> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

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 write-line geschriebenen Text.

tinkerforge call lcd-20x4-bricklet <uid> get-config¶

Ausgabe:	cursor – Typ: Bool, Standardwert: false blinking – Typ: Bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set-config gesetzt.

tinkerforge call lcd-20x4-bricklet <uid> is-button-pressed <button>¶

Parameter:	<button> – Typ: Int, Wertebereich: [0 bis 3]
Ausgabe:	pressed – Typ: Bool

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 button-pressed und button-released Callbacks zu nutzen.

tinkerforge call lcd-20x4-bricklet <uid> set-custom-character <index> <character>¶

Parameter:	<index> – Typ: Int, Wertebereich: [0 bis 7] <character> – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 31]
Ausgabe:	keine Ausgabe

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 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 20x4 Bricklets gesetzt werden.

Neu in Version 2.0.1 (Plugin).

tinkerforge call lcd-20x4-bricklet <uid> get-custom-character <index>¶

Parameter:	<index> – Typ: Int, Wertebereich: [0 bis 7]
Ausgabe:	character – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 31]

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von set-custom-character gesetzt.

Neu in Version 2.0.1 (Plugin).

tinkerforge call lcd-20x4-bricklet <uid> set-default-text <line> <text>¶

Parameter:	<line> – Typ: Int, Wertebereich: [0 bis 3] <text> – Typ: String, Länge: bis zu 20
Ausgabe:	keine Ausgabe

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 set-default-text-counter.

Neu in Version 2.0.2 (Plugin).

tinkerforge call lcd-20x4-bricklet <uid> get-default-text <line>¶

Parameter:	<line> – Typ: Int, Wertebereich: [0 bis 3]
Ausgabe:	text – Typ: String, Länge: bis zu 20

Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von set-default-text gesetzt.

Neu in Version 2.0.2 (Plugin).

tinkerforge call lcd-20x4-bricklet <uid> set-default-text-counter <counter>¶

Parameter:	<counter> – Typ: Int, Einheit: 1 ms, Wertebereich: [-231 bis 231 - 1], Standardwert: -1
Ausgabe:	keine Ausgabe

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 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 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).

tinkerforge call lcd-20x4-bricklet <uid> get-default-text-counter¶

Ausgabe:	counter – Typ: Int, Einheit: 1 ms, Wertebereich: [-231 bis 231 - 1], Standardwert: -1

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

Neu in Version 2.0.2 (Plugin).

tinkerforge call lcd-20x4-bricklet <uid> get-identity¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 1]

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. 

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch lcd-20x4-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch lcd-20x4-bricklet <uid> button-pressed¶

Ausgabe:	button – Typ: Int, Wertebereich: [0 bis 3]

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).

tinkerforge dispatch lcd-20x4-bricklet <uid> button-released¶

Ausgabe:	button – Typ: Int, Wertebereich: [0 bis 3]

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).