PHP - Multi Touch Bricklet 2.0

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

Examples

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

Simple

Download (ExampleSimple.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletMultiTouchV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMultiTouchV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Multi Touch Bricklet 2.0

$ipcon = new IPConnection(); // Create IP connection
$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
$state = $mt->getTouchState();

echo "Electrode 0: " . $state[0] . "\n";
echo "Electrode 1: " . $state[1] . "\n";
echo "Electrode 2: " . $state[2] . "\n";
echo "Electrode 3: " . $state[3] . "\n";
echo "Electrode 4: " . $state[4] . "\n";
echo "Electrode 5: " . $state[5] . "\n";
echo "Electrode 6: " . $state[6] . "\n";
echo "Electrode 7: " . $state[7] . "\n";
echo "Electrode 8: " . $state[8] . "\n";
echo "Electrode 9: " . $state[9] . "\n";
echo "Electrode 10: " . $state[10] . "\n";
echo "Electrode 11: " . $state[11] . "\n";
echo "Proximity: " . $state[12] . "\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletMultiTouchV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMultiTouchV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Multi Touch Bricklet 2.0

// Callback function for touch state callback
function cb_touchState($state)
{
    echo "Electrode 0: $state\n";
    echo "Electrode 1: $state\n";
    echo "Electrode 2: $state\n";
    echo "Electrode 3: $state\n";
    echo "Electrode 4: $state\n";
    echo "Electrode 5: $state\n";
    echo "Electrode 6: $state\n";
    echo "Electrode 7: $state\n";
    echo "Electrode 8: $state\n";
    echo "Electrode 9: $state\n";
    echo "Electrode 10: $state\n";
    echo "Electrode 11: $state\n";
    echo "Proximity: $state\n";
    echo "\n";
}

$ipcon = new IPConnection(); // Create IP connection
$mt = new BrickletMultiTouchV2(UID, $ipcon); // Create device object

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

// Register touch state callback to function cb_touchState
$mt->registerCallback(BrickletMultiTouchV2::CALLBACK_TOUCH_STATE, 'cb_touchState');

// Set period for touch state callback to 0.01s (10ms)
$mt->setTouchStateCallbackConfiguration(10, TRUE);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletMultiTouchV2(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $multi_touch_v2 – Type: BrickletMultiTouchV2

Creates an object with the unique device ID $uid:

<?php   $multi_touch_v2 = new BrickletMultiTouchV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickletMultiTouchV2::getTouchState()
Returns:
  • $state – Type: array(bool, ...), Length: 13

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 CALLBACK_TOUCH_STATE callback. You can set the callback configuration with setTouchStateCallbackConfiguration().

void BrickletMultiTouchV2::recalibrate()

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

void BrickletMultiTouchV2::setElectrodeConfig(array $enabled_electrodes)
Parameters:
  • $enabled_electrodes – Type: array(bool, ...), Length: 13

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 CALLBACK_TOUCH_STATE callback.

Disabling electrodes will also reduce power consumption.

Default: All electrodes enabled.

array BrickletMultiTouchV2::getElectrodeConfig()
Returns:
  • $enabled_electrodes – Type: array(bool, ...), Length: 13

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

void BrickletMultiTouchV2::setElectrodeSensitivity(int $sensitivity)
Parameters:
  • $sensitivity – Type: int, Range: [0 to 255]

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:
  • $sensitivity – Type: int, Range: [0 to 255]

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

void BrickletMultiTouchV2::setTouchLEDConfig(int $config)
Parameters:
  • $config – Type: int, Range: See constants

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:

For $config:

  • 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:
  • $config – Type: int, Range: See constants

Returns the LED configuration as set by setTouchLEDConfig()

The following constants are available for this function:

For $config:

  • 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

array BrickletMultiTouchV2::getAPIVersion()
Returns:
  • $api_version – Type: array(int, ...), Length: 3, Range: [0 to 255]

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.

bool BrickletMultiTouchV2::getResponseExpected(int $function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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

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

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

The following constants are available for this function:

For $function_id:

  • 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 $function_id, bool $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool

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

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

The following constants are available for this function:

For $function_id:

  • 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(bool $response_expected)
Parameters:
  • $response_expected – Type: bool

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

array BrickletMultiTouchV2::getSPITFPErrorCount()
Return Array:
  • 'error_count_ack_checksum' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_message_checksum' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_frame' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_overflow' – Type: int, Range: [0 to 232 - 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.

int BrickletMultiTouchV2::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:

  • 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

For $status:

  • 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:
  • $mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For $mode:

  • 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(int $pointer)
Parameters:
  • $pointer – Type: int, Range: [0 to 232 - 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 BrickletMultiTouchV2::writeFirmware(array $data)
Parameters:
  • $data – Type: array(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 BrickletMultiTouchV2::setStatusLEDConfig(int $config)
Parameters:
  • $config – Type: int, Range: See constants

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:

  • 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:
  • $config – Type: int, Range: See constants

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

  • 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:
  • $temperature – Type: int, Range: [-215 to 215 - 1]

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(int $uid)
Parameters:
  • $uid – Type: int, Range: [0 to 232 - 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.

int BrickletMultiTouchV2::readUID()
Returns:
  • $uid – Type: int, Range: [0 to 232 - 1]

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

array BrickletMultiTouchV2::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string
  • 'hardware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'device_identifier' – 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' or 'd'.

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

Callback Configuration Functions

void BrickletMultiTouchV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameters:
  • $callback_id – Type: int
  • $callback – Type: callable
  • $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletMultiTouchV2::setTouchStateCallbackConfiguration(int $period, bool $value_has_to_change)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: FALSE

The period is the period with which the CALLBACK_TOUCH_STATE callback is triggered periodically. A value of 0 turns the callback off.

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

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

array BrickletMultiTouchV2::getTouchStateCallbackConfiguration()
Return Array:
  • 'period' – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 'value_has_to_change' – Type: bool, Default: FALSE

Returns the callback configuration as set by setTouchStateCallbackConfiguration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$multi_touch_v2->registerCallback(BrickletMultiTouchV2::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

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

int BrickletMultiTouchV2::CALLBACK_TOUCH_STATE
<?php   void callback(array $state [, mixed $user_data])   ?>
Callback Parameters:
  • $state – Type: array(bool, ...), Length: 13
  • $user_data – Type: mixed

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

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

Constants

int BrickletMultiTouchV2::DEVICE_IDENTIFIER

This constant is used to identify a Multi Touch Bricklet 2.0.

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

string BrickletMultiTouchV2::DEVICE_DISPLAY_NAME

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