Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Color Bricklet 2.0

Delphi/Lazarus - Color Bricklet 2.0¶

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

Simple¶

Download (ExampleSimple.pas)

program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletColorV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletColorV2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var r, g, b, c_: word;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  c := TBrickletColorV2.Create(UID, ipcon);

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

  { Get current color }
  c.GetColor(r, g, b, c_);

  WriteLn(Format('Color [R]: %d', [r]));
  WriteLn(Format('Color [G]: %d', [g]));
  WriteLn(Format('Color [B]: %d', [b]));
  WriteLn(Format('Color [C]: %d', [c_]));

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

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

Callback¶

Download (ExampleCallback.pas)

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletColorV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletColorV2;
  public
    procedure ColorCB(sender: TBrickletColorV2; const r: word; const g: word;
                      const b: word; const c_: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for color callback }
procedure TExample.ColorCB(sender: TBrickletColorV2; const r: word; const g: word;
                           const b: word; const c_: word);
begin
  WriteLn(Format('Color [R]: %d', [r]));
  WriteLn(Format('Color [G]: %d', [g]));
  WriteLn(Format('Color [B]: %d', [b]));
  WriteLn(Format('Color [C]: %d', [c_]));
  WriteLn('');
end;

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

  { Create device object }
  c := TBrickletColorV2.Create(UID, ipcon);

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

  { Register color callback to procedure ColorCB }
  c.OnColor := {$ifdef FPC}@{$endif}ColorCB;

  { Set period for color callback to 0.1s (100ms) }
  c.SetColorCallbackConfiguration(100, false);

  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 TBrickletColorV2.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	colorV2 – Type: TBrickletColorV2

Creates an object with the unique device ID uid:

colorV2 := TBrickletColorV2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletColorV2.GetColor(out r: word; out g: word; out b: word; out c: word)¶

Output Parameters:	r – Type: word, Range: [0 to 2¹⁶ - 1] g – Type: word, Range: [0 to 2¹⁶ - 1] b – Type: word, Range: [0 to 2¹⁶ - 1] c – Type: word, Range: [0 to 2¹⁶ - 1]

Returns the measured color of the sensor.

The red (r), green (g), blue (b) and clear (c) colors are measured with four different photodiodes that are responsive at different wavelengths:

If you want to get the color periodically, it is recommended to use the OnColor callback and set the period with SetColorCallbackConfiguration.

function TBrickletColorV2.GetIlluminance: longword¶

Returns:	illuminance – Type: longword, Unit: ? lx, Range: [0 to 103438]

Returns the illuminance affected by the gain and integration time as set by SetConfiguration. To get the illuminance in Lux apply this formula:

lux = illuminance * 700 / gain / integration_time

To get a correct illuminance measurement make sure that the color values themselves are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see SetConfiguration.

If you want to get the value periodically, it is recommended to use the OnIlluminance callback. You can set the callback configuration with SetIlluminanceCallbackConfiguration.

function TBrickletColorV2.GetColorTemperature: word¶

Returns:	colorTemperature – Type: word, Unit: 1 K, Range: [0 to 2¹⁶ - 1]

Returns the color temperature.

To get a correct color temperature measurement make sure that the color values themselves are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see SetConfiguration.

If you want to get the value periodically, it is recommended to use the OnColorTemperature callback. You can set the callback configuration with SetColorTemperatureCallbackConfiguration.

procedure TBrickletColorV2.SetLight(const enable: boolean)¶

Parameters:	enable – Type: boolean, Default: false

Turns the white LED on the Bricklet on/off.

function TBrickletColorV2.GetLight: boolean¶

Returns:	enable – Type: boolean, Default: false

Returns the value as set by SetLight.

procedure TBrickletColorV2.SetConfiguration(const gain: byte; const integrationTime: byte)¶

Parameters:	gain – Type: byte, Range: See constants, Default: 3 integrationTime – Type: byte, Range: See constants, Default: 3

Sets the configuration of the sensor. Gain and integration time can be configured this way.

For configuring the gain:

0: 1x Gain
1: 4x Gain
2: 16x Gain
3: 60x Gain

For configuring the integration time:

0: 2.4ms
1: 24ms
2: 101ms
3: 154ms
4: 700ms

Increasing the gain enables the sensor to detect a color from a higher distance.

The integration time provides a trade-off between conversion time and accuracy. With a longer integration time the values read will be more accurate but it will take longer to get the conversion results.

The following constants are available for this function:

For gain:

BRICKLET_COLOR_V2_GAIN_1X = 0
BRICKLET_COLOR_V2_GAIN_4X = 1
BRICKLET_COLOR_V2_GAIN_16X = 2
BRICKLET_COLOR_V2_GAIN_60X = 3

For integrationTime:

BRICKLET_COLOR_V2_INTEGRATION_TIME_2MS = 0
BRICKLET_COLOR_V2_INTEGRATION_TIME_24MS = 1
BRICKLET_COLOR_V2_INTEGRATION_TIME_101MS = 2
BRICKLET_COLOR_V2_INTEGRATION_TIME_154MS = 3
BRICKLET_COLOR_V2_INTEGRATION_TIME_700MS = 4

procedure TBrickletColorV2.GetConfiguration(out gain: byte; out integrationTime: byte)¶

Output Parameters:	gain – Type: byte, Range: See constants, Default: 3 integrationTime – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetConfiguration.

The following constants are available for this function:

For gain:

BRICKLET_COLOR_V2_GAIN_1X = 0
BRICKLET_COLOR_V2_GAIN_4X = 1
BRICKLET_COLOR_V2_GAIN_16X = 2
BRICKLET_COLOR_V2_GAIN_60X = 3

For integrationTime:

BRICKLET_COLOR_V2_INTEGRATION_TIME_2MS = 0
BRICKLET_COLOR_V2_INTEGRATION_TIME_24MS = 1
BRICKLET_COLOR_V2_INTEGRATION_TIME_101MS = 2
BRICKLET_COLOR_V2_INTEGRATION_TIME_154MS = 3
BRICKLET_COLOR_V2_INTEGRATION_TIME_700MS = 4

Advanced Functions¶

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

Output Parameters:	errorCountAckChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountFrame – Type: longword, Range: [0 to 2³² - 1] errorCountOverflow – Type: longword, Range: [0 to 2³² - 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 TBrickletColorV2.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_COLOR_V2_STATUS_LED_CONFIG_OFF = 0
BRICKLET_COLOR_V2_STATUS_LED_CONFIG_ON = 1
BRICKLET_COLOR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_COLOR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletColorV2.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_COLOR_V2_STATUS_LED_CONFIG_OFF = 0
BRICKLET_COLOR_V2_STATUS_LED_CONFIG_ON = 1
BRICKLET_COLOR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_COLOR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletColorV2.GetChipTemperature: smallint¶

Returns:	temperature – Type: smallint, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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 TBrickletColorV2.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 TBrickletColorV2.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:

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 2¹⁶ - 1]

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 2¹⁶ - 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.

Callback Configuration Functions¶

procedure TBrickletColorV2.SetColorCallbackConfiguration(const period: longword; const valueHasToChange: boolean)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnColor 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.

procedure TBrickletColorV2.GetColorCallbackConfiguration(out period: longword; out valueHasToChange: boolean)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetColorCallbackConfiguration.

procedure TBrickletColorV2.SetIlluminanceCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longword; const max: longword)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longword, Unit: ? lx, Range: [0 to 2³² - 1], Default: 0 max – Type: longword, Unit: ? lx, Range: [0 to 2³² - 1], Default: 0

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

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

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the OnIlluminance callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

BRICKLET_COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletColorV2.GetIlluminanceCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longword; out max: longword)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longword, Unit: ? lx, Range: [0 to 2³² - 1], Default: 0 max – Type: longword, Unit: ? lx, Range: [0 to 2³² - 1], Default: 0

Returns the callback configuration as set by SetIlluminanceCallbackConfiguration.

The following constants are available for this function:

For option:

BRICKLET_COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletColorV2.SetColorTemperatureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: word; const max: word)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: word, Unit: 1 K, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: word, Unit: 1 K, Range: [0 to 2¹⁶ - 1], Default: 0

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

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

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the OnColorTemperature callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

BRICKLET_COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletColorV2.GetColorTemperatureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: word; out max: word)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: word, Unit: 1 K, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: word, Unit: 1 K, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the callback configuration as set by SetColorTemperatureCallbackConfiguration.

The following constants are available for this function:

For option:

BRICKLET_COLOR_V2_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_COLOR_V2_THRESHOLD_OPTION_GREATER = '>'

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

colorV2.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 TBrickletColorV2.OnColor¶

procedure(sender: TBrickletColorV2; const r: word; const g: word; const b: word; const c: word) of object;

Callback Parameters:	sender – Type: TBrickletColorV2 r – Type: word, Range: [0 to 2¹⁶ - 1] g – Type: word, Range: [0 to 2¹⁶ - 1] b – Type: word, Range: [0 to 2¹⁶ - 1] c – Type: word, Range: [0 to 2¹⁶ - 1]

This callback is triggered periodically with the period that is set by SetColorCallbackConfiguration. The parameter is the color of the sensor as RGBC.

The OnColor callback is only triggered if the color has changed since the last triggering.

property TBrickletColorV2.OnIlluminance¶

procedure(sender: TBrickletColorV2; const illuminance: longword) of object;

Callback Parameters:	sender – Type: TBrickletColorV2 illuminance – Type: longword, Unit: ? lx, Range: [0 to 103438]

This callback is triggered periodically according to the configuration set by SetIlluminanceCallbackConfiguration.

The parameter is the same as GetIlluminance.

property TBrickletColorV2.OnColorTemperature¶

procedure(sender: TBrickletColorV2; const colorTemperature: word) of object;

Callback Parameters:	sender – Type: TBrickletColorV2 colorTemperature – Type: word, Unit: 1 K, Range: [0 to 2¹⁶ - 1]

This callback is triggered periodically according to the configuration set by SetColorTemperatureCallbackConfiguration.

The parameter is the same as GetColorTemperature.

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 TBrickletColorV2.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 TBrickletColorV2.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_COLOR_V2_FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
BRICKLET_COLOR_V2_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
BRICKLET_COLOR_V2_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
BRICKLET_COLOR_V2_FUNCTION_SET_LIGHT = 13
BRICKLET_COLOR_V2_FUNCTION_SET_CONFIGURATION = 15
BRICKLET_COLOR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_COLOR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_COLOR_V2_FUNCTION_RESET = 243
BRICKLET_COLOR_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletColorV2.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.

The following constants are available for this function:

For functionId:

BRICKLET_COLOR_V2_FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
BRICKLET_COLOR_V2_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
BRICKLET_COLOR_V2_FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
BRICKLET_COLOR_V2_FUNCTION_SET_LIGHT = 13
BRICKLET_COLOR_V2_FUNCTION_SET_CONFIGURATION = 15
BRICKLET_COLOR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_COLOR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_COLOR_V2_FUNCTION_RESET = 243
BRICKLET_COLOR_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletColorV2.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 TBrickletColorV2.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_COLOR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_COLOR_V2_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_COLOR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BRICKLET_COLOR_V2_BOOTLOADER_STATUS_OK = 0
BRICKLET_COLOR_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
BRICKLET_COLOR_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
BRICKLET_COLOR_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BRICKLET_COLOR_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BRICKLET_COLOR_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletColorV2.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_COLOR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_COLOR_V2_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_COLOR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_COLOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletColorV2.SetWriteFirmwarePointer(const pointer: longword)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 2³² - 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 TBrickletColorV2.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 TBrickletColorV2.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 2³² - 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 TBrickletColorV2.ReadUID: longword¶

Returns:	uid – Type: longword, Range: [0 to 2³² - 1]

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

Constants¶

const BRICKLET_COLOR_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a Color 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_COLOR_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Color Bricklet 2.0.