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)
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 | Imports System
Imports Tinkerforge
Module ExampleHelloWorld
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 20x4 Bricklet
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim lcd As New BrickletLCD20x4(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Turn backlight on
lcd.BacklightOn()
' Write "Hello World"
lcd.WriteLine(0, 0, "Hello World")
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
Download (ExampleButtonCallback.vb)
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 29 30 31 32 33 34 35 36 | Imports System
Imports Tinkerforge
Module ExampleButtonCallback
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 20x4 Bricklet
' Callback subroutine for button pressed callback
Sub ButtonPressedCB(ByVal sender As BrickletLCD20x4, ByVal button As Byte)
Console.WriteLine("Button Pressed: " + button.ToString())
End Sub
' Callback subroutine for button released callback
Sub ButtonReleasedCB(ByVal sender As BrickletLCD20x4, ByVal button As Byte)
Console.WriteLine("Button Released: " + button.ToString())
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim lcd As New BrickletLCD20x4(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Register button pressed callback to subroutine ButtonPressedCB
AddHandler lcd.ButtonPressedCallback, AddressOf ButtonPressedCB
' Register button released callback to subroutine ButtonReleasedCB
AddHandler lcd.ButtonReleasedCallback, AddressOf ButtonReleasedCB
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | Imports System
Imports Tinkerforge
Module ExampleUnicode
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your LCD 20x4 Bricklet
' Maps a normal UTF-16 encoded string to the LCD charset
Function UTF16ToKS0066U(ByVal utf16 As String) As String
Dim ks0066u As String = ""
Dim c As Char
Dim i As Integer = 0
While i < utf16.Length
Dim codePoint As Integer = Char.ConvertToUtf32(utf16, i)
if Char.IsSurrogate(utf16, i) Then
' Skip low surrogate
i += 1
End If
' ASCII subset from JIS X 0201
if (codePoint >= &H0020) And (codePoint <= &H007e) Then
' The LCD charset doesn't include '\' and '~', use similar characters instead
Select Case codePoint
Case &H005c
c = Chr(&H00a4) ' REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
Case &H007e
c = Chr(&H002d) ' TILDE maps to HYPHEN-MINUS
Case Else
c = Chr(codePoint)
End Select
' Katakana subset from JIS X 0201
Else If (codePoint >= &Hff61) And (codePoint <= &Hff9f) Then
c = Chr(codePoint - &Hfec0)
' Special characters
Else
Select Case codePoint
Case &H00a5
c = Chr(&H5c) ' YEN SIGN
Case &H2192
c = Chr(&H7e) ' RIGHTWARDS ARROW
Case &H2190
c = Chr(&H7f) ' LEFTWARDS ARROW
Case &H00b0
c = Chr(&Hdf) ' DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
Case &H03b1
c = Chr(&He0) ' GREEK SMALL LETTER ALPHA
Case &H00c4
c = Chr(&He1) ' LATIN CAPITAL LETTER A WITH DIAERESIS
Case &H00e4
c = Chr(&He1) ' LATIN SMALL LETTER A WITH DIAERESIS
Case &H00df
c = Chr(&He2) ' LATIN SMALL LETTER SHARP S
Case &H03b5
c = Chr(&He3) ' GREEK SMALL LETTER EPSILON
Case &H00b5
c = Chr(&He4) ' MICRO SIGN
Case &H03bc
c = Chr(&He4) ' GREEK SMALL LETTER MU
Case &H03c2
c = Chr(&He5) ' GREEK SMALL LETTER FINAL SIGMA
Case &H03c1
c = Chr(&He6) ' GREEK SMALL LETTER RHO
Case &H221a
c = Chr(&He8) ' SQUARE ROOT
Case &H00b9
c = Chr(&He9) ' SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
Case &H00a4
c = Chr(&Heb) ' CURRENCY SIGN
Case &H00a2
c = Chr(&Hec) ' CENT SIGN
Case &H2c60
c = Chr(&Hed) ' LATIN CAPITAL LETTER L WITH DOUBLE BAR
Case &H00f1
c = Chr(&Hee) ' LATIN SMALL LETTER N WITH TILDE
Case &H00d6
c = Chr(&Hef) ' LATIN CAPITAL LETTER O WITH DIAERESIS
Case &H00f6
c = Chr(&Hef) ' LATIN SMALL LETTER O WITH DIAERESIS
Case &H03f4
c = Chr(&Hf2) ' GREEK CAPITAL THETA SYMBOL
Case &H221e
c = Chr(&Hf3) ' INFINITY
Case &H03a9
c = Chr(&Hf4) ' GREEK CAPITAL LETTER OMEGA
Case &H00dc
c = Chr(&Hf5) ' LATIN CAPITAL LETTER U WITH DIAERESIS
Case &H00fc
c = Chr(&Hf5) ' LATIN SMALL LETTER U WITH DIAERESIS
Case &H03a3
c = Chr(&Hf6) ' GREEK CAPITAL LETTER SIGMA
Case &H03c0
c = Chr(&Hf7) ' GREEK SMALL LETTER PI
Case &H0304
c = Chr(&Hf8) ' COMBINING MACRON
Case &H00f7
c = Chr(&Hfd) ' DIVISION SIGN
Case &H25a0
c = Chr(&Hff) ' BLACK SQUARE
Case Else
c = Chr(&Hff) ' BLACK SQUARE
End Select
End If
' Special handling for 'x' followed by COMBINING MACRON
If c = Chr(&Hf8) Then
If Not ks0066u.EndsWith("x") Then
c = Chr(&Hff) ' BLACK SQUARE
End If
If ks0066u.Length > 0 Then
ks0066u = ks0066u.Remove(ks0066u.Length - 1, 1)
End If
End If
ks0066u += c
i += 1
End While
Return ks0066u
End Function
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim lcd As New BrickletLCD20x4(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Turn backlight on
lcd.BacklightOn()
' Write some strings using the UTF16ToKS0066U function to map to the LCD charset
lcd.WriteLine(0, 0, UTF16ToKS0066U("Stromstärke: 17µA"))
lcd.WriteLine(1, 0, UTF16ToKS0066U("Temperatur: 23°C"))
' Write a string directly including characters from the LCD charset
lcd.WriteLine(2, 0, "Drehzahl: 750min" + Chr(&He9))
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End 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.
BrickletLCD20x4
(ByVal uid As String, ByVal ipcon As IPConnection)¶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.
BrickletLCD20x4.
WriteLine
(ByVal line As Byte, ByVal position As Byte, ByVal text As String)¶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.
BrickletLCD20x4.
ClearDisplay
()¶Löscht alle Zeichen auf dem Display.
BrickletLCD20x4.
BacklightOn
()¶Aktiviert die Hintergrundbeleuchtung.
BrickletLCD20x4.
BacklightOff
()¶Deaktiviert die Hintergrundbeleuchtung.
BrickletLCD20x4.
IsBacklightOn
() As Boolean¶Rückgabe: |
|
---|
Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.
BrickletLCD20x4.
SetConfig
(ByVal cursor As Boolean, ByVal blinking As Boolean)¶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.
BrickletLCD20x4.
GetConfig
(ByRef cursor As Boolean, ByRef blinking As Boolean)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfig()
gesetzt.
BrickletLCD20x4.
IsButtonPressed
(ByVal button As Byte) As Boolean¶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.
BrickletLCD20x4.
SetCustomCharacter
(ByVal index As Byte, ByVal character() As Byte)¶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.
Neu in Version 2.0.1 (Plugin).
BrickletLCD20x4.
GetCustomCharacter
(ByVal index As Byte) As Byte()¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den benutzerdefinierten Buchstaben für den gegebenen
Index zurück, wie von SetCustomCharacter()
gesetzt.
Neu in Version 2.0.1 (Plugin).
BrickletLCD20x4.
SetDefaultText
(ByVal line As Byte, ByVal text As String)¶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()
.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
GetDefaultText
(ByVal line As Byte) As String¶Parameter: |
|
---|---|
Rückgabe: |
|
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
(ByVal counter As Integer)¶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.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
GetDefaultTextCounter
() As Integer¶Rückgabe: |
|
---|
Gibt den aktuellen Wert des Standard-Text-Zählers zurück.
Neu in Version 2.0.2 (Plugin).
BrickletLCD20x4.
GetIdentity
(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶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.
BrickletLCD20x4.
ButtonPressedCallback
(ByVal sender As BrickletLCD20x4, ByVal button As Byte)¶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).
BrickletLCD20x4.
ButtonReleasedCallback
(ByVal sender As BrickletLCD20x4, ByVal button As Byte)¶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.
BrickletLCD20x4.
GetAPIVersion
() As Byte()¶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.
BrickletLCD20x4.
GetResponseExpected
(ByVal functionId As Byte) As Boolean¶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.
SetResponseExpected
(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶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.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.