Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1program ExampleSimple;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletAccelerometer;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 a: TBrickletAccelerometer;
14 public
15 procedure Execute;
16 end;
17
18const
19 HOST = 'localhost';
20 PORT = 4223;
21 UID = 'XYZ'; { Change XYZ to the UID of your Accelerometer Bricklet }
22
23var
24 e: TExample;
25
26procedure TExample.Execute;
27var x, y, z: smallint;
28begin
29 { Create IP connection }
30 ipcon := TIPConnection.Create;
31
32 { Create device object }
33 a := TBrickletAccelerometer.Create(UID, ipcon);
34
35 { Connect to brickd }
36 ipcon.Connect(HOST, PORT);
37 { Don't use device before ipcon is connected }
38
39 { Get current acceleration }
40 a.GetAcceleration(x, y, z);
41
42 WriteLn(Format('Acceleration [X]: %f g', [x/1000.0]));
43 WriteLn(Format('Acceleration [Y]: %f g', [y/1000.0]));
44 WriteLn(Format('Acceleration [Z]: %f g', [z/1000.0]));
45
46 WriteLn('Press key to exit');
47 ReadLn;
48 ipcon.Destroy; { Calls ipcon.Disconnect internally }
49end;
50
51begin
52 e := TExample.Create;
53 e.Execute;
54 e.Destroy;
55end.
Download (ExampleCallback.pas)
1program ExampleCallback;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletAccelerometer;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 a: TBrickletAccelerometer;
14 public
15 procedure AccelerationCB(sender: TBrickletAccelerometer; const x: smallint;
16 const y: smallint; const z: smallint);
17 procedure Execute;
18 end;
19
20const
21 HOST = 'localhost';
22 PORT = 4223;
23 UID = 'XYZ'; { Change XYZ to the UID of your Accelerometer Bricklet }
24
25var
26 e: TExample;
27
28{ Callback procedure for acceleration callback }
29procedure TExample.AccelerationCB(sender: TBrickletAccelerometer; const x: smallint;
30 const y: smallint; const z: smallint);
31begin
32 WriteLn(Format('Acceleration [X]: %f g', [x/1000.0]));
33 WriteLn(Format('Acceleration [Y]: %f g', [y/1000.0]));
34 WriteLn(Format('Acceleration [Z]: %f g', [z/1000.0]));
35 WriteLn('');
36end;
37
38procedure TExample.Execute;
39begin
40 { Create IP connection }
41 ipcon := TIPConnection.Create;
42
43 { Create device object }
44 a := TBrickletAccelerometer.Create(UID, ipcon);
45
46 { Connect to brickd }
47 ipcon.Connect(HOST, PORT);
48 { Don't use device before ipcon is connected }
49
50 { Register acceleration callback to procedure AccelerationCB }
51 a.OnAcceleration := {$ifdef FPC}@{$endif}AccelerationCB;
52
53 { Set period for acceleration callback to 1s (1000ms)
54 Note: The acceleration callback is only called every second
55 if the acceleration has changed since the last call! }
56 a.SetAccelerationCallbackPeriod(1000);
57
58 WriteLn('Press key to exit');
59 ReadLn;
60 ipcon.Destroy; { Calls ipcon.Disconnect internally }
61end;
62
63begin
64 e := TExample.Create;
65 e.Execute;
66 e.Destroy;
67end.
Download (ExampleThreshold.pas)
1program ExampleThreshold;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletAccelerometer;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 a: TBrickletAccelerometer;
14 public
15 procedure AccelerationReachedCB(sender: TBrickletAccelerometer; const x: smallint;
16 const y: smallint; const z: smallint);
17 procedure Execute;
18 end;
19
20const
21 HOST = 'localhost';
22 PORT = 4223;
23 UID = 'XYZ'; { Change XYZ to the UID of your Accelerometer Bricklet }
24
25var
26 e: TExample;
27
28{ Callback procedure for acceleration reached callback }
29procedure TExample.AccelerationReachedCB(sender: TBrickletAccelerometer;
30 const x: smallint; const y: smallint;
31 const z: smallint);
32begin
33 WriteLn(Format('Acceleration [X]: %f g', [x/1000.0]));
34 WriteLn(Format('Acceleration [Y]: %f g', [y/1000.0]));
35 WriteLn(Format('Acceleration [Z]: %f g', [z/1000.0]));
36 WriteLn('');
37end;
38
39procedure TExample.Execute;
40begin
41 { Create IP connection }
42 ipcon := TIPConnection.Create;
43
44 { Create device object }
45 a := TBrickletAccelerometer.Create(UID, ipcon);
46
47 { Connect to brickd }
48 ipcon.Connect(HOST, PORT);
49 { Don't use device before ipcon is connected }
50
51 { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
52 a.SetDebouncePeriod(10000);
53
54 { Register acceleration reached callback to procedure AccelerationReachedCB }
55 a.OnAccelerationReached := {$ifdef FPC}@{$endif}AccelerationReachedCB;
56
57 { Configure threshold for acceleration "greater than 2 g, 2 g, 2 g" }
58 a.SetAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
59
60 WriteLn('Press key to exit');
61 ReadLn;
62 ipcon.Destroy; { Calls ipcon.Disconnect internally }
63end;
64
65begin
66 e := TExample.Create;
67 e.Execute;
68 e.Destroy;
69end.
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
accelerometer := TBrickletAccelerometer.Create('YOUR_DEVICE_UID', ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Ausgabeparameter: |
|
|---|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/1000 (1gₙ = 9,80665m/s²). Der Wertebereich
wird mit SetConfiguration konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen
den OnAcceleration Callback zu nutzen und die Periode mit
SetAccelerationCallbackPeriod vorzugeben.
| Rückgabe: |
|
|---|
Gibt die Temperatur des Beschleunigungssensors zurück.
Aktiviert die LED auf dem Bricklet.
Deaktiviert die LED auf dem Bricklet.
| Rückgabe: |
|
|---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
| Parameter: |
|
|---|
Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:
Datenrate zwischen 0Hz und 1600Hz.
Wertebereich von ±2gₙ bis zu ±16gₙ.
Filterbandbreite zwischen 50Hz und 800Hz.
Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
BRICKLET_ACCELEROMETER_DATA_RATE_OFF = 0
BRICKLET_ACCELEROMETER_DATA_RATE_3HZ = 1
BRICKLET_ACCELEROMETER_DATA_RATE_6HZ = 2
BRICKLET_ACCELEROMETER_DATA_RATE_12HZ = 3
BRICKLET_ACCELEROMETER_DATA_RATE_25HZ = 4
BRICKLET_ACCELEROMETER_DATA_RATE_50HZ = 5
BRICKLET_ACCELEROMETER_DATA_RATE_100HZ = 6
BRICKLET_ACCELEROMETER_DATA_RATE_400HZ = 7
BRICKLET_ACCELEROMETER_DATA_RATE_800HZ = 8
BRICKLET_ACCELEROMETER_DATA_RATE_1600HZ = 9
Für fullScale:
BRICKLET_ACCELEROMETER_FULL_SCALE_2G = 0
BRICKLET_ACCELEROMETER_FULL_SCALE_4G = 1
BRICKLET_ACCELEROMETER_FULL_SCALE_6G = 2
BRICKLET_ACCELEROMETER_FULL_SCALE_8G = 3
BRICKLET_ACCELEROMETER_FULL_SCALE_16G = 4
Für filterBandwidth:
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_800HZ = 0
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_400HZ = 1
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_200HZ = 2
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_50HZ = 3
| Ausgabeparameter: |
|
|---|
Gibt die Konfiguration zurück, wie von SetConfiguration gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
BRICKLET_ACCELEROMETER_DATA_RATE_OFF = 0
BRICKLET_ACCELEROMETER_DATA_RATE_3HZ = 1
BRICKLET_ACCELEROMETER_DATA_RATE_6HZ = 2
BRICKLET_ACCELEROMETER_DATA_RATE_12HZ = 3
BRICKLET_ACCELEROMETER_DATA_RATE_25HZ = 4
BRICKLET_ACCELEROMETER_DATA_RATE_50HZ = 5
BRICKLET_ACCELEROMETER_DATA_RATE_100HZ = 6
BRICKLET_ACCELEROMETER_DATA_RATE_400HZ = 7
BRICKLET_ACCELEROMETER_DATA_RATE_800HZ = 8
BRICKLET_ACCELEROMETER_DATA_RATE_1600HZ = 9
Für fullScale:
BRICKLET_ACCELEROMETER_FULL_SCALE_2G = 0
BRICKLET_ACCELEROMETER_FULL_SCALE_4G = 1
BRICKLET_ACCELEROMETER_FULL_SCALE_6G = 2
BRICKLET_ACCELEROMETER_FULL_SCALE_8G = 3
BRICKLET_ACCELEROMETER_FULL_SCALE_16G = 4
Für filterBandwidth:
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_800HZ = 0
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_400HZ = 1
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_200HZ = 2
BRICKLET_ACCELEROMETER_FILTER_BANDWIDTH_50HZ = 3
| Ausgabeparameter: |
|
|---|
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.
| Parameter: |
|
|---|
Setzt die Periode mit welcher der OnAcceleration Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der OnAcceleration Callback wird nur ausgelöst, wenn sich die Acceleration
seit der letzten Auslösung geändert hat.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetAccelerationCallbackPeriod gesetzt.
| Parameter: |
|
|---|
Setzt den Schwellwert für den OnAccelerationReached Callback.
Die folgenden Optionen sind möglich:
Option |
Beschreibung |
|---|---|
'x' |
Callback ist inaktiv |
'o' |
Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist |
'i' |
Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist |
'<' |
Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert) |
'>' |
Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_GREATER = '>'
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetAccelerationCallbackThreshold gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_ACCELEROMETER_THRESHOLD_OPTION_GREATER = '>'
| Parameter: |
|
|---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
| Rückgabe: |
|
|---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.
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: TBrickletAccelerometer; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; accelerometer.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.
procedure(sender: TBrickletAccelerometer; const x: smallint; const y: smallint; const z: smallint) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAccelerationCallbackPeriod, ausgelöst. Die Parameter
sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit SetConfiguration konfiguriert.
Der OnAcceleration Callback wird nur ausgelöst, wenn sich die Beschleunigung
seit der letzten Auslösung geändert hat.
procedure(sender: TBrickletAccelerometer; const x: smallint; const y: smallint; const z: smallint) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAccelerationCallbackThreshold gesetzt, erreicht wird.
Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit SetConfiguration konfiguriert.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod gesetzt, ausgelöst.
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.
| Ausgabeparameter: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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_ACCELEROMETER_FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
BRICKLET_ACCELEROMETER_FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
BRICKLET_ACCELEROMETER_FUNCTION_SET_DEBOUNCE_PERIOD = 6
BRICKLET_ACCELEROMETER_FUNCTION_SET_CONFIGURATION = 9
BRICKLET_ACCELEROMETER_FUNCTION_LED_ON = 11
BRICKLET_ACCELEROMETER_FUNCTION_LED_OFF = 12
| Parameter: |
|
|---|
Ä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_ACCELEROMETER_FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
BRICKLET_ACCELEROMETER_FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
BRICKLET_ACCELEROMETER_FUNCTION_SET_DEBOUNCE_PERIOD = 6
BRICKLET_ACCELEROMETER_FUNCTION_SET_CONFIGURATION = 9
BRICKLET_ACCELEROMETER_FUNCTION_LED_ON = 11
BRICKLET_ACCELEROMETER_FUNCTION_LED_OFF = 12
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein Accelerometer 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.
Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.