MATLAB/Octave - CAN Bricklet¶

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

function matlab_example_loopback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletCAN;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your CAN Bricklet

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

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

    % Configure transceiver for loopback mode
    can.setConfiguration(BrickletCAN.BAUD_RATE_1000KBPS, ...
                         BrickletCAN.TRANSCEIVER_MODE_LOOPBACK, 0);

    % Register frame read callback to function cb_frame_read
    set(can, 'FrameReadCallback', @(h, e) cb_frame_read(e));

    % Enable frame read callback
    can.enableFrameReadCallback();

    % Write standard data frame with identifier 1742 and 3 bytes of data
    data = [42, 23, 17, 0, 0, 0, 0, 0];
    can.writeFrame(BrickletCAN.FRAME_TYPE_STANDARD_DATA, 1742, data, 3);

    input('Press key to exit\n', 's');

    can.disableFrameReadCallback();

    ipcon.disconnect();
end

% Callback function for frame read callback
function cb_frame_read(e)
    if e.frameType == com.tinkerforge.BrickletCAN.FRAME_TYPE_STANDARD_DATA
        fprintf('Frame Type: Standard Data\n');
    elseif e.frameType == com.tinkerforge.BrickletCAN.FRAME_TYPE_STANDARD_REMOTE
        fprintf('Frame Type: Standard Remote\n');
    elseif e.frameType == com.tinkerforge.BrickletCAN.FRAME_TYPE_EXTENDED_DATA
        fprintf('Frame Type: Extended Data\n');
    elseif e.frameType == com.tinkerforge.BrickletCAN.FRAME_TYPE_EXTENDED_REMOTE
        fprintf('Frame Type: Extended Remote\n');
    end

    fprintf('Identifier: %i\n', e.identifier);
    fprintf('Data (Length: %i):', e.length);

    for i = 1:min(e.length, 8)
        fprintf(' %i', e.data(i));
    end

    fprintf('\n');
    fprintf('\n');
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;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your CAN Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    can = javaObject("com.tinkerforge.BrickletCAN", UID, ipcon); % Create device object

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

    % Configure transceiver for loopback mode
    can.setConfiguration(can.BAUD_RATE_1000KBPS, can.TRANSCEIVER_MODE_LOOPBACK, 0);

    % Register frame read callback to function cb_frame_read
    can.addFrameReadCallback(@cb_frame_read);

    % Enable frame read callback
    can.enableFrameReadCallback();

    % Write standard data frame with identifier 1742 and 3 bytes of data
    data = [42, 23, 17, 0, 0, 0, 0, 0];
    can.writeFrame(can.FRAME_TYPE_STANDARD_DATA, 1742, data, 3);

    input("Press key to exit\n", "s");

    can.disableFrameReadCallback();

    ipcon.disconnect();
end

% Callback function for frame read callback
function cb_frame_read(e)
    data = e.data;
    len = java2int(e.length);

    if java2int(e.frameType) == 0
        fprintf("Frame Type: Standard Data\n");
    elseif java2int(e.frameType) == 1
        fprintf("Frame Type: Standard Remote\n");
    elseif java2int(e.frameType) == 2
        fprintf("Frame Type: Extended Data\n");
    elseif java2int(e.frameType) == 3
        fprintf("Frame Type: Extended Remote\n");
    end

    fprintf("Identifier: %d\n", java2int(e.identifier));
    fprintf("Data (Length: %d):", len);

    for i = 1:min(len, 8)
        fprintf(" %d", java2int(data(i)));
    end

    fprintf("\n");
    fprintf("\n");
end

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

Grundfunktionen¶

