Java - Multi Touch Bricklet 2.0

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

Simple

Download (ExampleSimple.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletMultiTouchV2;

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

    // Change XYZ to the UID of your Multi Touch 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
        BrickletMultiTouchV2 mt = new BrickletMultiTouchV2(UID, ipcon); // Create device object

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

        // Get current touch state
        boolean[] state = mt.getTouchState(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Electrode 0: " + state[0]);
        System.out.println("Electrode 1: " + state[1]);
        System.out.println("Electrode 2: " + state[2]);
        System.out.println("Electrode 3: " + state[3]);
        System.out.println("Electrode 4: " + state[4]);
        System.out.println("Electrode 5: " + state[5]);
        System.out.println("Electrode 6: " + state[6]);
        System.out.println("Electrode 7: " + state[7]);
        System.out.println("Electrode 8: " + state[8]);
        System.out.println("Electrode 9: " + state[9]);
        System.out.println("Electrode 10: " + state[10]);
        System.out.println("Electrode 11: " + state[11]);
        System.out.println("Proximity: " + state[12]);

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

Callback

Download (ExampleCallback.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletMultiTouchV2;

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

    // Change XYZ to the UID of your Multi Touch 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
        BrickletMultiTouchV2 mt = new BrickletMultiTouchV2(UID, ipcon); // Create device object

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

        // Add touch state listener
        mt.addTouchStateListener(new BrickletMultiTouchV2.TouchStateListener() {
            public void touchState(boolean[] state) {
                System.out.println("Electrode 0: " + state[0]);
                System.out.println("Electrode 1: " + state[1]);
                System.out.println("Electrode 2: " + state[2]);
                System.out.println("Electrode 3: " + state[3]);
                System.out.println("Electrode 4: " + state[4]);
                System.out.println("Electrode 5: " + state[5]);
                System.out.println("Electrode 6: " + state[6]);
                System.out.println("Electrode 7: " + state[7]);
                System.out.println("Electrode 8: " + state[8]);
                System.out.println("Electrode 9: " + state[9]);
                System.out.println("Electrode 10: " + state[10]);
                System.out.println("Electrode 11: " + state[11]);
                System.out.println("Proximity: " + state[12]);
                System.out.println("");
            }
        });

        // Set period for touch state callback to 0.01s (10ms)
        mt.setTouchStateCallbackConfiguration(10, true);

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

Creates an object with the unique device ID uid:

BrickletMultiTouchV2 multiTouchV2 = new BrickletMultiTouchV2("YOUR_DEVICE_UID", ipcon);

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

boolean[] BrickletMultiTouchV2.getTouchState()

Returns the current touch state. The state is given as a array of bools.

Element 0 to 11 represent the 12 electrodes and element 12 represents the proximity.

If an electrode is touched, the corresponding element is true. If a hand or similar is in proximity to the electrodes, element 12 is true.

The proximity is activated with a distance of 1-2cm. An electrode is already counted as touched if a finger is nearly touching the electrode. This means that you can put a piece of paper or foil or similar on top of a electrode to build a touch panel with a professional look.

If you want to get the value periodically, it is recommended to use the TouchStateListener listener. You can set the listener configuration with setTouchStateCallbackConfiguration().

void BrickletMultiTouchV2.recalibrate()

Recalibrates the electrodes. Call this function whenever you changed or moved you electrodes.

void BrickletMultiTouchV2.setElectrodeConfig(boolean[] enabledElectrodes)

Enables/disables electrodes with a bool array (see getTouchState()).

True enables the electrode, false disables the electrode. A disabled electrode will always return false as its state. If you don't need all electrodes you can disable the electrodes that are not needed.

It is recommended that you disable the proximity electrode (element 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by the TouchStateListener listener.

Disabling electrodes will also reduce power consumption.

Default: All electrodes enabled.

boolean[] BrickletMultiTouchV2.getElectrodeConfig()

Returns the electrode configuration, as set by setElectrodeConfig().

void BrickletMultiTouchV2.setElectrodeSensitivity(int sensitivity)

Sets the sensitivity of the electrodes. An electrode with a high sensitivity will register a touch earlier then an electrode with a low sensitivity.

If you build a big electrode you might need to decrease the sensitivity, since the area that can be charged will get bigger. If you want to be able to activate an electrode from further away you need to increase the sensitivity.

After a new sensitivity is set, you likely want to call recalibrate() to calibrate the electrodes with the newly defined sensitivity.

The valid sensitivity value range is 5-201.

The default sensitivity value is 181.

int BrickletMultiTouchV2.getElectrodeSensitivity()

Returns the current sensitivity, as set by setElectrodeSensitivity().

void BrickletMultiTouchV2.setTouchLEDConfig(int config)

Configures the touch LED to be either turned off, turned on, blink in heartbeat mode or show the touch state (electrode touched = LED on).

The default value is 3 (show touch state).

The following constants are available for this function:

  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_OFF = 0
  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_ON = 1
  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_SHOW_TOUCH = 3
int BrickletMultiTouchV2.getTouchLEDConfig()

Returns the LED configuration as set by setTouchLEDConfig()

The following constants are available for this function:

  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_OFF = 0
  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_ON = 1
  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletMultiTouchV2.TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Advanced Functions

int[] BrickletMultiTouchV2.getAPIVersion()

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

boolean BrickletMultiTouchV2.getResponseExpected(int functionId)

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

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • BrickletMultiTouchV2.FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION = 2
  • BrickletMultiTouchV2.FUNCTION_RECALIBRATE = 5
  • BrickletMultiTouchV2.FUNCTION_SET_ELECTRODE_CONFIG = 6
  • BrickletMultiTouchV2.FUNCTION_SET_ELECTRODE_SENSITIVITY = 8
  • BrickletMultiTouchV2.FUNCTION_SET_TOUCH_LED_CONFIG = 10
  • BrickletMultiTouchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletMultiTouchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletMultiTouchV2.FUNCTION_RESET = 243
  • BrickletMultiTouchV2.FUNCTION_WRITE_UID = 248
void BrickletMultiTouchV2.setResponseExpected(int functionId, boolean responseExpected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • BrickletMultiTouchV2.FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION = 2
  • BrickletMultiTouchV2.FUNCTION_RECALIBRATE = 5
  • BrickletMultiTouchV2.FUNCTION_SET_ELECTRODE_CONFIG = 6
  • BrickletMultiTouchV2.FUNCTION_SET_ELECTRODE_SENSITIVITY = 8
  • BrickletMultiTouchV2.FUNCTION_SET_TOUCH_LED_CONFIG = 10
  • BrickletMultiTouchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletMultiTouchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletMultiTouchV2.FUNCTION_RESET = 243
  • BrickletMultiTouchV2.FUNCTION_WRITE_UID = 248
void BrickletMultiTouchV2.setResponseExpectedAll(boolean responseExpected)

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

BrickletMultiTouchV2.SPITFPErrorCount BrickletMultiTouchV2.getSPITFPErrorCount()

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

The errors are divided into

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

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

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

int BrickletMultiTouchV2.setBootloaderMode(int mode)

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

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

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

The following constants are available for this function:

  • BrickletMultiTouchV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletMultiTouchV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletMultiTouchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletMultiTouchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletMultiTouchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletMultiTouchV2.BOOTLOADER_STATUS_OK = 0
  • BrickletMultiTouchV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletMultiTouchV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletMultiTouchV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletMultiTouchV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletMultiTouchV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletMultiTouchV2.getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletMultiTouchV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletMultiTouchV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletMultiTouchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletMultiTouchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletMultiTouchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletMultiTouchV2.setWriteFirmwarePointer(long pointer)

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

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

int BrickletMultiTouchV2.writeFirmware(int[] data)

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

You can only write firmware in bootloader mode.

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

void BrickletMultiTouchV2.setStatusLEDConfig(int config)

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

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

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

The following constants are available for this function:

  • BrickletMultiTouchV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletMultiTouchV2.STATUS_LED_CONFIG_ON = 1
  • BrickletMultiTouchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletMultiTouchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletMultiTouchV2.getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletMultiTouchV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletMultiTouchV2.STATUS_LED_CONFIG_ON = 1
  • BrickletMultiTouchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletMultiTouchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletMultiTouchV2.getChipTemperature()

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

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

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

void BrickletMultiTouchV2.writeUID(long uid)

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

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

long BrickletMultiTouchV2.readUID()

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

BrickletMultiTouchV2.Identity BrickletMultiTouchV2.getIdentity()

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

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

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

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

Listener Configuration Functions

void BrickletMultiTouchV2.setTouchStateCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the TouchStateListener listener is triggered periodically. A value of 0 turns the listener off.

If the value has to change-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change.

If it is set to false, the listener is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletMultiTouchV2.TouchStateCallbackConfiguration BrickletMultiTouchV2.getTouchStateCallbackConfiguration()

Returns the listener configuration as set by setTouchStateCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

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 BrickletMultiTouchV2.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 BrickletMultiTouchV2.TouchStateListener()

This listener can be added with the addTouchStateListener() function. An added listener can be removed with the removeTouchStateListener() function.

void touchState(boolean[] state)

Returns the current touch state, see getTouchState() for information about the state.

This listener is triggered every time the touch state changes with a given period (see setTouchStateCallbackConfiguration())

Constants

static final int BrickletMultiTouchV2.DEVICE_IDENTIFIER

This constant is used to identify a Multi Touch 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.

static final String BrickletMultiTouchV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Multi Touch Bricklet 2.0.