Delphi/Lazarus - Laser Range Finder 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
53
54
55
56
57
58
59

program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletLaserRangeFinder;

type
  TExample = class
  private
    ipcon: TIPConnection;
    lrf: TBrickletLaserRangeFinder;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Laser Range Finder Bricklet }

var
  e: TExample;

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

  { Create device object }
  lrf := TBrickletLaserRangeFinder.Create(UID, ipcon);

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

  { Turn laser on and wait 250ms for very first measurement to be ready }
  lrf.EnableLaser;
  Sleep(250);

  { Get current distance }
  distance := lrf.GetDistance;
  WriteLn(Format('Distance: %d cm', [distance]));

  WriteLn('Press key to exit');
  ReadLn;

  lrf.DisableLaser; { Turn laser off }

  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
63
64
65
66
67
68
69

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletLaserRangeFinder;

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

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Laser Range Finder Bricklet }

var
  e: TExample;

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

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

  { Create device object }
  lrf := TBrickletLaserRangeFinder.Create(UID, ipcon);

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

  { Turn laser on and wait 250ms for very first measurement to be ready }
  lrf.EnableLaser;
  Sleep(250);

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

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

  WriteLn('Press key to exit');
  ReadLn;

  lrf.DisableLaser; { Turn laser off }

  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
64
65
66
67
68
69
70
71

program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletLaserRangeFinder;

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

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Laser Range Finder Bricklet }

