Dies ist die Beschreibung der Visual Basic .NET API Bindings für das RS232 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 2.0 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).
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 | Imports System
Imports Tinkerforge
' For this example connect the RX1 and TX pin to receive the send message
Module ExampleLoopback
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your RS232 Bricklet 2.0
' Callback subroutine for read callback
Sub ReadCB(ByVal sender As BrickletRS232V2, ByVal message As Char())
' Assume that the message consists of ASCII characters and convert it
' from an array of chars to a string
Console.WriteLine("Message: ""{0}""", new String(message))
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim rs232 As New BrickletRS232V2(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Register read callback to subroutine ReadCB
AddHandler rs232.ReadCallback, AddressOf ReadCB
' Enable read callback
rs232.EnableReadCallback()
' Write "test" string
rs232.Write("test".ToCharArray())
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.
BrickletRS232V2
(ByVal uid As String, ByVal ipcon As IPConnection)¶Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
Dim rs232V2 As New BrickletRS232V2("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletRS232V2.
Write
(ByVal message() As Char) As Integer¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.
Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.
Siehe SetConfiguration()
für Konfigurationsmöglichkeiten
bezüglich Baudrate, Parität usw.
BrickletRS232V2.
Read
(ByVal length As Integer) As Char()¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.
Anstatt mit dieser Funktion zu pollen, ist es auch möglich
Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn
der Read-Callback nicht aktiv ist.
Siehe EnableReadCallback()
und ReadCallback
Callback.
BrickletRS232V2.
SetConfiguration
(ByVal baudrate As Long, ByVal parity As Byte, ByVal stopbits As Byte, ByVal wordlength As Byte, ByVal flowcontrol As Byte)¶Parameter: |
|
---|
Setzt die Konfiguration für die RS232-Kommunikation.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für parity:
Für stopbits:
Für wordlength:
Für flowcontrol:
BrickletRS232V2.
GetConfiguration
(ByRef baudrate As Long, ByRef parity As Byte, ByRef stopbits As Byte, ByRef wordlength As Byte, ByRef flowcontrol As Byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für parity:
Für stopbits:
Für wordlength:
Für flowcontrol:
BrickletRS232V2.
SetBufferConfig
(ByVal sendBufferSize As Integer, ByVal receiveBufferSize As Integer)¶Parameter: |
|
---|
Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.
Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.
Der Sendebuffer hält die Daten welche über Write()
übergeben und noch
nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche
über RS232 empfangen wurden aber noch nicht über Read()
oder
ReadCallback
Callback an ein Nutzerprogramm übertragen werden konnten.
BrickletRS232V2.
GetBufferConfig
(ByRef sendBufferSize As Integer, ByRef receiveBufferSize As Integer)¶Ausgabeparameter: |
|
---|
Gibt die Buffer-Konfiguration zurück, wie von SetBufferConfig()
gesetzt.
BrickletRS232V2.
GetBufferStatus
(ByRef sendBufferUsed As Integer, ByRef receiveBufferUsed As Integer)¶Ausgabeparameter: |
|
---|
Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.
Siehe SetBufferConfig()
zur Konfiguration der Buffergrößen.
BrickletRS232V2.
GetErrorCount
(ByRef errorCountOverrun As Long, ByRef errorCountParity As Long)¶Ausgabeparameter: |
|
---|
Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.
BrickletRS232V2.
GetSPITFPErrorCount
(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶Ausgabeparameter: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletRS232V2.
SetStatusLEDConfig
(ByVal config As Byte)¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletRS232V2.
GetStatusLEDConfig
() As Byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletRS232V2.
GetChipTemperature
() As Short¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletRS232V2.
Reset
()¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletRS232V2.
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.
BrickletRS232V2.
EnableReadCallback
()¶Aktiviert den ReadCallback
Callback. Dies deaktiviert den FrameReadableCallback
Callback.
Im Startzustand ist der Callback deaktiviert.
BrickletRS232V2.
DisableReadCallback
()¶Deaktiviert den ReadCallback
Callback.
Im Startzustand ist der Callback deaktiviert.
BrickletRS232V2.
IsReadCallbackEnabled
() As Boolean¶Rückgabe: |
|
---|
Gibt true zurück falls ReadCallback
Callback aktiviert ist,
false sonst.
BrickletRS232V2.
SetFrameReadableCallbackConfiguration
(ByVal frameSize As Integer)¶Parameter: |
|
---|
Konfiguriert den FrameReadableCallback
Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst.
Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den ReadCallback
Callback.
Im Startzustand ist der Callback deaktiviert.
Neu in Version 2.0.3 (Plugin).
BrickletRS232V2.
GetFrameReadableCallbackConfiguration
() As Integer¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetFrameReadableCallbackConfiguration()
gesetzt.
Neu in Version 2.0.3 (Plugin).
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 BrickletRS232V2, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler rs232V2.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.
BrickletRS232V2.
ReadCallback
(ByVal sender As BrickletRS232V2, ByVal message() As Char)¶Callback-Parameter: |
|
---|
Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.
Dieser Callback kann durch EnableReadCallback()
aktiviert werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit Nothing für message ausgelöst.
BrickletRS232V2.
ErrorCountCallback
(ByVal sender As BrickletRS232V2, ByVal errorCountOverrun As Long, ByVal errorCountParity As Long)¶Callback-Parameter: |
|
---|
Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.
BrickletRS232V2.
FrameReadableCallback
(ByVal sender As BrickletRS232V2, ByVal frameCount As Integer)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit SetFrameReadableCallbackConfiguration()
konfiguriert werden.
Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen.
Der Callback wird nur einmal pro Read()
Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal
wenn das Callback ausgelöst wird, X Bytes mit der Read()
-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.
Neu in Version 2.0.3 (Plugin).
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.
BrickletRS232V2.
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.
BrickletRS232V2.
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:
BrickletRS232V2.
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:
BrickletRS232V2.
SetResponseExpectedAll
(ByVal responseExpected As Boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletRS232V2.
SetBootloaderMode
(ByVal mode As Byte) As Byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletRS232V2.
GetBootloaderMode
() As Byte¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletRS232V2.
SetWriteFirmwarePointer
(ByVal pointer As Long)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für WriteFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletRS232V2.
WriteFirmware
(ByVal data() As Byte) As Byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletRS232V2.
WriteUID
(ByVal uid As Long)¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletRS232V2.
ReadUID
() As Long¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletRS232V2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 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.
BrickletRS232V2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.