Visual Basic .NET - RS232 Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das RS232 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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

    ' Convert message to array of length 60 as needed by write
    Function StringToCharArray(ByVal message As String) As Char()
        Dim chars As Char() = message.ToCharArray()
        ReDim Preserve chars(60)
        Return chars
    End Function

    ' Assume that the message consists of ASCII characters and
    ' convert it from an array of chars to a string
    Function CharArrayToString(ByVal message As Char(), ByVal length As Byte) As String
        Return new String(message, 0, length)
    End Function

    ' Callback subroutine for read callback
    Sub ReadCB(ByVal sender As BrickletRS232, ByVal message As Char(), _
               ByVal length As Byte)
        Dim ascii as String = CharArrayToString(message, length)
        Console.WriteLine("Message (Length: {0}): ""{1}""", length, ascii)
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim rs232 As New BrickletRS232(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(StringToCharArray("test"), 4)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

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.

Grundfunktionen

Class BrickletRS232(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim rs232 As New BrickletRS232("YOUR_DEVICE_UID", ipcon)

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

Function BrickletRS232.Write(ByVal message() As Char, ByVal length As Byte) As Byte

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

Siehe SetConfiguration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

Sub BrickletRS232.Read(ByRef message() As Char, ByRef length As Byte)

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe EnableReadCallback() und ReadCallback Callback.

Sub BrickletRS232.SetConfiguration(ByVal baudrate As Byte, ByVal parity As Byte, ByVal stopbits As Byte, ByVal wordlength As Byte, ByVal hardwareFlowcontrol As Byte, ByVal softwareFlowcontrol As Byte)

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 300 und 230400 Baud.
  • Parität von None, Odd, Even und Forced Parity.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Hard-/Software Flow Control aus.

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

  • BrickletRS232.BAUDRATE_300 = 0
  • BrickletRS232.BAUDRATE_600 = 1
  • BrickletRS232.BAUDRATE_1200 = 2
  • BrickletRS232.BAUDRATE_2400 = 3
  • BrickletRS232.BAUDRATE_4800 = 4
  • BrickletRS232.BAUDRATE_9600 = 5
  • BrickletRS232.BAUDRATE_14400 = 6
  • BrickletRS232.BAUDRATE_19200 = 7
  • BrickletRS232.BAUDRATE_28800 = 8
  • BrickletRS232.BAUDRATE_38400 = 9
  • BrickletRS232.BAUDRATE_57600 = 10
  • BrickletRS232.BAUDRATE_115200 = 11
  • BrickletRS232.BAUDRATE_230400 = 12
  • BrickletRS232.PARITY_NONE = 0
  • BrickletRS232.PARITY_ODD = 1
  • BrickletRS232.PARITY_EVEN = 2
  • BrickletRS232.PARITY_FORCED_PARITY_1 = 3
  • BrickletRS232.PARITY_FORCED_PARITY_0 = 4
  • BrickletRS232.STOPBITS_1 = 1
  • BrickletRS232.STOPBITS_2 = 2
  • BrickletRS232.WORDLENGTH_5 = 5
  • BrickletRS232.WORDLENGTH_6 = 6
  • BrickletRS232.WORDLENGTH_7 = 7
  • BrickletRS232.WORDLENGTH_8 = 8
  • BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1
  • BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1
Sub BrickletRS232.GetConfiguration(ByRef baudrate As Byte, ByRef parity As Byte, ByRef stopbits As Byte, ByRef wordlength As Byte, ByRef hardwareFlowcontrol As Byte, ByRef softwareFlowcontrol As Byte)

Gibt die Konfiguration zurück, wie von SetConfiguration() gesetzt.

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

  • BrickletRS232.BAUDRATE_300 = 0
  • BrickletRS232.BAUDRATE_600 = 1
  • BrickletRS232.BAUDRATE_1200 = 2
  • BrickletRS232.BAUDRATE_2400 = 3
  • BrickletRS232.BAUDRATE_4800 = 4
  • BrickletRS232.BAUDRATE_9600 = 5
  • BrickletRS232.BAUDRATE_14400 = 6
  • BrickletRS232.BAUDRATE_19200 = 7
  • BrickletRS232.BAUDRATE_28800 = 8
  • BrickletRS232.BAUDRATE_38400 = 9
  • BrickletRS232.BAUDRATE_57600 = 10
  • BrickletRS232.BAUDRATE_115200 = 11
  • BrickletRS232.BAUDRATE_230400 = 12
  • BrickletRS232.PARITY_NONE = 0
  • BrickletRS232.PARITY_ODD = 1
  • BrickletRS232.PARITY_EVEN = 2
  • BrickletRS232.PARITY_FORCED_PARITY_1 = 3
  • BrickletRS232.PARITY_FORCED_PARITY_0 = 4
  • BrickletRS232.STOPBITS_1 = 1
  • BrickletRS232.STOPBITS_2 = 2
  • BrickletRS232.WORDLENGTH_5 = 5
  • BrickletRS232.WORDLENGTH_6 = 6
  • BrickletRS232.WORDLENGTH_7 = 7
  • BrickletRS232.WORDLENGTH_8 = 8
  • BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1
  • BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
  • BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1
Sub BrickletRS232.SetBreakCondition(ByVal breakTime As Integer)

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition (in ms).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

Function BrickletRS232.GetAPIVersion() As Byte()

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.

Function BrickletRS232.GetResponseExpected(ByVal functionId As Byte) As Boolean

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:

  • BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
Sub BrickletRS232.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

Ä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:

  • BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
  • BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
Sub BrickletRS232.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletRS232.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)

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.

Konfigurationsfunktionen für Callbacks

Sub BrickletRS232.EnableReadCallback()

Aktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

Sub BrickletRS232.DisableReadCallback()

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

Function BrickletRS232.IsReadCallbackEnabled() As Boolean

Gibt true zurück falls ReadCallback Callback aktiviert ist, false sonst.

Callbacks

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 BrickletRS232, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler rs232.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.

Event BrickletRS232.ReadCallback(ByVal sender As BrickletRS232, ByVal message() As Char, ByVal length As Byte)

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch EnableReadCallback() aktiviert werden.

Event BrickletRS232.ErrorCallback(ByVal sender As BrickletRS232, ByVal error As Byte)

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

  • BrickletRS232.ERROR_OVERRUN = 1
  • BrickletRS232.ERROR_PARITY = 2
  • BrickletRS232.ERROR_FRAMING = 4

Neu in Version 2.0.1 (Plugin).

Konstanten

Const BrickletRS232.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS232 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.

Const BrickletRS232.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.