Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets (Discontinued) / Voltage/Current Bricklet

Current Bricklet¶

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    vc: TBrickletVoltageCurrent;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  vc := TBrickletVoltageCurrent.Create(UID, ipcon);

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

  { Get current voltage }
  voltage := vc.GetVoltage;
  WriteLn(Format('Voltage: %f V', [voltage/1000.0]));

  { Get current current }
  current := vc.GetCurrent;
  WriteLn(Format('Current: %f A', [current/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)

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletVoltageCurrent;

type
  TExample = class
  private
    ipcon: TIPConnection;
    vc: TBrickletVoltageCurrent;
  public
    procedure CurrentCB(sender: TBrickletVoltageCurrent; const current: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for current callback }
procedure TExample.CurrentCB(sender: TBrickletVoltageCurrent; const current: longint);
begin
  WriteLn(Format('Current: %f A', [current/1000.0]));
end;

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

  { Create device object }
  vc := TBrickletVoltageCurrent.Create(UID, ipcon);

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

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

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    vc: TBrickletVoltageCurrent;
  public
    procedure PowerReachedCB(sender: TBrickletVoltageCurrent; const power: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for power reached callback }
procedure TExample.PowerReachedCB(sender: TBrickletVoltageCurrent; const power: longint);
begin
  WriteLn(Format('Power: %f W', [power/1000.0]));
end;

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

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

  { Register power reached callback to procedure PowerReachedCB }
  vc.OnPowerReached := {$ifdef FPC}@{$endif}PowerReachedCB;

  { Configure threshold for power "greater than 10 W" }
  vc.SetPowerCallbackThreshold('>', 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.

Basic Functions¶

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	voltageCurrent – Type: TBrickletVoltageCurrent

Creates an object with the unique device ID uid:

voltageCurrent := TBrickletVoltageCurrent.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletVoltageCurrent.GetCurrent: longint¶

Returns:	current – Type: longint, Unit: 1 mA, Range: [-20000 to 20000]

Returns the current.

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

function TBrickletVoltageCurrent.GetVoltage: longint¶

Returns:	voltage – Type: longint, Unit: 1 mV, Range: [0 to 36000]

Returns the voltage.

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

function TBrickletVoltageCurrent.GetPower: longint¶

Returns:	power – Type: longint, Unit: 1 mW, Range: [0 to 720000]

Returns the power.

If you want to get the power periodically, it is recommended to use the OnPower callback and set the period with SetPowerCallbackPeriod.

procedure TBrickletVoltageCurrent.SetConfiguration(const averaging: byte; const voltageConversionTime: byte; const currentConversionTime: byte)¶

Parameters:	averaging – Type: byte, Range: See constants, Default: 3 voltageConversionTime – Type: byte, Range: See constants, Default: 4 currentConversionTime – Type: byte, Range: See constants, Default: 4

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

The following constants are available for this function:

For averaging:

BRICKLET_VOLTAGE_CURRENT_AVERAGING_1 = 0
BRICKLET_VOLTAGE_CURRENT_AVERAGING_4 = 1
BRICKLET_VOLTAGE_CURRENT_AVERAGING_16 = 2
BRICKLET_VOLTAGE_CURRENT_AVERAGING_64 = 3
BRICKLET_VOLTAGE_CURRENT_AVERAGING_128 = 4
BRICKLET_VOLTAGE_CURRENT_AVERAGING_256 = 5
BRICKLET_VOLTAGE_CURRENT_AVERAGING_512 = 6
BRICKLET_VOLTAGE_CURRENT_AVERAGING_1024 = 7

For voltageConversionTime:

BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

For currentConversionTime:

BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

procedure TBrickletVoltageCurrent.GetConfiguration(out averaging: byte; out voltageConversionTime: byte; out currentConversionTime: byte)¶

Output Parameters:	averaging – Type: byte, Range: See constants, Default: 3 voltageConversionTime – Type: byte, Range: See constants, Default: 4 currentConversionTime – Type: byte, Range: See constants, Default: 4

Returns the configuration as set by SetConfiguration.

The following constants are available for this function:

For averaging:

BRICKLET_VOLTAGE_CURRENT_AVERAGING_1 = 0
BRICKLET_VOLTAGE_CURRENT_AVERAGING_4 = 1
BRICKLET_VOLTAGE_CURRENT_AVERAGING_16 = 2
BRICKLET_VOLTAGE_CURRENT_AVERAGING_64 = 3
BRICKLET_VOLTAGE_CURRENT_AVERAGING_128 = 4
BRICKLET_VOLTAGE_CURRENT_AVERAGING_256 = 5
BRICKLET_VOLTAGE_CURRENT_AVERAGING_512 = 6
BRICKLET_VOLTAGE_CURRENT_AVERAGING_1024 = 7

For voltageConversionTime:

BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

For currentConversionTime:

BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
BRICKLET_VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

Advanced Functions¶

procedure TBrickletVoltageCurrent.SetCalibration(const gainMultiplier: word; const gainDivisor: word)¶

Parameters:	gainMultiplier – Type: word, Range: [0 to 2¹⁶ - 1] gainDivisor – Type: word, Range: [0 to 2¹⁶ - 1]

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

procedure TBrickletVoltageCurrent.GetCalibration(out gainMultiplier: word; out gainDivisor: word)¶

Output Parameters:	gainMultiplier – Type: word, Range: [0 to 2¹⁶ - 1] gainDivisor – Type: word, Range: [0 to 2¹⁶ - 1]

Returns the calibration as set by SetCalibration.

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

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

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

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

function TBrickletVoltageCurrent.GetCurrentCallbackPeriod: longword¶

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

Returns the period as set by SetCurrentCallbackPeriod.

procedure TBrickletVoltageCurrent.SetVoltageCallbackPeriod(const period: longword)¶

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

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

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

function TBrickletVoltageCurrent.GetVoltageCallbackPeriod: longword¶

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

Returns the period as set by SetVoltageCallbackPeriod.

procedure TBrickletVoltageCurrent.SetPowerCallbackPeriod(const period: longword)¶

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

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

The OnPower callback is only triggered if the power has changed since the last triggering.

function TBrickletVoltageCurrent.GetPowerCallbackPeriod: longword¶

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

Returns the period as set by GetPowerCallbackPeriod.

procedure TBrickletVoltageCurrent.SetCurrentCallbackThreshold(const option: char; const min: longint; const max: longint)¶

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

Sets the thresholds for the OnCurrentReached callback.

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_VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletVoltageCurrent.GetCurrentCallbackThreshold(out option: char; out min: longint; out max: longint)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: 1 mA, 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_VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletVoltageCurrent.SetVoltageCallbackThreshold(const option: char; const min: longint; const max: longint)¶

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

Sets the thresholds for the OnVoltageReached callback.

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 following constants are available for this function:

For option:

BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletVoltageCurrent.GetVoltageCallbackThreshold(out option: char; out min: longint; out max: longint)¶

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

Returns the threshold as set by SetVoltageCallbackThreshold.

The following constants are available for this function:

For option:

BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletVoltageCurrent.SetPowerCallbackThreshold(const option: char; const min: longint; const max: longint)¶

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

Sets the thresholds for the OnPowerReached callback.

The following options are possible:

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

The following constants are available for this function:

For option:

BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletVoltageCurrent.GetPowerCallbackThreshold(out option: char; out min: longint; out max: longint)¶

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

Returns the threshold as set by SetPowerCallbackThreshold.

The following constants are available for this function:

For option:

BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'

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

OnCurrentReached,
OnVoltageReached,
OnPowerReached

are triggered, if the thresholds

SetCurrentCallbackThreshold,
SetVoltageCallbackThreshold,
SetPowerCallbackThreshold

keep being reached.

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

voltageCurrent.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 TBrickletVoltageCurrent.OnCurrent¶

procedure(sender: TBrickletVoltageCurrent; const current: longint) of object;

Callback Parameters:	sender – Type: TBrickletVoltageCurrent current – Type: longint, Unit: 1 mA, Range: [-20000 to 20000]

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 TBrickletVoltageCurrent.OnVoltage¶

procedure(sender: TBrickletVoltageCurrent; const voltage: longint) of object;

Callback Parameters:	sender – Type: TBrickletVoltageCurrent voltage – Type: longint, Unit: 1 mV, Range: [0 to 36000]

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

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

property TBrickletVoltageCurrent.OnPower¶

procedure(sender: TBrickletVoltageCurrent; const power: longint) of object;

Callback Parameters:	sender – Type: TBrickletVoltageCurrent power – Type: longint, Unit: 1 mW, Range: [0 to 720000]

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

The OnPower callback is only triggered if the power has changed since the last triggering.

property TBrickletVoltageCurrent.OnCurrentReached¶

procedure(sender: TBrickletVoltageCurrent; const current: longint) of object;

Callback Parameters:	sender – Type: TBrickletVoltageCurrent current – Type: longint, Unit: 1 mA, Range: [-20000 to 20000]

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.

property TBrickletVoltageCurrent.OnVoltageReached¶

procedure(sender: TBrickletVoltageCurrent; const voltage: longint) of object;

Callback Parameters:	sender – Type: TBrickletVoltageCurrent voltage – Type: longint, Unit: 1 mV, Range: [0 to 36000]

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

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

property TBrickletVoltageCurrent.OnPowerReached¶

procedure(sender: TBrickletVoltageCurrent; const power: longint) of object;

Callback Parameters:	sender – Type: TBrickletVoltageCurrent power – Type: longint, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered when the threshold as set by SetPowerCallbackThreshold is reached. The parameter is the power 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 TBrickletVoltageCurrent.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 TBrickletVoltageCurrent.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_VOLTAGE_CURRENT_FUNCTION_SET_CONFIGURATION = 4
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_CALIBRATION = 6
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 20

procedure TBrickletVoltageCurrent.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_VOLTAGE_CURRENT_FUNCTION_SET_CONFIGURATION = 4
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_CALIBRATION = 6
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
BRICKLET_VOLTAGE_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 20

procedure TBrickletVoltageCurrent.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_VOLTAGE_CURRENT_DEVICE_IDENTIFIER¶

This constant is used to identify a Voltage/Current 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_VOLTAGE_CURRENT_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Voltage/Current Bricklet.