Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / CAN Bricklet

JavaScript - CAN Bricklet¶

Dies ist die Beschreibung der JavaScript API Bindings für das CAN Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CAN Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die JavaScript API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback (Node.js)¶

Download (ExampleLoopback.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var can = new Tinkerforge.BrickletCAN(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Configure transceiver for loopback mode
        can.setConfiguration(Tinkerforge.BrickletCAN.BAUD_RATE_1000KBPS,
                             Tinkerforge.BrickletCAN.TRANSCEIVER_MODE_LOOPBACK, 0);

        // Enable frame read callback
        can.enableFrameReadCallback();

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

// Register frame read callback
can.on(Tinkerforge.BrickletCAN.CALLBACK_FRAME_READ,
    // Callback function for frame read callback
    function (frameType, identifier, data, len) {
        if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_STANDARD_DATA) {
            console.log('Frame Type: Standard Data');
        }
        else if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_STANDARD_REMOTE) {
            console.log('Frame Type: Standard Remote');
        }
        else if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_EXTENDED_DATA) {
            console.log('Frame Type: Extended Data');
        }
        else if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_EXTENDED_REMOTE) {
            console.log('Frame Type: Extended Remote');
        }

        console.log('Identifier: ' + identifier);

        var str = 'Data (Length: ' + len + '):';
        for (var i = 0; i < len && i < 8; ++i) {
            str += ' ' + data[i];
        }

        console.log(str);
        console.log();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        can.disableFrameReadCallback();

        ipcon.disconnect();
        process.exit(0);
    }
);

Loopback (HTML)¶

Download (ExampleLoopback.html), Test (ExampleLoopback.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>CAN Bricklet Loopback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var can = new Tinkerforge.BrickletCAN(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Configure transceiver for loopback mode
                        can.setConfiguration(Tinkerforge.BrickletCAN.BAUD_RATE_1000KBPS,
                                             Tinkerforge.BrickletCAN.TRANSCEIVER_MODE_LOOPBACK, 0);

                        // Enable frame read callback
                        can.enableFrameReadCallback();

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

                // Register frame read callback
                can.on(Tinkerforge.BrickletCAN.CALLBACK_FRAME_READ,
                    // Callback function for frame read callback
                    function (frameType, identifier, data, len) {
                        if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_STANDARD_DATA) {
                            textArea.value += 'Frame Type: Standard Data\n';
                        }
                        else if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_STANDARD_REMOTE) {
                            textArea.value += 'Frame Type: Standard Remote\n';
                        }
                        else if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_EXTENDED_DATA) {
                            textArea.value += 'Frame Type: Extended Data\n';
                        }
                        else if(frameType === Tinkerforge.BrickletCAN.FRAME_TYPE_EXTENDED_REMOTE) {
                            textArea.value += 'Frame Type: Extended Remote\n';
                        }

                        textArea.value += 'Identifier: ' + identifier + '\n';
                        textArea.value += 'Data (Length: ' + len + '):';

                        for (var i = 0; i < len && i < 8; ++i) {
                            textArea.value += ' ' + data[i];
                        }

                        textArea.value += '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API¶

Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Funktion als Argumente aufgerufen, falls die Funktion ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen¶

new BrickletCAN(uid, ipcon)¶

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

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

var can = new BrickletCAN("YOUR_DEVICE_UID", ipcon)

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

BrickletCAN.writeFrame(frameType, identifier, data, length[, returnCallback][, errorCallback])¶

Parameter:	frameType – Typ: int, Wertebereich: Siehe Konstanten identifier – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: [int, ...], Länge: 8, Wertebereich: [0 bis 255] length – Typ: int, Wertebereich: [0 bis 15]
Callback-Parameter:	success – Typ: boolean
Rückgabe:	undefined

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 frame_type:

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([returnCallback][, errorCallback])¶

Callback-Parameter:	success – Typ: boolean frameType – Typ: int, Wertebereich: Siehe Konstanten identifier – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: [int, ...], Länge: 8, Wertebereich: [0 bis 255] length – Typ: int, Wertebereich: [0 bis 15]
Rückgabe:	undefined

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 CALLBACK_FRAME_READ Callback.

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

Für frame_type:

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.setConfiguration(baudRate, transceiverMode, writeTimeout[, returnCallback][, errorCallback])¶

Parameter:	baudRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3 transceiverMode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 writeTimeout – Typ: int, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

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 baud_rate:

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 transceiver_mode:

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

BrickletCAN.getConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	baudRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3 transceiverMode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 writeTimeout – Typ: int, Wertebereich: [-1 bis 2³¹ - 1], Standardwert: 0
Rückgabe:	undefined

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

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

Für baud_rate:

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 transceiver_mode:

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

Fortgeschrittene Funktionen¶

BrickletCAN.setReadFilter(mode, mask, filter1, filter2[, returnCallback][, errorCallback])¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 mask – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] filter1 – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] filter2 – Typ: int, Wertebereich: [0 bis 2³⁰ - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.getReadFilter([returnCallback][, errorCallback])¶

Callback-Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 mask – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] filter1 – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] filter2 – Typ: int, Wertebereich: [0 bis 2³⁰ - 1]
Rückgabe:	undefined

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.getErrorLog([returnCallback][, errorCallback])¶