class BrickletCAN(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	can – Typ: BrickletCAN

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

In MATLAB:

import com.tinkerforge.BrickletCAN;

can = BrickletCAN("YOUR_DEVICE_UID", ipcon);

In Octave:

can = java_new("com.tinkerforge.BrickletCAN", "YOUR_DEVICE_UID", ipcon);

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

boolean BrickletCAN.writeFrame(short frameType, long identifier, short[] data, short length)¶

Parameter:	frameType – Typ: short, Wertebereich: Siehe Konstanten identifier – Typ: long, Wertebereich: [0 bis 230 - 1] data – Typ: short[], Länge: 8, Wertebereich: [0 bis 255] length – Typ: short, Wertebereich: [0 bis 15]
Rückgabe:	success – Typ: boolean

Schreibt einen Data- oder Remote-Frame in den Schreib-Buffer, damit dieser über den CAN-Transceiver übertragen wird.

Das Bricklet unterstützt die Standard 11-Bit (CAN 2.0A) und die zusätzlichen Extended 18-Bit (CAN 2.0B) Identifier. Für Standard-Frames verwendet das Bricklet Bit 0 bis 10 des identifier Parameters als Standard 11-Bit Identifier. Für Extended-Frames verwendet das Bricklet zusätzlich Bit 11 bis 28 des identifier Parameters als Extended 18-Bit Identifier.

Für Remote-Frames wird der data Parameter ignoriert.

Gibt true zurück, wenn der Frame dem Schreib-Buffer erfolgreich hinzugefügt wurde. Gibt false zurück wenn Frame nicht hinzugefügt werden konnte, weil der Schreib-Buffer bereits voll ist.

Der Schreib-Buffer kann überlaufen, wenn Frames schneller geschrieben werden als das Bricklet sie über deb CAN-Transceiver übertragen kann. Dies kann dadurch passieren, dass der CAN-Transceiver als nur-lesend oder mit einer niedrigen Baudrate konfiguriert ist (siehe setConfiguration()). Es kann auch sein, dass der CAN-Bus stark belastet ist und der Frame nicht übertragen werden kann, da er immer wieder die Arbitrierung verliert. Ein anderer Grund kann sein, dass der CAN-Transceiver momentan deaktiviert ist, bedingt duch ein hohes Schreib-Fehlerlevel (siehe getErrorLog()).

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

Für frameType:

• BrickletCAN.FRAME_TYPE_STANDARD_DATA = 0
• BrickletCAN.FRAME_TYPE_STANDARD_REMOTE = 1
• BrickletCAN.FRAME_TYPE_EXTENDED_DATA = 2
• BrickletCAN.FRAME_TYPE_EXTENDED_REMOTE = 3

BrickletCAN.ReadFrame BrickletCAN.readFrame()¶

Rückgabeobjekt:	success – Typ: boolean frameType – Typ: short, Wertebereich: Siehe Konstanten identifier – Typ: long, Wertebereich: [0 bis 230 - 1] data – Typ: short[], Länge: 8, Wertebereich: [0 bis 255] length – Typ: short, Wertebereich: [0 bis 15]

Versucht den nächsten Data- oder Remote-Frame aus dem Lese-Buffer zu lesen und zurückzugeben. Falls ein Frame erfolgreich gelesen wurde, dann wird der success Rückgabewert auf true gesetzt und die anderen Rückgabewerte beinhalte den gelesenen Frame. Falls der Lese-Buffer leer ist und kein Frame gelesen werden konnte, dann wird der success Rückgabewert auf false gesetzt und die anderen Rückgabewerte beinhalte ungültige Werte.

Der identifier Rückgabewerte folgt dem für writeFrame() beschriebenen Format.

Für Remote-Frames beinhalte der data Rückgabewerte immer ungültigen Werte.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames vom CAN-Transceiver überhaupt empfangen und im Lese-Buffer abgelegt werden sollen (siehe setReadFilter()).

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe die enableFrameReadCallback() Funktion und den FrameReadCallback Callback.

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

Für frameType:

• BrickletCAN.FRAME_TYPE_STANDARD_DATA = 0
• BrickletCAN.FRAME_TYPE_STANDARD_REMOTE = 1
• BrickletCAN.FRAME_TYPE_EXTENDED_DATA = 2
• BrickletCAN.FRAME_TYPE_EXTENDED_REMOTE = 3

void BrickletCAN.setConfiguration(short baudRate, short transceiverMode, int writeTimeout)¶

Parameter:	baudRate – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 transceiverMode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 writeTimeout – Typ: int, Wertebereich: [-1 bis 231 - 1], Standardwert: 0

Setzt die Konfiguration für die CAN-Bus-Kommunikation.

Die Baudrate kann in Schritten zwischen 10 und 1000 kBit/s eingestellt werden.

Der CAN-Transceiver hat drei verschiedene Modi:

• Normal: Es wird vom CAN-Bus gelesen und auf den CAN-Bus geschrieben und aktiv an der Bus-Fehlererkennung und dem Acknowledgement mitgewirkt.
• Loopback: Alle Lese- und Schreiboperationen werden intern durchgeführt. Der Transceiver ist nicht mit dem eigentlichen CAN-Bus verbunden.
• Read-Only: Es wird nur vom CAN-Bus gelesen, allerdings ohne aktiv an der Bus-Fehlererkennung oder dem Acknowledgement mitzuwirken. Nur der empfangende Teil des Transceivers ist mit dem CAN-Bus verbunden.

Der Schreib-Timeout hat drei verschiedene Modi, die festlegen wie mit einer fehlgeschlagen Frame-Übertragung umgegangen werden soll:

• One-Shot (= -1): Es wird nur ein Übertragungsversuch durchgeführt. Falls die Übertragung fehlschlägt wird der Frame verworfen.
• Infinite (= 0): Es werden unendlich viele Übertragungsversuche durchgeführt. Der Frame wird niemals verworfen.
• Milliseconds (> 0): Es wird eine beschränkte Anzahl Übertragungsversuche durchgeführt. Falls der Frame nach der eingestellten Anzahl Millisekunden noch nicht erfolgreich übertragen wurde, dann wird er verworfen.

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

Für baudRate:

• BrickletCAN.BAUD_RATE_10KBPS = 0
• BrickletCAN.BAUD_RATE_20KBPS = 1
• BrickletCAN.BAUD_RATE_50KBPS = 2
• BrickletCAN.BAUD_RATE_125KBPS = 3
• BrickletCAN.BAUD_RATE_250KBPS = 4
• BrickletCAN.BAUD_RATE_500KBPS = 5
• BrickletCAN.BAUD_RATE_800KBPS = 6
• BrickletCAN.BAUD_RATE_1000KBPS = 7

Für transceiverMode:

• BrickletCAN.TRANSCEIVER_MODE_NORMAL = 0
• BrickletCAN.TRANSCEIVER_MODE_LOOPBACK = 1
• BrickletCAN.TRANSCEIVER_MODE_READ_ONLY = 2

BrickletCAN.Configuration BrickletCAN.getConfiguration()¶

Rückgabeobjekt:	baudRate – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 transceiverMode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 writeTimeout – Typ: int, Wertebereich: [-1 bis 231 - 1], Standardwert: 0

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

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

Für baudRate:

• BrickletCAN.BAUD_RATE_10KBPS = 0
• BrickletCAN.BAUD_RATE_20KBPS = 1
• BrickletCAN.BAUD_RATE_50KBPS = 2
• BrickletCAN.BAUD_RATE_125KBPS = 3
• BrickletCAN.BAUD_RATE_250KBPS = 4
• BrickletCAN.BAUD_RATE_500KBPS = 5
• BrickletCAN.BAUD_RATE_800KBPS = 6
• BrickletCAN.BAUD_RATE_1000KBPS = 7

Für transceiverMode:

• BrickletCAN.TRANSCEIVER_MODE_NORMAL = 0
• BrickletCAN.TRANSCEIVER_MODE_LOOPBACK = 1
• BrickletCAN.TRANSCEIVER_MODE_READ_ONLY = 2

Fortgeschrittene Funktionen¶

void BrickletCAN.setReadFilter(short mode, long mask, long filter1, long filter2)¶

Parameter:	mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 mask – Typ: long, Wertebereich: [0 bis 230 - 1] filter1 – Typ: long, Wertebereich: [0 bis 230 - 1] filter2 – Typ: long, Wertebereich: [0 bis 230 - 1]

Setzt die Konfiguration für den Lesefilter. Damit kann festgelegt werden, welche Frames von der CAN-Transceiver überhaupt empfangen und im Lese-Buffer abgelegt werden sollen.

Der Lesefilter hat fünf verschiedene Modi, die festlegen ob und wie die Maske und die beiden Filter angewendet werden:

• Disabled: Es wird keinerlei Filterung durchgeführt. Alle Frames inklusive unvollständiger und fehlerhafter Frames werden empfangen. Dieser Modus sollte nur für Debugging-Zwecke verwendet werden.
• Accept-All: Alle vollständigen und fehlerfreien Frames werden empfangen.
• Match-Standard: Nur Standard-Frames, deren Identifier der eingestellten Maske und Filtern entspricht, werden empfangen.
• Match-Standard-and-Data: Nur Standard-Frames, deren Identifier und Daten der eingestellten Maske und Filtern entspricht, werden empfangen.
• Match-Extended: Nur Extended-Frames, deren Identifier der eingestellten Maske und Filtern entspricht, werden empfangen.

Maske und Filter werden als Bitmasken verwendet. Ihre Verwendung hängt vom Modus ab:

• Disabled: Maske und Filter werden ignoriert.
• Accept-All: Maske und Filter werden ignoriert.
• Match-Standard: Bit 0 bis 10 (11 Bits) der Maske und Filter werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet.
• Match-Standard-and-Data: Bit 0 bis 10 (11 Bits) der Maske und Filter werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet. Bit 11 bis 18 (8 Bits) und Bit 19 bis 26 (8 Bits) der Maske und Filter werden zum Abgleich mit dem ersten und zweiten Daten-Byte (sofern vorhanden) von Standard-Frames verwendet.
• Match-Extended: Bit 0 bis 10 (11 Bits) der Maske und Filter werden zum Abgleich mit dem Standard 11-Bit Identifier-Teil von Extended-Frames verwendet. Bit 11 bis 28 (18 Bits) der Maske und Filter werden zum Abgleich mit dem Extended 18-Bit Identifier-Teil von Extended-Frames verwendet.

Maske und Filter werden auf diese Weise angewendet: Mit der Maske werden die Identifier- und Daten-Bits ausgewählt, die mit den entsprechenden Filter-Bits verglichen werden sollen. Alle nicht-ausgewählten Bits werden automatisch akzeptiert. Alle ausgewählten Bits müssen einem der beiden Filter entsprechen, um akzeptiert zu werden. Wenn alle Bits für den ausgewählte Modus akzeptiert wurden, dann ist der Frame akzeptiert und wird im Lese-Buffer abgelegt.

Masken-Bit	Filter-Bit	Identifier/Daten-Bit	Ergebnis
0	X	X	akzeptiert
1	0	0	akzeptiert
1	0	1	verworfen
1	1	0	verworfen
1	1	1	akzeptiert

Ein Beispiel: Um nur Standard-Frames mit Identifier 0x123 zu empfangen kann der Modus auf Match-Standard mit 0x7FF als Maske und 0x123 als Filter 1 und Filter 2 eingestellt werden. Die Maske 0x7FF wählt alle 11 Identifier-Bits zum Abgleich aus, so dass der Identifier exakt 0x123 sein muss um akzeptiert zu werden.

Um Identifier 0x123 und 0x456 gleichzeitig zu akzeptieren kann Filter 2 auf 0x456 gesetzt und die Maske und Filter 1 beibehalten werden.

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

Für mode:

• BrickletCAN.FILTER_MODE_DISABLED = 0
• BrickletCAN.FILTER_MODE_ACCEPT_ALL = 1
• BrickletCAN.FILTER_MODE_MATCH_STANDARD = 2
• BrickletCAN.FILTER_MODE_MATCH_STANDARD_AND_DATA = 3
• BrickletCAN.FILTER_MODE_MATCH_EXTENDED = 4

BrickletCAN.ReadFilter BrickletCAN.getReadFilter()¶

Rückgabeobjekt:	mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1 mask – Typ: long, Wertebereich: [0 bis 230 - 1] filter1 – Typ: long, Wertebereich: [0 bis 230 - 1] filter2 – Typ: long, Wertebereich: [0 bis 230 - 1]

Gibt die Lesefilter zurück, wie von setReadFilter() gesetzt.

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

Für mode:

• BrickletCAN.FILTER_MODE_DISABLED = 0
• BrickletCAN.FILTER_MODE_ACCEPT_ALL = 1
• BrickletCAN.FILTER_MODE_MATCH_STANDARD = 2
• BrickletCAN.FILTER_MODE_MATCH_STANDARD_AND_DATA = 3
• BrickletCAN.FILTER_MODE_MATCH_EXTENDED = 4

BrickletCAN.ErrorLog BrickletCAN.getErrorLog()¶

Rückgabeobjekt:	writeErrorLevel – Typ: short, Wertebereich: [0 bis 255] readErrorLevel – Typ: short, Wertebereich: [0 bis 255] transceiverDisabled – Typ: boolean writeTimeoutCount – Typ: long, Wertebereich: [0 bis 232 - 1] readRegisterOverflowCount – Typ: long, Wertebereich: [0 bis 232 - 1] readBufferOverflowCount – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt Informationen über verschiedene Fehlerarten zurück.

Die Schreib- und Lesefehler-Level geben Aufschluss über das aktuelle Level der Prüfsummen-, Acknowledgement-, Form-, Bit- und Stuffing-Fehler während CAN-Bus Schreib- und Leseoperationen.

Wenn das Schreibfehler-Level 255 überschreitet dann wird der CAN-Transceiver deaktiviert und es können keine Frames mehr übertragen und empfangen werden. Wenn auf dem CAN-Bus für eine Weile Ruhe herrscht, dann wird der CAN-Transceiver automatisch wieder aktiviert.

Die Schreib- und Lesefehler-Level Werte sind im Read-Only Transceiver-Modus nicht verfügbar (see setConfiguration()). Außerdem werden sie als Seiteneffekt von Konfigurations- und Lesefilteränderungen auf 0 zurückgesetzt.

Die Werte für Schreib-Timeout, Lese-Register- und Lese-Buffer-Überlauf zählen die Anzahl dieser Fehler:

• Ein Schreib-Timeout tritt dann auf, wenn ein Frame nicht übertragen werden konnte bevor der eingestellte Schreib-Timeout abgelaufen ist (siehe setConfiguration()).
• Ein Lese-Register-Überlauf tritt dann auf, wenn im Lese-Register des CAN-Transceiver noch der zuletzt empfangen Frame steht wenn der nächste Frame ankommt. In diesem Fall geht der neu ankommende Frame verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt als das Bricklet behandeln kann. Mit Hilfe des Lesefilters (siehe setReadFilter()) kann die Anzahl der empfangen Frames verringert werden. Dieser Zähler ist nicht exakt, sondern stellt eine untere Grenze da. Es kann vorkommen, dass das Bricklet nicht alle Überläufe erkennt, wenn diese in schneller Abfolge auftreten.
• Ein Lese-Buffer-Überlauf tritt dann auf, wenn der Lese-Buffer des Bricklets bereits voll ist und noch ein Frame vom Lese-Register des CAN-Transceiver gelesen werden soll. In diesem Fall geht der Frame im Lese-Register verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt, die dem Lese-Buffer hinzugefügt werden sollen, als Frames mit der readFrame() Funktion aus dem Lese-Buffer entnommen werden. Die Verwendung des FrameReadCallback Callbacks stellt sicher, dass der Lese-Buffer nicht überlaufen kann.

BrickletCAN.Identity BrickletCAN.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 BrickletCAN.enableFrameReadCallback()¶

Aktiviert den FrameReadCallback Callback.

Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der FrameReadableCallback Callback deaktiviert.

void BrickletCAN.disableFrameReadCallback()¶

Deaktiviert den FrameReadCallback Callback.

Standardmäßig ist der Callback deaktiviert.

boolean BrickletCAN.isFrameReadCallbackEnabled()¶

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

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

void BrickletCAN.setFrameReadableCallbackConfiguration(boolean enabled)¶

Parameter:	enabled – Typ: boolean, Standardwert: false

Aktiviert/deaktiviert den FrameReadableCallback Callback.

Standardmäßig ist der Callback deaktiviert. Wenn dieser Callback aktiviert wird, wird der FrameReadCallback Callback deaktiviert.

Neu in Version 2.0.1 (Plugin).

boolean BrickletCAN.getFrameReadableCallbackConfiguration()¶

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

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

Neu in Version 2.0.1 (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 BrickletCAN.FrameReadCallback¶

Event-Objekt:	frameType – Typ: short, Wertebereich: Siehe Konstanten identifier – Typ: long, Wertebereich: [0 bis 230 - 1] data – Typ: short[], Länge: 8, Wertebereich: [0 bis 255] length – Typ: short, Wertebereich: [0 bis 15]

Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde.

Der identifier Rückgabewerte folgt dem für writeFrame() beschriebenen Format.

Für Remote-Frames beinhalte der data Rückgabewerte immer ungültigen Werte.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames von der CAN-Transceiver überhaupt empfangen werden sollen (siehe setReadFilter()).

Dieser Callback kann durch enableFrameReadCallback() aktiviert werden.

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

Für frameType:

• BrickletCAN.FRAME_TYPE_STANDARD_DATA = 0
• BrickletCAN.FRAME_TYPE_STANDARD_REMOTE = 1
• BrickletCAN.FRAME_TYPE_EXTENDED_DATA = 2
• BrickletCAN.FRAME_TYPE_EXTENDED_REMOTE = 3

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

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

callback BrickletCAN.FrameReadableCallback¶

Event-Objekt:	leeres Objekt

Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde. Der empfangene Frame kann mit readFrame() ausgelesen werden. Falls weitere Frames empfangen werden, bevor readFrame() aufgerufen wurde, wird der Callback nicht erneut ausgelöst.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames vom CAN-Transceiver überhaupt empfangen und im Lese-Queue abgelegt werden sollen (siehe setReadFilter()).

Dieser Callback kann durch setFrameReadableCallbackConfiguration() aktiviert werden.

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 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[] BrickletCAN.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 BrickletCAN.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:

• BrickletCAN.FUNCTION_ENABLE_FRAME_READ_CALLBACK = 3
• BrickletCAN.FUNCTION_DISABLE_FRAME_READ_CALLBACK = 4
• BrickletCAN.FUNCTION_SET_CONFIGURATION = 6
• BrickletCAN.FUNCTION_SET_READ_FILTER = 8
• BrickletCAN.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 12

void BrickletCAN.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:

• BrickletCAN.FUNCTION_ENABLE_FRAME_READ_CALLBACK = 3
• BrickletCAN.FUNCTION_DISABLE_FRAME_READ_CALLBACK = 4
• BrickletCAN.FUNCTION_SET_CONFIGURATION = 6
• BrickletCAN.FUNCTION_SET_READ_FILTER = 8
• BrickletCAN.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 12

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

Konstanten¶

int BrickletCAN.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein CAN 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 BrickletCAN.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines CAN Bricklet dar.