Java - RS485 Bricklet¶

This is the description of the Java 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 Java API bindings is part of their general description.

Examples¶

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

Loopback¶

Download (ExampleLoopback.java)

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

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

public class ExampleLoopback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your RS485 Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRS485 rs485 = new 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, BrickletRS485.PARITY_NONE,
                                    BrickletRS485.STOPBITS_1, BrickletRS485.WORDLENGTH_8,
                                    BrickletRS485.DUPLEX_FULL);

        // Add read listener
        rs485.addReadListener(new BrickletRS485.ReadListener() {
            public void read(char[] message) {
                // Assume that the message consists of ASCII characters and
                // convert it from an array of chars to a string
                System.out.println("Message: \"" + String.valueOf(message) + "\"");
            }
        });

        // Enable read callback
        rs485.enableReadCallback();

        // Write "test" string
        rs485.write("test".toCharArray());

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Modbus Master¶

Download (ExampleModbusMaster.java)

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

public class ExampleModbusMaster {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your RS485 Bricklet
    private static final String UID = "XYZ";

    private static int expectedRequestID = 0;

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRS485 rs485 = new 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(BrickletRS485.MODE_MODBUS_MASTER_RTU);

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

        // Add Modbus master write single register response listener
        rs485.addModbusMasterWriteSingleRegisterResponseListener(new BrickletRS485.ModbusMasterWriteSingleRegisterResponseListener() {
            public void modbusMasterWriteSingleRegisterResponse(int requestID,
                                                                int exceptionCode) {
                System.out.println("Request ID: " + requestID);
                System.out.println("Exception Code: " + exceptionCode);

                if (requestID != expectedRequestID) {
                    System.out.println("Error: Unexpected request ID");
                }
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Modbus Slave¶

Download (ExampleModbusSlave.java)

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

public class ExampleModbusSlave {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your RS485 Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        // Note: Declare rs485 as final, so the listener can access it
        final BrickletRS485 rs485 = new 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(BrickletRS485.MODE_MODBUS_SLAVE_RTU);

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

        // Add Modbus slave write single register request listener
        rs485.addModbusSlaveWriteSingleRegisterRequestListener(new BrickletRS485.ModbusSlaveWriteSingleRegisterRequestListener() {
            public void modbusSlaveWriteSingleRegisterRequest(int requestID,
                                                              long registerAddress,
                                                              int registerValue) {
                System.out.println("Request ID: " + requestID);
                System.out.println("Register Address: " + registerAddress);
                System.out.println("Register Value: " + registerValue);

                if (registerAddress != 42) {
                    System.out.println("Error: Invalid register address");

                    try {
                        rs485.modbusSlaveReportException(requestID, BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
                    } catch(TinkerforgeException e) {
                    }
                } else {
                    try {
                        rs485.modbusSlaveAnswerWriteSingleRegisterRequest(requestID);
                    } catch(TinkerforgeException e) {
                    }
                }
            }
        });

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API¶

Generally, every method of the Java 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 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¶

class BrickletRS485(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	rs485 – Type: BrickletRS485

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected.

int BrickletRS485.write(char[] message)¶

Parameters:	message – Type: char[], Length: variable
Returns:	messageWritten – Type: int, Range: [0 to 2¹⁶ - 1]

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.

char[] BrickletRS485.read(int length)¶

Parameters:	length – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	message – Type: char[], Length: variable

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 listener is disabled. See enableReadCallback() and ReadListener listener.

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

Parameters:	baudrate – Type: long, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 parity – Type: int, Range: See constants, Default: 0 stopbits – Type: int, Range: See constants, Default: 1 wordlength – Type: int, Range: See constants, Default: 8 duplex – Type: int, Range: See constants, Default: 0

Sets the configuration for the RS485 communication.

The following constants are available for this function:

For parity:

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

For stopbits:

BrickletRS485.STOPBITS_1 = 1
BrickletRS485.STOPBITS_2 = 2

For wordlength:

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

For duplex:

BrickletRS485.DUPLEX_HALF = 0
BrickletRS485.DUPLEX_FULL = 1

BrickletRS485.RS485Configuration BrickletRS485.getRS485Configuration()¶

Return Object:	baudrate – Type: long, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 parity – Type: int, Range: See constants, Default: 0 stopbits – Type: int, Range: See constants, Default: 1 wordlength – Type: int, Range: See constants, Default: 8 duplex – Type: int, Range: See constants, Default: 0

Returns the configuration as set by setRS485Configuration().

The following constants are available for this function:

For parity:

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

For stopbits:

BrickletRS485.STOPBITS_1 = 1
BrickletRS485.STOPBITS_2 = 2

For wordlength:

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

For duplex:

BrickletRS485.DUPLEX_HALF = 0
BrickletRS485.DUPLEX_FULL = 1

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

Parameters:	slaveAddress – Type: int, Range: [1 to 247], Default: 1 masterRequestTimeout – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 1000

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 when in Modbus master mode.

BrickletRS485.ModbusConfiguration BrickletRS485.getModbusConfiguration()¶

Return Object:	slaveAddress – Type: int, Range: [1 to 247], Default: 1 masterRequestTimeout – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 1000

Returns the configuration as set by setModbusConfiguration().

void BrickletRS485.setMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants, Default: 0

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

RS485,
Modbus Master RTU and
Modbus Slave RTU.

The following constants are available for this function:

For mode:

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

int BrickletRS485.getMode()¶

Returns:	mode – Type: int, Range: See constants, Default: 0

Returns the configuration as set by setMode().

The following constants are available for this function:

For mode:

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

Advanced Functions¶

void BrickletRS485.setCommunicationLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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:

For 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()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setCommunicationLEDConfig()

The following constants are available for this function:

For 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)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the error LED configuration.

By default the error LED turns on if there is any error (see ErrorCountListener 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:

For 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()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setErrorLEDConfig().

The following constants are available for this function:

For 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)¶

Parameters:	sendBufferSize – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120 receiveBufferSize – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120

Sets the send and receive buffer size in byte. In sum there is 10240 byte (10KiB) buffer available and the minimum buffer size is 1024 byte (1KiB) 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 ReadListener listener.

BrickletRS485.BufferConfig BrickletRS485.getBufferConfig()¶

Return Object:	sendBufferSize – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120 receiveBufferSize – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120

Returns the buffer configuration as set by setBufferConfig().

BrickletRS485.BufferStatus BrickletRS485.getBufferStatus()¶

Return Object:	sendBufferUsed – Type: int, Unit: 1 B, Range: [0 to 9216] receiveBufferUsed – Type: int, Unit: 1 B, Range: [0 to 9216]

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

See setBufferConfig() for buffer size configuration.

BrickletRS485.ErrorCount BrickletRS485.getErrorCount()¶

Return Object:	overrunErrorCount – Type: long, Range: [0 to 2³² - 1] parityErrorCount – Type: long, Range: [0 to 2³² - 1]

Returns the current number of overrun and parity errors.

BrickletRS485.ModbusCommonErrorCount BrickletRS485.getModbusCommonErrorCount()¶

Return Object:

Return Object:	timeoutErrorCount – Type: long, Range: [0 to 2³² - 1] checksumErrorCount – Type: long, Range: [0 to 2³² - 1] frameTooBigErrorCount – Type: long, Range: [0 to 2³² - 1] illegalFunctionErrorCount – Type: long, Range: [0 to 2³² - 1] illegalDataAddressErrorCount – Type: long, Range: [0 to 2³² - 1] illegalDataValueErrorCount – Type: long, Range: [0 to 2³² - 1] slaveDeviceFailureErrorCount – Type: long, Range: [0 to 2³² - 1]

timeoutErrorCount – Type: long, Range: [0 to 2³² - 1]
checksumErrorCount – Type: long, Range: [0 to 2³² - 1]
frameTooBigErrorCount – Type: long, Range: [0 to 2³² - 1]
illegalFunctionErrorCount – Type: long, Range: [0 to 2³² - 1]
illegalDataAddressErrorCount – Type: long, Range: [0 to 2³² - 1]
illegalDataValueErrorCount – Type: long, Range: [0 to 2³² - 1]
slaveDeviceFailureErrorCount – Type: long, Range: [0 to 2³² - 1]

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.

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

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants

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:

For 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)¶

Parameters:	requestID – Type: int, Range: [0 to 255] coils – Type: boolean[], Length: variable

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 ModbusSlaveReadCoilsRequestListener listener with the Request ID as provided by the argument of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 2000]
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the first coil to read. For backwards compatibility reasons this parameter is called Starting Address. It is not an address, but instead a coil number in the range of 1 to 65536.
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 ModbusMasterReadCoilsResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

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

Parameters:	requestID – Type: int, Range: [0 to 255] holdingRegisters – Type: int[], Length: variable, Range: [0 to 2¹⁶ - 1]

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 ModbusSlaveReadHoldingRegistersRequestListener listener with the Request ID as provided by the argument of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 125]
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the first holding register to read. For backwards compatibility reasons this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted.
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 ModbusMasterReadHoldingRegistersResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

void BrickletRS485.modbusSlaveAnswerWriteSingleCoilRequest(int requestID)¶

Parameters:	requestID – Type: int, Range: [0 to 255]

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 ModbusSlaveWriteSingleCoilRequestListener listener with the Request ID as provided by the arguments of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] coilAddress – Type: long, Range: [1 to 2¹⁶] coilValue – Type: boolean
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the coil to be written. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a coil number in the range of 1 to 65536.
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 ModbusMasterWriteSingleCoilResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

void BrickletRS485.modbusSlaveAnswerWriteSingleRegisterRequest(int requestID)¶

Parameters:	requestID – Type: int, Range: [0 to 255]

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 ModbusSlaveWriteSingleRegisterRequestListener listener with the Request ID, Register Address and Register Value as provided by the arguments of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] registerAddress – Type: long, Range: [1 to 2¹⁶] registerValue – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	requestID – Type: int, Range: [0 to 255]

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

Slave Address: Address of the target Modbus slave.
Register Address: Number of the holding register to be written. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted.
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 ModbusMasterWriteSingleRegisterResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

void BrickletRS485.modbusSlaveAnswerWriteMultipleCoilsRequest(int requestID)¶

Parameters:	requestID – Type: int, Range: [0 to 255]

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 ModbusSlaveWriteMultipleCoilsRequestListener listener with the Request ID of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] startingAddress – Type: long, Range: [1 to 2¹⁶] coils – Type: boolean[], Length: variable
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the first coil to write. For backwards compatibility reasons, this parameter is called Starting Address.It is not an address, but instead a coil number in the range of 1 to 65536.

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 ModbusMasterWriteMultipleCoilsResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