var
  e: TExample;

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

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

  { Create device object }
  lrf := TBrickletLaserRangeFinder.Create(UID, ipcon);

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

  { Turn laser on and wait 250ms for very first measurement to be ready }
  lrf.EnableLaser;
  Sleep(250);

  { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
  lrf.SetDebouncePeriod(10000);

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

  { Configure threshold for distance "greater than 20 cm" }
  lrf.SetDistanceCallbackThreshold('>', 20, 0);

  WriteLn('Press key to exit');
  ReadLn;

  lrf.DisableLaser; { Turn laser off }

  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

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

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	laserRangeFinder – Typ: TBrickletLaserRangeFinder

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

laserRangeFinder := TBrickletLaserRangeFinder.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletLaserRangeFinder.GetDistance: word¶

Rückgabe:	distance – Typ: word, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Gibt die gemessene Distanz zurück.

Sensor Hardware Version 1 (siehe GetSensorHardwareVersion) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels SetMode der Distanzmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen. Zusätzlich muss der Laser aktiviert werden, siehe EnableLaser.

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

function TBrickletLaserRangeFinder.GetVelocity: smallint¶

Rückgabe:	velocity – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Gibt die gemessene Geschwindigkeit zurück.

Sensor Hardware Version 1 (siehe GetSensorHardwareVersion) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels SetMode ein Geschwindigkeitsmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen, jedoch liefert die Geschwindigkeitsmessung nur dann stabile Werte, wenn eine feste Messfrequenz (siehe SetConfiguration) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe EnableLaser.

Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen den OnVelocity Callback zu nutzen und die Periode mit SetVelocityCallbackPeriod vorzugeben.

procedure TBrickletLaserRangeFinder.SetMode(const mode: byte)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Bemerkung

Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware Version 1 verbaut ist. Für Hardware Version 3 gibt es SetConfiguration. die Hardware Version des Sensors kann mittels GetSensorHardwareVersion abgefragt werden.

Der LIDAR-Lite Sensor (Hardware Version 1) hat fünf verschiedene Modi. Ein Modus ist für Distanzmessungen und vier Modi sind für Geschwindigkeitsmessungen mit unterschiedlichen Wertebereichen.

Die folgenden Modi können genutzt werden:

• 0: Distanz wird gemessen mit Auflösung 1,0 cm und Wertebereich 0-4000 cm
• 1: Geschwindigkeit wird gemessen mit Auflösung 0,1 m/s und Wertebereich 0-12,7 m/s
• 2: Geschwindigkeit wird gemessen mit Auflösung 0,25 m/s und Wertebereich 0-31,75 m/s
• 3: Geschwindigkeit wird gemessen mit Auflösung 0,5 m/s und Wertebereich 0-63,5 m/s
• 4: Geschwindigkeit wird gemessen mit Auflösung 1,0 m/s und Wertebereich 0-127 m/s

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

Für mode:

• BRICKLET_LASER_RANGE_FINDER_MODE_DISTANCE = 0
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_13MS = 1
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_32MS = 2
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_64MS = 3
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_127MS = 4

function TBrickletLaserRangeFinder.GetMode: byte¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Modus zurück, wie von SetMode gesetzt.

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

Für mode:

• BRICKLET_LASER_RANGE_FINDER_MODE_DISTANCE = 0
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_13MS = 1
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_32MS = 2
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_64MS = 3
• BRICKLET_LASER_RANGE_FINDER_MODE_VELOCITY_MAX_127MS = 4

procedure TBrickletLaserRangeFinder.EnableLaser¶

Aktiviert den Laser des LIDAR.

Wir empfehlen nach dem aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von GetDistance um stabile Messwerte zu garantieren.

procedure TBrickletLaserRangeFinder.DisableLaser¶

Deaktiviert den Laser des LIDAR.

function TBrickletLaserRangeFinder.IsLaserEnabled: boolean¶

Rückgabe:	laserEnabled – Typ: boolean

Gibt true zurück wenn der Laser aktiviert ist, false sonst.

procedure TBrickletLaserRangeFinder.SetConfiguration(const acquisitionCount: byte; const enableQuickTermination: boolean; const thresholdValue: byte; const measurementFrequency: word)¶

Parameter:	acquisitionCount – Typ: byte, Wertebereich: [1 bis 255], Standardwert: 128 enableQuickTermination – Typ: boolean, Standardwert: false thresholdValue – Typ: byte, Wertebereich: [0 bis 255], Standardwert: 0 measurementFrequency – Typ: word, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Bemerkung

Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware Version 3 verbaut ist. Für Hardware Version 1 gibt es SetMode. Die Hardware Version des Sensors kann mittels GetSensorHardwareVersion abgefragt werden.

Der Parameter Acquisition Count definiert die Anzahl der Datenerfassungen die integriert werden, um eine Korrelation zu finden. Mit einer größeren Anzahl kann das Bricklet höhere Distanzen messen, mit einer kleineren Anzahl ist die Messrate höher. Erlaubte Werte sind 1-255.

Wenn der Parameter Enable Quick Termination auf true gesetzt wird, wird die Distanzmessung abgeschlossen, sobald das erste mal ein hoher Peak erfasst wird. Dadurch kann eine höhere Messrate erreicht werden wobei gleichzeitig Messungen mit langer Distanz möglich sind. Die Wahrscheinlichkeit einer Falschmessung erhöht sich allerdings.

Normalerweise wird die Distanz mit Hilfe eines Detektionsalgorithmus berechnet. Dieser verwendet Peak-Werte, Signalstärke und Rauschen. Es ist möglich stattdessen über den Parameter Threshold Value einen festen Schwellwert zu setzen der zur Distanzbestimmung genutzt werden soll. Um den Abstand zu einem Objekt mit sehr niedriger Reflektivität zu messen (z.B. Glas) kann der Wert niedrig gesetzt werden. Um den Abstand zu einem Objekt mit sehr hoher Reflektivität zu messen (z.B. Spiegel) kann der Wert sehr hoch gesetzt werden. Mit einem Wert von 0 wird der Standardalgorithmus genutzt. Ansonsten ist der erlaubte Wertebereich 1-255.

Der Measurement Frequency Parameter erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).

Neu in Version 2.0.3 (Plugin).

procedure TBrickletLaserRangeFinder.GetConfiguration(out acquisitionCount: byte; out enableQuickTermination: boolean; out thresholdValue: byte; out measurementFrequency: word)¶

