Delphi/Lazarus - Industrial Dual Analog In Bricklet

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    idai: TBrickletIndustrialDualAnalogIn;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual Analog In Bricklet }

var
  e: TExample;

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

  { Create device object }
  idai := TBrickletIndustrialDualAnalogIn.Create(UID, ipcon);

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

  { Get current voltage from channel 1 }
  voltage := idai.GetVoltage(1);
  WriteLn(Format('Voltage (Channel 1): %f V', [voltage/1000.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
63
64
65
66
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletIndustrialDualAnalogIn;

type
  TExample = class
  private
    ipcon: TIPConnection;
    idai: TBrickletIndustrialDualAnalogIn;
  public
    procedure VoltageCB(sender: TBrickletIndustrialDualAnalogIn; const channel: byte;
                        const voltage: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual Analog In Bricklet }

var
  e: TExample;

{ Callback procedure for voltage callback }
procedure TExample.VoltageCB(sender: TBrickletIndustrialDualAnalogIn; const channel: byte;
                             const voltage: longint);
begin
  WriteLn(Format('Channel: %d', [channel]));
  WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
  WriteLn('');
end;

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

  { Create device object }
  idai := TBrickletIndustrialDualAnalogIn.Create(UID, ipcon);

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

  { Register voltage callback to procedure VoltageCB }
  idai.OnVoltage := {$ifdef FPC}@{$endif}VoltageCB;

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

 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
67
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletIndustrialDualAnalogIn;

type
  TExample = class
  private
    ipcon: TIPConnection;
    idai: TBrickletIndustrialDualAnalogIn;
  public
    procedure VoltageReachedCB(sender: TBrickletIndustrialDualAnalogIn;
                               const channel: byte; const voltage: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual Analog In Bricklet }

var
  e: TExample;

{ Callback procedure for voltage reached callback }
procedure TExample.VoltageReachedCB(sender: TBrickletIndustrialDualAnalogIn;
                                    const channel: byte; const voltage: longint);
begin
  WriteLn(Format('Channel: %d', [channel]));
  WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
  WriteLn('');
end;

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

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

  { Register voltage reached callback to procedure VoltageReachedCB }
  idai.OnVoltageReached := {$ifdef FPC}@{$endif}VoltageReachedCB;

  { Configure threshold for voltage (channel 1) "greater than 10 V" }
  idai.SetVoltageCallbackThreshold(1, '>', 10*1000, 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.

The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.

Basic Functions

constructor TBrickletIndustrialDualAnalogIn.Create(const uid: string; ipcon: TIPConnection)

Creates an object with the unique device ID uid:

industrialDualAnalogIn := TBrickletIndustrialDualAnalogIn.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialDualAnalogIn.GetVoltage(const channel: byte): longint

Returns the voltage for the given channel in mV.

If you want to get the voltage periodically, it is recommended to use the OnVoltage callback and set the period with SetVoltageCallbackPeriod.

Advanced Functions

procedure TBrickletIndustrialDualAnalogIn.SetSampleRate(const rate: byte)

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

The default value is 6 (2 samples per second).

The following constants are available for this function:

  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
function TBrickletIndustrialDualAnalogIn.GetSampleRate: byte

Returns the sample rate as set by SetSampleRate.

The following constants are available for this function:

  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
procedure TBrickletIndustrialDualAnalogIn.SetCalibration(const offset: array [0..1] of longint; const gain: array [0..1] of longint)

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

procedure TBrickletIndustrialDualAnalogIn.GetCalibration(out offset: array [0..1] of longint; out gain: array [0..1] of longint)

Returns the calibration as set by SetCalibration.

function TBrickletIndustrialDualAnalogIn.GetADCValues: array [0..1] of longint

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see SetCalibration.

function TBrickletIndustrialDualAnalogIn.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 TBrickletIndustrialDualAnalogIn.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 TBrickletIndustrialDualAnalogIn.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_INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_SAMPLE_RATE = 8
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_CALIBRATION = 10
procedure TBrickletIndustrialDualAnalogIn.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletIndustrialDualAnalogIn.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 TBrickletIndustrialDualAnalogIn.SetVoltageCallbackPeriod(const channel: byte; const period: longword)

Sets the period in ms with which the OnVoltage callback is triggered periodically for the given channel. A value of 0 turns the callback off.

The OnVoltage callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

function TBrickletIndustrialDualAnalogIn.GetVoltageCallbackPeriod(const channel: byte): longword

Returns the period as set by SetVoltageCallbackPeriod.

procedure TBrickletIndustrialDualAnalogIn.SetVoltageCallbackThreshold(const channel: byte; const option: char; const min: longint; const max: longint)

Sets the thresholds for the OnVoltageReached callback for the given channel.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the voltage is outside the min and max values
'i' Callback is triggered when the voltage is inside the min and max values
'<' Callback is triggered when the voltage is smaller than the min value (max is ignored)
'>' Callback is triggered when the voltage 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_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletIndustrialDualAnalogIn.GetVoltageCallbackThreshold(const channel: byte; out option: char; out min: longint; out max: longint)

Returns the threshold as set by SetVoltageCallbackThreshold.

The following constants are available for this function:

  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletIndustrialDualAnalogIn.SetDebouncePeriod(const debounce: longword)

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

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

industrialDualAnalogIn.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 TBrickletIndustrialDualAnalogIn.OnVoltage
procedure(sender: TBrickletIndustrialDualAnalogIn; const channel: byte; const voltage: longint) of object;

This callback is triggered periodically with the period that is set by SetVoltageCallbackPeriod. The parameter is the voltage of the channel.

The OnVoltage callback is only triggered if the voltage has changed since the last triggering.

property TBrickletIndustrialDualAnalogIn.OnVoltageReached
procedure(sender: TBrickletIndustrialDualAnalogIn; const channel: byte; const voltage: longint) of object;

This callback is triggered when the threshold as set by SetVoltageCallbackThreshold is reached. The parameter is the voltage of the channel.

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

Constants

const BRICKLET_INDUSTRIAL_DUAL_ANALOG_IN_DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual Analog In 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_INDUSTRIAL_DUAL_ANALOG_IN_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual Analog In Bricklet.