void BrickletRS485.modbusSlaveAnswerWriteMultipleRegistersRequest(int requestID)¶

Parameters:	requestID – Type: int, Range: [0 to 255]

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 ModbusSlaveWriteMultipleRegistersRequestListener listener with the Request ID of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] startingAddress – Type: long, Range: [1 to 2¹⁶] registers – Type: int[], Length: variable, Range: [0 to 2¹⁶ - 1]
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the first holding register to write. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted.

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 ModbusMasterWriteMultipleRegistersResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

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

Parameters:	requestID – Type: int, Range: [0 to 255] discreteInputs – Type: boolean[], Length: variable

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 ModbusSlaveReadDiscreteInputsRequestListener listener with the Request ID as provided by the argument of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 2000]
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the first discrete input to read. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a discrete input number in the range of 1 to 65536. The prefix digit 1 (for discrete input) is implicit and must be omitted.
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 ModbusMasterReadDiscreteInputsResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

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

Parameters:	requestID – Type: int, Range: [0 to 255] inputRegisters – Type: int[], Length: variable, Range: [0 to 2¹⁶ - 1]

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 ModbusSlaveReadInputRegistersRequestListener listener with the Request ID as provided by the argument of the listener.

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

Parameters:	slaveAddress – Type: int, Range: [0 to 247] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 125]
Returns:	requestID – Type: int, Range: [0 to 255]

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: Number of the first input register to read. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead an input register number in the range of 1 to 65536. The prefix digit 3 (for input register) is implicit and must be omitted.
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 ModbusMasterReadInputRegistersResponseListener callback. In this listener the Request ID provided by the listener argument must be matched with the Request ID returned from this function to verify that the listener is indeed for a particular request.

