Delphi/Lazarus - Distance US 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, BrickletDistanceUS;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dus: TBrickletDistanceUS;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  dus := TBrickletDistanceUS.Create(UID, ipcon);

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

  { Get current distance value }
  distance := dus.GetDistanceValue;
  WriteLn(Format('Distance Value: %d', [distance]));

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    dus: TBrickletDistanceUS;
  public
    procedure DistanceCB(sender: TBrickletDistanceUS; const distance: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for distance value callback }
procedure TExample.DistanceCB(sender: TBrickletDistanceUS; const distance: word);
begin
  WriteLn(Format('Distance Value: %d', [distance]));
end;

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

  { Create device object }
  dus := TBrickletDistanceUS.Create(UID, ipcon);

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

  { Register distance value callback to procedure DistanceCB }
  dus.OnDistance := {$ifdef FPC}@{$endif}DistanceCB;

  { Set period for distance value callback to 0.2s (200ms)
    Note: The distance value callback is only called every 0.2 seconds
          if the distance value has changed since the last call! }
  dus.SetDistanceCallbackPeriod(200);

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    dus: TBrickletDistanceUS;
  public
    procedure DistanceReachedCB(sender: TBrickletDistanceUS; const distance: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for distance value reached callback }
procedure TExample.DistanceReachedCB(sender: TBrickletDistanceUS; const distance: word);
begin
  WriteLn(Format('Distance Value: %d', [distance]));
end;

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

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

  { Register distance value reached callback to procedure DistanceReachedCB }
  dus.OnDistanceReached := {$ifdef FPC}@{$endif}DistanceReachedCB;

  { Configure threshold for distance value "smaller than 200" }
  dus.SetDistanceCallbackThreshold('<', 200, 0);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	distanceUS – Typ: TBrickletDistanceUS

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

distanceUS := TBrickletDistanceUS.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletDistanceUS.GetDistanceValue: word¶

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

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den OnDistance Callback zu nutzen und die Periode mit SetDistanceCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen¶

procedure TBrickletDistanceUS.SetMovingAverage(const average: byte)¶

Parameter:	average – Typ: byte, Wertebereich: [0 bis 100], Standardwert: 20

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

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

function TBrickletDistanceUS.GetMovingAverage: byte¶

Rückgabe:	average – Typ: byte, Wertebereich: [0 bis 100], Standardwert: 20

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

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

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

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

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

function TBrickletDistanceUS.GetDistanceCallbackPeriod: longword¶

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

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

procedure TBrickletDistanceUS.SetDistanceCallbackThreshold(const option: char; const min: word; const max: word)¶

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

Setzt den Schwellwert für den OnDistanceReached Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletDistanceUS.GetDistanceCallbackThreshold(out option: char; out min: word; out max: word)¶

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

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

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

Für option:

• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_DISTANCE_US_THRESHOLD_OPTION_GREATER = '>'

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

• OnDistanceReached,

ausgelöst werden, wenn die Schwellwerte

• SetDistanceCallbackThreshold,

weiterhin erreicht bleiben.

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

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

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

property TBrickletDistanceUS.OnDistance¶

procedure(sender: TBrickletDistanceUS; const distance: word) of object;

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

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

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

property TBrickletDistanceUS.OnDistanceReached¶

procedure(sender: TBrickletDistanceUS; const distance: word) of object;

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetDistanceCallbackThreshold gesetzt, erreicht wird. Der Parameter ist der Entfernungswert 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 TBrickletDistanceUS.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 TBrickletDistanceUS.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_DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
• BRICKLET_DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
• BRICKLET_DISTANCE_US_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BRICKLET_DISTANCE_US_FUNCTION_SET_MOVING_AVERAGE = 10

procedure TBrickletDistanceUS.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_DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
• BRICKLET_DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
• BRICKLET_DISTANCE_US_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BRICKLET_DISTANCE_US_FUNCTION_SET_MOVING_AVERAGE = 10

procedure TBrickletDistanceUS.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_DISTANCE_US_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Distance US 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_DISTANCE_US_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet dar.