Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das IMU Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Bricklet 3.0 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 56 | program ExampleSimple;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletIMUV3;
type
TExample = class
private
ipcon: TIPConnection;
imu: TBrickletIMUV3;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your IMU Bricklet 3.0 }
var
e: TExample;
procedure TExample.Execute;
var w, x, y, z: smallint;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
imu := TBrickletIMUV3.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Get current quaternion }
imu.GetQuaternion(w, x, y, z);
WriteLn(Format('Quaternion [W]: %f', [w/16383.0]));
WriteLn(Format('Quaternion [X]: %f', [x/16383.0]));
WriteLn(Format('Quaternion [Y]: %f', [y/16383.0]));
WriteLn(Format('Quaternion [Z]: %f', [z/16383.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 | program ExampleCallback;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletIMUV3;
type
TExample = class
private
ipcon: TIPConnection;
imu: TBrickletIMUV3;
public
procedure QuaternionCB(sender: TBrickletIMUV3; const w: smallint; 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 IMU Bricklet 3.0 }
var
e: TExample;
{ Callback procedure for quaternion callback }
procedure TExample.QuaternionCB(sender: TBrickletIMUV3; const w: smallint;
const x: smallint; const y: smallint; const z: smallint);
begin
WriteLn(Format('Quaternion [W]: %f', [w/16383.0]));
WriteLn(Format('Quaternion [X]: %f', [x/16383.0]));
WriteLn(Format('Quaternion [Y]: %f', [y/16383.0]));
WriteLn(Format('Quaternion [Z]: %f', [z/16383.0]));
WriteLn('');
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
imu := TBrickletIMUV3.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Register quaternion callback to procedure QuaternionCB }
imu.OnQuaternion := {$ifdef FPC}@{$endif}QuaternionCB;
{ Set period for quaternion callback to 0.1s (100ms) }
imu.SetQuaternionCallbackConfiguration(100, false);
WriteLn('Press key to exit');
ReadLn;
ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;
begin
e := TExample.Create;
e.Execute;
e.Destroy;
end.
|
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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | program ExampleAllData;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletIMUV3;
type
TExample = class
private
ipcon: TIPConnection;
imu: TBrickletIMUV3;
public
procedure AllDataCB(sender: TBrickletIMUV3; const acceleration: TArray0To2OfInt16;
const magneticField: TArray0To2OfInt16;
const angularVelocity: TArray0To2OfInt16;
const eulerAngle: TArray0To2OfInt16;
const quaternion: TArray0To3OfInt16;
const linearAcceleration: TArray0To2OfInt16;
const gravityVector: TArray0To2OfInt16;
const temperature: shortint; const calibrationStatus: byte);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your IMU Bricklet 3.0 }
var
e: TExample;
{ Callback procedure for all data callback }
procedure TExample.AllDataCB(sender: TBrickletIMUV3;
const acceleration: TArray0To2OfInt16;
const magneticField: TArray0To2OfInt16;
const angularVelocity: TArray0To2OfInt16;
const eulerAngle: TArray0To2OfInt16;
const quaternion: TArray0To3OfInt16;
const linearAcceleration: TArray0To2OfInt16;
const gravityVector: TArray0To2OfInt16;
const temperature: shortint; const calibrationStatus: byte);
begin
WriteLn(Format('Acceleration [X]: %f m/s²', [acceleration[0]/100.0]));
WriteLn(Format('Acceleration [Y]: %f m/s²', [acceleration[1]/100.0]));
WriteLn(Format('Acceleration [Z]: %f m/s²', [acceleration[2]/100.0]));
WriteLn(Format('Magnetic Field [X]: %f µT', [magneticField[0]/16.0]));
WriteLn(Format('Magnetic Field [Y]: %f µT', [magneticField[1]/16.0]));
WriteLn(Format('Magnetic Field [Z]: %f µT', [magneticField[2]/16.0]));
WriteLn(Format('Angular Velocity [X]: %f °/s', [angularVelocity[0]/16.0]));
WriteLn(Format('Angular Velocity [Y]: %f °/s', [angularVelocity[1]/16.0]));
WriteLn(Format('Angular Velocity [Z]: %f °/s', [angularVelocity[2]/16.0]));
WriteLn(Format('Euler Angle [Heading]: %f °', [eulerAngle[0]/16.0]));
WriteLn(Format('Euler Angle [Roll]: %f °', [eulerAngle[1]/16.0]));
WriteLn(Format('Euler Angle [Pitch]: %f °', [eulerAngle[2]/16.0]));
WriteLn(Format('Quaternion [W]: %f', [quaternion[0]/16383.0]));
WriteLn(Format('Quaternion [X]: %f', [quaternion[1]/16383.0]));
WriteLn(Format('Quaternion [Y]: %f', [quaternion[2]/16383.0]));
WriteLn(Format('Quaternion [Z]: %f', [quaternion[3]/16383.0]));
WriteLn(Format('Linear Acceleration [X]: %f m/s²', [linearAcceleration[0]/100.0]));
WriteLn(Format('Linear Acceleration [Y]: %f m/s²', [linearAcceleration[1]/100.0]));
WriteLn(Format('Linear Acceleration [Z]: %f m/s²', [linearAcceleration[2]/100.0]));
WriteLn(Format('Gravity Vector [X]: %f m/s²', [gravityVector[0]/100.0]));
WriteLn(Format('Gravity Vector [Y]: %f m/s²', [gravityVector[1]/100.0]));
WriteLn(Format('Gravity Vector [Z]: %f m/s²', [gravityVector[2]/100.0]));
WriteLn(Format('Temperature: %d °C', [temperature]));
WriteLn(Format('Calibration Status: %d', [calibrationStatus]));
WriteLn('');
end;
procedure TExample.Execute;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
imu := TBrickletIMUV3.Create(UID, ipcon);
{ Connect to brickd }
ipcon.Connect(HOST, PORT);
{ Don't use device before ipcon is connected }
{ Register all data callback to procedure AllDataCB }
imu.OnAllData := {$ifdef FPC}@{$endif}AllDataCB;
{ Set period for all data callback to 0.1s (100ms) }
imu.SetAllDataCallbackConfiguration(100, false);
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.
TBrickletIMUV3.
Create
(const uid: string; ipcon: TIPConnection)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
imuV3 := TBrickletIMUV3.Create('YOUR_DEVICE_UID', ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
TBrickletIMUV3.
GetOrientation
(out heading: smallint; out roll: smallint; out pitch: smallint)¶Ausgabeparameter: |
|
---|
Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren. Wir empfehlen daher stattdessen Quaternionen zu verwenden, wenn die absolute Lage im Raum bestimmt werden soll.
Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den
OnOrientation
Callback zu nutzen und die Periode mit
SetOrientationCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetLinearAcceleration
(out x: smallint; out y: smallint; out z: smallint)¶Ausgabeparameter: |
|
---|
Gibt die lineare Beschleunigungen des IMU Brick für die
X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit
SetSensorConfiguration
konfiguriert wurde.
Die lineare Beschleunigung ist die Beschleunigung in jede der drei Achsen. Der Einfluss von Erdbeschleunigung ist entfernt.
Es ist auch möglich einen Vektor der Erdbeschleunigung zu bekommen, siehe
GetGravityVector
Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen
den OnLinearAcceleration
Callback zu nutzen und die Periode mit
SetLinearAccelerationCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetGravityVector
(out x: smallint; out y: smallint; out z: smallint)¶Ausgabeparameter: |
|
---|
Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse zurück.
Die Erdbeschleunigung ist die Beschleunigung die auf Grund von Schwerkraft entsteht. Einflüsse von linearen Beschleunigungen sind entfernt.
Es ist auch möglich die lineare Beschleunigung zu bekommen, siehe
GetLinearAcceleration
Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen
den OnGravityVector
Callback zu nutzen und die Periode mit
SetGravityVectorCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetQuaternion
(out w: smallint; out x: smallint; out y: smallint; out z: smallint)¶Ausgabeparameter: |
|
---|
Gibt die aktuelle Orientierung (w, x, y, z) des IMU Brick als Quaterinonen zurück.
Die Rückgabewerte müssen mit 16383 (14 Bit) dividiert werden, um in den üblichen Wertebereich für Quaternionen (-1,0 bis +1,0) gebracht zu werden.
Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den
OnQuaternion
Callback zu nutzen und die Periode mit
SetQuaternionCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetAllData
(out acceleration: array [0..2] of smallint; out magneticField: array [0..2] of smallint; out angularVelocity: array [0..2] of smallint; out eulerAngle: array [0..2] of smallint; out quaternion: array [0..3] of smallint; out linearAcceleration: array [0..2] of smallint; out gravityVector: array [0..2] of smallint; out temperature: shortint; out calibrationStatus: byte)¶Ausgabeparameter: |
|
---|
Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.
GetAcceleration
)GetMagneticField
)GetAngularVelocity
)GetOrientation
)GetQuaternion
)GetLinearAcceleration
)GetGravityVector
)GetTemperature
)Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.
Ein Wert von 0 bedeutet "nicht kalibriert" und ein Wert von 3 bedeutet "vollständig kalibriert". Normalerweise kann der Kalibrierungsstatus vollständig ignoriert werden. Er wird vom Brick Viewer im Kalibrierungsfenster benutzt und nur für die initiale Kalibrierung benötigt. Mehr Information zur Kalibrierung des IMU Bricks gibt es im Kalibrierungsfenster.
Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den
OnAllData
Callback zu nutzen und die Periode mit
SetAllDataCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetAcceleration
(out x: smallint; out y: smallint; out z: smallint)¶Ausgabeparameter: |
|
---|
Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die
X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit
SetSensorConfiguration
konfiguriert wurde.
Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen
den OnAcceleration
Callback zu nutzen und die Periode mit
SetAccelerationCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetMagneticField
(out x: smallint; out y: smallint; out z: smallint)¶Ausgabeparameter: |
|
---|
Gibt das kalibrierte Magnetfeld des Magnetometers für die X-, Y- und Z-Komponenten zurück.
Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen
den OnMagneticField
Callback zu nutzen und die Periode mit
SetMagneticFieldCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetAngularVelocity
(out x: smallint; out y: smallint; out z: smallint)¶Ausgabeparameter: |
|
---|
Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und
Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit
SetSensorConfiguration
konfiguriert wurde.
Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird
empfohlen den OnAngularVelocity
Callback zu nutzen und die Periode mit
SetAngularVelocityCallbackConfiguration
vorzugeben.
TBrickletIMUV3.
GetTemperature
: shortint¶Rückgabe: |
|
---|
Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.
TBrickletIMUV3.
SaveCalibration
: boolean¶Rückgabe: |
|
---|
Ein Aufruf dieser Funktion speichert die aktuelle Kalibrierung damit sie beim nächsten Neustart des IMU Brick als Startpunkt für die kontinuierliche Kalibrierung genutzt werden kann.
Ein Rückgabewert von true bedeutet das die Kalibrierung genutzt werden konnte und false bedeutet das die Kalibrierung nicht genutzt werden konnte (dies passiert wenn der Kalibrierungsstatus nicht "fully calibrated" ist).
Diese Funktion wird vom Kalibrierungsfenster des Brick Viewer benutzt. Sie sollte in einem normalen Benutzerprogramm nicht aufgerufen werden müssen.
TBrickletIMUV3.
SetSensorConfiguration
(const magnetometerRate: byte; const gyroscopeRange: byte; const gyroscopeBandwidth: byte; const accelerometerRange: byte; const accelerometerBandwidth: byte)¶Parameter: |
|
---|
Setzt die verfügbaren Sensor-Konfigurationen für Magnetometer, Gyroskop und Beschleunigungssensor. Der Beschleunigungssensor-Wertebereich ist in allen Fusion-Modi wählbar, während alle anderen Konfigurationen im Fusion-Modus automatisch kontrolliert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für magnetometerRate:
Für gyroscopeRange:
Für gyroscopeBandwidth:
Für accelerometerRange:
Für accelerometerBandwidth:
TBrickletIMUV3.
GetSensorConfiguration
(out magnetometerRate: byte; out gyroscopeRange: byte; out gyroscopeBandwidth: byte; out accelerometerRange: byte; out accelerometerBandwidth: byte)¶Ausgabeparameter: |
|
---|
Gibt die Sensor-Konfiguration zurück, wie von SetSensorConfiguration
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für magnetometerRate:
Für gyroscopeRange:
Für gyroscopeBandwidth:
Für accelerometerRange:
Für accelerometerBandwidth:
TBrickletIMUV3.
SetSensorFusionMode
(const mode: byte)¶Parameter: |
|
---|
Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen
GetAcceleration
, GetMagneticField
und
GetAngularVelocity
unkalibrierte und umkompensierte Sensorwerte
zurück. Alle anderen Sensordaten-Getter geben keine Daten zurück.
Seit Firmware Version 2.0.6 kann auch ein Fusion-Modus ohne Magnetometer ausgewählt werden. In diesem Modus wird die Orientierung relativ berechnet (mit Magnetometer ist sie absolut in Bezug auf die Erde). Allerdings kann die Berechnung in diesem Fall nicht von störenden Magnetfeldern beeinflusst werden.
Seit Firmware Version 2.0.13 kann auch ein Fusion-Modus ohne schnelle Magnetometer-Kalibrierung ausgewählt werden. Dieser Modus ist der gleiche wie der "normale" Fusion-Modus, aber die schnelle Magnetometer-Kalibrierung ist aus. D.h. die Orientierung zu finden mag beim ersten start länger dauern, allerdings mag es sein das kleine magnetische einflüsse die automatische Kalibrierung nicht so stark stören.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
TBrickletIMUV3.
GetSensorFusionMode
: byte¶Rückgabe: |
|
---|
Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von
SetSensorFusionMode
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
TBrickletIMUV3.
GetSPITFPErrorCount
(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶Ausgabeparameter: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
TBrickletIMUV3.
SetStatusLEDConfig
(const config: byte)¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
TBrickletIMUV3.
GetStatusLEDConfig
: byte¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
TBrickletIMUV3.
GetChipTemperature
: smallint¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
TBrickletIMUV3.
Reset
¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
TBrickletIMUV3.
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.
TBrickletIMUV3.
SetAccelerationCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnAcceleration
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetAccelerationCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetAccelerationCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetMagneticFieldCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnMagneticField
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetMagneticFieldCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetMagneticFieldCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetAngularVelocityCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnAngularVelocity
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetAngularVelocityCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetAngularVelocityCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetTemperatureCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnTemperature
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetTemperatureCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetTemperatureCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetOrientationCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnOrientation
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetOrientationCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetOrientationCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetLinearAccelerationCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnLinearAcceleration
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetLinearAccelerationCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetLinearAccelerationCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetGravityVectorCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnGravityVector
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetGravityVectorCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetGravityVectorCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetQuaternionCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnQuaternion
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetQuaternionCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetQuaternionCallbackConfiguration
gesetzt.
TBrickletIMUV3.
SetAllDataCallbackConfiguration
(const period: longword; const valueHasToChange: boolean)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OnAllData
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
TBrickletIMUV3.
GetAllDataCallbackConfiguration
(out period: longword; out valueHasToChange: boolean)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetAllDataCallbackConfiguration
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: TBrickletIMUV3; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; imuV3.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.
TBrickletIMUV3.
OnAcceleration
¶procedure(sender: TBrickletIMUV3; const x: smallint; const y: smallint; const z: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAccelerationCallbackConfiguration
, ausgelöst. Die Parameter sind die
Beschleunigungen der X, Y und Z-Achse.
TBrickletIMUV3.
OnMagneticField
¶procedure(sender: TBrickletIMUV3; const x: smallint; const y: smallint; const z: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetMagneticFieldCallbackConfiguration
, ausgelöst. Die Parameter sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
TBrickletIMUV3.
OnAngularVelocity
¶procedure(sender: TBrickletIMUV3; const x: smallint; const y: smallint; const z: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAngularVelocityCallbackConfiguration
, ausgelöst. Die Parameter sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
TBrickletIMUV3.
OnTemperature
¶procedure(sender: TBrickletIMUV3; const temperature: shortint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetTemperatureCallbackConfiguration
, ausgelöst. Der Parameter ist die
Temperatur.
TBrickletIMUV3.
OnLinearAcceleration
¶procedure(sender: TBrickletIMUV3; const x: smallint; const y: smallint; const z: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetLinearAccelerationCallbackConfiguration
, ausgelöst. Die Parameter sind
die linearen Beschleunigungen der X, Y und Z-Achse.
TBrickletIMUV3.
OnGravityVector
¶procedure(sender: TBrickletIMUV3; const x: smallint; const y: smallint; const z: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetGravityVectorCallbackConfiguration
, ausgelöst. Die Parameter sind die
Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.
TBrickletIMUV3.
OnOrientation
¶procedure(sender: TBrickletIMUV3; const heading: smallint; const roll: smallint; const pitch: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetOrientationCallbackConfiguration
, ausgelöst. Die Parameter sind die
Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe
GetOrientation
für Details.
TBrickletIMUV3.
OnQuaternion
¶procedure(sender: TBrickletIMUV3; const w: smallint; const x: smallint; const y: smallint; const z: smallint) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetQuaternionCallbackConfiguration
, ausgelöst. Die Parameter sind die
Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe
GetQuaternion
für Details.
TBrickletIMUV3.
OnAllData
¶procedure(sender: TBrickletIMUV3; const acceleration: array [0..2] of smallint; const magneticField: array [0..2] of smallint; const angularVelocity: array [0..2] of smallint; const eulerAngle: array [0..2] of smallint; const quaternion: array [0..3] of smallint; const linearAcceleration: array [0..2] of smallint; const gravityVector: array [0..2] of smallint; const temperature: shortint; const calibrationStatus: byte) of object;
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAllDataCallbackConfiguration
, ausgelöst. Die Parameter sind die
gleichen wie bei GetAllData
.
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.
TBrickletIMUV3.
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.
TBrickletIMUV3.
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:
TBrickletIMUV3.
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:
TBrickletIMUV3.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
TBrickletIMUV3.
SetBootloaderMode
(const mode: byte): byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
TBrickletIMUV3.
GetBootloaderMode
: byte¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
TBrickletIMUV3.
SetWriteFirmwarePointer
(const pointer: longword)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für WriteFirmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
TBrickletIMUV3.
WriteFirmware
(const data: array [0..63] of byte): byte¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
TBrickletIMUV3.
WriteUID
(const uid: longword)¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
TBrickletIMUV3.
ReadUID
: longword¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BRICKLET_IMU_V3_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein IMU Bricklet 3.0 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_IMU_V3_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IMU Bricklet 3.0 dar.