BrickletRS485.SPITFPErrorCount BrickletRS485.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: long, Range: [0 to 2³² - 1] errorCountFrame – Type: long, Range: [0 to 2³² - 1] errorCountOverflow – Type: long, Range: [0 to 2³² - 1]

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.

void BrickletRS485.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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:

For 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()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For 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()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature 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.

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

BrickletRS485.Identity BrickletRS485.getIdentity()¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: short[], Length: 3

0: major – Type: short, Range: [0 to 255]
1: minor – Type: short, Range: [0 to 255]
2: revision – Type: short, Range: [0 to 255]

firmwareVersion – Type: short[], Length: 3

0: major – Type: short, Range: [0 to 255]
1: minor – Type: short, Range: [0 to 255]
2: revision – Type: short, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Listener Configuration Functions¶

void BrickletRS485.enableReadCallback()¶

Enables the ReadListener listener. This will disable the FrameReadableListener listener.

By default the listener is disabled.

void BrickletRS485.disableReadCallback()¶

Disables the ReadListener listener.

By default the listener is disabled.

boolean BrickletRS485.isReadCallbackEnabled()¶

Returns:	enabled – Type: boolean, Default: false

Returns true if the ReadListener listener is enabled, false otherwise.

void BrickletRS485.enableErrorCountCallback()¶

