MATLAB/Octave - RS232 Bricklet 2.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

function matlab_example_loopback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRS232V2;
    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 2.0

    ipcon = IPConnection(); % Create IP connection
    rs232 = handle(BrickletRS232V2(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('test').toCharArray());

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

% Callback function for read callback
function cb_read(e)
    fprintf('Message: %s\n', e.message);
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

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 2.0

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

    % Enable read callback
    rs232.enableReadCallback();

    % Write "test" string
    rs232.write(string2chars("test")); % FIXME: throws java.lang.StringIndexOutOfBoundsException: String index out of range: 0

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

% Callback function for read callback
function cb_read(e)
    fprintf("Message: \"%s\"\n", chars2string(e.message));
end

% Convert string to array
function chars = string2chars(string)
    chars = javaArray("java.lang.String", length(string));

    for i = 1:length(string)
        chars(i) = substr(string, i, 1);
    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)
    string = "";

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

Grundfunktionen¶

class BrickletRS232V2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	rs232V2 – Typ: BrickletRS232V2

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

In MATLAB:

import com.tinkerforge.BrickletRS232V2;

rs232V2 = BrickletRS232V2("YOUR_DEVICE_UID", ipcon);

In Octave:

rs232V2 = java_new("com.tinkerforge.BrickletRS232V2", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletRS232V2.write(char[] message)¶

Parameter:	message – Typ: char[], Länge: variabel
Rückgabe:	messageWritten – Typ: int, Wertebereich: [0 bis 216 - 1]

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.

char[] BrickletRS232V2.read(int length)¶

Parameter:	length – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:	message – Typ: char[], Länge: variabel

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.

void BrickletRS232V2.setConfiguration(long baudrate, int parity, int stopbits, int wordlength, int flowcontrol)¶

Parameter:	baudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8 flowcontrol – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS232-Kommunikation.

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

Für parity:

• BrickletRS232V2.PARITY_NONE = 0
• BrickletRS232V2.PARITY_ODD = 1
• BrickletRS232V2.PARITY_EVEN = 2

Für stopbits:

• BrickletRS232V2.STOPBITS_1 = 1
• BrickletRS232V2.STOPBITS_2 = 2

Für wordlength:

• BrickletRS232V2.WORDLENGTH_5 = 5
• BrickletRS232V2.WORDLENGTH_6 = 6
• BrickletRS232V2.WORDLENGTH_7 = 7
• BrickletRS232V2.WORDLENGTH_8 = 8

Für flowcontrol:

• BrickletRS232V2.FLOWCONTROL_OFF = 0
• BrickletRS232V2.FLOWCONTROL_SOFTWARE = 1
• BrickletRS232V2.FLOWCONTROL_HARDWARE = 2

BrickletRS232V2.Configuration BrickletRS232V2.getConfiguration()¶

Rückgabeobjekt:	baudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 8 flowcontrol – Typ: int, 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 parity:

• BrickletRS232V2.PARITY_NONE = 0
• BrickletRS232V2.PARITY_ODD = 1
• BrickletRS232V2.PARITY_EVEN = 2

Für stopbits:

• BrickletRS232V2.STOPBITS_1 = 1
• BrickletRS232V2.STOPBITS_2 = 2

Für wordlength:

• BrickletRS232V2.WORDLENGTH_5 = 5
• BrickletRS232V2.WORDLENGTH_6 = 6
• BrickletRS232V2.WORDLENGTH_7 = 7
• BrickletRS232V2.WORDLENGTH_8 = 8

Für flowcontrol:

• BrickletRS232V2.FLOWCONTROL_OFF = 0
• BrickletRS232V2.FLOWCONTROL_SOFTWARE = 1
• BrickletRS232V2.FLOWCONTROL_HARDWARE = 2

Fortgeschrittene Funktionen¶

void BrickletRS232V2.setBufferConfig(int sendBufferSize, int receiveBufferSize)¶

Parameter:	sendBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120 receiveBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

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.BufferConfig BrickletRS232V2.getBufferConfig()¶

Rückgabeobjekt:	sendBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120 receiveBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von setBufferConfig() gesetzt.

BrickletRS232V2.BufferStatus BrickletRS232V2.getBufferStatus()¶

Rückgabeobjekt:	sendBufferUsed – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216] receiveBufferUsed – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216]

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe setBufferConfig() zur Konfiguration der Buffergrößen.

