Delphi/Lazarus - Dual Button Bricklet 2.0

This is the description of the Delphi/Lazarus API bindings for the Dual Button Bricklet 2.0. General information and technical specifications for the Dual Button Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Delphi/Lazarus API bindings is part of their general description.

Examples

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

Callback

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
program ExampleCallback;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletDualButtonV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    db: TBrickletDualButtonV2;
  public
    procedure StateChangedCB(sender: TBrickletDualButtonV2; const buttonL: byte;
                             const buttonR: byte; const ledL: byte; const ledR: byte);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Dual Button Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for state changed callback }
procedure TExample.StateChangedCB(sender: TBrickletDualButtonV2; const buttonL: byte;
                                  const buttonR: byte; const ledL: byte;
                                  const ledR: byte);
begin
  if (buttonL = BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_PRESSED) then begin
    WriteLn('Left Button: Pressed');
  end
  else if (buttonL = BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_RELEASED) then begin
    WriteLn('Left Button: Released');
  end;

  if (buttonR = BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_PRESSED) then begin
    WriteLn('Right Button: Pressed');
  end
  else if (buttonR = BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_RELEASED) then begin
    WriteLn('Right Button: Released');
  end;

  WriteLn('');
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  db := TBrickletDualButtonV2.Create(UID, ipcon);

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

  { Register state changed callback to procedure StateChangedCB }
  db.OnStateChanged := {$ifdef FPC}@{$endif}StateChangedCB;

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

API

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.

Basic Functions

constructor TBrickletDualButtonV2.Create(const uid: string; ipcon: TIPConnection)

Creates an object with the unique device ID uid:

dualButtonV2 := TBrickletDualButtonV2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletDualButtonV2.SetLEDState(const ledL: byte; const ledR: byte)

Sets the state of the LEDs. Possible states are:

  • 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.
  • 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.
  • 2 = On: Enables LED (auto toggle is disabled).
  • 3 = Off: Disables LED (auto toggle is disabled).

In auto toggle mode the LED is toggled automatically at each press of a button.

If you just want to set one of the LEDs and don't know the current state of the other LED, you can get the state with GetLEDState or you can use SetSelectedLEDState.

The default value is (1, 1).

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_ON = 0
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_OFF = 1
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_ON = 2
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_OFF = 3
procedure TBrickletDualButtonV2.GetLEDState(out ledL: byte; out ledR: byte)

Returns the current state of the LEDs, as set by SetLEDState.

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_ON = 0
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_OFF = 1
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_ON = 2
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_OFF = 3
procedure TBrickletDualButtonV2.GetButtonState(out buttonL: byte; out buttonR: byte)

Returns the current state for both buttons. Possible states are:

  • 0 = pressed
  • 1 = released

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_PRESSED = 0
  • BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_RELEASED = 1

Advanced Functions

procedure TBrickletDualButtonV2.SetSelectedLEDState(const led: byte; const state: byte)

Sets the state of the selected LED (0 or 1).

The other LED remains untouched.

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_LED_LEFT = 0
  • BRICKLET_DUAL_BUTTON_V2_LED_RIGHT = 1
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_ON = 0
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_OFF = 1
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_ON = 2
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_OFF = 3
function TBrickletDualButtonV2.GetAPIVersion: array [0..2] of byte

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.

function TBrickletDualButtonV2.GetResponseExpected(const functionId: byte): 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 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.

See SetResponseExpected for the list of function ID constants available for this function.

procedure TBrickletDualButtonV2.SetResponseExpected(const functionId: byte; const responseExpected: 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 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 function ID constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_SET_LED_STATE = 1
  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_SET_SELECTED_LED_STATE = 5
  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION = 6
  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_RESET = 243
  • BRICKLET_DUAL_BUTTON_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletDualButtonV2.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletDualButtonV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)

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.

function TBrickletDualButtonV2.SetBootloaderMode(const mode: byte): byte

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:

  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletDualButtonV2.GetBootloaderMode: byte

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_DUAL_BUTTON_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletDualButtonV2.SetWriteFirmwarePointer(const pointer: longword)

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.

function TBrickletDualButtonV2.WriteFirmware(const data: array [0..63] of byte): byte

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.

procedure TBrickletDualButtonV2.SetStatusLEDConfig(const config: byte)

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:

  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletDualButtonV2.GetStatusLEDConfig: byte

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_DUAL_BUTTON_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletDualButtonV2.GetChipTemperature: smallint

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.

procedure TBrickletDualButtonV2.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!

procedure TBrickletDualButtonV2.WriteUID(const uid: longword)

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.

function TBrickletDualButtonV2.ReadUID: longword

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

procedure TBrickletDualButtonV2.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)

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

procedure TBrickletDualButtonV2.SetStateChangedCallbackConfiguration(const enabled: boolean)

If you enable this callback, the OnStateChanged callback is triggered every time a button is pressed/released

By default this callback is disabled.

function TBrickletDualButtonV2.GetStateChangedCallbackConfiguration: boolean

Returns the configuration as set by SetStateChangedCallbackConfiguration.

Callbacks

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: TBrickletDualButtonV2; const param: word);
begin
  WriteLn(param);
end;

dualButtonV2.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback property and their type of parameters 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.

property TBrickletDualButtonV2.OnStateChanged
procedure(sender: TBrickletDualButtonV2; const buttonL: byte; const buttonR: byte; const ledL: byte; const ledR: byte) of object;

This callback is called whenever a button is pressed.

Possible states for buttons are:

  • 0 = pressed
  • 1 = released

Possible states for LEDs are:

  • 0 = AutoToggleOn: Auto toggle enabled and LED on.
  • 1 = AutoToggleOff: Auto toggle enabled and LED off.
  • 2 = On: LED on (auto toggle is disabled).
  • 3 = Off: LED off (auto toggle is disabled).

This callback can be enabled with SetStateChangedCallbackConfiguration.

The following constants are available for this function:

  • BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_PRESSED = 0
  • BRICKLET_DUAL_BUTTON_V2_BUTTON_STATE_RELEASED = 1
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_ON = 0
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_AUTO_TOGGLE_OFF = 1
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_ON = 2
  • BRICKLET_DUAL_BUTTON_V2_LED_STATE_OFF = 3

Constants

const BRICKLET_DUAL_BUTTON_V2_DEVICE_IDENTIFIER

This constant is used to identify a Dual Button Bricklet 2.0.

The GetIdentity function and the OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_DUAL_BUTTON_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Dual Button Bricklet 2.0.