Enables the ErrorCountListener listener.

By default the listener is disabled.

void BrickletRS485.disableErrorCountCallback()¶

Disables the ErrorCountListener listener.

By default the listener is disabled.

boolean BrickletRS485.isErrorCountCallbackEnabled()¶

Returns:	enabled – Type: boolean, Default: true

Returns true if the ErrorCountListener listener is enabled, false otherwise.

void BrickletRS485.setFrameReadableCallbackConfiguration(int frameSize)¶

Parameters:	frameSize – Type: int, Unit: 1 B, Range: [0 to 9216], Default: 0

Configures the FrameReadableListener listener. The frame size is the number of bytes, that have to be readable to trigger the listener. A frame size of 0 disables the listener. A frame size greater than 0 enables the listener and disables the ReadListener listener.

By default the listener is disabled.

Added in version 2.0.5$nbsp;(Plugin).

int BrickletRS485.getFrameReadableCallbackConfiguration()¶

Returns:	frameSize – Type: int, Unit: 1 B, Range: [0 to 9216], Default: 0

Returns the listener configuration as set by setFrameReadableCallbackConfiguration().

Added in version 2.0.5$nbsp;(Plugin).

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletRS485.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

Note

Using listeners 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.

class BrickletRS485.ReadListener()¶

This listener can be added with the addReadListener() function. An added listener can be removed with the removeReadListener() function.

void read(char[] message)

Parameters:	message – Type: char[], Length: variable

This listener is called if new data is available.

To enable this listener, use enableReadCallback().

Note

If reconstructing the value fails, the listener is triggered with null for message.

class BrickletRS485.ErrorCountListener()¶

This listener can be added with the addErrorCountListener() function. An added listener can be removed with the removeErrorCountListener() function.

