Delphi/Lazarus - Linear Poti Bricklet¶

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.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	linearPoti – Typ: TBrickletLinearPoti

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.

function TBrickletLinearPoti.GetPosition: word¶

Rückgabe:	position – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 100]

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¶

Rückgabe:	value – Typ: word, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

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.

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

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

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

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

function TBrickletLinearPoti.GetPositionCallbackPeriod: longword¶

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

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

procedure TBrickletLinearPoti.SetAnalogValueCallbackPeriod(const period: longword)¶

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

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

function TBrickletLinearPoti.GetAnalogValueCallbackPeriod: longword¶

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

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

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

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für option:

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

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für option:

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

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

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

Setzt die Periode mit welcher die Schwellwert Callbacks

• OnPositionReached,
• OnAnalogValueReached

ausgelöst werden, wenn die Schwellwerte

• SetPositionCallbackThreshold,
• SetAnalogValueCallbackThreshold

weiterhin erreicht bleiben.

function TBrickletLinearPoti.GetDebouncePeriod: longword¶

Rückgabe:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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: TBrickletLinearPoti; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

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

property TBrickletLinearPoti.OnPosition¶

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

Callback-Parameter:	sender – Typ: TBrickletLinearPoti position – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 100]

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;

Callback-Parameter:	sender – Typ: TBrickletLinearPoti value – Typ: word, Wertebereich: [0 bis 212 - 1]

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;

Callback-Parameter:	sender – Typ: TBrickletLinearPoti position – Typ: word, Einheit: 1 %, Wertebereich: [0 bis 100]

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;

Callback-Parameter:	sender – Typ: TBrickletLinearPoti value – Typ: word, Wertebereich: [0 bis 212 - 1]

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.

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

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

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

Diese Konstante wird verwendet um ein Linear Poti 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_LINEAR_POTI_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.