Software / API Bindings / MATLAB/Octave / API Referenz und Beispiele / Bricklets / RS485 Bricklet

MATLAB/Octave - RS485 Bricklet¶

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback (MATLAB)¶

Download (matlab_example_loopback.m)

function matlab_example_loopback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRS485;
    import java.lang.String;

    % 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

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

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

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

    % Enable full-duplex mode
    rs485.setRS485Configuration(115200, BrickletRS485.PARITY_NONE, ...
                                BrickletRS485.STOPBITS_1, BrickletRS485.WORDLENGTH_8, ...
                                BrickletRS485.DUPLEX_FULL);

    % Register read callback to function cb_read
    set(rs485, 'ReadCallback', @(h, e) cb_read(e));

    % Enable read callback
    rs485.enableReadCallback();

    % Write "test" string
    rs485.write(String('test').toCharArray());

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

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

Modbus Master (MATLAB)¶

Download (matlab_example_modbus_master.m)

function matlab_example_modbus_master()
    global expected_request_id;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRS485;

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

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

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

    % Set operating mode to Modbus RTU master
    rs485.setMode(BrickletRS485.MODE_MODBUS_MASTER_RTU);

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

    % Register Modbus master write single register response callback to function
    % cb_modbus_master_write_single_register_response
    set(rs485, 'ModbusMasterWriteSingleRegisterResponseCallback',
        @(h, e) cb_modbus_master_write_single_register_response(e));

    % Write 65535 to register 42 of slave 17
    expected_request_id = rs485.modbusMasterWriteSingleRegister(17, 42, 65535);

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

% Callback function for Modbus master write single register response callback
function cb_modbus_master_write_single_register_response(e)
    global expected_request_id;

    fprintf('Request ID: %i\n', e.requestID);
    fprintf('Exception Code: %i\n', e.exceptionCode);

    if e.requestID ~= expected_request_id
        fprintf('Error: Unexpected request ID\n');
    end
end

Modbus Slave (MATLAB)¶

Download (matlab_example_modbus_slave.m)