void errorCount(long overrunErrorCount, long parityErrorCount)

Parameters:	overrunErrorCount – Type: long, Range: [0 to 2³² - 1] parityErrorCount – Type: long, Range: [0 to 2³² - 1]

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

class BrickletRS485.ModbusSlaveReadCoilsRequestListener()¶

This listener can be added with the addModbusSlaveReadCoilsRequestListener() function. An added listener can be removed with the removeModbusSlaveReadCoilsRequestListener() function.

void modbusSlaveReadCoilsRequest(int requestID, long startingAddress, int count)

Parameters:	requestID – Type: int, Range: [0 to 255] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 2000]

This listener 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 number of the first coil to be read and the number of coils to be read as received by the request. The number of the first coil is called starting address for backwards compatibility reasons. It is not an address, but instead a coil number in the range of 1 to 65536.

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

class BrickletRS485.ModbusMasterReadCoilsResponseListener()¶

This listener can be added with the addModbusMasterReadCoilsResponseListener() function. An added listener can be removed with the removeModbusMasterReadCoilsResponseListener() function.

void modbusMasterReadCoilsResponse(int requestID, int exceptionCode, boolean[] coils)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants coils – Type: boolean[], Length: variable

This listener 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 0 then the number represents a Modbus exception code. If it is less than 0 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().

Note

If reconstructing the value fails, the listener is triggered with null for coils.

The following constants are available for this function:

For 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

class BrickletRS485.ModbusSlaveReadHoldingRegistersRequestListener()¶

This listener can be added with the addModbusSlaveReadHoldingRegistersRequestListener() function. An added listener can be removed with the removeModbusSlaveReadHoldingRegistersRequestListener() function.

void modbusSlaveReadHoldingRegistersRequest(int requestID, long startingAddress, int count)

Parameters:	requestID – Type: int, Range: [0 to 255] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 125]

This listener 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 number of the first holding register to be read and the number of holding registers to be read as received by the request. The number of the first holding register is called starting address for backwards compatibility reasons. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is omitted.

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

class BrickletRS485.ModbusMasterReadHoldingRegistersResponseListener()¶

This listener can be added with the addModbusMasterReadHoldingRegistersResponseListener() function. An added listener can be removed with the removeModbusMasterReadHoldingRegistersResponseListener() function.

void modbusMasterReadHoldingRegistersResponse(int requestID, int exceptionCode, int[] holdingRegisters)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants holdingRegisters – Type: int[], Length: variable, Range: [0 to 2¹⁶ - 1]

This listener 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.

Note

If reconstructing the value fails, the listener is triggered with null for holdingRegisters.

The following constants are available for this function:

For 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

class BrickletRS485.ModbusSlaveWriteSingleCoilRequestListener()¶

This listener can be added with the addModbusSlaveWriteSingleCoilRequestListener() function. An added listener can be removed with the removeModbusSlaveWriteSingleCoilRequestListener() function.

void modbusSlaveWriteSingleCoilRequest(int requestID, long coilAddress, boolean coilValue)

Parameters:	requestID – Type: int, Range: [0 to 255] coilAddress – Type: long, Range: [1 to 2¹⁶] coilValue – Type: boolean

This listener 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 number of the coil and the value of coil to be written as received by the request. The number of the coil is called coil address for backwards compatibility reasons. It is not an address, but instead a coil number in the range of 1 to 65536.

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

class BrickletRS485.ModbusMasterWriteSingleCoilResponseListener()¶

This listener can be added with the addModbusMasterWriteSingleCoilResponseListener() function. An added listener can be removed with the removeModbusMasterWriteSingleCoilResponseListener() function.

void modbusMasterWriteSingleCoilResponse(int requestID, int exceptionCode)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants

This listener 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.

The following constants are available for this function:

For 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

class BrickletRS485.ModbusSlaveWriteSingleRegisterRequestListener()¶

