This is the description of the Delphi/Lazarus 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 Delphi/Lazarus API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | program ExampleSimple;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletMultiTouchV2;
type
TExample = class
private
ipcon: TIPConnection;
mt: TBrickletMultiTouchV2;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Multi Touch Bricklet 2.0 }
var
e: TExample;
procedure TExample.Execute;
var state: TArray0To12OfBoolean;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
mt := TBrickletMultiTouchV2.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Get current touch state }
state := mt.GetTouchState;
WriteLn(Format('Electrode 0: %d', [state[0]]));
WriteLn(Format('Electrode 1: %d', [state[1]]));
WriteLn(Format('Electrode 2: %d', [state[2]]));
WriteLn(Format('Electrode 3: %d', [state[3]]));
WriteLn(Format('Electrode 4: %d', [state[4]]));
WriteLn(Format('Electrode 5: %d', [state[5]]));
WriteLn(Format('Electrode 6: %d', [state[6]]));
WriteLn(Format('Electrode 7: %d', [state[7]]));
WriteLn(Format('Electrode 8: %d', [state[8]]));
WriteLn(Format('Electrode 9: %d', [state[9]]));
WriteLn(Format('Electrode 10: %d', [state[10]]));
WriteLn(Format('Electrode 11: %d', [state[11]]));
WriteLn(Format('Proximity: %d', [state[12]]));
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
Download (ExampleCallback.pas)
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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | program ExampleCallback;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletMultiTouchV2;
type
TExample = class
private
ipcon: TIPConnection;
mt: TBrickletMultiTouchV2;
public
procedure TouchStateCB(sender: TBrickletMultiTouchV2;
const state: TArray0To12OfBoolean);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Multi Touch Bricklet 2.0 }
var
e: TExample;
{ Callback procedure for touch state callback }
procedure TExample.TouchStateCB(sender: TBrickletMultiTouchV2;
const state: TArray0To12OfBoolean);
begin
WriteLn(Format('Electrode 0: %d', [state[0]]));
WriteLn(Format('Electrode 1: %d', [state[1]]));
WriteLn(Format('Electrode 2: %d', [state[2]]));
WriteLn(Format('Electrode 3: %d', [state[3]]));
WriteLn(Format('Electrode 4: %d', [state[4]]));
WriteLn(Format('Electrode 5: %d', [state[5]]));
WriteLn(Format('Electrode 6: %d', [state[6]]));
WriteLn(Format('Electrode 7: %d', [state[7]]));
WriteLn(Format('Electrode 8: %d', [state[8]]));
WriteLn(Format('Electrode 9: %d', [state[9]]));
WriteLn(Format('Electrode 10: %d', [state[10]]));
WriteLn(Format('Electrode 11: %d', [state[11]]));
WriteLn(Format('Proximity: %d', [state[12]]));
WriteLn('');
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
mt := TBrickletMultiTouchV2.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Register touch state callback to procedure TouchStateCB }
mt.OnTouchState := {$ifdef FPC}@{$endif}TouchStateCB;
{ Set period for touch state callback to 0.01s (10ms) }
mt.SetTouchStateCallbackConfiguration(10, true);
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
Since Delphi does not support multiple return values directly, we use the
out
keyword to return multiple values from a function.
All functions and procedures listed below are thread-safe.
TBrickletMultiTouchV2.
Create
(const uid: string; ipcon: TIPConnection)¶Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid
:
multiTouchV2 := TBrickletMultiTouchV2.Create('YOUR_DEVICE_UID', ipcon);
This object can then be used after the IP Connection is connected.
TBrickletMultiTouchV2.
GetTouchState
: array [0..12] of boolean¶Returns: |
|
---|
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
OnTouchState
callback. You can set the callback configuration
with SetTouchStateCallbackConfiguration
.
TBrickletMultiTouchV2.
Recalibrate
¶Recalibrates the electrodes. Call this function whenever you changed or moved you electrodes.
TBrickletMultiTouchV2.
SetElectrodeConfig
(const enabledElectrodes: array [0..12] of boolean)¶Parameters: |
|
---|
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 OnTouchState
callback.
Disabling electrodes will also reduce power consumption.
TBrickletMultiTouchV2.
GetElectrodeConfig
: array [0..12] of boolean¶Returns: |
|
---|
Returns the electrode configuration, as set by SetElectrodeConfig
.
TBrickletMultiTouchV2.
SetElectrodeSensitivity
(const sensitivity: byte)¶Parameters: |
|
---|
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.
TBrickletMultiTouchV2.
GetElectrodeSensitivity
: byte¶Returns: |
|
---|
Returns the current sensitivity, as set by SetElectrodeSensitivity
.
TBrickletMultiTouchV2.
SetTouchLEDConfig
(const config: byte)¶Parameters: |
|
---|
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 following constants are available for this function:
For config:
TBrickletMultiTouchV2.
GetTouchLEDConfig
: byte¶Returns: |
|
---|
Returns the LED configuration as set by SetTouchLEDConfig
The following constants are available for this function:
For config:
TBrickletMultiTouchV2.
GetSPITFPErrorCount
(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶Output Parameters: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
TBrickletMultiTouchV2.
SetStatusLEDConfig
(const config: byte)¶Parameters: |
|
---|
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:
TBrickletMultiTouchV2.
GetStatusLEDConfig
: byte¶Returns: |
|
---|
Returns the configuration as set by SetStatusLEDConfig
The following constants are available for this function:
For config:
TBrickletMultiTouchV2.
GetChipTemperature
: smallint¶Returns: |
|
---|
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.
TBrickletMultiTouchV2.
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!
TBrickletMultiTouchV2.
GetIdentity
(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)¶Output Parameters: |
|
---|
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.
TBrickletMultiTouchV2.
SetTouchStateCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameters: |
|
---|
The period is the period with which the OnTouchState
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.
TBrickletMultiTouchV2.
GetTouchStateCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Output Parameters: |
|
---|
Returns the callback configuration as set by
SetTouchStateCallbackConfiguration
.
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:
procedure TExample.MyCallback(sender: TBrickletMultiTouchV2; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; multiTouchV2.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;
The available callback properties and their parameter types 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.
TBrickletMultiTouchV2.
OnTouchState
¶procedure(sender: TBrickletMultiTouchV2; const state: array [0..12] of boolean) of object;
Callback Parameters: |
|
---|
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
)
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.
TBrickletMultiTouchV2.
GetAPIVersion
: array [0..2] of byte¶Output Parameters: |
|
---|
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.
TBrickletMultiTouchV2.
GetResponseExpected
(const functionId: byte): boolean¶Parameters: |
|
---|---|
Returns: |
|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
TBrickletMultiTouchV2.
SetResponseExpected
(const functionId: byte; const responseExpected: boolean)¶Parameters: |
|
---|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
TBrickletMultiTouchV2.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
TBrickletMultiTouchV2.
SetBootloaderMode
(const mode: byte): byte¶Parameters: |
|
---|---|
Returns: |
|
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:
For status:
TBrickletMultiTouchV2.
GetBootloaderMode
: byte¶Returns: |
|
---|
Returns the current bootloader mode, see SetBootloaderMode
.
The following constants are available for this function:
For mode:
TBrickletMultiTouchV2.
SetWriteFirmwarePointer
(const pointer: longword)¶Parameters: |
|
---|
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.
TBrickletMultiTouchV2.
WriteFirmware
(const data: array [0..63] of byte): byte¶Parameters: |
|
---|---|
Returns: |
|
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.
TBrickletMultiTouchV2.
WriteUID
(const uid: longword)¶Parameters: |
|
---|
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.
TBrickletMultiTouchV2.
ReadUID
: longword¶Returns: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
BRICKLET_MULTI_TOUCH_V2_DEVICE_IDENTIFIER
¶This constant is used to identify a Multi Touch Bricklet 2.0.
The GetIdentity
function and the
TIPConnection.OnEnumerate
callback of the IP Connection have a deviceIdentifier
parameter to specify
the Brick's or Bricklet's type.
BRICKLET_MULTI_TOUCH_V2_DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Multi Touch Bricklet 2.0.