Ausgabeparameter:	acquisitionCount – Typ: byte, Wertebereich: [1 bis 255], Standardwert: 128 enableQuickTermination – Typ: boolean, Standardwert: false thresholdValue – Typ: byte, Wertebereich: [0 bis 255], Standardwert: 0 measurementFrequency – Typ: word, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

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

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen¶

procedure TBrickletLaserRangeFinder.SetMovingAverage(const distanceAverageLength: byte; const velocityAverageLength: byte)¶

Parameter:	distanceAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10 velocityAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10

Setzt die Länge eines gleitenden Mittelwerts für die Entfernung und Geschwindigkeit.

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.

procedure TBrickletLaserRangeFinder.GetMovingAverage(out distanceAverageLength: byte; out velocityAverageLength: byte)¶

Ausgabeparameter:	distanceAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10 velocityAverageLength – Typ: byte, Wertebereich: [0 bis 30], Standardwert: 10

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

function TBrickletLaserRangeFinder.GetSensorHardwareVersion: byte¶

Rückgabe:	version – Typ: byte, Wertebereich: Siehe Konstanten

Gibt die LIDAR-Lite Hardware version zurück.

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

Für version:

• BRICKLET_LASER_RANGE_FINDER_VERSION_1 = 1
• BRICKLET_LASER_RANGE_FINDER_VERSION_3 = 3

Neu in Version 2.0.3 (Plugin).

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

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

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

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

function TBrickletLaserRangeFinder.GetVelocityCallbackPeriod: longword¶

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

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

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

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

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_LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'

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

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

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

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

Für option:

• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletLaserRangeFinder.SetVelocityCallbackThreshold(const option: char; const min: smallint; const max: smallint)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den OnVelocityReached Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletLaserRangeFinder.GetVelocityCallbackThreshold(out option: char; out min: smallint; out max: smallint)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_LASER_RANGE_FINDER_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletLaserRangeFinder.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,
• OnVelocityReached,

ausgelöst werden, wenn die Schwellwerte

• SetDistanceCallbackThreshold,
• SetVelocityCallbackThreshold,

weiterhin erreicht bleiben.

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

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

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

property TBrickletLaserRangeFinder.OnDistance¶

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

Callback-Parameter:	sender – Typ: TBrickletLaserRangeFinder distance – Typ: word, Einheit: 1 cm, Wertebereich: [0 bis 4000]

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 TBrickletLaserRangeFinder.OnVelocity¶

procedure(sender: TBrickletLaserRangeFinder; const velocity: smallint) of object;

Callback-Parameter:	sender – Typ: TBrickletLaserRangeFinder velocity – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

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

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

property TBrickletLaserRangeFinder.OnDistanceReached¶

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

Callback-Parameter:	sender – Typ: TBrickletLaserRangeFinder distance – Typ: word, Einheit: 1 cm, Wertebereich: [0 bis 4000]

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.

property TBrickletLaserRangeFinder.OnVelocityReached¶

procedure(sender: TBrickletLaserRangeFinder; const velocity: smallint) of object;

Callback-Parameter:	sender – Typ: TBrickletLaserRangeFinder velocity – Typ: smallint, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetVelocityCallbackThreshold gesetzt, erreicht wird. Der Parameter ist der Geschwindigkeitswert 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 TBrickletLaserRangeFinder.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 TBrickletLaserRangeFinder.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_LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_MOVING_AVERAGE = 13
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_MODE = 15
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_ENABLE_LASER = 17
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_DISABLE_LASER = 18
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_CONFIGURATION = 25

procedure TBrickletLaserRangeFinder.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_LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_MOVING_AVERAGE = 13
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_MODE = 15
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_ENABLE_LASER = 17
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_DISABLE_LASER = 18
• BRICKLET_LASER_RANGE_FINDER_FUNCTION_SET_CONFIGURATION = 25

procedure TBrickletLaserRangeFinder.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_LASER_RANGE_FINDER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Laser Range Finder 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_LASER_RANGE_FINDER_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Laser Range Finder Bricklet dar.