This listener can be added with the addModbusSlaveWriteSingleRegisterRequestListener() function. An added listener can be removed with the removeModbusSlaveWriteSingleRegisterRequestListener() function.

void modbusSlaveWriteSingleRegisterRequest(int requestID, long registerAddress, int registerValue)

Parameters:	requestID – Type: int, Range: [0 to 255] registerAddress – Type: long, Range: [1 to 2¹⁶] registerValue – Type: int, Range: [0 to 2¹⁶ - 1]

This listener is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single holding register. The parameters are request ID of the request, the number of the holding register and the register value to be written as received by the request. The number of the holding register is called starting address for backwards compatibility reasons. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is omitted.

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

class BrickletRS485.ModbusMasterWriteSingleRegisterResponseListener()¶

This listener can be added with the addModbusMasterWriteSingleRegisterResponseListener() function. An added listener can be removed with the removeModbusMasterWriteSingleRegisterResponseListener() function.

void modbusMasterWriteSingleRegisterResponse(int requestID, int exceptionCode)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants

This listener 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.

The following constants are available for this function:

For 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

class BrickletRS485.ModbusSlaveWriteMultipleCoilsRequestListener()¶

This listener can be added with the addModbusSlaveWriteMultipleCoilsRequestListener() function. An added listener can be removed with the removeModbusSlaveWriteMultipleCoilsRequestListener() function.

void modbusSlaveWriteMultipleCoilsRequest(int requestID, long startingAddress, boolean[] coils)

Parameters:	requestID – Type: int, Range: [0 to 255] startingAddress – Type: long, Range: [1 to 2¹⁶] coils – Type: boolean[], Length: variable

This listener 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 number of the first coil and the data to be written as received by the request. The number of the first coil is called starting address for backwards compatibility reasons. It is not an address, but instead a coil number in the range of 1 to 65536.

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

Note

If reconstructing the value fails, the listener is triggered with null for coils.

class BrickletRS485.ModbusMasterWriteMultipleCoilsResponseListener()¶

This listener can be added with the addModbusMasterWriteMultipleCoilsResponseListener() function. An added listener can be removed with the removeModbusMasterWriteMultipleCoilsResponseListener() function.

void modbusMasterWriteMultipleCoilsResponse(int requestID, int exceptionCode)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants

This listener 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 0 then the number represents a Modbus exception code. If it is less than 0 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:

For 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

class BrickletRS485.ModbusSlaveWriteMultipleRegistersRequestListener()¶

This listener can be added with the addModbusSlaveWriteMultipleRegistersRequestListener() function. An added listener can be removed with the removeModbusSlaveWriteMultipleRegistersRequestListener() function.

void modbusSlaveWriteMultipleRegistersRequest(int requestID, long startingAddress, int[] registers)

Parameters:	requestID – Type: int, Range: [0 to 255] startingAddress – Type: long, Range: [1 to 2¹⁶] registers – Type: int[], Length: variable, Range: [0 to 2¹⁶ - 1]

This listener is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple holding registers. The parameters are request ID of the request, the number of the first holding register and the data to be written as received by the request. The number of the first holding register is called starting address for backwards compatibility reasons. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is omitted.

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

Note

If reconstructing the value fails, the listener is triggered with null for registers.

class BrickletRS485.ModbusMasterWriteMultipleRegistersResponseListener()¶

This listener can be added with the addModbusMasterWriteMultipleRegistersResponseListener() function. An added listener can be removed with the removeModbusMasterWriteMultipleRegistersResponseListener() function.

void modbusMasterWriteMultipleRegistersResponse(int requestID, int exceptionCode)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants

This listener 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 0 then the number represents a Modbus exception code. If it is less than 0 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:

For 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

class BrickletRS485.ModbusSlaveReadDiscreteInputsRequestListener()¶