BrickletRS232V2.ErrorCount BrickletRS232V2.getErrorCount()¶

Rückgabeobjekt:	errorCountOverrun – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountParity – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

BrickletRS232V2.SPITFPErrorCount BrickletRS232V2.getSPITFPErrorCount()¶

Rückgabeobjekt:	errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

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.

void BrickletRS232V2.setStatusLEDConfig(int config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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.STATUS_LED_CONFIG_OFF = 0
• BrickletRS232V2.STATUS_LED_CONFIG_ON = 1
• BrickletRS232V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletRS232V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletRS232V2.getStatusLEDConfig()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• BrickletRS232V2.STATUS_LED_CONFIG_OFF = 0
• BrickletRS232V2.STATUS_LED_CONFIG_ON = 1
• BrickletRS232V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletRS232V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletRS232V2.getChipTemperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

void 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.Identity BrickletRS232V2.getIdentity()¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, 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 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¶

void BrickletRS232V2.enableReadCallback()¶

Aktiviert den ReadCallback Callback. Dies deaktiviert den FrameReadableCallback Callback.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS232V2.disableReadCallback()¶

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

boolean BrickletRS232V2.isReadCallbackEnabled()¶

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

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

void BrickletRS232V2.setFrameReadableCallbackConfiguration(int frameSize)¶

Parameter:	frameSize – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216], 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.3 (Plugin).

int BrickletRS232V2.getFrameReadableCallbackConfiguration()¶

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

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

Neu in Version 2.0.3 (Plugin).

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.

callback BrickletRS232V2.ReadCallback¶

Event-Objekt:	message – Typ: char[], Länge: variabel

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 null für message ausgelöst.

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 werden. Eine hinzugefügter Callback-Function kann mit removeReadCallback() wieder entfernt werden.

callback BrickletRS232V2.ErrorCountCallback¶

Event-Objekt:	errorCountOverrun – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountParity – Typ: long, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.

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

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

callback BrickletRS232V2.FrameReadableCallback¶

Event-Objekt:	frameCount – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

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

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.

short[] BrickletRS232V2.getAPIVersion()¶

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

boolean BrickletRS232V2.getResponseExpected(byte functionId)¶

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:

• BrickletRS232V2.FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232V2.FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232V2.FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232V2.FUNCTION_SET_BUFFER_CONFIG = 8
• BrickletRS232V2.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
• BrickletRS232V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRS232V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRS232V2.FUNCTION_RESET = 243
• BrickletRS232V2.FUNCTION_WRITE_UID = 248

void BrickletRS232V2.setResponseExpected(byte functionId, boolean responseExpected)¶

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:

• BrickletRS232V2.FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232V2.FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232V2.FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232V2.FUNCTION_SET_BUFFER_CONFIG = 8
• BrickletRS232V2.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
• BrickletRS232V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletRS232V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletRS232V2.FUNCTION_RESET = 243
• BrickletRS232V2.FUNCTION_WRITE_UID = 248

void BrickletRS232V2.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.

Interne Funktionen¶

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.

int BrickletRS232V2.setBootloaderMode(int mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

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:

• BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletRS232V2.BOOTLOADER_STATUS_OK = 0
• BrickletRS232V2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletRS232V2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletRS232V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletRS232V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletRS232V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletRS232V2.getBootloaderMode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

• BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletRS232V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletRS232V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletRS232V2.setWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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.

int BrickletRS232V2.writeFirmware(int[] data)¶

Parameter:	data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

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.

void BrickletRS232V2.writeUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

long BrickletRS232V2.readUID()¶

Rückgabe:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

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

String BrickletRS232V2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.