Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleHelloWorld.vb)
1Imports System
2Imports Tinkerforge
3
4Module ExampleHelloWorld
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 20x4 Bricklet
8
9 Sub Main()
10 Dim ipcon As New IPConnection() ' Create IP connection
11 Dim lcd As New BrickletLCD20x4(UID, ipcon) ' Create device object
12
13 ipcon.Connect(HOST, PORT) ' Connect to brickd
14 ' Don't use device before ipcon is connected
15
16 ' Turn backlight on
17 lcd.BacklightOn()
18
19 ' Write "Hello World"
20 lcd.WriteLine(0, 0, "Hello World")
21
22 Console.WriteLine("Press key to exit")
23 Console.ReadLine()
24 ipcon.Disconnect()
25 End Sub
26End Module
1Imports System
2Imports Tinkerforge
3
4Module ExampleUnicode
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 20x4 Bricklet
8
9 ' Maps a normal UTF-16 encoded string to the LCD charset
10 Function UTF16ToKS0066U(ByVal utf16 As String) As String
11 Dim ks0066u As String = ""
12 Dim c As Char
13 Dim i As Integer = 0
14
15 While i < utf16.Length
16 Dim codePoint As Integer = Char.ConvertToUtf32(utf16, i)
17
18 if Char.IsSurrogate(utf16, i) Then
19 ' Skip low surrogate
20 i += 1
21 End If
22
23 ' ASCII subset from JIS X 0201
24 if (codePoint >= &H0020) And (codePoint <= &H007e) Then
25 ' The LCD charset doesn't include '\' and '~', use similar characters instead
26 Select Case codePoint
27 Case &H005c
28 c = Chr(&H00a4) ' REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
29 Case &H007e
30 c = Chr(&H002d) ' TILDE maps to HYPHEN-MINUS
31 Case Else
32 c = Chr(codePoint)
33 End Select
34 ' Katakana subset from JIS X 0201
35 Else If (codePoint >= &Hff61) And (codePoint <= &Hff9f) Then
36 c = Chr(codePoint - &Hfec0)
37 ' Special characters
38 Else
39 Select Case codePoint
40 Case &H00a5
41 c = Chr(&H5c) ' YEN SIGN
42 Case &H2192
43 c = Chr(&H7e) ' RIGHTWARDS ARROW
44 Case &H2190
45 c = Chr(&H7f) ' LEFTWARDS ARROW
46 Case &H00b0
47 c = Chr(&Hdf) ' DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
48 Case &H03b1
49 c = Chr(&He0) ' GREEK SMALL LETTER ALPHA
50 Case &H00c4
51 c = Chr(&He1) ' LATIN CAPITAL LETTER A WITH DIAERESIS
52 Case &H00e4
53 c = Chr(&He1) ' LATIN SMALL LETTER A WITH DIAERESIS
54 Case &H00df
55 c = Chr(&He2) ' LATIN SMALL LETTER SHARP S
56 Case &H03b5
57 c = Chr(&He3) ' GREEK SMALL LETTER EPSILON
58 Case &H00b5
59 c = Chr(&He4) ' MICRO SIGN
60 Case &H03bc
61 c = Chr(&He4) ' GREEK SMALL LETTER MU
62 Case &H03c2
63 c = Chr(&He5) ' GREEK SMALL LETTER FINAL SIGMA
64 Case &H03c1
65 c = Chr(&He6) ' GREEK SMALL LETTER RHO
66 Case &H221a
67 c = Chr(&He8) ' SQUARE ROOT
68 Case &H00b9
69 c = Chr(&He9) ' SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
70 Case &H00a4
71 c = Chr(&Heb) ' CURRENCY SIGN
72 Case &H00a2
73 c = Chr(&Hec) ' CENT SIGN
74 Case &H2c60
75 c = Chr(&Hed) ' LATIN CAPITAL LETTER L WITH DOUBLE BAR
76 Case &H00f1
77 c = Chr(&Hee) ' LATIN SMALL LETTER N WITH TILDE
78 Case &H00d6
79 c = Chr(&Hef) ' LATIN CAPITAL LETTER O WITH DIAERESIS
80 Case &H00f6
81 c = Chr(&Hef) ' LATIN SMALL LETTER O WITH DIAERESIS
82 Case &H03f4
83 c = Chr(&Hf2) ' GREEK CAPITAL THETA SYMBOL
84 Case &H221e
85 c = Chr(&Hf3) ' INFINITY
86 Case &H03a9
87 c = Chr(&Hf4) ' GREEK CAPITAL LETTER OMEGA
88 Case &H00dc
89 c = Chr(&Hf5) ' LATIN CAPITAL LETTER U WITH DIAERESIS
90 Case &H00fc
91 c = Chr(&Hf5) ' LATIN SMALL LETTER U WITH DIAERESIS
92 Case &H03a3
93 c = Chr(&Hf6) ' GREEK CAPITAL LETTER SIGMA
94 Case &H03c0
95 c = Chr(&Hf7) ' GREEK SMALL LETTER PI
96 Case &H0304
97 c = Chr(&Hf8) ' COMBINING MACRON
98 Case &H00f7
99 c = Chr(&Hfd) ' DIVISION SIGN
100 Case &H25a0
101 c = Chr(&Hff) ' BLACK SQUARE
102 Case Else
103 c = Chr(&Hff) ' BLACK SQUARE
104 End Select
105 End If
106
107 ' Special handling for 'x' followed by COMBINING MACRON
108 If c = Chr(&Hf8) Then
109 If Not ks0066u.EndsWith("x") Then
110 c = Chr(&Hff) ' BLACK SQUARE
111 End If
112
113 If ks0066u.Length > 0 Then
114 ks0066u = ks0066u.Remove(ks0066u.Length - 1, 1)
115 End If
116 End If
117
118 ks0066u += c
119 i += 1
120 End While
121
122 Return ks0066u
123 End Function
124
125 Sub Main()
126 Dim ipcon As New IPConnection() ' Create IP connection
127 Dim lcd As New BrickletLCD20x4(UID, ipcon) ' Create device object
128
129 ipcon.Connect(HOST, PORT) ' Connect to brickd
130 ' Don't use device before ipcon is connected
131
132 ' Turn backlight on
133 lcd.BacklightOn()
134
135 ' Write some strings using the UTF16ToKS0066U function to map to the LCD charset
136 lcd.WriteLine(0, 0, UTF16ToKS0066U("Stromstärke: 17µA"))
137 lcd.WriteLine(1, 0, UTF16ToKS0066U("Temperatur: 23°C"))
138
139 ' Write a string directly including characters from the LCD charset
140 lcd.WriteLine(2, 0, "Drehzahl: 750min" + Chr(&He9))
141
142 Console.WriteLine("Press key to exit")
143 Console.ReadLine()
144 ipcon.Disconnect()
145 End Sub
146End Module
Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das
ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.
Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
Dim lcd20x4 As New BrickletLCD20x4("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Parameter: |
|
|---|
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.
Löscht alle Zeichen auf dem Display.
Aktiviert die Hintergrundbeleuchtung.
Deaktiviert die Hintergrundbeleuchtung.
| Rückgabe: |
|
|---|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
| Parameter: |
|
|---|
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.
| Ausgabeparameter: |
|
|---|
Gibt die Konfiguration zurück, wie von SetConfig() gesetzt.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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.
| Parameter: |
|
|---|
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" 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.
Added in version 2.0.1$nbsp;(Plugin).
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von SetCustomCharacter() gesetzt.
Added in version 2.0.1$nbsp;(Plugin).
| Parameter: |
|
|---|
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().
Added in version 2.0.2$nbsp;(Plugin).
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Gibt den Standard-Text für die Zeilen 0-3 zurück, wie von
SetDefaultText() gesetzt.
Added in version 2.0.2$nbsp;(Plugin).
| Parameter: |
|
|---|
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 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.
Added in version 2.0.2$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Added in version 2.0.2$nbsp;(Plugin).
| Ausgabeparameter: |
|
|---|
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 können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:
Sub MyCallback(ByVal sender As BrickletLCD20x4, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler lcd20x4.ExampleCallback, AddressOf MyCallback
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.
| Callback-Parameter: |
|
|---|
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).
| Callback-Parameter: |
|
|---|
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).
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.
| Ausgabeparameter: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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:
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
| Parameter: |
|
|---|
Ä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:
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
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
Diese Konstante stellt den Anzeigenamen eines LCD 20x4 Bricklet dar.