Java - RS232 Bricklet¶

Loopback¶

Download (ExampleLoopback.java)

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

import java.util.Arrays;
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletRS232;

// 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
    private static final String UID = "XYZ";

    // Convert string to array of length 60 as needed by write
    public static char[] stringToCharArray(String message) {
        return Arrays.copyOf(message.toCharArray(), 60);
    }

    // Assume that the message consists of ASCII characters and
    // convert it from an array of chars to a string
    public static String charArrayToString(char[] message, short length) {
        return new String(message, 0, length);
    }

    // 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
        BrickletRS232 rs232 = new BrickletRS232(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 BrickletRS232.ReadListener() {
            public void read(char[] message, short length) {
                String str = charArrayToString(message, length);
                System.out.println("Message (Length: " + length + "): \"" + str + "\"");
            }
        });

        // Enable read callback
        rs232.enableReadCallback();

        // Write "test" string
        rs232.write(stringToCharArray("test"), (short)4);

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

Basic Functions¶

class BrickletRS232(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	rs232 – Type: BrickletRS232

Creates an object with the unique device ID uid:

BrickletRS232 rs232 = new BrickletRS232("YOUR_DEVICE_UID", ipcon);

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

short BrickletRS232.write(char[] message, short length)¶

Parameters:	message – Type: char[], Length: 60 length – Type: short, Range: [0 to 60]
Returns:	written – Type: short, Range: [0 to 60]

Writes a string of up to 60 characters to the RS232 interface. The string can be binary data, ASCII or similar is not necessary.

The length of the string has to be given as an additional parameter.

The return value is the number of bytes that could be written.

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

BrickletRS232.Read BrickletRS232.read()¶

Return Object:	message – Type: char[], Length: 60 length – Type: short, Range: [0 to 60]

Returns the currently buffered message. The maximum length of message is 60. If the returned length is 0, no new data was available.

Instead of polling with this function, you can also use callbacks. See enableReadCallback() and ReadListener listener.

void BrickletRS232.setConfiguration(short baudrate, short parity, short stopbits, short wordlength, short hardwareFlowcontrol, short softwareFlowcontrol)¶

Parameters:	baudrate – Type: short, Range: See constants, Default: 11 parity – Type: short, Range: See constants, Default: 0 stopbits – Type: short, Range: See constants, Default: 1 wordlength – Type: short, Range: See constants, Default: 8 hardwareFlowcontrol – Type: short, Range: See constants, Default: 0 softwareFlowcontrol – Type: short, Range: See constants, Default: 0

Sets the configuration for the RS232 communication.

Hard-/Software flow control can either be on or off but not both simultaneously on.

The following constants are available for this function:

For baudrate:

• BrickletRS232.BAUDRATE_300 = 0
• BrickletRS232.BAUDRATE_600 = 1
• BrickletRS232.BAUDRATE_1200 = 2
• BrickletRS232.BAUDRATE_2400 = 3
• BrickletRS232.BAUDRATE_4800 = 4
• BrickletRS232.BAUDRATE_9600 = 5
• BrickletRS232.BAUDRATE_14400 = 6
• BrickletRS232.BAUDRATE_19200 = 7
• BrickletRS232.BAUDRATE_28800 = 8
• BrickletRS232.BAUDRATE_38400 = 9
• BrickletRS232.BAUDRATE_57600 = 10
• BrickletRS232.BAUDRATE_115200 = 11
• BrickletRS232.BAUDRATE_230400 = 12

For parity:

• BrickletRS232.PARITY_NONE = 0
• BrickletRS232.PARITY_ODD = 1
• BrickletRS232.PARITY_EVEN = 2
• BrickletRS232.PARITY_FORCED_PARITY_1 = 3
• BrickletRS232.PARITY_FORCED_PARITY_0 = 4

For stopbits:

• BrickletRS232.STOPBITS_1 = 1
• BrickletRS232.STOPBITS_2 = 2

For wordlength:

• BrickletRS232.WORDLENGTH_5 = 5
• BrickletRS232.WORDLENGTH_6 = 6
• BrickletRS232.WORDLENGTH_7 = 7
• BrickletRS232.WORDLENGTH_8 = 8

For hardwareFlowcontrol:

• BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1

For softwareFlowcontrol:

• BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1

BrickletRS232.Configuration BrickletRS232.getConfiguration()¶

Return Object:	baudrate – Type: short, Range: See constants, Default: 11 parity – Type: short, Range: See constants, Default: 0 stopbits – Type: short, Range: See constants, Default: 1 wordlength – Type: short, Range: See constants, Default: 8 hardwareFlowcontrol – Type: short, Range: See constants, Default: 0 softwareFlowcontrol – Type: short, Range: See constants, Default: 0

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For baudrate:

• BrickletRS232.BAUDRATE_300 = 0
• BrickletRS232.BAUDRATE_600 = 1
• BrickletRS232.BAUDRATE_1200 = 2
• BrickletRS232.BAUDRATE_2400 = 3
• BrickletRS232.BAUDRATE_4800 = 4
• BrickletRS232.BAUDRATE_9600 = 5
• BrickletRS232.BAUDRATE_14400 = 6
• BrickletRS232.BAUDRATE_19200 = 7
• BrickletRS232.BAUDRATE_28800 = 8
• BrickletRS232.BAUDRATE_38400 = 9
• BrickletRS232.BAUDRATE_57600 = 10
• BrickletRS232.BAUDRATE_115200 = 11
• BrickletRS232.BAUDRATE_230400 = 12

For parity:

• BrickletRS232.PARITY_NONE = 0
• BrickletRS232.PARITY_ODD = 1
• BrickletRS232.PARITY_EVEN = 2
• BrickletRS232.PARITY_FORCED_PARITY_1 = 3
• BrickletRS232.PARITY_FORCED_PARITY_0 = 4

For stopbits:

• BrickletRS232.STOPBITS_1 = 1
• BrickletRS232.STOPBITS_2 = 2

For wordlength:

• BrickletRS232.WORDLENGTH_5 = 5
• BrickletRS232.WORDLENGTH_6 = 6
• BrickletRS232.WORDLENGTH_7 = 7
• BrickletRS232.WORDLENGTH_8 = 8

For hardwareFlowcontrol:

• BrickletRS232.HARDWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.HARDWARE_FLOWCONTROL_ON = 1

For softwareFlowcontrol:

• BrickletRS232.SOFTWARE_FLOWCONTROL_OFF = 0
• BrickletRS232.SOFTWARE_FLOWCONTROL_ON = 1

void BrickletRS232.setBreakCondition(int breakTime)¶

Parameters:	breakTime – Type: int, Unit: 1 ms, Range: [0 to 216 - 1]

Sets a break condition (the TX output is forced to a logic 0 state). The parameter sets the hold-time of the break condition.

New in version 2.0.2 (Plugin).

BrickletRS232.ReadFrame BrickletRS232.readFrame()¶

Return Object:	message – Type: char[], Length: 60 length – Type: short, Range: [0 to 60]

Returns up to one frame of bytes from the read buffer. The frame size is configured with setFrameReadableCallbackConfiguration(). If the returned length is 0, no new data was available.

New in version 2.0.4 (Plugin).

Advanced Functions¶

BrickletRS232.Identity BrickletRS232.getIdentity()¶

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 216 - 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 BrickletRS232.enableReadCallback()¶

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

By default the listener is disabled.

void BrickletRS232.disableReadCallback()¶

Disables the ReadListener listener.

By default the listener is disabled.

boolean BrickletRS232.isReadCallbackEnabled()¶

Returns:	enabled – Type: boolean, Default: false

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

void BrickletRS232.setFrameReadableCallbackConfiguration(short frameSize)¶

Parameters:	frameSize – Type: short, Unit: 1 B, Range: [0 to 100], 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.4 (Plugin).

short BrickletRS232.getFrameReadableCallbackConfiguration()¶

Returns:	frameSize – Type: short, Unit: 1 B, Range: [0 to 100], Default: 0

Returns the listener configuration as set by setFrameReadableCallbackConfiguration().

New in version 2.0.4 (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 BrickletRS232.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.

class BrickletRS232.ReadListener()¶

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

void read(char[] message, short length)

Parameters:	message – Type: char[], Length: 60 length – Type: short, Range: [1 to 60]

This listener is called if new data is available. The message has a maximum size of 60 characters. The actual length of the message is given in addition.

To enable this listener, use enableReadCallback().

class BrickletRS232.ErrorListener()¶

This listener can be added with the addErrorListener() function. An added listener can be removed with the removeErrorListener() function.

void error(short error)

Parameters:	error – Type: short, Range: See constants

This listener is called if an error occurs. Possible errors are overrun, parity or framing error.

The following constants are available for this function:

For error:

• BrickletRS232.ERROR_OVERRUN = 1
• BrickletRS232.ERROR_PARITY = 2
• BrickletRS232.ERROR_FRAMING = 4

New in version 2.0.1 (Plugin).

class BrickletRS232.FrameReadableListener()¶

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

void frameReadable(short frameCount)

Parameters:	frameCount – Type: short, Range: [0 to 255]

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() or readFrame() is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the readFrame() function, every time the listener triggers without checking the frame count parameter.

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

• BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
• BrickletRS232.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

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

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:

• BrickletRS232.FUNCTION_ENABLE_READ_CALLBACK = 3
• BrickletRS232.FUNCTION_DISABLE_READ_CALLBACK = 4
• BrickletRS232.FUNCTION_SET_CONFIGURATION = 6
• BrickletRS232.FUNCTION_SET_BREAK_CONDITION = 10
• BrickletRS232.FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 11

void BrickletRS232.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletRS232.DEVICE_IDENTIFIER¶

This constant is used to identify a RS232 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 BrickletRS232.DEVICE_DISPLAY_NAME¶

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