MATLAB/Octave - RS485 Bricklet

This is the description of the MATLAB/Octave API bindings for the RS485 Bricklet. General information and technical specifications for the RS485 Bricklet are summarized in its hardware description.

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Loopback (MATLAB)

Download (matlab_example_loopback.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

public class BrickletRS485(String uid, IPConnection ipcon)

Creates an object with the unique device 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);

This object can then be used after the IP Connection is connected (see examples above).

public int write(char[] message)

Writes characters to the RS485 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See setRS485Configuration() for configuration possibilities regarding baudrate, parity and so on.

public char[] read(int length)

Returns up to length characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See enableReadCallback() and ReadCallback callback.

public void setRS485Configuration(long baudrate, int parity, int stopbits, int wordlength, int duplex)

Sets the configuration for the RS485 communication. Available options:

  • Baudrate between 100 and 2000000 baud.
  • Parity of none, odd or even.
  • Stopbits can be 1 or 2.
  • Word length of 5 to 8.
  • Half- or Full-Duplex.

The default is: 115200 baud, parity none, 1 stop bit, word length 8, half duplex.

The following constants are available for this function:

  • BrickletRS485.PARITY_NONE = 0
  • BrickletRS485.PARITY_ODD = 1
  • BrickletRS485.PARITY_EVEN = 2
  • BrickletRS485.STOPBITS_1 = 1
  • BrickletRS485.STOPBITS_2 = 2
  • BrickletRS485.WORDLENGTH_5 = 5
  • BrickletRS485.WORDLENGTH_6 = 6
  • BrickletRS485.WORDLENGTH_7 = 7
  • BrickletRS485.WORDLENGTH_8 = 8
  • BrickletRS485.DUPLEX_HALF = 0
  • BrickletRS485.DUPLEX_FULL = 1
public BrickletRS485.RS485Configuration getRS485Configuration()

Returns the configuration as set by setRS485Configuration().

The following constants are available for this function:

  • BrickletRS485.PARITY_NONE = 0
  • BrickletRS485.PARITY_ODD = 1
  • BrickletRS485.PARITY_EVEN = 2
  • BrickletRS485.STOPBITS_1 = 1
  • BrickletRS485.STOPBITS_2 = 2
  • BrickletRS485.WORDLENGTH_5 = 5
  • BrickletRS485.WORDLENGTH_6 = 6
  • BrickletRS485.WORDLENGTH_7 = 7
  • BrickletRS485.WORDLENGTH_8 = 8
  • BrickletRS485.DUPLEX_HALF = 0
  • BrickletRS485.DUPLEX_FULL = 1

The returned object has the public member variables long baudrate, int parity, int stopbits, int wordlength and int duplex.

public void setModbusConfiguration(int slaveAddress, long masterRequestTimeout)

Sets the configuration for the RS485 Modbus communication. Available options:

  • Slave Address: Address to be used as the Modbus slave address in Modbus slave mode. Valid Modbus slave address range is 1 to 247.
  • Master Request Timeout: Specifies how long the master should wait for a response from a slave in milliseconds when in Modbus master mode.

The default is: Slave Address = 1 and Master Request Timeout = 1000 milliseconds (1 second).

public BrickletRS485.ModbusConfiguration getModbusConfiguration()

Returns the configuration as set by setModbusConfiguration().

The returned object has the public member variables int slaveAddress and long masterRequestTimeout.

public void setMode(int mode)

Sets the mode of the Bricklet in which it operates. Available options are

  • RS485,
  • Modbus Master RTU and
  • Modbus Slave RTU.

The default is: RS485 mode.

The following constants are available for this function:

  • BrickletRS485.MODE_RS485 = 0
  • BrickletRS485.MODE_MODBUS_MASTER_RTU = 1
  • BrickletRS485.MODE_MODBUS_SLAVE_RTU = 2
public int getMode()

Returns the configuration as set by setMode().

The following constants are available for this function:

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

Advanced Functions

