Software / API Bindings / Java / API Reference and Examples / Bricklets / RS232 Bricklet 2.0

Java - RS232 Bricklet 2.0¶

This is the description of the Java API bindings for the RS232 Bricklet 2.0. General information and technical specifications for the RS232 Bricklet 2.0 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.BrickletRS232V2;

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

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

    // Change XYZ to the UID of your RS232 Bricklet 2.0
    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
        BrickletRS232V2 rs232 = new BrickletRS232V2(UID, ipcon); // Create device object

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

        // Add read listener
        rs232.addReadListener(new BrickletRS232V2.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: \"" + new String(message) + "\"");
            }
        });

        // Enable read callback
        rs232.enableReadCallback();

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

        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 BrickletRS232V2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	rs232V2 – Type: BrickletRS232V2

Creates an object with the unique device ID uid:

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

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

int BrickletRS232V2.write(char[] message)¶

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

Writes characters to the RS232 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 setConfiguration() for configuration possibilities regarding baud rate, parity and so on.

char[] BrickletRS232V2.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 BrickletRS232V2.setConfiguration(long baudrate, int parity, int stopbits, int wordlength, int flowcontrol)¶

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 flowcontrol – Type: int, Range: See constants, Default: 0

Sets the configuration for the RS232 communication.

The following constants are available for this function:

For parity:

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

For stopbits:

BrickletRS232V2.STOPBITS_1 = 1
BrickletRS232V2.STOPBITS_2 = 2

For wordlength:

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

For flowcontrol:

BrickletRS232V2.FLOWCONTROL_OFF = 0
BrickletRS232V2.FLOWCONTROL_SOFTWARE = 1
BrickletRS232V2.FLOWCONTROL_HARDWARE = 2

BrickletRS232V2.Configuration BrickletRS232V2.getConfiguration()¶

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 flowcontrol – Type: int, Range: See constants, Default: 0

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For parity:

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

For stopbits:

BrickletRS232V2.STOPBITS_1 = 1
BrickletRS232V2.STOPBITS_2 = 2

For wordlength:

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

For flowcontrol:

BrickletRS232V2.FLOWCONTROL_OFF = 0
BrickletRS232V2.FLOWCONTROL_SOFTWARE = 1
BrickletRS232V2.FLOWCONTROL_HARDWARE = 2

Advanced Functions¶

void BrickletRS232V2.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 total the buffers have to be 10240 byte (10KiB) in size, the minimum buffer size is 1024 byte (1KiB) for each.

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

The send buffer holds data that is given by write() and can not be written yet. The receive buffer holds data that is received through RS232 but could not yet be send to the user, either by read() or through ReadListener listener.

BrickletRS232V2.BufferConfig BrickletRS232V2.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().

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

BrickletRS232V2.ErrorCount BrickletRS232V2.getErrorCount()¶

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

Returns the current number of overrun and parity errors.

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

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

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

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

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

BrickletRS232V2.Identity BrickletRS232V2.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 BrickletRS232V2.enableReadCallback()¶

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

By default the listener is disabled.

void BrickletRS232V2.disableReadCallback()¶

Disables the ReadListener listener.

By default the listener is disabled.

boolean BrickletRS232V2.isReadCallbackEnabled()¶

Returns:	enabled – Type: boolean, Default: false

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

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

New in version 2.0.3 (Plugin).

int BrickletRS232V2.getFrameReadableCallbackConfiguration()¶

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

Returns the listener configuration as set by setFrameReadableCallbackConfiguration().

New in version 2.0.3 (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 BrickletRS232V2.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 BrickletRS232V2.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 BrickletRS232V2.ErrorCountListener()¶

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

void errorCount(long errorCountOverrun, long errorCountParity)

Parameters:	errorCountOverrun – Type: long, Range: [0 to 2³² - 1] errorCountParity – 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 BrickletRS232V2.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.

New in version 2.0.3 (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[] BrickletRS232V2.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 BrickletRS232V2.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:

BrickletRS232V2.FUNCTION_ENABLE_READ_CALLBACK = 3
BrickletRS232V2.FUNCTION_DISABLE_READ_CALLBACK = 4
BrickletRS232V2.FUNCTION_SET_CONFIGURATION = 6
BrickletRS232V2.FUNCTION_SET_BUFFER_CONFIG = 8
BrickletRS232V2.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
BrickletRS232V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRS232V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRS232V2.FUNCTION_RESET = 243
BrickletRS232V2.FUNCTION_WRITE_UID = 248

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

BrickletRS232V2.FUNCTION_ENABLE_READ_CALLBACK = 3
BrickletRS232V2.FUNCTION_DISABLE_READ_CALLBACK = 4
BrickletRS232V2.FUNCTION_SET_CONFIGURATION = 6
BrickletRS232V2.FUNCTION_SET_BUFFER_CONFIG = 8
BrickletRS232V2.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
BrickletRS232V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRS232V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRS232V2.FUNCTION_RESET = 243
BrickletRS232V2.FUNCTION_WRITE_UID = 248

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

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

For status:

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

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

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

void BrickletRS232V2.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 BrickletRS232V2.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 BrickletRS232V2.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 BrickletRS232V2.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 BrickletRS232V2.DEVICE_IDENTIFIER¶

This constant is used to identify a RS232 Bricklet 2.0.

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 BrickletRS232V2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a RS232 Bricklet 2.0.