Visual Basic .NET - RS232 Bricklet¶

Loopback¶

Download (ExampleLoopback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4' For this example connect the RX1 and TX pin to receive the send message
 5
 6Module ExampleLoopback
 7    Const HOST As String = "localhost"
 8    Const PORT As Integer = 4223
 9    Const UID As String = "XYZ" ' Change XYZ to the UID of your RS232 Bricklet
10
11    ' Convert message to array of length 60 as needed by write
12    Function StringToCharArray(ByVal message As String) As Char()
13        Dim chars As Char() = message.ToCharArray()
14        ReDim Preserve chars(60)
15        Return chars
16    End Function
17
18    ' Assume that the message consists of ASCII characters and
19    ' convert it from an array of chars to a string
20    Function CharArrayToString(ByVal message As Char(), ByVal length As Byte) As String
21        Return new String(message, 0, length)
22    End Function
23
24    ' Callback subroutine for read callback
25    Sub ReadCB(ByVal sender As BrickletRS232, ByVal message As Char(), _
26               ByVal length As Byte)
27        Dim ascii as String = CharArrayToString(message, length)
28        Console.WriteLine("Message (Length: {0}): ""{1}""", length, ascii)
29    End Sub
30
31    Sub Main()
32        Dim ipcon As New IPConnection() ' Create IP connection
33        Dim rs232 As New BrickletRS232(UID, ipcon) ' Create device object
34
35        ipcon.Connect(HOST, PORT) ' Connect to brickd
36        ' Don't use device before ipcon is connected
37
38        ' Register read callback to subroutine ReadCB
39        AddHandler rs232.ReadCallback, AddressOf ReadCB
40
41        ' Enable read callback
42        rs232.EnableReadCallback()
43
44        ' Write "test" string
45        rs232.Write(StringToCharArray("test"), 4)
46
47        Console.WriteLine("Press key to exit")
48        Console.ReadLine()
49        ipcon.Disconnect()
50    End Sub
51End Module

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.

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

Parameter:	message – Typ: Char Array, Länge: 60 length – Typ: Byte, Wertebereich: [0 bis 60]
Rückgabe:	written – Typ: Byte, Wertebereich: [0 bis 60]

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)¶

Ausgabeparameter:	message – Typ: Char Array, Länge: 60 length – Typ: Byte, Wertebereich: [0 bis 60]

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die zurückgegebene Länge 0 ist, 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)¶

Parameter:

baudrate – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 11 parity – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 8 hardwareFlowcontrol – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 softwareFlowcontrol – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS232-Kommunikation.

Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

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

Für baudrate:

• 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

Für parity:

• BrickletRS232.PARITY_NONE = 0

• BrickletRS232.PARITY_ODD = 1

• BrickletRS232.PARITY_EVEN = 2

• BrickletRS232.PARITY_FORCED_PARITY_1 = 3

• BrickletRS232.PARITY_FORCED_PARITY_0 = 4

Für stopbits:

• BrickletRS232.STOPBITS_1 = 1

• BrickletRS232.STOPBITS_2 = 2

Für wordlength:

• BrickletRS232.WORDLENGTH_5 = 5

• BrickletRS232.WORDLENGTH_6 = 6

• BrickletRS232.WORDLENGTH_7 = 7

• BrickletRS232.WORDLENGTH_8 = 8

Für hardwareFlowcontrol:

• BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0

• BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1

Für softwareFlowcontrol:

• 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)¶

Ausgabeparameter:

baudrate – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 11 parity – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 8 hardwareFlowcontrol – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0 softwareFlowcontrol – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für baudrate:

• 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

Für parity:

• BrickletRS232.PARITY_NONE = 0

• BrickletRS232.PARITY_ODD = 1

• BrickletRS232.PARITY_EVEN = 2

• BrickletRS232.PARITY_FORCED_PARITY_1 = 3

• BrickletRS232.PARITY_FORCED_PARITY_0 = 4

Für stopbits:

• BrickletRS232.STOPBITS_1 = 1

• BrickletRS232.STOPBITS_2 = 2

Für wordlength:

• BrickletRS232.WORDLENGTH_5 = 5

• BrickletRS232.WORDLENGTH_6 = 6

• BrickletRS232.WORDLENGTH_7 = 7

• BrickletRS232.WORDLENGTH_8 = 8

Für hardwareFlowcontrol:

• BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0

• BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1

Für softwareFlowcontrol:

• BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0

• BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1

Sub BrickletRS232.SetBreakCondition(ByVal breakTime As Integer)¶

Parameter:	breakTime – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]

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

Neu in Version 2.0.2$nbsp;(Plugin).

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

Ausgabeparameter:	message – Typ: Char Array, Länge: 60 length – Typ: Byte, Wertebereich: [0 bis 60]

Gibt bis zu einem Frame an Daten aus dem Lesebuffer zurück. Die Größe eines Frames kann mit SetFrameReadableCallbackConfiguration() konfiguriert werden. Wenn die zurückgegebene Länge 0 ist, waren keine neuen Daten verfügbar.

Neu in Version 2.0.4$nbsp;(Plugin).

Fortgeschrittene Funktionen¶

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)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, 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.

Konfigurationsfunktionen für Callbacks¶

Sub BrickletRS232.EnableReadCallback()¶

Aktiviert den ReadCallback Callback. Dies deaktiviert den FrameReadableCallback 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¶

Rückgabe:	enabled – Typ: Boolean, Standardwert: false

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

Sub BrickletRS232.SetFrameReadableCallbackConfiguration(ByVal frameSize As Byte)¶

Parameter:	frameSize – Typ: Byte, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

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.4$nbsp;(Plugin).

Function BrickletRS232.GetFrameReadableCallbackConfiguration() As Byte¶

Rückgabe:	frameSize – Typ: Byte, Einheit: 1 B, Wertebereich: [0 bis 100], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels SetFrameReadableCallbackConfiguration() gesetzt.

Neu in Version 2.0.4$nbsp;(Plugin).

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.

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

Callback-Parameter:	sender – Typ: BrickletRS232 message – Typ: Char Array, Länge: 60 length – Typ: Byte, Wertebereich: [1 bis 60]

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)¶

Callback-Parameter:	sender – Typ: BrickletRS232 error – Typ: Byte, Wertebereich: Siehe Konstanten

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:

Für error:

• BrickletRS232.ERROR_OVERRUN = 1

• BrickletRS232.ERROR_PARITY = 2

• BrickletRS232.ERROR_FRAMING = 4

Neu in Version 2.0.1$nbsp;(Plugin).

Event BrickletRS232.FrameReadableCallback(ByVal sender As BrickletRS232, ByVal frameCount As Byte)¶

Callback-Parameter:	sender – Typ: BrickletRS232 frameCount – Typ: Byte, Wertebereich: [0 bis 255]

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() oder ReadFrame() 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 ReadFrame()-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.4$nbsp;(Plugin).

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.

Function BrickletRS232.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 3 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, 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.

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

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

Für functionId:

• BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3

• BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4

• BrickletRS232.FUNCTION_SET_CONFIGURATION = 6

• BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10

• BrickletRS232.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

Sub BrickletRS232.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: 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:

Für functionId:

• BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3

• BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4

• BrickletRS232.FUNCTION_SET_CONFIGURATION = 6

• BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10

• BrickletRS232.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

Sub BrickletRS232.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

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.