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

JavaScript - RS485 Bricklet¶

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

// For this example connect the RX+/- pins to TX+/- pins on the same Bricklet
// and configure the DIP switch on the Bricklet to full-duplex mode

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs485 = new Tinkerforge.BrickletRS485(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 full-duplex mode
        rs485.setRS485Configuration(115200, Tinkerforge.BrickletRS485.PARITY_NONE,
                                    Tinkerforge.BrickletRS485.STOPBITS_1,
                                    Tinkerforge.BrickletRS485.WORDLENGTH_8,
                                    Tinkerforge.BrickletRS485.DUPLEX_FULL);

        // Enable read callback
        rs485.enableReadCallback();

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

// Register read callback
rs485.on(Tinkerforge.BrickletRS485.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);
    }
);

Modbus Slave (Node.js)¶

Download (ExampleModbusSlave.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs485 = new Tinkerforge.BrickletRS485(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) {
        // Set operating mode to Modbus RTU slave
        rs485.setMode(Tinkerforge.BrickletRS485.MODE_MODBUS_SLAVE_RTU);

        // Modbus specific configuration:
        // - slave address = 17
        // - master request timeout = 0ms (unused in slave mode)
        rs485.setModbusConfiguration(17, 0);
    }
);

// Register Modbus slave write single register request callback
rs485.on(Tinkerforge.BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST,
    // Callback function for Modbus slave write single register request callback
    function (requestID, registerAddress, registerValue) {
        console.log('Request ID: ' + requestID);
        console.log('Register Address: ' + registerAddress);
        console.log('Register Value: ' + registerValue);

        if (registerAddress != 42) {
            console.log('Requested invalid register address');
            rs485.modbusSlaveReportException(requestID, Tinkerforge.BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
        } else {
            rs485.modbusSlaveAnswerWriteSingleRegisterRequest(requestID);
        }
    }
);

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

Modbus Master (Node.js)¶

Download (ExampleModbusMaster.js)

var Tinkerforge = require('tinkerforge');

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

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

var expectedRequestID = 0;

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) {
        // Set operating mode to Modbus RTU master
        rs485.setMode(Tinkerforge.BrickletRS485.MODE_MODBUS_MASTER_RTU);

        // Modbus specific configuration:
        // - slave address = 1 (unused in master mode)
        // - master request timeout = 1000ms
        rs485.setModbusConfiguration(1, 1000);

        // Write 65535 to register 42 of slave 17
        rs485.modbusMasterWriteSingleRegister(17, 42, 65535,
            function (requestID) {
                expectedRequestID = requestID;
            }
        );
    }
);

// Register Modbus master write single register response callback
rs485.on(Tinkerforge.BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE,
    // Callback function for Modbus master write single register response callback
    function (requestID, exceptionCode) {
        console.log('Request ID: ' + requestID);
        console.log('Exception Code: ' + exceptionCode);

        if (requestID != expectedRequestID) {
            console.log('Error: Unexpected request ID');
        }
    }
);

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 RX+/- pins to TX+/- pins on the same Bricklet
     and configure the DIP switch on the Bricklet to full-duplex mode -->

