Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Industrial Dual 0-20mA Bricklet

Delphi/Lazarus - Industrial Dual 0-20mA Bricklet¶

This is the description of the Delphi/Lazarus API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA 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, BrickletIndustrialDual020mA;

type
  TExample = class
  private
    ipcon: TIPConnection;
    id020: TBrickletIndustrialDual020mA;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet }

var
  e: TExample;

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

  { Create device object }
  id020 := TBrickletIndustrialDual020mA.Create(UID, ipcon);

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

  { Get current current from sensor 1 }
  current := id020.GetCurrent(1);
  WriteLn(Format('Current (Sensor 1): %f mA', [current/1000000.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, BrickletIndustrialDual020mA;

type
  TExample = class
  private
    ipcon: TIPConnection;
    id020: TBrickletIndustrialDual020mA;
  public
    procedure CurrentCB(sender: TBrickletIndustrialDual020mA; const sensor: byte;
                        const current: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet }

var
  e: TExample;

{ Callback procedure for current callback }
procedure TExample.CurrentCB(sender: TBrickletIndustrialDual020mA; const sensor: byte;
                             const current: longint);
begin
  WriteLn(Format('Sensor: %d', [sensor]));
  WriteLn(Format('Current: %f mA', [current/1000000.0]));
  WriteLn('');
end;

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

  { Create device object }
  id020 := TBrickletIndustrialDual020mA.Create(UID, ipcon);

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

  { Register current callback to procedure CurrentCB }
  id020.OnCurrent := {$ifdef FPC}@{$endif}CurrentCB;

  { Set period for current (sensor 1) callback to 1s (1000ms)
    Note: The current (sensor 1) callback is only called every second
          if the current (sensor 1) has changed since the last call! }
  id020.SetCurrentCallbackPeriod(1, 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, BrickletIndustrialDual020mA;

type
  TExample = class
  private
    ipcon: TIPConnection;
    id020: TBrickletIndustrialDual020mA;
  public
    procedure CurrentReachedCB(sender: TBrickletIndustrialDual020mA; const sensor: byte;
                               const current: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet }

var
  e: TExample;

{ Callback procedure for current reached callback }
procedure TExample.CurrentReachedCB(sender: TBrickletIndustrialDual020mA;
                                    const sensor: byte; const current: longint);
begin
  WriteLn(Format('Sensor: %d', [sensor]));
  WriteLn(Format('Current: %f mA', [current/1000000.0]));
  WriteLn('');
end;

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

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

  { Register current reached callback to procedure CurrentReachedCB }
  id020.OnCurrentReached := {$ifdef FPC}@{$endif}CurrentReachedCB;

  { Configure threshold for current (sensor 1) "greater than 10 mA" }
  id020.SetCurrentCallbackThreshold(1, '>', 10*1000000, 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 TBrickletIndustrialDual020mA.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	industrialDual020mA – Type: TBrickletIndustrialDual020mA

Creates an object with the unique device ID uid:

industrialDual020mA := TBrickletIndustrialDual020mA.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialDual020mA.GetCurrent(const sensor: byte): longint¶

Parameters:	sensor – Type: byte, Range: [0 to 1]
Returns:	current – Type: longint, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

If you want to get the current periodically, it is recommended to use the OnCurrent callback and set the period with SetCurrentCallbackPeriod.

Advanced Functions¶

procedure TBrickletIndustrialDual020mA.SetSampleRate(const rate: byte)¶

Parameters:	rate – Type: byte, Range: See constants, Default: 3

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value	Description
0	240 samples per second, 12 bit resolution
1	60 samples per second, 14 bit resolution
2	15 samples per second, 16 bit resolution
3	4 samples per second, 18 bit resolution

The following constants are available for this function:

For rate:

BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_240_SPS = 0
BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_60_SPS = 1
BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_15_SPS = 2
BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_4_SPS = 3

function TBrickletIndustrialDual020mA.GetSampleRate: byte¶

Returns:	rate – Type: byte, Range: See constants, Default: 3

Returns the sample rate as set by SetSampleRate.

The following constants are available for this function:

For rate:

BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_240_SPS = 0
BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_60_SPS = 1
BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_15_SPS = 2
BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_4_SPS = 3

procedure TBrickletIndustrialDual020mA.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 TBrickletIndustrialDual020mA.SetCurrentCallbackPeriod(const sensor: byte; const period: longword)¶

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

Sets the period with which the OnCurrent callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

The OnCurrent callback is only triggered if the current has changed since the last triggering.

function TBrickletIndustrialDual020mA.GetCurrentCallbackPeriod(const sensor: byte): longword¶

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

Returns the period as set by SetCurrentCallbackPeriod.

procedure TBrickletIndustrialDual020mA.SetCurrentCallbackThreshold(const sensor: byte; const option: char; const min: longint; const max: longint)¶

Parameters:	sensor – Type: byte, Range: [0 to 1] option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the OnCurrentReached callback for the given sensor.

The following options are possible:

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

The following constants are available for this function:

For option:

BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialDual020mA.GetCurrentCallbackThreshold(const sensor: byte; out option: char; out min: longint; out max: longint)¶

Parameters:	sensor – Type: byte, Range: [0 to 1]
Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: 1 nA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by SetCurrentCallbackThreshold.

The following constants are available for this function:

For option:

BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_GREATER = '>'

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

OnCurrentReached

is triggered, if the threshold

SetCurrentCallbackThreshold

keeps being reached.

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

industrialDual020mA.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 TBrickletIndustrialDual020mA.OnCurrent¶

procedure(sender: TBrickletIndustrialDual020mA; const sensor: byte; const current: longint) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialDual020mA sensor – Type: byte, Range: [0 to 1] current – Type: longint, Unit: 1 nA, Range: [0 to 22505322]

This callback is triggered periodically with the period that is set by SetCurrentCallbackPeriod. The parameter is the current of the sensor.

The OnCurrent callback is only triggered if the current has changed since the last triggering.

property TBrickletIndustrialDual020mA.OnCurrentReached¶

procedure(sender: TBrickletIndustrialDual020mA; const sensor: byte; const current: longint) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialDual020mA sensor – Type: byte, Range: [0 to 1] current – Type: longint, Unit: 1 nA, Range: [0 to 22505322]

This callback is triggered when the threshold as set by SetCurrentCallbackThreshold is reached. The parameter is the current 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 TBrickletIndustrialDual020mA.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 TBrickletIndustrialDual020mA.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_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_DEBOUNCE_PERIOD = 6
BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_SAMPLE_RATE = 8

procedure TBrickletIndustrialDual020mA.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_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_DEBOUNCE_PERIOD = 6
BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_SAMPLE_RATE = 8

procedure TBrickletIndustrialDual020mA.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_INDUSTRIAL_DUAL_0_20MA_DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Dual 0-20mA 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_INDUSTRIAL_DUAL_0_20MA_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.