Deutsch
English
Menu
Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Remote Switch Bricklet 2.0

Delphi/Lazarus - Remote Switch Bricklet 2.0

This is the description of the Delphi/Lazarus API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch 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).

Switch Socket

Download (ExampleSwitchSocket.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
program ExampleSwitchSocket;

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

uses
  SysUtils, IPConnection, BrickletRemoteSwitchV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs: TBrickletRemoteSwitchV2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  rs := TBrickletRemoteSwitchV2.Create(UID, ipcon);

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

  { Switch on a type A socket with house code 17 and receiver code 1.
    House code 17 is 10001 in binary (least-significant bit first)
    and means that the DIP switches 1 and 5 are on and 2-4 are off.
    Receiver code 1 is 10000 in binary (least-significant bit first)
    and means that the DIP switch A is on and B-E are off. }
  rs.SwitchSocketA(17, 1, BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON);

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

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

Remote Callback

Download (ExampleRemoteCallback.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 ExampleRemoteCallback;

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

uses
  SysUtils, IPConnection, BrickletRemoteSwitchV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs: TBrickletRemoteSwitchV2;
  public
    procedure RemoteStatusACB(sender: TBrickletRemoteSwitchV2; const houseCode: byte;
                              const receiverCode: byte; const switchTo: byte;
                              const repeats: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for remote status a callback }
procedure TExample.RemoteStatusACB(sender: TBrickletRemoteSwitchV2; const houseCode: byte;
                                   const receiverCode: byte; const switchTo: byte;
                                   const repeats: word);
begin
  WriteLn(Format('House Code: %d', [houseCode]));
  WriteLn(Format('Receiver Code: %d', [receiverCode]));

  if (switchTo = BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF) then begin
    WriteLn('Switch To: Off');
  end
  else if (switchTo = BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON) then begin
    WriteLn('Switch To: On');
  end;

  WriteLn(Format('Repeats: %d', [repeats]));
  WriteLn('');
end;

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

  { Create device object }
  rs := TBrickletRemoteSwitchV2.Create(UID, ipcon);

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

  { Configure to receive from remote type A with minimum repeats set to 1 and enable callback }
  rs.SetRemoteConfiguration(BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_A, 1, true);

  { Register remote status a callback to procedure RemoteStatusACB }
  rs.OnRemoteStatusA := {$ifdef FPC}@{$endif}RemoteStatusACB;

  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 TBrickletRemoteSwitchV2.Create(const uid: string; ipcon: TIPConnection)
Parameters:
  • uid – Type: string
  • ipcon – Type: TIPConnection
Returns:
  • remoteSwitchV2 – Type: TBrickletRemoteSwitchV2

Creates an object with the unique device ID uid:

remoteSwitchV2 := TBrickletRemoteSwitchV2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletRemoteSwitchV2.GetSwitchingState: byte
Returns:
  • state – Type: byte, Range: See constants

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switch socket functions until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see SetRepeats.

The following constants are available for this function:

For state:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCHING_STATE_READY = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCHING_STATE_BUSY = 1
procedure TBrickletRemoteSwitchV2.SwitchSocketA(const houseCode: byte; const receiverCode: byte; const switchTo: byte)
Parameters:
  • houseCode – Type: byte, Range: [0 to 31]
  • receiverCode – Type: byte, Range: [0 to 31]
  • switchTo – Type: byte, Range: See constants

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.SwitchSocketB(const address: longword; const unit: byte; const switchTo: byte)
Parameters:
  • address – Type: longword, Range: [0 to 226 - 1]
  • unit – Type: byte, Range: [0 to 15, 255]
  • switchTo – Type: byte, Range: See constants

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.DimSocketB(const address: longword; const unit: byte; const dimValue: byte)
Parameters:
  • address – Type: longword, Range: [0 to 226 - 1]
  • unit – Type: byte, Range: [0 to 15, 255]
  • dimValue – Type: byte, Range: [0 to 255]

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

procedure TBrickletRemoteSwitchV2.SwitchSocketC(const systemCode: char; const deviceCode: byte; const switchTo: byte)
Parameters:
  • systemCode – Type: char, Range: ['A' to 'P']
  • deviceCode – Type: byte, Range: [1 to 16]
  • switchTo – Type: byte, Range: See constants

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.SetRemoteConfiguration(const remoteType: byte; const minimumRepeats: word; const callbackEnabled: boolean)
Parameters:
  • remoteType – Type: byte, Range: See constants, Default: 0
  • minimumRepeats – Type: word, Range: [0 to 216 - 1], Default: 2
  • callbackEnabled – Type: boolean, Default: false

Sets the configuration for receiving data from a remote of type A, B or C.

  • Remote Type: A, B or C depending on the type of remote you want to receive.
  • Minimum Repeats: The minimum number of repeated data packets until the callback is triggered (if enabled).
  • Callback Enabled: Enable or disable callback (see OnRemoteStatusA callback, OnRemoteStatusB callback and OnRemoteStatusC callback).

The following constants are available for this function:

For remoteType:

  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2
procedure TBrickletRemoteSwitchV2.GetRemoteConfiguration(out remoteType: byte; out minimumRepeats: word; out callbackEnabled: boolean)
Output Parameters:
  • remoteType – Type: byte, Range: See constants, Default: 0
  • minimumRepeats – Type: word, Range: [0 to 216 - 1], Default: 2
  • callbackEnabled – Type: boolean, Default: false

Returns the remote configuration as set by SetRemoteConfiguration

The following constants are available for this function:

For remoteType:

  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2
procedure TBrickletRemoteSwitchV2.GetRemoteStatusA(out houseCode: byte; out receiverCode: byte; out switchTo: byte; out repeats: word)
Output Parameters:
  • houseCode – Type: byte, Range: [0 to 31]
  • receiverCode – Type: byte, Range: [0 to 31]
  • switchTo – Type: byte, Range: See constants
  • repeats – Type: word, Range: [0 to 216 - 1]

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration and OnRemoteStatusA callback.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.GetRemoteStatusB(out address: longword; out unit: byte; out switchTo: byte; out dimValue: byte; out repeats: word)
Output Parameters:
  • address – Type: longword, Range: [0 to 226 - 1]
  • unit – Type: byte, Range: [0 to 15]
  • switchTo – Type: byte, Range: See constants
  • dimValue – Type: byte, Range: [0 to 255]
  • repeats – Type: word, Range: [0 to 216 - 1]

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration and OnRemoteStatusB callback.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.GetRemoteStatusC(out systemCode: char; out deviceCode: byte; out switchTo: byte; out repeats: word)
Output Parameters:
  • systemCode – Type: char, Range: ['A' to 'P']
  • deviceCode – Type: byte, Range: [1 to 16]
  • switchTo – Type: byte, Range: See constants
  • repeats – Type: word, Range: [0 to 216 - 1]

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration and OnRemoteStatusC callback.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

Advanced Functions

procedure TBrickletRemoteSwitchV2.SetRepeats(const repeats: byte)
Parameters:
  • repeats – Type: byte, Range: [0 to 255], Default: 5

Sets the number of times the code is sent when one of the Switch Socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

function TBrickletRemoteSwitchV2.GetRepeats: byte
Returns:
  • repeats – Type: byte, Range: [0 to 255], Default: 5

Returns the number of repeats as set by SetRepeats.

procedure TBrickletRemoteSwitchV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Output Parameters:
  • errorCountAckChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountFrame – Type: longword, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: longword, 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.

procedure TBrickletRemoteSwitchV2.SetStatusLEDConfig(const config: byte)
Parameters:
  • config – Type: byte, Range: See constants, Default: 3

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:

  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletRemoteSwitchV2.GetStatusLEDConfig: byte
Returns:
  • config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

For config:

  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletRemoteSwitchV2.GetChipTemperature: smallint
Returns:
  • temperature – Type: smallint, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

procedure TBrickletRemoteSwitchV2.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 TBrickletRemoteSwitchV2.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:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • firmwareVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • deviceIdentifier – Type: word, 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.

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: TBrickletRemoteSwitchV2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

remoteSwitchV2.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.

property TBrickletRemoteSwitchV2.OnSwitchingDone
procedure(sender: TBrickletRemoteSwitchV2) of object;
Callback Parameters:
  • sender – Type: TBrickletRemoteSwitchV2

This callback is triggered whenever the switching state changes from busy to ready, see GetSwitchingState.

property TBrickletRemoteSwitchV2.OnRemoteStatusA
procedure(sender: TBrickletRemoteSwitchV2; const houseCode: byte; const receiverCode: byte; const switchTo: byte; const repeats: word) of object;
Callback Parameters:
  • sender – Type: TBrickletRemoteSwitchV2
  • houseCode – Type: byte, Range: [0 to 31]
  • receiverCode – Type: byte, Range: [0 to 31]
  • switchTo – Type: byte, Range: See constants
  • repeats – Type: word, Range: [0 to 216 - 1]

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
property TBrickletRemoteSwitchV2.OnRemoteStatusB
procedure(sender: TBrickletRemoteSwitchV2; const address: longword; const unit: byte; const switchTo: byte; const dimValue: byte; const repeats: word) of object;
Callback Parameters:
  • sender – Type: TBrickletRemoteSwitchV2
  • address – Type: longword, Range: [0 to 226 - 1]
  • unit – Type: byte, Range: [0 to 15, 255]
  • switchTo – Type: byte, Range: See constants
  • dimValue – Type: byte, Range: [0 to 255]
  • repeats – Type: word, Range: [0 to 216 - 1]

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
property TBrickletRemoteSwitchV2.OnRemoteStatusC
procedure(sender: TBrickletRemoteSwitchV2; const systemCode: char; const deviceCode: byte; const switchTo: byte; const repeats: word) of object;
Callback Parameters:
  • sender – Type: TBrickletRemoteSwitchV2
  • systemCode – Type: char, Range: ['A' to 'P']
  • deviceCode – Type: byte, Range: [1 to 16]
  • switchTo – Type: byte, Range: See constants
  • repeats – Type: word, Range: [0 to 216 - 1]

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

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.

function TBrickletRemoteSwitchV2.GetAPIVersion: array [0..2] of byte
Output Parameters:
  • apiVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, 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.

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

  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_RESET = 243
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletRemoteSwitchV2.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
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 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:

  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_RESET = 243
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletRemoteSwitchV2.SetResponseExpectedAll(const responseExpected: boolean)
Parameters:
  • responseExpected – Type: boolean

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

Internal Functions

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.

function TBrickletRemoteSwitchV2.SetBootloaderMode(const mode: byte): byte
Parameters:
  • mode – Type: byte, Range: See constants
Returns:
  • status – Type: byte, 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:

  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletRemoteSwitchV2.GetBootloaderMode: byte
Returns:
  • mode – Type: byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

For mode:

  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletRemoteSwitchV2.SetWriteFirmwarePointer(const pointer: longword)
Parameters:
  • pointer – Type: longword, Unit: 1 B, 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.

function TBrickletRemoteSwitchV2.WriteFirmware(const data: array [0..63] of byte): byte
Parameters:
  • data – Type: array [0..63] of byte, Range: [0 to 255]
Returns:
  • status – Type: byte, 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.

procedure TBrickletRemoteSwitchV2.WriteUID(const uid: longword)
Parameters:
  • uid – Type: longword, 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.

function TBrickletRemoteSwitchV2.ReadUID: longword
Returns:
  • uid – Type: longword, Range: [0 to 232 - 1]

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

Constants

const BRICKLET_REMOTE_SWITCH_V2_DEVICE_IDENTIFIER

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

const BRICKLET_REMOTE_SWITCH_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Remote Switch Bricklet 2.0.