public void setCommunicationLEDConfig(int config)

Sets the communication LED configuration. By default the LED shows RS485 communication traffic by flickering.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • 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
public int getCommunicationLEDConfig()

Returns the configuration as set by setCommunicationLEDConfig()

The following constants are available for this function:

  • 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
public void setErrorLEDConfig(int config)

Sets the error LED configuration.

By default the error LED turns on if there is any error (see ErrorCountCallback callback). If you call this function with the SHOW ERROR option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • 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
public int getErrorLEDConfig()

Returns the configuration as set by setErrorLEDConfig().

The following constants are available for this function:

  • 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
public void setBufferConfig(int sendBufferSize, int receiveBufferSize)

Sets the send and receive buffer size in byte. In sum there is 10240 byte (10kb) buffer available and the minimum buffer size is 1024 byte (1kb) for both.

The current buffer content is lost if this function is called.

The send buffer holds data that was given by write() and could not be written yet. The receive buffer holds data that is received through RS485 but could not yet be send to the user, either by read() or through ReadCallback callback.

The default configuration is 5120 byte (5kb) per buffer.

public BrickletRS485.BufferConfig getBufferConfig()

Returns the buffer configuration as set by setBufferConfig().

The returned object has the public member variables int sendBufferSize and int receiveBufferSize.

public BrickletRS485.BufferStatus getBufferStatus()

Returns the currently used bytes for the send and received buffer.

See setBufferConfig() for buffer size configuration.

The returned object has the public member variables int sendBufferUsed and int receiveBufferUsed.

public BrickletRS485.ErrorCount getErrorCount()

Returns the current number of overrun and parity errors.

The returned object has the public member variables long overrunErrorCount and long parityErrorCount.

public BrickletRS485.ModbusCommonErrorCount getModbusCommonErrorCount()

Returns the current number of errors occurred in Modbus mode.

  • Timeout Error Count: Number of timeouts occurred.
  • Checksum Error Count: Number of failures due to Modbus frame CRC16 checksum mismatch.
  • Frame Too Big Error Count: Number of times frames were rejected because they exceeded maximum Modbus frame size which is 256 bytes.
  • Illegal Function Error Count: Number of errors when an unimplemented or illegal function is requested. This corresponds to Modbus exception code 1.
  • Illegal Data Address Error Count: Number of errors due to invalid data address. This corresponds to Modbus exception code 2.
  • Illegal Data Value Error Count: Number of errors due to invalid data value. This corresponds to Modbus exception code 3.
  • Slave Device Failure Error Count: Number of errors occurred on the slave device which were unrecoverable. This corresponds to Modbus exception code 4.

The returned object has the public member variables long timeoutErrorCount, long checksumErrorCount, long frameTooBigErrorCount, long illegalFunctionErrorCount, long illegalDataAddressErrorCount, long illegalDataValueErrorCount and long slaveDeviceFailureErrorCount.

public void modbusSlaveReportException(int requestID, int exceptionCode)

In Modbus slave mode this function can be used to report a Modbus exception for a Modbus master request.

  • Request ID: Request ID of the request received by the slave.
  • Exception Code: Modbus exception code to report to the Modbus master.

The following constants are available for this function:

  • 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
public void modbusSlaveAnswerReadCoilsRequest(int requestID, boolean[] coils)

In Modbus slave mode this function can be used to answer a master request to read coils.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Coils: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadCoilsRequestCallback callback with the Request ID as provided by the argument of the callback.

public int modbusMasterReadCoils(int slaveAddress, long startingAddress, int count)

In Modbus master mode this function can be used to read coils from a slave. This function creates a Modbus function code 1 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of coils to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerReadHoldingRegistersRequest(int requestID, int[] holdingRegisters)

In Modbus slave mode this function can be used to answer a master request to read holding registers.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Holding Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadHoldingRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

public int modbusMasterReadHoldingRegisters(int slaveAddress, long startingAddress, int count)

