Delphi/Lazarus - Analog In Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Analog In Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog In Bricklet 2.0 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)

 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, BrickletAnalogInV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ai: TBrickletAnalogInV2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  ai := TBrickletAnalogInV2.Create(UID, ipcon);

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

  { Get current voltage }
  voltage := ai.GetVoltage;
  WriteLn(Format('Voltage: %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
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletAnalogInV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ai: TBrickletAnalogInV2;
  public
    procedure VoltageCB(sender: TBrickletAnalogInV2; const voltage: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for voltage callback }
procedure TExample.VoltageCB(sender: TBrickletAnalogInV2; const voltage: word);
begin
  WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
end;

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

  { Create device object }
  ai := TBrickletAnalogInV2.Create(UID, ipcon);

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

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

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

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

uses
  SysUtils, IPConnection, BrickletAnalogInV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ai: TBrickletAnalogInV2;
  public
    procedure VoltageReachedCB(sender: TBrickletAnalogInV2; const voltage: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for voltage reached callback }
procedure TExample.VoltageReachedCB(sender: TBrickletAnalogInV2; const voltage: word);
begin
  WriteLn(Format('Voltage: %f V', [voltage/1000.0]));
end;

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

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

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

  { Configure threshold for voltage "smaller than 5 V" }
  ai.SetVoltageCallbackThreshold('<', 5*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 TBrickletAnalogInV2.Create(const uid: string; ipcon: TIPConnection)

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

analogInV2 := TBrickletAnalogInV2.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

function TBrickletAnalogInV2.GetVoltage: word

Gibt die gemessene Spannung zurück. Der Wert ist in mV und im Bereich von 0 bis 42V. Die Auflösung ca. 10mV.

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

Fortgeschrittene Funktionen

function TBrickletAnalogInV2.GetAnalogValue: word

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den OnAnalogValue Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod vorzugeben.

procedure TBrickletAnalogInV2.SetMovingAverage(const average: byte)

Setzt die Länge eines gleitenden Mittelwerts für die Spannung.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-50.

Der Standardwert ist 50.

function TBrickletAnalogInV2.GetMovingAverage: byte

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage gesetzt.

function TBrickletAnalogInV2.GetAPIVersion: array [0..2] of byte

Gibt die Version der API Definition (Major, Minor, Revision) 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 TBrickletAnalogInV2.GetResponseExpected(const functionId: byte): 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:

  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_MOVING_AVERAGE = 13
procedure TBrickletAnalogInV2.SetResponseExpected(const functionId: byte; const responseExpected: 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.

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:

  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BRICKLET_ANALOG_IN_V2_FUNCTION_SET_MOVING_AVERAGE = 13
procedure TBrickletAnalogInV2.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletAnalogInV2.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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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 TBrickletAnalogInV2.SetVoltageCallbackPeriod(const period: longword)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

function TBrickletAnalogInV2.GetVoltageCallbackPeriod: longword

Gibt die Periode zurück, wie von SetVoltageCallbackPeriod gesetzt.

procedure TBrickletAnalogInV2.SetAnalogValueCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletAnalogInV2.GetAnalogValueCallbackPeriod: longword

Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod gesetzt.

procedure TBrickletAnalogInV2.SetVoltageCallbackThreshold(const option: char; const min: word; const max: word)

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)

Der Standardwert ist ('x', 0, 0).

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

  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAnalogInV2.GetVoltageCallbackThreshold(out option: char; out min: word; out max: word)

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

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

  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAnalogInV2.SetAnalogValueCallbackThreshold(const option: char; const min: word; const max: word)

Setzt den Schwellwert für den OnAnalogValueReached Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAnalogInV2.GetAnalogValueCallbackThreshold(out option: char; out min: word; out max: word)

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

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

  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAnalogInV2.SetDebouncePeriod(const debounce: longword)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

function TBrickletAnalogInV2.GetDebouncePeriod: longword

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

analogInV2.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 TBrickletAnalogInV2.OnVoltage
procedure(sender: TBrickletAnalogInV2; const voltage: word) of object;

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

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

property TBrickletAnalogInV2.OnAnalogValue
procedure(sender: TBrickletAnalogInV2; const value: word) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod, ausgelöst. Der Parameter ist der Analogwert des Sensors.

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

property TBrickletAnalogInV2.OnVoltageReached
procedure(sender: TBrickletAnalogInV2; const voltage: word) of object;

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

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

property TBrickletAnalogInV2.OnAnalogValueReached
procedure(sender: TBrickletAnalogInV2; const value: word) of object;

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

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

Konstanten

const BRICKLET_ANALOG_IN_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Analog In Bricklet 2.0 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_ANALOG_IN_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet 2.0 dar.