Delphi/Lazarus - Linear Poti Bricklet

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

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    lp: TBrickletLinearPoti;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Linear Poti Bricklet }

var
  e: TExample;

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

  { Create device object }
  lp := TBrickletLinearPoti.Create(UID, ipcon);

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

  { Get current position }
  position := lp.GetPosition;
  WriteLn(Format('Position: %d', [position])); { Range: 0 to 100 }

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    lp: TBrickletLinearPoti;
  public
    procedure PositionCB(sender: TBrickletLinearPoti; const position: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Linear Poti Bricklet }

var
  e: TExample;

{ Callback procedure for position callback }
procedure TExample.PositionCB(sender: TBrickletLinearPoti; const position: word);
begin
  WriteLn(Format('Position: %d', [position])); { Range: 0 to 100 }
end;

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

  { Create device object }
  lp := TBrickletLinearPoti.Create(UID, ipcon);

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

  { Register position callback to procedure PositionCB }
  lp.OnPosition := {$ifdef FPC}@{$endif}PositionCB;

  { Set period for position callback to 0.05s (50ms)
    Note: The position callback is only called every 0.05 seconds
          if the position has changed since the last call! }
  lp.SetPositionCallbackPeriod(50);

  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 TBrickletLinearPoti.Create(const uid: string; ipcon: TIPConnection)

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

linearPoti := TBrickletLinearPoti.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletLinearPoti.GetPosition: word

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0 (Schieberegler unten) und 100 (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den OnPosition Callback zu nutzen und die Periode mit SetPositionCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen

function TBrickletLinearPoti.GetAnalogValue: word

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

Bemerkung

Der von GetPosition zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

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

function TBrickletLinearPoti.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 TBrickletLinearPoti.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.

Siehe SetResponseExpected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

procedure TBrickletLinearPoti.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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BRICKLET_LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BRICKLET_LINEAR_POTI_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BRICKLET_LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BRICKLET_LINEAR_POTI_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BRICKLET_LINEAR_POTI_FUNCTION_SET_DEBOUNCE_PERIOD = 11
procedure TBrickletLinearPoti.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletLinearPoti.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 TBrickletLinearPoti.SetPositionCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletLinearPoti.GetPositionCallbackPeriod: longword

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

procedure TBrickletLinearPoti.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 TBrickletLinearPoti.GetAnalogValueCallbackPeriod: longword

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

procedure TBrickletLinearPoti.SetPositionCallbackThreshold(const option: char; const min: word; const max: word)

Setzt den Schwellwert für den OnPositionReached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn die Position außerhalb der min und max Werte ist
'i' Callback wird ausgelöst wenn die Position innerhalb der min und max Werte ist
'<' Callback wird ausgelöst wenn die Position kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die Position 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_LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletLinearPoti.GetPositionCallbackThreshold(out option: char; out min: word; out max: word)

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

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

  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletLinearPoti.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 der min und max Werte ist
'i' Callback wird ausgelöst wenn der Analogwert innerhalb der min und max Werte 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_LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletLinearPoti.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_LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletLinearPoti.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 TBrickletLinearPoti.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: TBrickletLinearPoti; const param: word);
begin
  WriteLn(param);
end;

linearPoti.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 TBrickletLinearPoti.OnPosition
procedure(sender: TBrickletLinearPoti; const position: word) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod, ausgelöst. Der Parameter ist die Position des Linearpotentiometers.

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

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

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

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

property TBrickletLinearPoti.OnPositionReached
procedure(sender: TBrickletLinearPoti; const position: word) of object;

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von SetPositionCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Position des Linearpotentiometers.

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

property TBrickletLinearPoti.OnAnalogValueReached
procedure(sender: TBrickletLinearPoti; 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 Linearpotentiometers.

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

Konstanten

const BRICKLET_LINEAR_POTI_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Linear Poti Bricklet zu identifizieren.

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

const BRICKLET_LINEAR_POTI_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.