Mathematica - LCD 20x4 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World

Download (ExampleHelloWorld.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LCD 20x4 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD20x4",uid,ipcon]
ipcon@Connect[host,port]

(*Turn backlight on*)
lcd@BacklightOn[]

(*Write "Hello World"*)
lcd@WriteLine[0,0,"Hello World"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[lcd]
ReleaseNETObject[ipcon]

Button Callback

Download (ExampleButtonCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LCD 20x4 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD20x4",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for button pressed callback*)
ButtonPressedCB[sender_,button_]:=
 Print["Button Pressed: "<>ToString[button]]
AddEventHandler[lcd@ButtonPressedCallback,ButtonPressedCB]

(*Callback function for button released callback*)
ButtonReleasedCB[sender_,button_]:=
 Print["Button Released: "<>ToString[button]]
AddEventHandler[lcd@ButtonReleasedCallback,ButtonReleasedCB]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[lcd]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.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.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

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

Grundfunktionen

BrickletLCD20x4[uid, ipcon] → lcd20x4
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • lcd20x4 -- NETObject[BrickletLCD20x4]

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

lcd20x4=NETNew["Tinkerforge.BrickletLCD20x4","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletLCD20x4@WriteLine[line, position, text] → Null
Parameter:
  • line -- Integer
  • position -- Integer
  • 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[] → Null

Löscht alle Zeichen auf dem Display.

BrickletLCD20x4@BacklightOn[] → Null

Aktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4@BacklightOff[] → Null

Deaktiviert die Hintergrundbeleuchtung.

BrickletLCD20x4@IsBacklightOn[] → backlight
Rückgabe:
  • backlight -- True/False

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

Fortgeschrittene Funktionen

BrickletLCD20x4@SetConfig[cursor, blinking] → Null
Parameter:
  • cursor -- True/False
  • blinking -- True/False

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[out cursor, out blinking] → Null
Parameter:
  • cursor -- True/False
  • blinking -- True/False

Gibt die Konfiguration zurück, wie von SetConfig[] gesetzt.

BrickletLCD20x4@IsButtonPressed[button] → pressed
Parameter:
  • button -- Integer
Rückgabe:
  • pressed -- True/False

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, {character1, character2, ..., character8}] → Null
Parameter:
  • index -- Integer
  • characteri -- Integer

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] → {character1, character2, ..., character8}
Parameter:
  • index -- Integer
Rückgabe:
  • characteri -- Integer

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] → Null
Parameter:
  • line -- Integer
  • 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
Parameter:
  • line -- Integer
Rückgabe:
  • 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] → Null
Parameter:
  • counter -- Integer

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
Rückgabe:
  • counter -- Integer

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

Neu in Version 2.0.2 (Plugin).

BrickletLCD20x4@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

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
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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.

Siehe SetResponseExpected[] für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletLCD20x4@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletLCD20x4`FUNCTIONUWRITEULINE = 1
  • BrickletLCD20x4`FUNCTIONUCLEARUDISPLAY = 2
  • BrickletLCD20x4`FUNCTIONUBACKLIGHTUON = 3
  • BrickletLCD20x4`FUNCTIONUBACKLIGHTUOFF = 4
  • BrickletLCD20x4`FUNCTIONUSETUCONFIG = 6
  • BrickletLCD20x4`FUNCTIONUSETUCUSTOMUCHARACTER = 11
  • BrickletLCD20x4`FUNCTIONUSETUDEFAULTUTEXT = 13
  • BrickletLCD20x4`FUNCTIONUSETUDEFAULTUTEXTUCOUNTER = 15
BrickletLCD20x4@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickletLCD20x4@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[lcd20x4@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

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]
Parameter:
  • sender -- NETObject[BrickletLCD20x4]
  • button -- Integer

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]
Parameter:
  • sender -- NETObject[BrickletLCD20x4]
  • button -- Integer

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`DEVICEUIDENTIFIER

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`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.