Delphi/Lazarus - CO2 Bricklet

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    co2: TBrickletCO2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  co2 := TBrickletCO2.Create(UID, ipcon);

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

  { Get current CO2 concentration }
  co2Concentration := co2.GetCO2Concentration;
  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));

  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, BrickletCO2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    co2: TBrickletCO2;
  public
    procedure CO2ConcentrationCB(sender: TBrickletCO2; const co2Concentration: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for CO2 concentration callback }
procedure TExample.CO2ConcentrationCB(sender: TBrickletCO2; const co2Concentration: word);
begin
  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
end;

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

  { Create device object }
  co2 := TBrickletCO2.Create(UID, ipcon);

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

  { Register CO2 concentration callback to procedure CO2ConcentrationCB }
  co2.OnCO2Concentration := {$ifdef FPC}@{$endif}CO2ConcentrationCB;

  { Set period for CO2 concentration callback to 1s (1000ms)
    Note: The CO2 concentration callback is only called every second
          if the CO2 concentration has changed since the last call! }
  co2.SetCO2ConcentrationCallbackPeriod(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
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletCO2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    co2: TBrickletCO2;
  public
    procedure CO2ConcentrationReachedCB(sender: TBrickletCO2;
                                        const co2Concentration: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for CO2 concentration reached callback }
procedure TExample.CO2ConcentrationReachedCB(sender: TBrickletCO2;
                                             const co2Concentration: word);
begin
  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
end;

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

  { Create device object }
  co2 := TBrickletCO2.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) }
  co2.SetDebouncePeriod(10000);

  { Register CO2 concentration reached callback to procedure CO2ConcentrationReachedCB }
  co2.OnCO2ConcentrationReached := {$ifdef FPC}@{$endif}CO2ConcentrationReachedCB;

  { Configure threshold for CO2 concentration "greater than 750 ppm" }
  co2.SetCO2ConcentrationCallbackThreshold('>', 750, 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 TBrickletCO2.Create(const uid: string; ipcon: TIPConnection)

Creates an object with the unique device ID uid:

co2 := TBrickletCO2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletCO2.GetCO2Concentration: word

Returns the measured CO2 concentration. The value is in ppm (parts per million) and between 0 to 10000.

If you want to get the CO2 concentration periodically, it is recommended to use the OnCO2Concentration callback and set the period with SetCO2ConcentrationCallbackPeriod.

Advanced Functions

function TBrickletCO2.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 TBrickletCO2.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 TBrickletCO2.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_CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
  • BRICKLET_CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
  • BRICKLET_CO2_FUNCTION_SET_DEBOUNCE_PERIOD = 6
procedure TBrickletCO2.SetResponseExpectedAll(const responseExpected: boolean)

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

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

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

The OnCO2Concentration callback is only triggered if the CO2 concentration has changed since the last triggering.

The default value is 0.

function TBrickletCO2.GetCO2ConcentrationCallbackPeriod: longword

Returns the period as set by SetCO2ConcentrationCallbackPeriod.

procedure TBrickletCO2.SetCO2ConcentrationCallbackThreshold(const option: char; const min: word; const max: word)

Sets the thresholds for the OnCO2ConcentrationReached callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the CO2 concentration is outside the min and max values
'i' Callback is triggered when the CO2 concentration is inside the min and max values
'<' Callback is triggered when the CO2 concentration is smaller than the min value (max is ignored)
'>' Callback is triggered when the CO2 concentration 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_CO2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2.GetCO2ConcentrationCallbackThreshold(out option: char; out min: word; out max: word)

Returns the threshold as set by SetCO2ConcentrationCallbackThreshold.

The following constants are available for this function:

  • BRICKLET_CO2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2.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 TBrickletCO2.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: TBrickletCO2; const param: word);
begin
  WriteLn(param);
end;

co2.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 TBrickletCO2.OnCO2Concentration
procedure(sender: TBrickletCO2; const co2Concentration: word) of object;

This callback is triggered periodically with the period that is set by SetCO2ConcentrationCallbackPeriod. The parameter is the CO2 concentration of the sensor.

The OnCO2Concentration callback is only triggered if the CO2 concentration has changed since the last triggering.

property TBrickletCO2.OnCO2ConcentrationReached
procedure(sender: TBrickletCO2; const co2Concentration: word) of object;

This callback is triggered when the threshold as set by SetCO2ConcentrationCallbackThreshold is reached. The parameter is the CO2 concentration.

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

Constants

const BRICKLET_CO2_DEVICE_IDENTIFIER

This constant is used to identify a CO2 Bricklet.

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

const BRICKLET_CO2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a CO2 Bricklet.