Shell - LCD 20x4 Bricklet

Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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'`"

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

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> -- string
  • <function> -- 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> -- string
  • <callback> -- 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> -- string
  • <function> -- 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> -- string
  • <callback> -- 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> -- int
  • <position> -- int
  • <text> -- string
Ausgabe:

keine Ausgabe

Schreibt einen Text in die angegebene Zeile (0 bis 3) mit einer vorgegebenen Position (0 bis 19). 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 -- 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> -- bool
  • <blinking> -- bool
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.

Der Standardwert ist (false, false).

tinkerforge call lcd-20x4-bricklet <uid> get-config
Ausgabe:
  • cursor -- bool
  • blinking -- bool

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

tinkerforge call lcd-20x4-bricklet <uid> is-button-pressed <button>
Parameter:
  • <button> -- int
Ausgabe:
  • pressed -- 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> -- int
  • <character> -- int,int,..5x..,int
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") bis 15 ("x0F") 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> -- int
Ausgabe:
  • character -- int,int,..5x..,int

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> -- int
  • <text> -- string
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> -- int
Ausgabe:
  • text -- string

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> -- int
Ausgabe:

keine Ausgabe

Setzt den Standard-Text-Zähler in ms. 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.

Der Standardwert ist -1.

Neu in Version 2.0.2 (Plugin).

tinkerforge call lcd-20x4-bricklet <uid> get-default-text-counter
Ausgabe:
  • counter -- int

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 -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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 kann 'a', 'b', 'c' oder 'd' sein.

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.

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.

tinkerforge dispatch lcd-20x4-bricklet <uid> button-pressed
Ausgabe:
  • button -- int

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 -- int

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