MATLAB/Octave - RS232 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback (MATLAB)

Download (matlab_example_loopback.m)

 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
function matlab_example_loopback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRS232;
    import java.lang.String;

    % 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

    ipcon = IPConnection(); % Create IP connection
    rs232 = handle(BrickletRS232(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register read callback to function cb_read
    set(rs232, 'ReadCallback', @(h, e) cb_read(e));

    % Enable read callback
    rs232.enableReadCallback();

    % Write "test" string
    rs232.write(string_to_char_array(String('test')), 4);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for read callback
function cb_read(e)
    fprintf('Message (Length: %g): %s\n', e.length, e.message);
end

% Convert string to array of length 60 as needed by write
function char_array = string_to_char_array(message)
    import java.util.Arrays;
    char_array = Arrays.copyOf(message.toCharArray(), 60);
end

Loopback (Octave)

Download (octave_example_loopback.m)

 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
function octave_example_loopback()
    more off;

    % 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

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    rs232 = javaObject("com.tinkerforge.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 function cb_read
    rs232.addReadCallback(@cb_read);

    % Enable read callback
    rs232.enableReadCallback();

    % Write "test" string
    rs232.write(string2chars("test"), 4);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for read callback
function cb_read(e)
    message = java_invoke("java.util.Arrays", "copyOf", e.message, e.length);
    len = java2int(e.length)

    fprintf("Message (Length: %d): \"%s\"\n", len, chars2string(e.message, len));
end

% Convert string to array of length 60 as needed by write
function chars = string2chars(string)
    chars = javaArray("java.lang.String", 60);

    for i = 1:length(string)
        chars(i) = substr(string, i, 1);
    end

    for i = length(string)+1:60
        chars(i) = "x";
    end
end

% Assume that the message consists of ASCII characters and
% convert it from an array of chars to a string
function string = chars2string(chars, len)
    string = "";

    for i = 1:len
        string = strcat(string, chars(i));
    end
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine 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.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletRS232(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • rs232 – Typ: BrickletRS232

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

In MATLAB:

import com.tinkerforge.BrickletRS232;

rs232 = BrickletRS232("YOUR_DEVICE_UID", ipcon);

In Octave:

rs232 = java_new("com.tinkerforge.BrickletRS232", "YOUR_DEVICE_UID", ipcon);

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

short BrickletRS232.write(char[] message, short length)
Parameter:
  • message – Typ: char[], Länge: 60
  • length – Typ: short, Wertebereich: [0 bis 255]
Rückgabe:
  • written – Typ: short, Wertebereich: [0 bis 255]

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 BrickletRS232.read()
Rückgabeobjekt:
  • message – Typ: char[], Länge: 60
  • length – Typ: short, Wertebereich: [0 bis 255]

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.

void BrickletRS232.setConfiguration(short baudrate, short parity, short stopbits, short wordlength, short hardwareFlowcontrol, short softwareFlowcontrol)
Parameter:
  • baudrate – Typ: short, Wertebereich: Siehe Konstanten
  • parity – Typ: short, Wertebereich: Siehe Konstanten
  • stopbits – Typ: short, Wertebereich: Siehe Konstanten
  • wordlength – Typ: short, Wertebereich: Siehe Konstanten
  • hardwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten
  • softwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten

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:

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
BrickletRS232.Configuration BrickletRS232.getConfiguration()
Rückgabeobjekt:
  • baudrate – Typ: short, Wertebereich: Siehe Konstanten
  • parity – Typ: short, Wertebereich: Siehe Konstanten
  • stopbits – Typ: short, Wertebereich: Siehe Konstanten
  • wordlength – Typ: short, Wertebereich: Siehe Konstanten
  • hardwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten
  • softwareFlowcontrol – Typ: short, Wertebereich: Siehe Konstanten

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
void BrickletRS232.setBreakCondition(int breakTime)
Parameter:
  • breakTime – Typ: int, 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 (in ms).

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

short[] BrickletRS232.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]

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.

boolean BrickletRS232.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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
void BrickletRS232.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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
void BrickletRS232.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

BrickletRS232.Identity BrickletRS232.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, 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 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

void BrickletRS232.enableReadCallback()

Aktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

void BrickletRS232.disableReadCallback()

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

boolean BrickletRS232.isReadCallbackEnabled()
Rückgabe:
  • enabled – Typ: 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletRS232.ReadCallback
Event-Objekt:
  • message – Typ: char[], Länge: 60
  • length – Typ: short, Wertebereich: [0 bis 255]

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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addReadCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeReadCallback() wieder entfernt werden.

callback BrickletRS232.ErrorCallback
Event-Objekt:
  • error – Typ: short, 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 (Plugin).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addErrorCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeErrorCallback() wieder entfernt werden.

Konstanten

int 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.

String BrickletRS232.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.