Current Bricklet¶

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist 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¶

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	voltageCurrent – Typ: TBrickletVoltageCurrent

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

function TBrickletVoltageCurrent.GetCurrent: longint¶

Rückgabe:	current – Typ: longint, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den OnCurrent Callback zu nutzen und die Periode mit SetCurrentCallbackPeriod vorzugeben.

function TBrickletVoltageCurrent.GetVoltage: longint¶

Rückgabe:	voltage – Typ: longint, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den OnVoltage Callback zu nutzen und die Periode mit SetVoltageCallbackPeriod vorzugeben.

function TBrickletVoltageCurrent.GetPower: longint¶

Rückgabe:	power – Typ: longint, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den OnPower Callback zu nutzen und die Periode mit SetPowerCallbackPeriod vorzugeben.

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

Parameter:	averaging – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4

Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Für 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

Für 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)¶

Ausgabeparameter:	averaging – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 4

Gibt die Konfiguration zurück, wie von SetConfiguration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Für 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

Für 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

Fortgeschrittene Funktionen¶

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

Parameter:	gainMultiplier – Typ: word, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: word, Wertebereich: [0 bis 2¹⁶ - 1]

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen, falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

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

Ausgabeparameter:	gainMultiplier – Typ: word, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: word, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Kalibrierung zurück, wie von SetCalibration gesetzt.

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)¶

Ausgabeparameter:

Ausgabeparameter:	uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: word, Wertebereich: [0 bis 2¹⁶ - 1]

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
hardwareVersion – Typ: array [0..2] of byte

0: major – Typ: byte, Wertebereich: [0 bis 255]
1: minor – Typ: byte, Wertebereich: [0 bis 255]
2: revision – Typ: byte, Wertebereich: [0 bis 255]

firmwareVersion – Typ: array [0..2] of byte

0: major – Typ: byte, Wertebereich: [0 bis 255]
1: minor – Typ: byte, Wertebereich: [0 bis 255]
2: revision – Typ: byte, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: word, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

procedure TBrickletVoltageCurrent.SetCurrentCallbackPeriod(const period: longword)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der OnCurrent Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der OnCurrent Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

function TBrickletVoltageCurrent.GetCurrentCallbackPeriod: longword¶

Rückgabe:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetCurrentCallbackPeriod gesetzt

procedure TBrickletVoltageCurrent.SetVoltageCallbackPeriod(const period: longword)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der OnVoltage Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der OnVoltage Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

function TBrickletVoltageCurrent.GetVoltageCallbackPeriod: longword¶

Rückgabe:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetVoltageCallbackPeriod gesetzt

procedure TBrickletVoltageCurrent.SetPowerCallbackPeriod(const period: longword)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der OnPower Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der OnPower Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

function TBrickletVoltageCurrent.GetPowerCallbackPeriod: longword¶

Rückgabe:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von GetPowerCallbackPeriod gesetzt

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

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Setzt den Schwellwert für den OnCurrentReached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetCurrentCallbackThreshold gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Setzt den Schwellwert für den OnVoltageReached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Setzt den Schwellwert für den OnPowerReached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Leistung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Leistung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Leistung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Leistung größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetPowerCallbackThreshold gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Parameter:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

OnCurrentReached,
OnVoltageReached,
OnPowerReached

ausgelöst werden, wenn die Schwellwerte

SetCurrentCallbackThreshold,
SetVoltageCallbackThreshold,
SetPowerCallbackThreshold

weiterhin erreicht bleiben.

function TBrickletVoltageCurrent.GetDebouncePeriod: longword¶

Rückgabe:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletVoltageCurrent; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

voltageCurrent.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

property TBrickletVoltageCurrent.OnCurrent¶

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

Callback-Parameter:	sender – Typ: TBrickletVoltageCurrent current – Typ: longint, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentCallbackPeriod, ausgelöst. Der Parameter ist die Stromstärke des Sensors.

Der OnCurrent Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

property TBrickletVoltageCurrent.OnVoltage¶

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

Callback-Parameter:	sender – Typ: TBrickletVoltageCurrent voltage – Typ: longint, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetVoltageCallbackPeriod, ausgelöst. Der Parameter ist die Spannung des Sensors.

Der OnVoltage Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

property TBrickletVoltageCurrent.OnPower¶

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

Callback-Parameter:	sender – Typ: TBrickletVoltageCurrent power – Typ: longint, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetPowerCallbackPeriod, ausgelöst. Der Parameter ist die Leistung des Sensors.

Der OnPower Callback wird nur ausgelöst, wenn sich die Leistung seit der letzten Auslösung geändert hat.

property TBrickletVoltageCurrent.OnCurrentReached¶

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

Callback-Parameter:	sender – Typ: TBrickletVoltageCurrent current – Typ: longint, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCurrentCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Stromstärke des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

property TBrickletVoltageCurrent.OnVoltageReached¶

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

Callback-Parameter:	sender – Typ: TBrickletVoltageCurrent voltage – Typ: longint, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetVoltageCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

property TBrickletVoltageCurrent.OnPowerReached¶

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

Callback-Parameter:	sender – Typ: TBrickletVoltageCurrent power – Typ: longint, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPowerCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

function TBrickletVoltageCurrent.GetAPIVersion: array [0..2] of byte¶

Ausgabeparameter:	apiVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

function TBrickletVoltageCurrent.GetResponseExpected(const functionId: byte): boolean¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)¶

Parameter:	responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

const BRICKLET_VOLTAGE_CURRENT_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Voltage/Current Bricklet zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_VOLTAGE_CURRENT_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.