Mathematica - RS232 Bricklet

Dies ist die Beschreibung der Mathematica 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 Mathematica API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

(*For this example connect the RX1 and TX pin to receive the send message*)

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your RS232 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rs232=NETNew["Tinkerforge.BrickletRS232",uid,ipcon]
ipcon@Connect[host,port]

(*Convert string to char array with length 60,as needed by write*)
StringToCharList[message_]:=PadRight[ToCharacterCode[message],60,0]

(*Assume that the message consists of ASCII characters and*)
(*convert it from an array of chars to a string*)
CharListToString[message_,length_]:=StringTake[FromCharacterCode[message],length]

(*Callback function for read callback *)
ReadCB[sender_,message_,length_]:=
 Print["Message (Length: "<>ToString[N[length]]<>"): "<>
       CharListToString[message,length]]
AddEventHandler[rs232@ReadCallback,ReadCB]

(*Enable read callback*)
rs232@EnableReadCallback[]

(*Write "test" string*)
message:="test"
(*FIXME: This call crashes Mono with a SIGSEGV, no clue why*)
rs232@Write[StringToCharList[message],StringLength[message]]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rs232]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletRS232[uid, ipcon] → rs232
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • rs232 -- NETObject[BrickletRS232]

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

rs232=NETNew["Tinkerforge.BrickletRS232","YOUR_DEVICE_UID",ipcon]

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

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletRS232@Write[{message1, message2, ..., message60}, length] → written
Parameter:
  • messagei -- Integer
  • length -- Integer
Rückgabe:
  • written -- Integer

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.

BrickletRS232@Read[out {message1, message2, ..., message60}, out length] → Null
Parameter:
  • messagei -- Integer
  • length -- Integer

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.

BrickletRS232@SetConfiguration[baudrate, parity, stopbits, wordlength, hardwareFlowcontrol, softwareFlowcontrol] → Null
Parameter:
  • baudrate -- Integer
  • parity -- Integer
  • stopbits -- Integer
  • wordlength -- Integer
  • hardwareFlowcontrol -- Integer
  • softwareFlowcontrol -- Integer

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`BAUDRATEU300 = 0
  • BrickletRS232`BAUDRATEU600 = 1
  • BrickletRS232`BAUDRATEU1200 = 2
  • BrickletRS232`BAUDRATEU2400 = 3
  • BrickletRS232`BAUDRATEU4800 = 4
  • BrickletRS232`BAUDRATEU9600 = 5
  • BrickletRS232`BAUDRATEU14400 = 6
  • BrickletRS232`BAUDRATEU19200 = 7
  • BrickletRS232`BAUDRATEU28800 = 8
  • BrickletRS232`BAUDRATEU38400 = 9
  • BrickletRS232`BAUDRATEU57600 = 10
  • BrickletRS232`BAUDRATEU115200 = 11
  • BrickletRS232`BAUDRATEU230400 = 12
  • BrickletRS232`PARITYUNONE = 0
  • BrickletRS232`PARITYUODD = 1
  • BrickletRS232`PARITYUEVEN = 2
  • BrickletRS232`PARITYUFORCEDUPARITYU1 = 3
  • BrickletRS232`PARITYUFORCEDUPARITYU0 = 4
  • BrickletRS232`STOPBITSU1 = 1
  • BrickletRS232`STOPBITSU2 = 2
  • BrickletRS232`WORDLENGTHU5 = 5
  • BrickletRS232`WORDLENGTHU6 = 6
  • BrickletRS232`WORDLENGTHU7 = 7
  • BrickletRS232`WORDLENGTHU8 = 8
  • BrickletRS232`HARDWAREUFLOWCONTROLUOFF = 0
  • BrickletRS232`HARDWAREUFLOWCONTROLUON = 1
  • BrickletRS232`SOFTWAREUFLOWCONTROLUOFF = 0
  • BrickletRS232`SOFTWAREUFLOWCONTROLUON = 1
BrickletRS232@GetConfiguration[out baudrate, out parity, out stopbits, out wordlength, out hardwareFlowcontrol, out softwareFlowcontrol] → Null
Parameter:
  • baudrate -- Integer
  • parity -- Integer
  • stopbits -- Integer
  • wordlength -- Integer
  • hardwareFlowcontrol -- Integer
  • softwareFlowcontrol -- Integer

Gibt die Konfiguration zurück, wie von SetConfiguration[] gesetzt.

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

  • BrickletRS232`BAUDRATEU300 = 0
  • BrickletRS232`BAUDRATEU600 = 1
  • BrickletRS232`BAUDRATEU1200 = 2
  • BrickletRS232`BAUDRATEU2400 = 3
  • BrickletRS232`BAUDRATEU4800 = 4
  • BrickletRS232`BAUDRATEU9600 = 5
  • BrickletRS232`BAUDRATEU14400 = 6
  • BrickletRS232`BAUDRATEU19200 = 7
  • BrickletRS232`BAUDRATEU28800 = 8
  • BrickletRS232`BAUDRATEU38400 = 9
  • BrickletRS232`BAUDRATEU57600 = 10
  • BrickletRS232`BAUDRATEU115200 = 11
  • BrickletRS232`BAUDRATEU230400 = 12
  • BrickletRS232`PARITYUNONE = 0
  • BrickletRS232`PARITYUODD = 1
  • BrickletRS232`PARITYUEVEN = 2
  • BrickletRS232`PARITYUFORCEDUPARITYU1 = 3
  • BrickletRS232`PARITYUFORCEDUPARITYU0 = 4
  • BrickletRS232`STOPBITSU1 = 1
  • BrickletRS232`STOPBITSU2 = 2
  • BrickletRS232`WORDLENGTHU5 = 5
  • BrickletRS232`WORDLENGTHU6 = 6
  • BrickletRS232`WORDLENGTHU7 = 7
  • BrickletRS232`WORDLENGTHU8 = 8
  • BrickletRS232`HARDWAREUFLOWCONTROLUOFF = 0
  • BrickletRS232`HARDWAREUFLOWCONTROLUON = 1
  • BrickletRS232`SOFTWAREUFLOWCONTROLUOFF = 0
  • BrickletRS232`SOFTWAREUFLOWCONTROLUON = 1
BrickletRS232@SetBreakCondition[breakTime] → Null
Parameter:
  • breakTime -- 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

BrickletRS232@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

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.

BrickletRS232@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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.

Siehe SetResponseExpected[] für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletRS232@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletRS232`FUNCTIONUENABLEUREADUCALLBACK = 3
  • BrickletRS232`FUNCTIONUDISABLEUREADUCALLBACK = 4
  • BrickletRS232`FUNCTIONUSETUCONFIGURATION = 6
  • BrickletRS232`FUNCTIONUSETUBREAKUCONDITION = 10
BrickletRS232@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickletRS232@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- 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

BrickletRS232@EnableReadCallback[] → Null

Aktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232@DisableReadCallback[] → Null

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

BrickletRS232@IsReadCallbackEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

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 Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[rs232@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

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[sender, {message1, message2, ..., message60}, length]
Parameter:
  • sender -- NETObject[BrickletRS232]
  • messagei -- Integer
  • length -- Integer

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[sender, error]
Parameter:
  • sender -- NETObject[BrickletRS232]
  • error -- Integer

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`ERRORUOVERRUN = 1
  • BrickletRS232`ERRORUPARITY = 2
  • BrickletRS232`ERRORUFRAMING = 4

Neu in Version 2.0.1 (Plugin).

Konstanten

BrickletRS232`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um ein RS232 Bricklet zu identifizieren.

Die GetIdentity[] Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRS232`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.