function matlab_example_modbus_slave()
    global rs485;

    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRS485;

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

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

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

    % Set operating mode to Modbus RTU slave
    rs485.setMode(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 to function
    % cb_modbus_slave_write_single_register_request
    set(rs485, 'ModbusSlaveWriteSingleRegisterRequestCallback',
        @(h, e) cb_modbus_slave_write_single_register_request(e));

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

% Callback function for Modbus slave write single register request callback
function cb_modbus_slave_write_single_register_request(e)
    global rs485;

    fprintf('Request ID: %i\n', e.requestID);
    fprintf('Register Address: %i\n', e.registerAddress);
    fprintf('Register Value: %i\n', e.registerValue);

    if e.registerAddress ~= 42
        fprintf('Error: Invalid register address\n');
        rs485.modbusSlaveReportException(e.requestID, com.tinkerforge.BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
    else
        rs485.modbusSlaveAnswerWriteSingleRegisterRequest(e.requestID);
    end
end

Modbus Master (Octave)¶

Download (octave_example_modbus_master.m)

function octave_example_modbus_master()
    more off;
    global expected_request_id;

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

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

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

    % Set operating mode to Modbus RTU master
    rs485.setMode(rs485.MODE_MODBUS_MASTER_RTU);

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

    % Register Modbus master write single register response callback to function
    % cb_modbus_master_write_single_register_response
    rs485.addModbusMasterWriteSingleRegisterResponseCallback(@cb_modbus_master_write_single_register_response);

    % Write 65535 to register 42 of slave 17
    expected_request_id = rs485.modbusMasterWriteSingleRegister(17, 42, 65535);

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

% Callback function for Modbus master write single register response callback
function cb_modbus_master_write_single_register_response(e)
    global expected_request_id;

    fprintf("Request ID: %d\n", e.requestID);
    fprintf("Exception Code: %d\n", e.exceptionCode);

    if e.requestID ~= expected_request_id
        fprintf("Error: Unexpected request ID\n");
    end
end

Modbus Slave (Octave)¶

Download (octave_example_modbus_slave.m)

function octave_example_modbus_slave()
    more off;
    global rs485;

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

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

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

    % Set operating mode to Modbus RTU slave
    rs485.setMode(rs485.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 to function
    % cb_modbus_slave_write_single_register_request
    rs485.addModbusSlaveWriteSingleRegisterRequestCallback(@cb_modbus_slave_write_single_register_request);

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

% Callback function for Modbus slave write single register request callback
function cb_modbus_slave_write_single_register_request(e)
    global rs485;

    fprintf("Request ID: %d\n", e.requestID);
    fprintf("Register Address: %d\n", java2int(e.registerAddress));
    fprintf("Register Value: %d\n", e.registerValue);

    if e.registerAddress ~= 42
        fprintf("Error: Invalid register address\n");
        rs485.modbusSlaveReportException(e.requestID, rs485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
    else
        rs485.modbusSlaveAnswerWriteSingleRegisterRequest(e.requestID);
    end
end

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

Loopback (Octave)¶

Download (octave_example_loopback.m)

function octave_example_loopback()
    more off;

    % 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

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

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

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

    % Enable full-duplex mode
    rs485.setRS485Configuration(115200, rs485.PARITY_NONE, rs485.STOPBITS_1, ...
                                rs485.WORDLENGTH_8, rs485.DUPLEX_FULL);

    % Register read callback to function cb_read
    rs485.addReadCallback(@cb_read);

    % Enable read callback
    rs485.enableReadCallback();

    % Write "test" string
    rs485.write(string2chars("test"));

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

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

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

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

% Assume that the message consists of ASCII characters and
% convert it from an array of chars to a string
function string = chars2string(chars)
    string = "";

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

API¶

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen¶

class BrickletRS485(String uid, IPConnection ipcon)¶

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

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

In MATLAB:

import com.tinkerforge.BrickletRS485;

rs485 = BrickletRS485("YOUR_DEVICE_UID", ipcon);

In Octave:

rs485 = java_new("com.tinkerforge.BrickletRS485", "YOUR_DEVICE_UID", ipcon);

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

int BrickletRS485.write(char[] message)¶

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

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.

char[] BrickletRS485.read(int length)¶

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

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nich aktiv ist. Siehe enableReadCallback() und ReadCallback Callback.

void BrickletRS485.setRS485Configuration(long baudrate, int parity, int stopbits, int wordlength, int duplex)¶

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

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.RS485Configuration BrickletRS485.getRS485Configuration()¶

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

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

void BrickletRS485.setModbusConfiguration(int slaveAddress, long masterRequestTimeout)¶

Parameter:	slaveAddress – Typ: int, Wertebereich: [1 bis 247], Standardwert: 1 masterRequestTimeout – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000

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.ModbusConfiguration BrickletRS485.getModbusConfiguration()¶

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

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

void BrickletRS485.setMode(int mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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

int BrickletRS485.getMode()¶

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

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¶

void BrickletRS485.setCommunicationLEDConfig(int config)¶

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

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

int BrickletRS485.getCommunicationLEDConfig()¶

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

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

void BrickletRS485.setErrorLEDConfig(int config)¶

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

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe ErrorCountCallback 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

int BrickletRS485.getErrorLEDConfig()¶

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

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

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

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

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

BrickletRS485.BufferConfig BrickletRS485.getBufferConfig()¶

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

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

BrickletRS485.BufferStatus BrickletRS485.getBufferStatus()¶

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

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

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

BrickletRS485.ErrorCount BrickletRS485.getErrorCount()¶

Rückgabeobjekt:	overrunErrorCount – Typ: long, Wertebereich: [0 bis 2³² - 1] parityErrorCount – Typ: long, Wertebereich: [0 bis 2³² - 1]

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

BrickletRS485.ModbusCommonErrorCount BrickletRS485.getModbusCommonErrorCount()¶

Rückgabeobjekt:

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

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

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.

void BrickletRS485.modbusSlaveReportException(int requestID, int exceptionCode)¶

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

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

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

void BrickletRS485.modbusSlaveAnswerReadCoilsRequest(int requestID, boolean[] coils)¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] coils – Typ: boolean[], Länge: variabel

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 ModbusSlaveReadCoilsRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterReadCoils(int slaveAddress, long startingAddress, int count)¶

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

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

void BrickletRS485.modbusSlaveAnswerReadHoldingRegistersRequest(int requestID, int[] holdingRegisters)¶

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

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 ModbusSlaveReadHoldingRegistersRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterReadHoldingRegisters(int slaveAddress, long startingAddress, int count)¶

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

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

void BrickletRS485.modbusSlaveAnswerWriteSingleCoilRequest(int requestID)¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]

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 ModbusSlaveWriteSingleCoilRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterWriteSingleCoil(int slaveAddress, long coilAddress, boolean coilValue)¶

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

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

void BrickletRS485.modbusSlaveAnswerWriteSingleRegisterRequest(int requestID)¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]

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 ModbusSlaveWriteSingleRegisterRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterWriteSingleRegister(int slaveAddress, long registerAddress, int registerValue)¶

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

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

void BrickletRS485.modbusSlaveAnswerWriteMultipleCoilsRequest(int requestID)¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]

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 ModbusSlaveWriteMultipleCoilsRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterWriteMultipleCoils(int slaveAddress, long startingAddress, boolean[] coils)¶

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

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

void BrickletRS485.modbusSlaveAnswerWriteMultipleRegistersRequest(int requestID)¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255]

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 ModbusSlaveWriteMultipleRegistersRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterWriteMultipleRegisters(int slaveAddress, long startingAddress, int[] registers)¶

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

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

