Mathematica - LCD 16x2 Bricklet¶

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 16x2 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD16x2",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 16x2 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
lcd=NETNew["Tinkerforge.BrickletLCD16x2",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]

Grundfunktionen¶

BrickletLCD16x2[uid, ipcon] → lcd16x2¶

Parameter:	uid – Typ: String ipcon – Typ: NETObject[IPConnection]
Rückgabe:	lcd16x2 – Typ: NETObject[BrickletLCD16x2]

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

lcd16x2=NETNew["Tinkerforge.BrickletLCD16x2","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

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.

BrickletLCD16x2@WriteLine[line, position, text] → Null¶

Parameter:	line – Typ: Integer, Wertebereich: [0 bis 1] position – Typ: Integer, Wertebereich: [0 bis 15] text – Typ: String, Länge: bis zu 16

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 16 Zeichen lang sein.

Beispiel: (0, 5, "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.

BrickletLCD16x2@ClearDisplay[] → Null¶

Löscht alle Zeichen auf dem Display.

BrickletLCD16x2@BacklightOn[] → Null¶

Aktiviert die Hintergrundbeleuchtung.

BrickletLCD16x2@BacklightOff[] → Null¶

Deaktiviert die Hintergrundbeleuchtung.

BrickletLCD16x2@IsBacklightOn[] → backlight¶

Rückgabe:	backlight – Typ: True/False

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

Fortgeschrittene Funktionen¶

BrickletLCD16x2@SetConfig[cursor, blinking] → Null¶

Parameter:	cursor – Typ: True/False, Standardwert: False blinking – Typ: True/False, Standardwert: 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.

BrickletLCD16x2@GetConfig[out cursor, out blinking] → Null¶

Ausgabeparameter:	cursor – Typ: True/False, Standardwert: False blinking – Typ: True/False, Standardwert: False

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

BrickletLCD16x2@IsButtonPressed[button] → pressed¶

Parameter:	button – Typ: Integer, Wertebereich: [0 bis 2]
Rückgabe:	pressed – Typ: True/False

Gibt true zurück wenn die Taste gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die ButtonPressedCallback und ButtonReleasedCallback Callbacks zu nutzen.

BrickletLCD16x2@SetCustomCharacter[index, {character1, character2, ..., character8}] → Null¶

Parameter:	index – Typ: Integer, Wertebereich: [0 bis 7] characteri – Typ: Integer, Wertebereich: [0 bis 31]

Das LCD 16x2 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 16x2 Bricklets gesetzt werden.

Neu in Version 2.0.1 (Plugin).

BrickletLCD16x2@GetCustomCharacter[index] → {character1, character2, ..., character8}¶

Parameter:	index – Typ: Integer, Wertebereich: [0 bis 7]
Rückgabe:	characteri – Typ: Integer, Wertebereich: [0 bis 31]

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von GetCustomCharacter[] gesetzt.

Neu in Version 2.0.1 (Plugin).

BrickletLCD16x2@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Integer, Wertebereich: [ToCharacterCode["a"][[0]] bis ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]] hardwareVersioni – Typ: Integer 1: major – Typ: Integer, Wertebereich: [0 bis 255] 2: minor – Typ: Integer, Wertebereich: [0 bis 255] 3: revision – Typ: Integer, Wertebereich: [0 bis 255] firmwareVersioni – Typ: Integer 1: major – Typ: Integer, Wertebereich: [0 bis 255] 2: minor – Typ: Integer, Wertebereich: [0 bis 255] 3: revision – Typ: Integer, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Integer, 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. 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[lcd16x2@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.

event BrickletLCD16x2@ButtonPressedCallback[sender, button]¶

Callback-Parameter:	sender – Typ: NETObject[BrickletLCD16x2] button – Typ: Integer, Wertebereich: [0 bis 2]

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste.

event BrickletLCD16x2@ButtonReleasedCallback[sender, button]¶

Callback-Parameter:	sender – Typ: NETObject[BrickletLCD16x2] button – Typ: Integer, Wertebereich: [0 bis 2]

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste.

Virtuelle Funktionen¶

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.

BrickletLCD16x2@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}¶

Ausgabeparameter:	apiVersioni – Typ: Integer 1: major – Typ: Integer, Wertebereich: [0 bis 255] 2: minor – Typ: Integer, Wertebereich: [0 bis 255] 3: revision – Typ: Integer, Wertebereich: [0 bis 255]

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.

BrickletLCD16x2@GetResponseExpected[functionId] → responseExpected¶

Parameter:	functionId – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: 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.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletLCD16x2`FUNCTIONUWRITEULINE = 1
• BrickletLCD16x2`FUNCTIONUCLEARUDISPLAY = 2
• BrickletLCD16x2`FUNCTIONUBACKLIGHTUON = 3
• BrickletLCD16x2`FUNCTIONUBACKLIGHTUOFF = 4
• BrickletLCD16x2`FUNCTIONUSETUCONFIG = 6
• BrickletLCD16x2`FUNCTIONUSETUCUSTOMUCHARACTER = 11

BrickletLCD16x2@SetResponseExpected[functionId, responseExpected] → Null¶

Parameter:	functionId – Typ: Integer, Wertebereich: Siehe Konstanten responseExpected – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletLCD16x2`FUNCTIONUWRITEULINE = 1
• BrickletLCD16x2`FUNCTIONUCLEARUDISPLAY = 2
• BrickletLCD16x2`FUNCTIONUBACKLIGHTUON = 3
• BrickletLCD16x2`FUNCTIONUBACKLIGHTUOFF = 4
• BrickletLCD16x2`FUNCTIONUSETUCONFIG = 6
• BrickletLCD16x2`FUNCTIONUSETUCUSTOMUCHARACTER = 11

BrickletLCD16x2@SetResponseExpectedAll[responseExpected] → Null¶

Parameter:	responseExpected – Typ: True/False

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

Konstanten¶

BrickletLCD16x2`DEVICEUIDENTIFIER¶

Diese Konstante wird verwendet um ein LCD 16x2 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.

BrickletLCD16x2`DEVICEDISPLAYNAME¶

Diese Konstante stellt den Anzeigenamen eines LCD 16x2 Bricklet dar.