Callback-Parameter:	writeErrorLevel – Typ: int, Wertebereich: [0 bis 255] readErrorLevel – Typ: int, Wertebereich: [0 bis 255] transceiverDisabled – Typ: boolean writeTimeoutCount – Typ: int, Wertebereich: [0 bis 2³² - 1] readRegisterOverflowCount – Typ: int, Wertebereich: [0 bis 2³² - 1] readBufferOverflowCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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 CALLBACK_FRAME_READ Callbacks stellt sicher, dass der Lese-Buffer nicht überlaufen kann.

BrickletCAN.getIdentity([returnCallback][, errorCallback])¶

Callback-Parameter:

Callback-Parameter:	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: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] firmwareVersion – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	undefined

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: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmwareVersion – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Rückgabe:

undefined

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¶

BrickletCAN.on(callback_id, function[, errorCallback])¶

Parameter:	callback_id – Typ: int function – Typ: function
Rückgabe:	undefined

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletCAN.enableFrameReadCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert den CALLBACK_FRAME_READ Callback.

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

BrickletCAN.disableFrameReadCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Deaktiviert den CALLBACK_FRAME_READ Callback.

Standardmäßig ist der Callback deaktiviert.

BrickletCAN.isFrameReadCallbackEnabled([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: false
Rückgabe:	undefined

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

BrickletCAN.setFrameReadableCallbackConfiguration(enabled[, returnCallback][, errorCallback])¶

Parameter:	enabled – Typ: boolean, Standardwert: false
Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert/deaktiviert den CALLBACK_FRAME_READABLE Callback.

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

Neu in Version 2.0.1 (Plugin).

BrickletCAN.getFrameReadableCallbackConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: false
Rückgabe:	undefined

Gibt true zurück falls der CALLBACK_FRAME_READABLE 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 kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

can.on(BrickletCAN.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletCAN.CALLBACK_FRAME_READ¶

Callback-Parameter:	frameType – Typ: int, Wertebereich: Siehe Konstanten identifier – Typ: int, Wertebereich: [0 bis 2³⁰ - 1] data – Typ: [int, ...], Länge: 8, Wertebereich: [0 bis 255] length – Typ: int, 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 frame_type:

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.CALLBACK_FRAME_READABLE¶

Callback-Parameter:	undefined

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

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.

BrickletCAN.getAPIVersion()¶

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

BrickletCAN.getResponseExpected(functionId[, errorCallback])¶

Parameter:	functionId – Typ: int, 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 function_id:

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

BrickletCAN.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameter:	functionId – Typ: int, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean
Rückgabe:	undefined

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

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

Für function_id:

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

BrickletCAN.setResponseExpectedAll(responseExpected)¶

Parameter:	responseExpected – Typ: boolean
Rückgabe:	undefined

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

Konstanten¶

BrickletCAN.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein CAN Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletCAN.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines CAN Bricklet dar.