void BrickletRS485.modbusSlaveAnswerReadDiscreteInputsRequest(int requestID, boolean[] discreteInputs)¶

Parameter:	requestID – Typ: int, Wertebereich: [0 bis 255] discreteInputs – Typ: boolean[], Länge: variabel

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 ModbusSlaveReadDiscreteInputsRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterReadDiscreteInputs(int slaveAddress, long startingAddress, int count)¶

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

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

void BrickletRS485.modbusSlaveAnswerReadInputRegistersRequest(int requestID, int[] inputRegisters)¶

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

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 ModbusSlaveReadInputRegistersRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

int BrickletRS485.modbusMasterReadInputRegisters(int slaveAddress, long startingAddress, int count)¶

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

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 ModbusMasterReadInputRegistersResponseCallback 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.SPITFPErrorCount BrickletRS485.getSPITFPErrorCount()¶

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

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

Die Fehler sind aufgeteilt in

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

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

void BrickletRS485.setStatusLEDConfig(int config)¶

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

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

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

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

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

Für config:

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

int BrickletRS485.getStatusLEDConfig()¶

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

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

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

Für config:

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

int BrickletRS485.getChipTemperature()¶

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

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletRS485.reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletRS485.Identity BrickletRS485.getIdentity()¶

Rückgabeobjekt:

Rückgabeobjekt:	uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

uid – Typ: String, Länge: bis zu 8
connectedUid – Typ: String, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
hardwareVersion – Typ: short[], Länge: 3

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

firmwareVersion – Typ: short[], Länge: 3

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

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

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletRS485.enableReadCallback()¶

Aktiviert den ReadCallback Callback. Dies deaktiviert den FrameReadableCallback Callback.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS485.disableReadCallback()¶

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

boolean BrickletRS485.isReadCallbackEnabled()¶

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

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

void BrickletRS485.enableErrorCountCallback()¶

Aktiviert den ErrorCountCallback Callback.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS485.disableErrorCountCallback()¶

Deaktiviert den ErrorCountCallback Callback.

Im Startzustand ist der Callback deaktiviert.

boolean BrickletRS485.isErrorCountCallbackEnabled()¶

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

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

void BrickletRS485.setFrameReadableCallbackConfiguration(int frameSize)¶

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

Konfiguriert den FrameReadableCallback Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst. Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5 (Plugin).

int BrickletRS485.getFrameReadableCallbackConfiguration()¶

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

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

Neu in Version 2.0.5 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb beschrieben.

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.

callback BrickletRS485.ReadCallback¶

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

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch enableReadCallback() aktiviert werden.

Bemerkung

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

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

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

callback BrickletRS485.ErrorCountCallback¶

Event-Objekt:	overrunErrorCount – Typ: long, Wertebereich: [0 bis 2³² - 1] parityErrorCount – Typ: long, 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.

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

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

callback BrickletRS485.ModbusSlaveReadCoilsRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterReadCoilsResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveReadHoldingRegistersRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterReadHoldingRegistersResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveWriteSingleCoilRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] coilAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterWriteSingleCoilResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveWriteSingleRegisterRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] registerAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterWriteSingleRegisterResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveWriteMultipleCoilsRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterWriteMultipleCoilsResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveWriteMultipleRegistersRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterWriteMultipleRegistersResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveReadDiscreteInputsRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterReadDiscreteInputsResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.ModbusSlaveReadInputRegistersRequestCallback¶

Event-Objekt:	requestID – Typ: int, Wertebereich: [0 bis 255] startingAddress – Typ: long, 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.

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

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

callback BrickletRS485.ModbusMasterReadInputRegistersResponseCallback¶

Event-Objekt:	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 exceptionCode:

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

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

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

callback BrickletRS485.FrameReadableCallback¶

Event-Objekt:	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).

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

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

short[] BrickletRS485.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

boolean BrickletRS485.getResponseExpected(byte functionId)¶

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

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

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

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

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

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

Für functionId:

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

void BrickletRS485.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int BrickletRS485.setBootloaderMode(int mode)¶

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

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

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

int BrickletRS485.getBootloaderMode()¶

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

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

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

Für mode:

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

void BrickletRS485.setWriteFirmwarePointer(long pointer)¶

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

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletRS485.writeFirmware(int[] data)¶

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

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletRS485.writeUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 2³² - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

long BrickletRS485.readUID()¶

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

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

Konstanten¶

int BrickletRS485.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

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

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