Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / RS232 Bricklet 2.0

JavaScript - RS232 Bricklet 2.0¶

Dies ist die Beschreibung der JavaScript API Bindings für das RS232 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 2.0 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');

// For this example connect the RX1 and TX pin to receive the send message

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs232 = new Tinkerforge.BrickletRS232V2(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) {
        // Enable read callback
        rs232.enableReadCallback();

        // Write "test" string
        rs232.write('test'.split(''));
    }
);

// Register read callback
rs232.on(Tinkerforge.BrickletRS232V2.CALLBACK_READ,
    // Callback function for read callback
    function (message) {
        // Assume that the message consists of ASCII characters and
        // convert it from an array of chars to a string
        console.log('Message: "' + message.join('') + '"');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Loopback (HTML)¶

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

<!DOCTYPE html>

<!-- For this example connect the RX1 and TX pin to receive the send message -->

<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>RS232 Bricklet 2.0 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 rs232 = new Tinkerforge.BrickletRS232V2(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) {
                        // Enable read callback
                        rs232.enableReadCallback();

                        // Write "test" string
                        rs232.write('test'.split(''));
                    }
                );

                // Register read callback
                rs232.on(Tinkerforge.BrickletRS232V2.CALLBACK_READ,
                    // Callback function for read callback
                    function (message) {
                        // Assume that the message consists of ASCII characters and
                        // convert it from an array of chars to a string
                        textArea.value += 'Message: "' + message.join('') + '"\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 BrickletRS232V2(uid, ipcon)¶

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

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

var rs232V2 = new BrickletRS232V2("YOUR_DEVICE_UID", ipcon)

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

BrickletRS232V2.write(message[, returnCallback][, errorCallback])¶

Parameter:	message – Typ: [char, ...], Länge: variabel
Callback-Parameter:	messageWritten – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	undefined

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.

BrickletRS232V2.read(length[, returnCallback][, errorCallback])¶

Parameter:	length – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Callback-Parameter:	message – Typ: [char, ...], Länge: variabel
Rückgabe:	undefined

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

BrickletRS232V2.setConfiguration(baudrate, parity, stopbits, wordlength, flowcontrol[, returnCallback][, errorCallback])¶

Parameter:	baudrate – Typ: int, 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
Callback-Parameter:	undefined
Rückgabe:	undefined

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

Callback-Parameter:

Callback-Parameter:	baudrate – Typ: int, 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
Rückgabe:	undefined

baudrate – Typ: int, 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

Rückgabe:

undefined

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¶

BrickletRS232V2.setBufferConfig(sendBufferSize, receiveBufferSize[, returnCallback][, errorCallback])¶

Parameter:	sendBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receiveBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Callback-Parameter:	undefined
Rückgabe:	undefined

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 CALLBACK_READ Callback an ein Nutzerprogramm übertragen werden konnten.

BrickletRS232V2.getBufferConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	sendBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receiveBufferSize – Typ: int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Rückgabe:	undefined

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

BrickletRS232V2.getBufferStatus([returnCallback][, errorCallback])¶

Callback-Parameter:	sendBufferUsed – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216] receiveBufferUsed – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 9216]
Rückgabe:	undefined

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

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

BrickletRS232V2.getErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountOverrun – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountParity – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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

BrickletRS232V2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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.

BrickletRS232V2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

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

BrickletRS232V2.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

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

BrickletRS232V2.getChipTemperature([returnCallback][, errorCallback])¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	undefined

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.

BrickletRS232V2.reset([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

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

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

BrickletRS232V2.enableReadCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert den CALLBACK_READ Callback. Dies deaktiviert den CALLBACK_FRAME_READABLE Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS232V2.disableReadCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS232V2.isReadCallbackEnabled([returnCallback][, errorCallback])¶

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

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

BrickletRS232V2.setFrameReadableCallbackConfiguration(frameSize[, returnCallback][, errorCallback])¶

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

Konfiguriert den CALLBACK_FRAME_READABLE 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 CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.3 (Plugin).

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

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

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

rs232V2.on(BrickletRS232V2.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.

BrickletRS232V2.CALLBACK_READ¶

Callback-Parameter:	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.

BrickletRS232V2.CALLBACK_ERROR_COUNT¶

Callback-Parameter:	errorCountOverrun – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountParity – Typ: int, Wertebereich: [0 bis 2³² - 1]

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

BrickletRS232V2.CALLBACK_FRAME_READABLE¶

Callback-Parameter:	frameCount – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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).

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.

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

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

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

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

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

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

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.

BrickletRS232V2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

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

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

BrickletRS232V2.getBootloaderMode([returnCallback][, errorCallback])¶

Callback-Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

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

BrickletRS232V2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletRS232V2.writeFirmware(data[, returnCallback][, errorCallback])¶

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

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.

BrickletRS232V2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletRS232V2.readUID([returnCallback][, errorCallback])¶

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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

Konstanten¶

BrickletRS232V2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 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.

BrickletRS232V2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.