Delphi/Lazarus - Ambient Light Bricklet

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

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

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

var
  e: TExample;

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

  { Create device object }
  al := TBrickletAmbientLight.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/10.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
62
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletAmbientLight;

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

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

var
  e: TExample;

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

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

  { Create device object }
  al := TBrickletAmbientLight.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)
    Note: The illuminance callback is only called every second
          if the illuminance has changed since the last call! }
  al.SetIlluminanceCallbackPeriod(1000);

  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
64
65
66
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletAmbientLight;

type
  TExample = class
  private
    ipcon: TIPConnection;
    al: TBrickletAmbientLight;
  public
    procedure IlluminanceReachedCB(sender: TBrickletAmbientLight;
                                   const illuminance: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for illuminance reached callback }
procedure TExample.IlluminanceReachedCB(sender: TBrickletAmbientLight;
                                        const illuminance: word);
begin
  WriteLn(Format('Illuminance: %f lx', [illuminance/10.0]));
  WriteLn('Too bright, close the curtains!');
end;

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

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

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

  { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
  al.SetDebouncePeriod(10000);

  { Register illuminance reached callback to procedure IlluminanceReachedCB }
  al.OnIlluminanceReached := {$ifdef FPC}@{$endif}IlluminanceReachedCB;

  { Configure threshold for illuminance "greater than 200 lx" }
  al.SetIlluminanceCallbackThreshold('>', 200*10, 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 TBrickletAmbientLight.Create(const uid: string; ipcon: TIPConnection)

Creates an object with the unique device ID uid:

ambientLight := TBrickletAmbientLight.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletAmbientLight.GetIlluminance: word

Returns the illuminance of the ambient light sensor. The value has a range of 0 to 9000 and is given in lux/10, i.e. a value of 4500 means that an illuminance of 450lux is measured.

If you want to get the illuminance periodically, it is recommended to use the OnIlluminance callback and set the period with SetIlluminanceCallbackPeriod.

Advanced Functions

function TBrickletAmbientLight.GetAnalogValue: word

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by GetIlluminance is averaged over several samples to yield less noise, while GetAnalogValue gives back raw unfiltered analog values. The only reason to use GetAnalogValue is, if you need the full resolution of the analog-to-digital converter.

Also, the analog-to-digital converter covers three different ranges that are set dynamically depending on the light intensity. It is impossible to distinguish between these ranges with the analog value.

If you want the analog value periodically, it is recommended to use the OnAnalogValue callback and set the period with SetAnalogValueCallbackPeriod.

function TBrickletAmbientLight.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 TBrickletAmbientLight.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 TBrickletAmbientLight.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_AMBIENT_LIGHT_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BRICKLET_AMBIENT_LIGHT_FUNCTION_SET_DEBOUNCE_PERIOD = 11
procedure TBrickletAmbientLight.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletAmbientLight.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 TBrickletAmbientLight.SetIlluminanceCallbackPeriod(const period: longword)

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

The OnIlluminance callback is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

function TBrickletAmbientLight.GetIlluminanceCallbackPeriod: longword

Returns the period as set by SetIlluminanceCallbackPeriod.

procedure TBrickletAmbientLight.SetAnalogValueCallbackPeriod(const period: longword)

Sets the period in ms with which the OnAnalogValue callback is triggered periodically. A value of 0 turns the callback off.

The OnAnalogValue callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

function TBrickletAmbientLight.GetAnalogValueCallbackPeriod: longword

Returns the period as set by SetAnalogValueCallbackPeriod.

procedure TBrickletAmbientLight.SetIlluminanceCallbackThreshold(const option: char; const min: word; const max: word)

Sets the thresholds for the OnIlluminanceReached callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.GetIlluminanceCallbackThreshold(out option: char; out min: word; out max: word)

Returns the threshold as set by SetIlluminanceCallbackThreshold.

The following constants are available for this function:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.SetAnalogValueCallbackThreshold(const option: char; const min: word; const max: word)

Sets the thresholds for the OnAnalogValueReached callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.GetAnalogValueCallbackThreshold(out option: char; out min: word; out max: word)

Returns the threshold as set by SetAnalogValueCallbackThreshold.

The following constants are available for this function:

  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AMBIENT_LIGHT_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAmbientLight.SetDebouncePeriod(const debounce: longword)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

function TBrickletAmbientLight.GetDebouncePeriod: longword

Returns the debounce period as set by SetDebouncePeriod.

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

ambientLight.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 TBrickletAmbientLight.OnIlluminance
procedure(sender: TBrickletAmbientLight; const illuminance: word) of object;

This callback is triggered periodically with the period that is set by SetIlluminanceCallbackPeriod. The parameter is the illuminance of the ambient light sensor.

The OnIlluminance callback is only triggered if the illuminance has changed since the last triggering.

property TBrickletAmbientLight.OnAnalogValue
procedure(sender: TBrickletAmbientLight; const value: word) of object;

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod. The parameter is the analog value of the ambient light sensor.

The OnAnalogValue callback is only triggered if the analog value has changed since the last triggering.

property TBrickletAmbientLight.OnIlluminanceReached
procedure(sender: TBrickletAmbientLight; const illuminance: word) of object;

This callback is triggered when the threshold as set by SetIlluminanceCallbackThreshold is reached. The parameter is the illuminance of the ambient light sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

property TBrickletAmbientLight.OnAnalogValueReached
procedure(sender: TBrickletAmbientLight; const value: word) of object;

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold is reached. The parameter is the analog value of the ambient light sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

Constants

const BRICKLET_AMBIENT_LIGHT_DEVICE_IDENTIFIER

This constant is used to identify a Ambient Light Bricklet.

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_DEVICE_DISPLAY_NAME

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