This listener can be added with the addModbusSlaveReadDiscreteInputsRequestListener() function. An added listener can be removed with the removeModbusSlaveReadDiscreteInputsRequestListener() function.

void modbusSlaveReadDiscreteInputsRequest(int requestID, long startingAddress, int count)

Parameters:	requestID – Type: int, Range: [0 to 255] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 2000]

This listener 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 number of the first discrete input and the number of discrete inputs to be read as received by the request. The number of the first discrete input is called starting address for backwards compatibility reasons. It is not an address, but instead a discrete input number in the range of 1 to 65536. The prefix digit 1 (for discrete input) is omitted.

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

class BrickletRS485.ModbusMasterReadDiscreteInputsResponseListener()¶

This listener can be added with the addModbusMasterReadDiscreteInputsResponseListener() function. An added listener can be removed with the removeModbusMasterReadDiscreteInputsResponseListener() function.

void modbusMasterReadDiscreteInputsResponse(int requestID, int exceptionCode, boolean[] discreteInputs)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants discreteInputs – Type: boolean[], Length: variable

This listener 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 0 then the number represents a Modbus exception code. If it is less than 0 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().

Note

If reconstructing the value fails, the listener is triggered with null for discreteInputs.

The following constants are available for this function:

For 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

class BrickletRS485.ModbusSlaveReadInputRegistersRequestListener()¶

This listener can be added with the addModbusSlaveReadInputRegistersRequestListener() function. An added listener can be removed with the removeModbusSlaveReadInputRegistersRequestListener() function.

void modbusSlaveReadInputRegistersRequest(int requestID, long startingAddress, int count)

Parameters:	requestID – Type: int, Range: [0 to 255] startingAddress – Type: long, Range: [1 to 2¹⁶] count – Type: int, Range: [1 to 125]

This listener 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 number of the first input register and the number of input registers to be read as received by the request. The number of the first input register is called starting address for backwards compatibility reasons. It is not an address, but instead a input register number in the range of 1 to 65536. The prefix digit 3 (for input register) is omitted.

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

class BrickletRS485.ModbusMasterReadInputRegistersResponseListener()¶

This listener can be added with the addModbusMasterReadInputRegistersResponseListener() function. An added listener can be removed with the removeModbusMasterReadInputRegistersResponseListener() function.

void modbusMasterReadInputRegistersResponse(int requestID, int exceptionCode, int[] inputRegisters)

Parameters:	requestID – Type: int, Range: [0 to 255] exceptionCode – Type: int, Range: See constants inputRegisters – Type: int[], Length: variable, Range: [0 to 2¹⁶ - 1]

This listener 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 0 then the number represents a Modbus exception code. If it is less than 0 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().

Note

If reconstructing the value fails, the listener is triggered with null for inputRegisters.

The following constants are available for this function:

For 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

class BrickletRS485.FrameReadableListener()¶

This listener can be added with the addFrameReadableListener() function. An added listener can be removed with the removeFrameReadableListener() function.

void frameReadable(int frameCount)

Parameters:	frameCount – Type: int, Range: [0 to 2¹⁶ - 1]

This listener is called if at least one frame of data is readable. The frame size is configured with setFrameReadableCallbackConfiguration(). The frame count parameter is the number of frames that can be read. This listener is triggered only once until read() is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the read() function, every time the listener triggers without checking the frame count parameter.

Added in version 2.0.5$nbsp;(Plugin).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletRS485.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition 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.

boolean BrickletRS485.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

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 listener 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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 listener configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletRS485.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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:

For 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

For 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()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For 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)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 2³² - 1]

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.

int BrickletRS485.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

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.

void BrickletRS485.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 2³² - 1]

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.

long BrickletRS485.readUID()¶

Returns:	uid – Type: long, Range: [0 to 2³² - 1]

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

Constants¶

int BrickletRS485.DEVICE_IDENTIFIER¶

This constant is used to identify a RS485 Bricklet.

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

String BrickletRS485.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a RS485 Bricklet.