In Modbus master mode this function can be used to read holding registers from a slave. This function creates a Modbus function code 3 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of holding registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadHoldingRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerWriteSingleCoilRequest(int requestID)

In Modbus slave mode this function can be used to answer a master request to write a single coil.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteSingleCoilRequestCallback callback with the Request ID as provided by the arguments of the callback.

public int modbusMasterWriteSingleCoil(int slaveAddress, long coilAddress, boolean coilValue)

In Modbus master mode this function can be used to write a single coil of a slave. This function creates a Modbus function code 5 request.

  • Slave Address: Address of the target Modbus slave.
  • Coil Address: Address of the coil.
  • Coil Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteSingleCoilResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerWriteSingleRegisterRequest(int requestID)

In Modbus slave mode this function can be used to answer a master request to write a single register.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteSingleRegisterRequestCallback callback with the Request ID, Register Address and Register Value as provided by the arguments of the callback.

public int modbusMasterWriteSingleRegister(int slaveAddress, long registerAddress, int registerValue)

In Modbus master mode this function can be used to write a single register of a slave. This function creates a Modbus function code 6 request.

  • Slave Address: Address of the target Modbus slave.
  • Register Address: Address of the register.
  • Register Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteSingleRegisterResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerWriteMultipleCoilsRequest(int requestID)

In Modbus slave mode this function can be used to answer a master request to write multiple coils.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteMultipleCoilsRequestCallback callback with the Request ID of the callback.

public int modbusMasterWriteMultipleCoils(int slaveAddress, long startingAddress, boolean[] coils)

In Modbus master mode this function can be used to write multiple coils of a slave. This function creates a Modbus function code 15 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the write.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteMultipleCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerWriteMultipleRegistersRequest(int requestID)

In Modbus slave mode this function can be used to answer a master request to write multiple registers.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteMultipleRegistersRequestCallback callback with the Request ID of the callback.

public int modbusMasterWriteMultipleRegisters(int slaveAddress, long startingAddress, int[] registers)

In Modbus master mode this function can be used to write multiple registers of a slave. This function creates a Modbus function code 16 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting Address of the write.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteMultipleRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerReadDiscreteInputsRequest(int requestID, boolean[] discreteInputs)

In Modbus slave mode this function can be used to answer a master request to read discrete inputs.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Discrete Inputs: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadDiscreteInputsRequestCallback callback with the Request ID as provided by the argument of the callback.

public int modbusMasterReadDiscreteInputs(int slaveAddress, long startingAddress, int count)

In Modbus master mode this function can be used to read discrete inputs from a slave. This function creates a Modbus function code 2 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of discrete inputs to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadDiscreteInputsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public void modbusSlaveAnswerReadInputRegistersRequest(int requestID, int[] inputRegisters)

In Modbus slave mode this function can be used to answer a master request to read input registers.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Input Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadInputRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

public int modbusMasterReadInputRegisters(int slaveAddress, long startingAddress, int count)

In Modbus master mode this function can be used to read input registers from a slave. This function creates a Modbus function code 4 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of input registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadInputRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

public int[] getAPIVersion()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

public boolean getResponseExpected(int functionId)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

