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).
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 | program ExampleSimple;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletAccelerometer;
type
TExample = class
private
ipcon: TIPConnection;
a: TBrickletAccelerometer;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Accelerometer Bricklet }
var
e: TExample;
procedure TExample.Execute;
var x, y, z: smallint;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
a := TBrickletAccelerometer.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Get current acceleration }
a.GetAcceleration(x, y, z);
WriteLn(Format('Acceleration [X]: %f g', [x/1000.0]));
WriteLn(Format('Acceleration [Y]: %f g', [y/1000.0]));
WriteLn(Format('Acceleration [Z]: %f g', [z/1000.0]));
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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 | program ExampleCallback;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletAccelerometer;
type
TExample = class
private
ipcon: TIPConnection;
a: TBrickletAccelerometer;
public
procedure AccelerationCB(sender: TBrickletAccelerometer; const x: smallint;
const y: smallint; const z: smallint);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Accelerometer Bricklet }
var
e: TExample;
{ Callback procedure for acceleration callback }
procedure TExample.AccelerationCB(sender: TBrickletAccelerometer; const x: smallint;
const y: smallint; const z: smallint);
begin
WriteLn(Format('Acceleration [X]: %f g', [x/1000.0]));
WriteLn(Format('Acceleration [Y]: %f g', [y/1000.0]));
WriteLn(Format('Acceleration [Z]: %f g', [z/1000.0]));
WriteLn('');
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
a := TBrickletAccelerometer.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Register acceleration callback to procedure AccelerationCB }
a.OnAcceleration := {$ifdef FPC}@{$endif}AccelerationCB;
{ Set period for acceleration callback to 1s (1000ms)
Note: The acceleration callback is only called every second
if the acceleration has changed since the last call! }
a.SetAccelerationCallbackPeriod(1000);
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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 | program ExampleThreshold;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletAccelerometer;
type
TExample = class
private
ipcon: TIPConnection;
a: TBrickletAccelerometer;
public
procedure AccelerationReachedCB(sender: TBrickletAccelerometer; const x: smallint;
const y: smallint; const z: smallint);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your Accelerometer Bricklet }
var
e: TExample;
{ Callback procedure for acceleration reached callback }
procedure TExample.AccelerationReachedCB(sender: TBrickletAccelerometer;
const x: smallint; const y: smallint;
const z: smallint);
begin
WriteLn(Format('Acceleration [X]: %f g', [x/1000.0]));
WriteLn(Format('Acceleration [Y]: %f g', [y/1000.0]));
WriteLn(Format('Acceleration [Z]: %f g', [z/1000.0]));
WriteLn('');
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
a := TBrickletAccelerometer.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) }
a.SetDebouncePeriod(10000);
{ Register acceleration reached callback to procedure AccelerationReachedCB }
a.OnAccelerationReached := {$ifdef FPC}@{$endif}AccelerationReachedCB;
{ Configure threshold for acceleration "greater than 2 g, 2 g, 2 g" }
a.SetAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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.
TBrickletAccelerometer.
Create
(const uid: string; ipcon: TIPConnection)¶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.
TBrickletAccelerometer.
GetAcceleration
(out x: smallint; out y: smallint; out z: smallint)¶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.
TBrickletAccelerometer.
GetTemperature
: smallint¶Rückgabe: |
|
---|
Gibt die Temperatur des Beschleunigungssensors zurück.
TBrickletAccelerometer.
LEDOn
¶Aktiviert die LED auf dem Bricklet.
TBrickletAccelerometer.
LEDOff
¶Deaktiviert die LED auf dem Bricklet.
TBrickletAccelerometer.
IsLEDOn
: boolean¶Rückgabe: |
|
---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
TBrickletAccelerometer.
SetConfiguration
(const dataRate: byte; const fullScale: byte; const filterBandwidth: byte)¶Parameter: |
|
---|
Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:
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:
Für fullScale:
Für filterBandwidth:
TBrickletAccelerometer.
GetConfiguration
(out dataRate: byte; out fullScale: byte; out filterBandwidth: byte)¶Ausgabeparameter: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfiguration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
Für fullScale:
Für filterBandwidth:
TBrickletAccelerometer.
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: |
|
---|
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.
TBrickletAccelerometer.
SetAccelerationCallbackPeriod
(const period: longword)¶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.
TBrickletAccelerometer.
GetAccelerationCallbackPeriod
: longword¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAccelerationCallbackPeriod
gesetzt.
TBrickletAccelerometer.
SetAccelerationCallbackThreshold
(const option: char; const minX: smallint; const maxX: smallint; const minY: smallint; const maxY: smallint; const minZ: smallint; const maxZ: smallint)¶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:
TBrickletAccelerometer.
GetAccelerationCallbackThreshold
(out option: char; out minX: smallint; out maxX: smallint; out minY: smallint; out maxY: smallint; out minZ: smallint; out maxZ: smallint)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetAccelerationCallbackThreshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
TBrickletAccelerometer.
SetDebouncePeriod
(const debounce: longword)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
TBrickletAccelerometer.
GetDebouncePeriod
: longword¶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.
TBrickletAccelerometer.
OnAcceleration
¶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.
TBrickletAccelerometer.
OnAccelerationReached
¶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.
TBrickletAccelerometer.
GetAPIVersion
: array [0..2] of byte¶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.
TBrickletAccelerometer.
GetResponseExpected
(const functionId: byte): boolean¶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:
TBrickletAccelerometer.
SetResponseExpected
(const functionId: byte; const responseExpected: boolean)¶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:
TBrickletAccelerometer.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BRICKLET_ACCELEROMETER_DEVICE_IDENTIFIER
¶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.
BRICKLET_ACCELEROMETER_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.