Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets (Discontinued) / Temperature IR Bricklet

Delphi/Lazarus - Temperature IR Bricklet¶

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    tir: TBrickletTemperatureIR;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var ambientTemperature, objectTemperature: smallint;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  tir := TBrickletTemperatureIR.Create(UID, ipcon);

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

  { Get current ambient temperature }
  ambientTemperature := tir.GetAmbientTemperature;
  WriteLn(Format('Ambient Temperature: %f °C', [ambientTemperature/10.0]));

  { Get current object temperature }
  objectTemperature := tir.GetObjectTemperature;
  WriteLn(Format('Object Temperature: %f °C', [objectTemperature/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)

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletTemperatureIR;

type
  TExample = class
  private
    ipcon: TIPConnection;
    tir: TBrickletTemperatureIR;
  public
    procedure ObjectTemperatureCB(sender: TBrickletTemperatureIR;
                                  const temperature: smallint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for object temperature callback }
procedure TExample.ObjectTemperatureCB(sender: TBrickletTemperatureIR;
                                       const temperature: smallint);
begin
  WriteLn(Format('Object Temperature: %f °C', [temperature/10.0]));
end;

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

  { Create device object }
  tir := TBrickletTemperatureIR.Create(UID, ipcon);

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

  { Register object temperature callback to procedure ObjectTemperatureCB }
  tir.OnObjectTemperature := {$ifdef FPC}@{$endif}ObjectTemperatureCB;

  { Set period for object temperature callback to 1s (1000ms)
    Note: The object temperature callback is only called every second
          if the object temperature has changed since the last call! }
  tir.SetObjectTemperatureCallbackPeriod(1000);

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

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

Water Boiling¶

Download (ExampleWaterBoiling.pas)

program ExampleWaterBoiling;

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

uses
  SysUtils, IPConnection, BrickletTemperatureIR;

type
  TExample = class
  private
    ipcon: TIPConnection;
    tir: TBrickletTemperatureIR;
  public
    procedure ObjectTemperatureReachedCB(sender: TBrickletTemperatureIR;
                                         const temperature: smallint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for object temperature reached callback }
procedure TExample.ObjectTemperatureReachedCB(sender: TBrickletTemperatureIR;
                                              const temperature: smallint);
begin
  WriteLn(Format('Object Temperature: %f °C', [temperature/10.0]));
  WriteLn('The water is boiling!');
end;

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

  { Create device object }
  tir := TBrickletTemperatureIR.Create(UID, ipcon);

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

  { Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299) }
  tir.SetEmissivity(64224);

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

  { Register object temperature reached callback to procedure ObjectTemperatureReachedCB }
  tir.OnObjectTemperatureReached := {$ifdef FPC}@{$endif}ObjectTemperatureReachedCB;

  { Configure threshold for object temperature "greater than 100 °C" }
  tir.SetObjectTemperatureCallbackThreshold('>', 100*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 TBrickletTemperatureIR.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	temperatureIR – Type: TBrickletTemperatureIR

Creates an object with the unique device ID uid:

temperatureIR := TBrickletTemperatureIR.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletTemperatureIR.GetAmbientTemperature: smallint¶

Returns:	temperature – Type: smallint, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the OnAmbientTemperature callback and set the period with SetAmbientTemperatureCallbackPeriod.

function TBrickletTemperatureIR.GetObjectTemperature: smallint¶

Returns:	temperature – Type: smallint, Unit: 1/10 °C, Range: [-700 to 3800]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with SetEmissivity.

If you want to get the object temperature periodically, it is recommended to use the OnObjectTemperature callback and set the period with SetObjectTemperatureCallbackPeriod.

Advanced Functions¶

procedure TBrickletTemperatureIR.SetEmissivity(const emissivity: word)¶

Parameters:	emissivity – Type: word, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1

Sets the emissivity that is used to calculate the surface temperature as returned by GetObjectTemperature.

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of SetEmissivity has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

function TBrickletTemperatureIR.GetEmissivity: word¶

Returns:	emissivity – Type: word, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1

Returns the emissivity as set by SetEmissivity.

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

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

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

The OnAmbientTemperature callback is only triggered if the temperature has changed since the last triggering.

function TBrickletTemperatureIR.GetAmbientTemperatureCallbackPeriod: longword¶

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

Returns the period as set by SetAmbientTemperatureCallbackPeriod.

procedure TBrickletTemperatureIR.SetObjectTemperatureCallbackPeriod(const period: longword)¶

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

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

The OnObjectTemperature callback is only triggered if the temperature has changed since the last triggering.

function TBrickletTemperatureIR.GetObjectTemperatureCallbackPeriod: longword¶

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

Returns the period as set by SetObjectTemperatureCallbackPeriod.

procedure TBrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold(const option: char; const min: smallint; const max: smallint)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Sets the thresholds for the OnAmbientTemperatureReached callback.

The following options are possible:

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

The following constants are available for this function:

For option:

BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletTemperatureIR.GetAmbientTemperatureCallbackThreshold(out option: char; out min: smallint; out max: smallint)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Returns the threshold as set by SetAmbientTemperatureCallbackThreshold.

The following constants are available for this function:

For option:

BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletTemperatureIR.SetObjectTemperatureCallbackThreshold(const option: char; const min: smallint; const max: smallint)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Sets the thresholds for the OnObjectTemperatureReached callback.

The following options are possible:

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

The following constants are available for this function:

For option:

BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletTemperatureIR.GetObjectTemperatureCallbackThreshold(out option: char; out min: smallint; out max: smallint)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0

Returns the threshold as set by SetObjectTemperatureCallbackThreshold.

The following constants are available for this function:

For option:

BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_TEMPERATURE_IR_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletTemperatureIR.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 callbacks

OnAmbientTemperatureReached,
OnObjectTemperatureReached

are triggered, if the thresholds

SetAmbientTemperatureCallbackThreshold,
SetObjectTemperatureCallbackThreshold

keep being reached.

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

temperatureIR.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 TBrickletTemperatureIR.OnAmbientTemperature¶

procedure(sender: TBrickletTemperatureIR; const temperature: smallint) of object;

Callback Parameters:	sender – Type: TBrickletTemperatureIR temperature – Type: smallint, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered periodically with the period that is set by SetAmbientTemperatureCallbackPeriod. The parameter is the ambient temperature of the sensor.

The OnAmbientTemperature callback is only triggered if the ambient temperature has changed since the last triggering.

property TBrickletTemperatureIR.OnObjectTemperature¶

procedure(sender: TBrickletTemperatureIR; const temperature: smallint) of object;

Callback Parameters:	sender – Type: TBrickletTemperatureIR temperature – Type: smallint, Unit: 1/10 °C, Range: [-700 to 3800]

This callback is triggered periodically with the period that is set by SetObjectTemperatureCallbackPeriod. The parameter is the object temperature of the sensor.

The OnObjectTemperature callback is only triggered if the object temperature has changed since the last triggering.

property TBrickletTemperatureIR.OnAmbientTemperatureReached¶

procedure(sender: TBrickletTemperatureIR; const temperature: smallint) of object;

Callback Parameters:	sender – Type: TBrickletTemperatureIR temperature – Type: smallint, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered when the threshold as set by SetAmbientTemperatureCallbackThreshold is reached. The parameter is the ambient temperature of the sensor.

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

property TBrickletTemperatureIR.OnObjectTemperatureReached¶

procedure(sender: TBrickletTemperatureIR; const temperature: smallint) of object;

Callback Parameters:	sender – Type: TBrickletTemperatureIR temperature – Type: smallint, Unit: 1/10 °C, Range: [-700 to 3800]

This callback is triggered when the threshold as set by SetObjectTemperatureCallbackThreshold is reached. The parameter is the object temperature 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 TBrickletTemperatureIR.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 TBrickletTemperatureIR.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_TEMPERATURE_IR_FUNCTION_SET_EMISSIVITY = 3
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_DEBOUNCE_PERIOD = 13

procedure TBrickletTemperatureIR.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_TEMPERATURE_IR_FUNCTION_SET_EMISSIVITY = 3
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
BRICKLET_TEMPERATURE_IR_FUNCTION_SET_DEBOUNCE_PERIOD = 13

procedure TBrickletTemperatureIR.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_TEMPERATURE_IR_DEVICE_IDENTIFIER¶

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