public void setResponseExpected(int functionId, boolean responseExpected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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_WRITE_FIRMWARE_POINTER = 237
  • BrickletRS485.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRS485.FUNCTION_RESET = 243
  • BrickletRS485.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

public BrickletRS485.SPITFPErrorCount getSPITFPErrorCount()

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

The returned object has the public member variables long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public int setBootloaderMode(int mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • 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.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
public int getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • 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
public void setWriteFirmwarePointer(long pointer)

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

public int writeFirmware(int[] data)

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

public void setStatusLEDConfig(int config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • 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
public int getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • 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
public int getChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

public void reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

public void writeUID(long uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

public long readUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

public BrickletRS485.Identity getIdentity()

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned object has the public member variables String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion and int deviceIdentifier.

Callback Configuration Functions

public void enableReadCallback()

Enables the ReadCallback callback.

By default the callback is disabled.

public void disableReadCallback()

Disables the ReadCallback callback.

By default the callback is disabled.

public boolean isReadCallbackEnabled()

Returns true if the ReadCallback callback is enabled, false otherwise.

public void enableErrorCountCallback()

Enables the ErrorCountCallback callback.

By default the callback is disabled.

public void disableErrorCountCallback()

Disables the ErrorCountCallback callback.

By default the callback is disabled.

public boolean isErrorCountCallbackEnabled()

Returns true if the ErrorCountCallback callback is enabled, false otherwise.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

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

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

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

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

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

public callback BrickletRS485.ReadCallback
Parameters:message -- char[]

This callback is called if new data is available.

To enable this callback, use enableReadCallback().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addReadCallback() function. An added callback function can be removed with the removeReadCallback() function.

public callback BrickletRS485.ErrorCountCallback
Parameters:
  • overrunErrorCount -- long
  • parityErrorCount -- long

This callback is called if a new error occurs. It returns the current overrun and parity error count.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addErrorCountCallback() function. An added callback function can be removed with the removeErrorCountCallback() function.

public callback BrickletRS485.ModbusSlaveReadCoilsRequestCallback
Parameters:
  • requestID -- int
  • startingAddress -- long
  • count -- int

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read coils. The parameters are request ID of the request, the starting address and the number of coils to be read as received by the request.

To send a response of this request use modbusSlaveAnswerReadCoilsRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveReadCoilsRequestCallback() function. An added callback function can be removed with the removeModbusSlaveReadCoilsRequestCallback() function.

public callback BrickletRS485.ModbusMasterReadCoilsResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int
  • coils -- boolean[]

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterReadCoilsResponseCallback() function. An added callback function can be removed with the removeModbusMasterReadCoilsResponseCallback() function.

public callback BrickletRS485.ModbusSlaveReadHoldingRegistersRequestCallback
Parameters:
  • requestID -- int
  • startingAddress -- long
  • count -- int

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read holding registers. The parameters are request ID of the request, the starting address and the number of holding registers to be read as received by the request.

To send a response of this request use modbusSlaveAnswerReadHoldingRegistersRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveReadHoldingRegistersRequestCallback() function. An added callback function can be removed with the removeModbusSlaveReadHoldingRegistersRequestCallback() function.

public callback BrickletRS485.ModbusMasterReadHoldingRegistersResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int
  • holdingRegisters -- int[]

This callback is called only in Modbus master mode when the master receives a valid response of a request to read holding registers.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterReadHoldingRegistersResponseCallback() function. An added callback function can be removed with the removeModbusMasterReadHoldingRegistersResponseCallback() function.

public callback BrickletRS485.ModbusSlaveWriteSingleCoilRequestCallback
Parameters:
  • requestID -- int
  • coilAddress -- long
  • coilValue -- boolean

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single coil. The parameters are request ID of the request, the coil address and the value of coil to be written as received by the request.

To send a response of this request use modbusSlaveAnswerWriteSingleCoilRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveWriteSingleCoilRequestCallback() function. An added callback function can be removed with the removeModbusSlaveWriteSingleCoilRequestCallback() function.

public callback BrickletRS485.ModbusMasterWriteSingleCoilResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single coil.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterWriteSingleCoilResponseCallback() function. An added callback function can be removed with the removeModbusMasterWriteSingleCoilResponseCallback() function.

public callback BrickletRS485.ModbusSlaveWriteSingleRegisterRequestCallback
Parameters:
  • requestID -- int
  • registerAddress -- long
  • registerValue -- int

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single register. The parameters are request ID of the request, the register address and the register value to be written as received by the request.

To send a response of this request use modbusSlaveAnswerWriteSingleRegisterRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveWriteSingleRegisterRequestCallback() function. An added callback function can be removed with the removeModbusSlaveWriteSingleRegisterRequestCallback() function.

public callback BrickletRS485.ModbusMasterWriteSingleRegisterResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single register.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterWriteSingleRegisterResponseCallback() function. An added callback function can be removed with the removeModbusMasterWriteSingleRegisterResponseCallback() function.

public callback BrickletRS485.ModbusSlaveWriteMultipleCoilsRequestCallback
Parameters:
  • requestID -- int
  • startingAddress -- long
  • coils -- boolean[]

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple coils. The parameters are request ID of the request, the starting address and the data to be written as received by the request.

To send a response of this request use modbusSlaveAnswerWriteMultipleCoilsRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveWriteMultipleCoilsRequestCallback() function. An added callback function can be removed with the removeModbusSlaveWriteMultipleCoilsRequestCallback() function.

public callback BrickletRS485.ModbusMasterWriteMultipleCoilsResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterWriteMultipleCoilsResponseCallback() function. An added callback function can be removed with the removeModbusMasterWriteMultipleCoilsResponseCallback() function.

public callback BrickletRS485.ModbusSlaveWriteMultipleRegistersRequestCallback
Parameters:
  • requestID -- int
  • startingAddress -- long
  • registers -- int[]

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple registers. The parameters are request ID of the request, the starting address and the data to be written as received by the request.

To send a response of this request use modbusSlaveAnswerWriteMultipleRegistersRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveWriteMultipleRegistersRequestCallback() function. An added callback function can be removed with the removeModbusSlaveWriteMultipleRegistersRequestCallback() function.

public callback BrickletRS485.ModbusMasterWriteMultipleRegistersResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int

This callback is called only in Modbus master mode when the master receives a valid response of a request to write multiple registers.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterWriteMultipleRegistersResponseCallback() function. An added callback function can be removed with the removeModbusMasterWriteMultipleRegistersResponseCallback() function.

public callback BrickletRS485.ModbusSlaveReadDiscreteInputsRequestCallback
Parameters:
  • requestID -- int
  • startingAddress -- long
  • count -- int

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read discrete inputs. The parameters are request ID of the request, the starting address and the number of discrete inputs to be read as received by the request.

To send a response of this request use modbusSlaveAnswerReadDiscreteInputsRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveReadDiscreteInputsRequestCallback() function. An added callback function can be removed with the removeModbusSlaveReadDiscreteInputsRequestCallback() function.

public callback BrickletRS485.ModbusMasterReadDiscreteInputsResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int
  • discreteInputs -- boolean[]

This callback is called only in Modbus master mode when the master receives a valid response of a request to read discrete inputs.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterReadDiscreteInputsResponseCallback() function. An added callback function can be removed with the removeModbusMasterReadDiscreteInputsResponseCallback() function.

public callback BrickletRS485.ModbusSlaveReadInputRegistersRequestCallback
Parameters:
  • requestID -- int
  • startingAddress -- long
  • count -- int

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read input registers. The parameters are request ID of the request, the starting address and the number of input registers to be read as received by the request.

To send a response of this request use modbusSlaveAnswerReadInputRegistersRequest().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusSlaveReadInputRegistersRequestCallback() function. An added callback function can be removed with the removeModbusSlaveReadInputRegistersRequestCallback() function.

public callback BrickletRS485.ModbusMasterReadInputRegistersResponseCallback
Parameters:
  • requestID -- int
  • exceptionCode -- int
  • inputRegisters -- int[]

This callback is called only in Modbus master mode when the master receives a valid response of a request to read input registers.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by setModbusConfiguration().

The following constants are available for this function:

  • 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 the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addModbusMasterReadInputRegistersResponseCallback() function. An added callback function can be removed with the removeModbusMasterReadInputRegistersResponseCallback() function.

Constants

public static final int BrickletRS485.DEVICE_IDENTIFIER

This constant is used to identify a RS485 Bricklet.

The getIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

public static final String BrickletRS485.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a RS485 Bricklet.