Delphi/Lazarus - Ambient Light Bricklet 3.0

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

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

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

uses
  SysUtils, IPConnection, BrickletAmbientLightV3;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLightV3;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Ambient Light Bricklet 3.0 }

var
  e: TExample;

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

  { Create device object }
  al := TBrickletAmbientLightV3.Create(UID, ipcon);

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

  { Get current Illuminance }
  illuminance := al.GetIlluminance;
  WriteLn(Format('Illuminance: %f lx', [illuminance/100.0]));

  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)

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

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

uses
  SysUtils, IPConnection, BrickletAmbientLightV3;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLightV3;
  public
    procedure IlluminanceCB(sender: TBrickletAmbientLightV3; const illuminance: longword);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Ambient Light Bricklet 3.0 }

var
  e: TExample;

{ Callback procedure for illuminance callback }
procedure TExample.IlluminanceCB(sender: TBrickletAmbientLightV3;
                                 const illuminance: longword);
begin
  WriteLn(Format('Illuminance: %f lx', [illuminance/100.0]));
end;

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

  { Create device object }
  al := TBrickletAmbientLightV3.Create(UID, ipcon);

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

  { Register illuminance callback to procedure IlluminanceCB }
  al.OnIlluminance := {$ifdef FPC}@{$endif}IlluminanceCB;

  { Set period for illuminance callback to 1s (1000ms) without a threshold }
  al.SetIlluminanceCallbackConfiguration(1000, false, 'x', 0, 0);

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

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

Threshold

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

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

uses
  SysUtils, IPConnection, BrickletAmbientLightV3;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLightV3;
  public
    procedure IlluminanceCB(sender: TBrickletAmbientLightV3; const illuminance: longword);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Ambient Light Bricklet 3.0 }

var
  e: TExample;

{ Callback procedure for illuminance callback }
procedure TExample.IlluminanceCB(sender: TBrickletAmbientLightV3;
                                 const illuminance: longword);
begin
  WriteLn(Format('Illuminance: %f lx', [illuminance/100.0]));
  WriteLn('Too bright, close the curtains!');
end;

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

  { Create device object }
  al := TBrickletAmbientLightV3.Create(UID, ipcon);

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

  { Register illuminance callback to procedure IlluminanceCB }
  al.OnIlluminance := {$ifdef FPC}@{$endif}IlluminanceCB;

  { Configure threshold for illuminance "greater than 500 lx"
    with a debounce period of 1s (1000ms) }
  al.SetIlluminanceCallbackConfiguration(1000, false, '>', 500*100, 0);

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

Creates an object with the unique device ID uid:

ambientLightV3 := TBrickletAmbientLightV3.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletAmbientLightV3.GetIlluminance: longword
Returns:
  • illuminance – Type: longword, Unit: 1/100 lx, Range: [0 to 232 - 1]

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop. The illuminance is given in lux/100, i.e. a value of 450000 means that an illuminance of 4500lux is measured.

An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified (SetConfiguration) to better match the conditions.

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

procedure TBrickletAmbientLightV3.SetConfiguration(const illuminanceRange: byte; const integrationTime: byte)
Parameters:
  • illuminanceRange – Type: byte, Range: See constants, Default: 3
  • integrationTime – Type: byte, Range: See constants, Default: 2

Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.

The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop.

A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data.

If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported by GetIlluminance and the OnIlluminance callback. For example, 800001 for the 0-8000lux range.

With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported by GetIlluminance and the OnIlluminance callback.

If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.

The following constants are available for this function:

For illuminanceRange:

  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_UNLIMITED = 6
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_64000LUX = 0
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_32000LUX = 1
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_16000LUX = 2
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_8000LUX = 3
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_1300LUX = 4
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_600LUX = 5

For integrationTime:

  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_50MS = 0
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_100MS = 1
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_150MS = 2
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_200MS = 3
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_250MS = 4
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_300MS = 5
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_350MS = 6
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_400MS = 7
procedure TBrickletAmbientLightV3.GetConfiguration(out illuminanceRange: byte; out integrationTime: byte)
Output Parameters:
  • illuminanceRange – Type: byte, Range: See constants, Default: 3
  • integrationTime – Type: byte, Range: See constants, Default: 2

Returns the configuration as set by SetConfiguration.

The following constants are available for this function:

For illuminanceRange:

  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_UNLIMITED = 6
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_64000LUX = 0
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_32000LUX = 1
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_16000LUX = 2
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_8000LUX = 3
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_1300LUX = 4
  • BRICKLET_AMBIENT_LIGHT_V3_ILLUMINANCE_RANGE_600LUX = 5

For integrationTime:

  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_50MS = 0
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_100MS = 1
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_150MS = 2
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_200MS = 3
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_250MS = 4
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_300MS = 5
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_350MS = 6
  • BRICKLET_AMBIENT_LIGHT_V3_INTEGRATION_TIME_400MS = 7

Advanced Functions

procedure TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_AMBIENT_LIGHT_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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.

Callback Configuration Functions

procedure TBrickletAmbientLightV3.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 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: longword, Unit: 1/100 lx, Range: [0 to 232 - 1], Default: 0
  • max – Type: longword, Unit: 1/100 lx, Range: [0 to 232 - 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 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.

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_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLightV3.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 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: longword, Unit: 1/100 lx, Range: [0 to 232 - 1], Default: 0
  • max – Type: longword, Unit: 1/100 lx, Range: [0 to 232 - 1], Default: 0

Returns the callback configuration as set by SetIlluminanceCallbackConfiguration.

The following constants are available for this function:

For option:

  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_V3_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_V3_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: TBrickletAmbientLightV3; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

ambientLightV3.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 TBrickletAmbientLightV3.OnIlluminance
procedure(sender: TBrickletAmbientLightV3; const illuminance: longword) of object;
Callback Parameters:
  • sender – Type: TBrickletAmbientLightV3
  • illuminance – Type: longword, Unit: 1/100 lx, Range: [0 to 232 - 1]

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

The parameter is the same as GetIlluminance.

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 TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_SET_CONFIGURATION = 5
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_RESET = 243
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_WRITE_UID = 248
procedure TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 2
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_SET_CONFIGURATION = 5
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_RESET = 243
  • BRICKLET_AMBIENT_LIGHT_V3_FUNCTION_WRITE_UID = 248
procedure TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_AMBIENT_LIGHT_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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 TBrickletAmbientLightV3.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_AMBIENT_LIGHT_V3_DEVICE_IDENTIFIER

This constant is used to identify a Ambient Light Bricklet 3.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_AMBIENT_LIGHT_V3_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Ambient Light Bricklet 3.0.