Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Dust Detector Bricklet

Delphi/Lazarus - Dust Detector Bricklet¶

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

program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletDustDetector;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dd: TBrickletDustDetector;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  dd := TBrickletDustDetector.Create(UID, ipcon);

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

  { Get current dust density }
  dustDensity := dd.GetDustDensity;
  WriteLn(Format('Dust Density: %d µg/m³', [dustDensity]));

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    dd: TBrickletDustDetector;
  public
    procedure DustDensityCB(sender: TBrickletDustDetector; const dustDensity: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for dust density callback }
procedure TExample.DustDensityCB(sender: TBrickletDustDetector; const dustDensity: word);
begin
  WriteLn(Format('Dust Density: %d µg/m³', [dustDensity]));
end;

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

  { Create device object }
  dd := TBrickletDustDetector.Create(UID, ipcon);

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

  { Register dust density callback to procedure DustDensityCB }
  dd.OnDustDensity := {$ifdef FPC}@{$endif}DustDensityCB;

  { Set period for dust density callback to 1s (1000ms)
    Note: The dust density callback is only called every second
          if the dust density has changed since the last call! }
  dd.SetDustDensityCallbackPeriod(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)

program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletDustDetector;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dd: TBrickletDustDetector;
  public
    procedure DustDensityReachedCB(sender: TBrickletDustDetector;
                                   const dustDensity: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for dust density reached callback }
procedure TExample.DustDensityReachedCB(sender: TBrickletDustDetector;
                                        const dustDensity: word);
begin
  WriteLn(Format('Dust Density: %d µg/m³', [dustDensity]));
end;

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

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

  { Register dust density reached callback to procedure DustDensityReachedCB }
  dd.OnDustDensityReached := {$ifdef FPC}@{$endif}DustDensityReachedCB;

  { Configure threshold for dust density "greater than 10 µg/m³" }
  dd.SetDustDensityCallbackThreshold('>', 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 TBrickletDustDetector.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	dustDetector – Type: TBrickletDustDetector

Creates an object with the unique device ID uid:

dustDetector := TBrickletDustDetector.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletDustDetector.GetDustDensity: word¶

Returns:	dustDensity – Type: word, Unit: 1 µg/m³, Range: [0 to 500]

Returns the dust density.

If you want to get the dust density periodically, it is recommended to use the OnDustDensity callback and set the period with SetDustDensityCallbackPeriod.

Advanced Functions¶

procedure TBrickletDustDetector.SetMovingAverage(const average: byte)¶

Parameters:	average – Type: byte, Range: [0 to 100], Default: 100

Sets the length of a moving averaging for the dust density.

Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

function TBrickletDustDetector.GetMovingAverage: byte¶

Returns:	average – Type: byte, Range: [0 to 100], Default: 100

Returns the length moving average as set by SetMovingAverage.

procedure TBrickletDustDetector.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 TBrickletDustDetector.SetDustDensityCallbackPeriod(const period: longword)¶

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

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

The OnDustDensity callback is only triggered if the dust density has changed since the last triggering.

function TBrickletDustDetector.GetDustDensityCallbackPeriod: longword¶

Returns:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by SetDustDensityCallbackPeriod.

procedure TBrickletDustDetector.SetDustDensityCallbackThreshold(const option: char; const min: word; const max: word)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: word, Unit: 1 µg/m³, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: word, Unit: 1 µg/m³, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the thresholds for the OnDustDensityReached callback.

The following options are possible:

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

The following constants are available for this function:

For option:

BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletDustDetector.GetDustDensityCallbackThreshold(out option: char; out min: word; out max: word)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: word, Unit: 1 µg/m³, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: word, Unit: 1 µg/m³, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by SetDustDensityCallbackThreshold.

The following constants are available for this function:

For option:

BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletDustDetector.SetDebouncePeriod(const debounce: longword)¶

Parameters:	debounce – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callback

OnDustDensityReached

is triggered, if the threshold

SetDustDensityCallbackThreshold

keeps being reached.

function TBrickletDustDetector.GetDebouncePeriod: longword¶

Returns:	debounce – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

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

dustDetector.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 TBrickletDustDetector.OnDustDensity¶

procedure(sender: TBrickletDustDetector; const dustDensity: word) of object;

Callback Parameters:	sender – Type: TBrickletDustDetector dustDensity – Type: word, Unit: 1 µg/m³, Range: [0 to 500]

This callback is triggered periodically with the period that is set by SetDustDensityCallbackPeriod. The parameter is the dust density of the sensor.

Der OnDustDensity callback is only triggered if the dust density value has changed since the last triggering.

property TBrickletDustDetector.OnDustDensityReached¶

procedure(sender: TBrickletDustDetector; const dustDensity: word) of object;

Callback Parameters:	sender – Type: TBrickletDustDetector dustDensity – Type: word, Unit: 1 µg/m³, Range: [0 to 500]

This callback is triggered when the threshold as set by SetDustDensityCallbackThreshold is reached. The parameter is the dust density of the sensor.

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

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 TBrickletDustDetector.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 TBrickletDustDetector.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_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
BRICKLET_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
BRICKLET_DUST_DETECTOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
BRICKLET_DUST_DETECTOR_FUNCTION_SET_MOVING_AVERAGE = 10

procedure TBrickletDustDetector.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_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
BRICKLET_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
BRICKLET_DUST_DETECTOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
BRICKLET_DUST_DETECTOR_FUNCTION_SET_MOVING_AVERAGE = 10

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

Constants¶

const BRICKLET_DUST_DETECTOR_DEVICE_IDENTIFIER¶

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