LabVIEW - LCD 20x4 Bricklet

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

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet 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.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletLCD20x4(uid, ipcon) → lcd20x4
Eingabe:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Ausgabe:
  • lcd20x4 -- .NET Refnum (BrickletLCD20x4)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletLCD20x4.WriteLine(line, position, text)
Eingabe:
  • line -- Byte
  • position -- Byte
  • text -- String

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.

BrickletLCD20x4.ClearDisplay()

Löscht alle Zeichen auf dem Display.

BrickletLCD20x4.BacklightOn()

Aktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4.BacklightOff()

Deaktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4.IsBacklightOn() → backlight
Ausgabe:
  • backlight -- Boolean

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

Fortgeschrittene Funktionen

BrickletLCD20x4.SetConfig(cursor, blinking)
Eingabe:
  • cursor -- Boolean
  • blinking -- Boolean

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.

Der Standardwert ist (false, false).

BrickletLCD20x4.GetConfig() → cursor, blinking
Ausgabe:
  • cursor -- Boolean
  • blinking -- Boolean

Gibt die Konfiguration zurück, wie von SetConfig() gesetzt.

BrickletLCD20x4.IsButtonPressed(button) → pressed
Eingabe:
  • button -- Byte
Ausgabe:
  • pressed -- Boolean

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 ButtonPressedCallback und ButtonReleasedCallback Callbacks zu nutzen.

BrickletLCD20x4.SetCustomCharacter(index, character)
Eingabe:
  • index -- Byte
  • character -- Byte[8]

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

BrickletLCD20x4.GetCustomCharacter(index) → character
Eingabe:
  • index -- Byte
Ausgabe:
  • character -- Byte[8]

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)
Eingabe:
  • line -- Byte
  • text -- String

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) → text
Eingabe:
  • line -- Byte
Ausgabe:
  • text -- String

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)
Eingabe:
  • counter -- Int32

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

Der Standardwert ist -1.

Neu in Version 2.0.2 (Plugin).

BrickletLCD20x4.GetDefaultTextCounter() → counter
Ausgabe:
  • counter -- Int32

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

Neu in Version 2.0.2 (Plugin).

BrickletLCD20x4.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion -- Byte[3]

Gibt die Version der API Definition (Major, Minor, Revision) 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) → responseExpected
Eingabe:
  • functionId -- Byte
Ausgabe:
  • responseExpected -- Boolean

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:

  • 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
BrickletLCD20x4.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId -- Byte
  • responseExpected -- Boolean

Ä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:

  • 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
BrickletLCD20x4.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected -- Boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickletLCD20x4.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen 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.

event BrickletLCD20x4.ButtonPressedCallback(sender, button)
Eingabe:
  • sender -- .NET Refnum (BrickletLCD20x4)
  • button -- Byte

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

event BrickletLCD20x4.ButtonReleasedCallback(sender, button)
Eingabe:
  • sender -- .NET Refnum (BrickletLCD20x4)
  • button -- Byte

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

Konstanten

BrickletLCD20x4.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein LCD 20x4 Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback 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.