<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>RS485 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 rs485 = new Tinkerforge.BrickletRS485(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 full-duplex mode
                        rs485.setRS485Configuration(115200, Tinkerforge.BrickletRS485.PARITY_NONE,
                                                    Tinkerforge.BrickletRS485.STOPBITS_1,
                                                    Tinkerforge.BrickletRS485.WORDLENGTH_8,
                                                    Tinkerforge.BrickletRS485.DUPLEX_FULL);

                        // Enable read callback
                        rs485.enableReadCallback();

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

                // Register read callback
                rs485.on(Tinkerforge.BrickletRS485.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>

Modbus Slave (HTML)¶

Download (ExampleModbusSlave.html), Test (ExampleModbusSlave.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>RS485 Bricklet Modbus Slave 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 rs485 = new Tinkerforge.BrickletRS485(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) {
                        // Set operating mode to Modbus RTU slave
                        rs485.setMode(Tinkerforge.BrickletRS485.MODE_MODBUS_SLAVE_RTU);

                        // Modbus specific configuration:
                        // - slave address = 17
                        // - master request timeout = 0ms (unused in slave mode)
                        rs485.setModbusConfiguration(17, 0);
                    }
                );

                // Register Modbus slave write single register request callback
                rs485.on(Tinkerforge.BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST,
                    // Callback function for Modbus slave write single register request callback
                    function (requestID, registerAddress, registerValue) {
                        textArea.value += 'Request ID: ' + requestID + '\n';
                        textArea.value += 'Register Address: ' + registerAddress + '\n';
                        textArea.value += 'Register Value: ' + registerValue + '\n';

                        if (registerAddress != 42) {
                            textArea.value += 'Error: Invalid register address\n';
                            rs485.modbusSlaveReportException(requestID, Tinkerforge.BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
                        } else {
                            rs485.modbusSlaveAnswerWriteSingleRegisterRequest(requestID);
                        }

                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Modbus Master (HTML)¶

Download (ExampleModbusMaster.html), Test (ExampleModbusMaster.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>RS485 Bricklet Modbus Master 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 rs485 = new Tinkerforge.BrickletRS485(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) {
                        // Set operating mode to Modbus RTU master
                        rs485.setMode(Tinkerforge.BrickletRS485.MODE_MODBUS_MASTER_RTU);

                        // Modbus specific configuration:
                        // - slave address = 1 (unused in master mode)
                        // - master request timeout = 1000ms
                        rs485.setModbusConfiguration(1, 1000);

                        // Write 65535 to register 42 of slave 17
                        rs485.modbusMasterWriteSingleRegister(17, 42, 65535,
                            function (requestID) {
                                expectedRequestID = requestID;
                            }
                        );
                    }
                );

                // Register Modbus master write single register response callback
                rs485.on(Tinkerforge.BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE,
                    // Callback function for Modbus master write single register response callback
                    function (requestID, exceptionCode) {
                        textArea.value += 'Request ID: ' + requestID + '\n';
                        textArea.value += 'Exception Code: ' + exceptionCode + '\n';

                        if (requestID != expectedRequestID) {
                            textArea.value += 'Error: Unexpected request ID\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 BrickletRS485(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	rs485 – Typ: BrickletRS485

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

var rs485 = new BrickletRS485("YOUR_DEVICE_UID", ipcon)

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

BrickletRS485.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 RS485-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 setRS485Configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

BrickletRS485.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 nich aktiv ist. Siehe enableReadCallback() und CALLBACK_READ Callback.

BrickletRS485.setRS485Configuration(baudrate, parity, stopbits, wordlength, duplex[, 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 duplex – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Konfiguration für die RS485-Kommunikation.

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

Für parity:

BrickletRS485.PARITY_NONE = 0
BrickletRS485.PARITY_ODD = 1
BrickletRS485.PARITY_EVEN = 2

Für stopbits:

BrickletRS485.STOPBITS_1 = 1
BrickletRS485.STOPBITS_2 = 2

Für wordlength:

BrickletRS485.WORDLENGTH_5 = 5
BrickletRS485.WORDLENGTH_6 = 6
BrickletRS485.WORDLENGTH_7 = 7
BrickletRS485.WORDLENGTH_8 = 8

Für duplex:

BrickletRS485.DUPLEX_HALF = 0
BrickletRS485.DUPLEX_FULL = 1

BrickletRS485.getRS485Configuration([returnCallback][, errorCallback])¶

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 duplex – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	undefined

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

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

Für parity:

BrickletRS485.PARITY_NONE = 0
BrickletRS485.PARITY_ODD = 1
BrickletRS485.PARITY_EVEN = 2

Für stopbits:

BrickletRS485.STOPBITS_1 = 1
BrickletRS485.STOPBITS_2 = 2

Für wordlength:

BrickletRS485.WORDLENGTH_5 = 5
BrickletRS485.WORDLENGTH_6 = 6
BrickletRS485.WORDLENGTH_7 = 7
BrickletRS485.WORDLENGTH_8 = 8

Für duplex:

BrickletRS485.DUPLEX_HALF = 0
BrickletRS485.DUPLEX_FULL = 1

BrickletRS485.setModbusConfiguration(slaveAddress, masterRequestTimeout[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [1 bis 247], Standardwert: 1 masterRequestTimeout – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Konfiguration für die RS485 Modbus Kommunikation. Verfügbare Optionen:

Slave Address: Addresse die vom Modbus-Slave im Modbus-Slave Modus genutzt wird. Der gültige Adressbereich ist 1 bis 247.
Master Request Timeout: Spezifiziert wie lange der Modbus-Master auf eine Antwort von einem Modbus-Slave wartet.

BrickletRS485.getModbusConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	slaveAddress – Typ: int, Wertebereich: [1 bis 247], Standardwert: 1 masterRequestTimeout – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000
Rückgabe:	undefined

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

BrickletRS485.setMode(mode[, returnCallback][, errorCallback])¶

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

Setzt den Modus des Bricklets. Verfügbare Optionen sind

RS485,
Modbus-Master-RTU und
Modbus-Slave-RTU.

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

Für mode:

BrickletRS485.MODE_RS485 = 0
BrickletRS485.MODE_MODBUS_MASTER_RTU = 1
BrickletRS485.MODE_MODBUS_SLAVE_RTU = 2

BrickletRS485.getMode([returnCallback][, errorCallback])¶

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

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

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

Für mode:

BrickletRS485.MODE_RS485 = 0
BrickletRS485.MODE_MODBUS_MASTER_RTU = 1
BrickletRS485.MODE_MODBUS_SLAVE_RTU = 2

Fortgeschrittene Funktionen¶

BrickletRS485.setCommunicationLEDConfig(config[, returnCallback][, errorCallback])¶

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die RS485 Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

BrickletRS485.COMMUNICATION_LED_CONFIG_OFF = 0
BrickletRS485.COMMUNICATION_LED_CONFIG_ON = 1
BrickletRS485.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS485.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletRS485.getCommunicationLEDConfig([returnCallback][, errorCallback])¶

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

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

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

Für config:

BrickletRS485.COMMUNICATION_LED_CONFIG_OFF = 0
BrickletRS485.COMMUNICATION_LED_CONFIG_ON = 1
BrickletRS485.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS485.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

BrickletRS485.setErrorLEDConfig(config[, returnCallback][, errorCallback])¶

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

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe CALLBACK_ERROR_COUNT Callback). Wenn diese Funktion danach nochmal mit der "SHOW ERROR"-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

BrickletRS485.ERROR_LED_CONFIG_OFF = 0
BrickletRS485.ERROR_LED_CONFIG_ON = 1
BrickletRS485.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS485.ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletRS485.getErrorLEDConfig([returnCallback][, errorCallback])¶

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

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

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

Für config:

BrickletRS485.ERROR_LED_CONFIG_OFF = 0
BrickletRS485.ERROR_LED_CONFIG_ON = 1
BrickletRS485.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS485.ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletRS485.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 Senden- und Empfangsbuffers. In Summe können 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 Sendenbuffer hält die Daten welche über write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über read() oder CALLBACK_READ Callback an ein Nutzerprogramm übertragen werden konnten.

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

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

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

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

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

BrickletRS485.getModbusCommonErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:

Callback-Parameter:	timeoutErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] checksumErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] frameTooBigErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] illegalFunctionErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] illegalDataAddressErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] illegalDataValueErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1] slaveDeviceFailureErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

timeoutErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
checksumErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
frameTooBigErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
illegalFunctionErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
illegalDataAddressErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
illegalDataValueErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]
slaveDeviceFailureErrorCount – Typ: int, Wertebereich: [0 bis 2³² - 1]

Rückgabe:

undefined

Gibt die aktuelle Fehleranzahl für verschiedene Fehlerarten Modbus-Modus zurück.

Timeout Error Count: Anzahl Timeouts.
Checksum Error Count: Anzahl von Modbus CRC16 Checksummen-Fehlern.
Frame Too Big Error Count: Anzahl von verworfenen Frames auf Grund einer zu großen Frame Größe (maximal 256 Byte).
Illegal Function Error Count: Anzahl der Anfragen von nicht-implementierten oder illegalen Funktionen. Entsprocht Modbus Exception Code 1.
Illegal Data Address Error Count: Anzahl der Anfragen mit ungütiger Adresse. Entspricht Modbus Exception Code 2.
Illegal Data Value Error Count: Anzahl der Anfragen mit ungültigem Datenwert. Entspricht Modbus Exception Code 3.
Slave Device Failure Error Count: Anzahl der nicht-behebaren Fehler eines Slaves. Entspricht Modbus Exception Code 4.

BrickletRS485.modbusSlaveReportException(requestID, exceptionCode[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Modbus Exception auf eine Modbus-Master Anfrage zurückzugeben.

Request ID: Request ID einer Anfrage eines Slaves.
Exception Code: Modbus Exception Code für den Modbus Master.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.modbusSlaveAnswerReadCoilsRequest(requestID, coils[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] coils – Typ: [boolean, ...], Länge: variabel
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Coils: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_READ_COILS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterReadCoils(slaveAddress, startingAddress, count[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 2000]
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 1).

Slave Addresss: Adresse des Modbus-Slave
Starting Address: Nummer der ersten zu lesenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
Count: Anzahl der zu lesenden Coils.

Nach erfolgreichen Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_READ_COILS_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

BrickletRS485.modbusSlaveAnswerReadHoldingRegistersRequest(requestID, holdingRegisters[, returnCallback][, errorCallback])¶

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

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Holding Registers-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Holding Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterReadHoldingRegisters(slaveAddress, startingAddress, count[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 125]
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Holding Register-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 3).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu lesenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Nach erfolgreichem Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück, die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_READ_HOLDING_REGISTERS_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

BrickletRS485.modbusSlaveAnswerWriteSingleCoilRequest(requestID[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Single Coil-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterWriteSingleCoil(slaveAddress, coilAddress, coilValue[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] coilAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] coilValue – Typ: boolean
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine einzelne Coil eines Modbus-Slave zu schreiben (Modbus Funktionscode 5).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Coil Address: Nummer der zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
Coil Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_WRITE_SINGLE_COIL_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

BrickletRS485.modbusSlaveAnswerWriteSingleRegisterRequest(requestID[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Single Register-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterWriteSingleRegister(slaveAddress, registerAddress, registerValue[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] registerAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] registerValue – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um ein einzelnes Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 6).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Register Address: Nummer des zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
Register Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

BrickletRS485.modbusSlaveAnswerWriteMultipleCoilsRequest(requestID[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Multiple Coils-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterWriteMultipleCoils(slaveAddress, startingAddress, coils[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] coils – Typ: [boolean, ...], Länge: variabel
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine mehrere Coils eines Modbus-Slave zu schreiben (Modbus Funktionscode 15).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer der ersten zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_COILS_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

BrickletRS485.modbusSlaveAnswerWriteMultipleRegistersRequest(requestID[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Multiple Register-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterWriteMultipleRegisters(slaveAddress, startingAddress, registers[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] registers – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um ein oder mehrere Holding Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 16).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_REGISTERS_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

BrickletRS485.modbusSlaveAnswerReadDiscreteInputsRequest(requestID, discreteInputs[, returnCallback][, errorCallback])¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] discreteInputs – Typ: [boolean, ...], Länge: variabel
Callback-Parameter:	undefined
Rückgabe:	undefined

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Discrete Inputs: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterReadDiscreteInputs(slaveAddress, startingAddress, count[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 2000]
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 2).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu lesenden Discrete Inputs. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Discrete-Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_READ_DISCRETE_INPUTS_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

BrickletRS485.modbusSlaveAnswerReadInputRegistersRequest(requestID, inputRegisters[, returnCallback][, errorCallback])¶

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

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Input Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbusMasterReadInputRegisters(slaveAddress, startingAddress, count[, returnCallback][, errorCallback])¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [0 bis 247] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 125]
Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 4).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer der ersten zu lesenden Input Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Input-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der CALLBACK_MODBUS_MASTER_READ_INPUT_REGISTERS_RESPONSE Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

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

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

BrickletRS485.STATUS_LED_CONFIG_OFF = 0
BrickletRS485.STATUS_LED_CONFIG_ON = 1
BrickletRS485.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS485.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletRS485.STATUS_LED_CONFIG_OFF = 0
BrickletRS485.STATUS_LED_CONFIG_ON = 1
BrickletRS485.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS485.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

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

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

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

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

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

Callback-Parameter:	undefined
Rückgabe:	undefined

Deaktiviert den CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

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

BrickletRS485.enableErrorCountCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert den CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485.disableErrorCountCallback([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Deaktiviert den CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485.isErrorCountCallbackEnabled([returnCallback][, errorCallback])¶

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

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

BrickletRS485.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.5 (Plugin).

BrickletRS485.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.5 (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:

rs485.on(BrickletRS485.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.

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

BrickletRS485.CALLBACK_ERROR_COUNT¶

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

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

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_COILS_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 2000]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Coils erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der ersten zu lesenden Coil und die Anzahl der zu lesenden Coils. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerReadCoilsRequest() gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_COILS_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten coils – Typ: [boolean, ...], Länge: variabel

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Coils-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per setModbusConfiguration() gesetzt werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für coils ausgelöst.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 125]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Holding Registern erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten zu lesenden Holding Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerReadHoldingRegistersRequest() gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_HOLDING_REGISTERS_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten holdingRegisters – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Holding Registers-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für holdingRegisters ausgelöst.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] coilAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] coilValue – Typ: boolean

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Coil erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der Coil und der Wert der zu schreibenen Coil. Die Nummer der Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerWriteSingleCoilRequest() gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_SINGLE_COIL_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Coil-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] registerAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] registerValue – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Holding Registers erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des Holding Registers und der Wert des zuschreibenen Registers. Die Nummer des Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerWriteSingleRegisterRequest() gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Register-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] coils – Typ: [boolean, ...], Länge: variabel

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Coils erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der ersten Coil und die zu schreibenen Daten. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerWriteMultipleCoilsRequest() gesendet werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für coils ausgelöst.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_COILS_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Coils-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] registers – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Holding Register erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Holding Registers und die zu schreibenen Daten. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerWriteMultipleRegistersRequest() gesendet werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für registers ausgelöst.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_REGISTERS_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Register-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 2000]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Discrete Inputs erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Discrete Inputs und die Anzahl der zu lesenden Discrete Inputs. Die Nummer des ersten Discrete Inputs heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Discrete Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerReadDiscreteInputsRequest() gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_DISCRETE_INPUTS_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten discreteInputs – Typ: [boolean, ...], Länge: variabel

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Discrete Inputs-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für discreteInputs ausgelöst.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: int, Wertebereich: [1 bis 2¹⁶] count – Typ: int, Wertebereich: [1 bis 125]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Input Registern erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Input Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Input Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Input Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion modbusSlaveAnswerReadInputRegistersRequest() gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_INPUT_REGISTERS_RESPONSE¶

Callback-Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] exceptionCode – Typ: int, Wertebereich: Siehe Konstanten inputRegisters – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Input Registers-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für inputRegisters ausgelöst.

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

Für exception_code:

BrickletRS485.EXCEPTION_CODE_TIMEOUT = -1
BrickletRS485.EXCEPTION_CODE_SUCCESS = 0
BrickletRS485.EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
BrickletRS485.EXCEPTION_CODE_ACKNOWLEDGE = 5
BrickletRS485.EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
BrickletRS485.EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
BrickletRS485.EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
BrickletRS485.EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

BrickletRS485.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.5 (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.

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

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

BrickletRS485.FUNCTION_ENABLE_READ_CALLBACK = 3
BrickletRS485.FUNCTION_DISABLE_READ_CALLBACK = 4
BrickletRS485.FUNCTION_SET_RS485_CONFIGURATION = 6
BrickletRS485.FUNCTION_SET_MODBUS_CONFIGURATION = 8
BrickletRS485.FUNCTION_SET_MODE = 10
BrickletRS485.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
BrickletRS485.FUNCTION_SET_ERROR_LED_CONFIG = 14
BrickletRS485.FUNCTION_SET_BUFFER_CONFIG = 16
BrickletRS485.FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
BrickletRS485.FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
BrickletRS485.FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
BrickletRS485.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
BrickletRS485.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRS485.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRS485.FUNCTION_RESET = 243
BrickletRS485.FUNCTION_WRITE_UID = 248

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

BrickletRS485.FUNCTION_ENABLE_READ_CALLBACK = 3
BrickletRS485.FUNCTION_DISABLE_READ_CALLBACK = 4
BrickletRS485.FUNCTION_SET_RS485_CONFIGURATION = 6
BrickletRS485.FUNCTION_SET_MODBUS_CONFIGURATION = 8
BrickletRS485.FUNCTION_SET_MODE = 10
BrickletRS485.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
BrickletRS485.FUNCTION_SET_ERROR_LED_CONFIG = 14
BrickletRS485.FUNCTION_SET_BUFFER_CONFIG = 16
BrickletRS485.FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
BrickletRS485.FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
BrickletRS485.FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
BrickletRS485.FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
BrickletRS485.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
BrickletRS485.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRS485.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRS485.FUNCTION_RESET = 243
BrickletRS485.FUNCTION_WRITE_UID = 248

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

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

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

Für status:

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

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

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

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

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

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

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

BrickletRS485.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS485 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.

BrickletRS485.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.