Dies ist die Beschreibung der MATLAB/Octave API Bindings für den IMU Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (matlab_example_simple.m)
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 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickIMU;
HOST = 'localhost';
PORT = 4223;
UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your IMU Brick
ipcon = IPConnection(); % Create IP connection
imu = handle(BrickIMU(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current quaternion
quaternion = imu.getQuaternion();
fprintf('Quaternion [X]: %f\n', quaternion.x);
fprintf('Quaternion [Y]: %f\n', quaternion.y);
fprintf('Quaternion [Z]: %f\n', quaternion.z);
fprintf('Quaternion [W]: %f\n', quaternion.w);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
|
Download (matlab_example_callback.m)
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 | function matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickIMU;
HOST = 'localhost';
PORT = 4223;
UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your IMU Brick
ipcon = IPConnection(); % Create IP connection
imu = handle(BrickIMU(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register quaternion callback to function cb_quaternion
set(imu, 'QuaternionCallback', @(h, e) cb_quaternion(e));
% Set period for quaternion callback to 1s (1000ms)
imu.setQuaternionPeriod(1000);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for quaternion callback
function cb_quaternion(e)
fprintf('Quaternion [X]: %f\n', e.x);
fprintf('Quaternion [Y]: %f\n', e.y);
fprintf('Quaternion [Z]: %f\n', e.z);
fprintf('Quaternion [W]: %f\n', e.w);
fprintf('\n');
end
|
Download (octave_example_simple.m)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XXYYZZ"; % Change XXYYZZ to the UID of your IMU Brick
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
imu = javaObject("com.tinkerforge.BrickIMU", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current quaternion
quaternion = imu.getQuaternion();
fprintf("Quaternion [X]: %f\n", quaternion.x);
fprintf("Quaternion [Y]: %f\n", quaternion.y);
fprintf("Quaternion [Z]: %f\n", quaternion.z);
fprintf("Quaternion [W]: %f\n", quaternion.w);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
|
Download (octave_example_callback.m)
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 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XXYYZZ"; % Change XXYYZZ to the UID of your IMU Brick
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
imu = javaObject("com.tinkerforge.BrickIMU", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register quaternion callback to function cb_quaternion
imu.addQuaternionCallback(@cb_quaternion);
% Set period for quaternion callback to 1s (1000ms)
imu.setQuaternionPeriod(1000);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for quaternion callback
function cb_quaternion(e)
fprintf("Quaternion [X]: %f\n", e.x);
fprintf("Quaternion [Y]: %f\n", e.y);
fprintf("Quaternion [Z]: %f\n", e.z);
fprintf("Quaternion [W]: %f\n", e.w);
fprintf("\n");
end
|
Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException
werfen. Diese Exception wird
geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt
wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der
Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung
können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu
groß wird.
Neben der TimeoutException
kann auch noch eine NotConnectedException
geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu
kommunizieren, aber die IP Connection nicht verbunden ist.
Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.
Das Package für alle Brick/Bricklet Bindings und die IP Connection ist
com.tinkerforge.*
Alle folgend aufgelisteten Methoden sind Thread-sicher.
BrickIMU
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
.
In MATLAB:
import com.tinkerforge.BrickIMU;
imu = BrickIMU("YOUR_DEVICE_UID", ipcon);
In Octave:
imu = java_new("com.tinkerforge.BrickIMU", "YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickIMU.
getOrientation
()¶Rückgabeobjekt: |
|
---|
Gibt die aktuelle Orientierung (Roll-, Nick-, Gierwinkel) des IMU Brick in Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren.
Wir empfehlen die Verwendung von Quaternionen stattdessen.
Die Reihenfolge in denen die Orientierungswerte angewandt werden sollten, ist Roll-, Nick-, Gierwinkel.
Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den
OrientationCallback
Callback zu nutzen und die Periode mit
setOrientationPeriod()
vorzugeben.
BrickIMU.
getQuaternion
()¶Rückgabeobjekt: |
|
---|
Gibt die aktuelle Orientierung (x, y, z, w) des IMU Brick als Quaterinonen zurück.
Die Umrechnung von Quaternionen in Eulerwinkel ist mit folgender Formel möglich:
xAngle = atan2(2*y*w - 2*x*z, 1 - 2*y*y - 2*z*z)
yAngle = atan2(2*x*w - 2*y*z, 1 - 2*x*x - 2*z*z)
zAngle = asin(2*x*y + 2*z*w)
Es ist auch möglich unabhängige Winkel zu berechen. Yaw, Pitch und Roll in einem rechtshändigen Fahrzeugkoordinatensystem nach DIN70000 können wie folgt berechnet werden:
yaw = atan2(2*x*y + 2*w*z, w*w + x*x - y*y - z*z)
pitch = -asin(2*w*y - 2*x*z)
roll = -atan2(2*y*z + 2*w*x, -w*w + x*x + y*y - z*z))
Diese Umrechnung ist irreversibel aufgrund der kardanischen Blockade.
Die Umrechnung von Quaternionen in eine OpenGL Transformationsmatrix ist mit folgender Formel möglich:
matrix = [[1 - 2*(y*y + z*z), 2*(x*y - w*z), 2*(x*z + w*y), 0],
[ 2*(x*y + w*z), 1 - 2*(x*x + z*z), 2*(y*z - w*x), 0],
[ 2*(x*z - w*y), 2*(y*z + w*x), 1 - 2*(x*x + y*y), 0],
[ 0, 0, 0, 1]]
Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den
QuaternionCallback
Callback zu nutzen und die Periode mit
setQuaternionPeriod()
vorzugeben.
BrickIMU.
ledsOn
()¶Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
BrickIMU.
ledsOff
()¶Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
BrickIMU.
areLedsOn
()¶Rückgabe: |
|
---|
Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.
BrickIMU.
setConvergenceSpeed
(int speed)¶Parameter: |
|
---|
Setzt die Konvergenzgeschwindigkeit des IMU Brick. Die Konvergenzgeschwindigkeit bestimmt wie die unterschiedlichen Sensormessungen vereinigt werden.
Wenn die Orientierung des IMU Brick eine Abweichung von 10° hat und die Konvergenzgeschwindigkeit auf 20°/s konfiguriert ist, dann dauert es 0,5s bis die Orientierung korrigiert ist. Bei einer zu hohen Konvergenzgeschwindigkeit wird nach Erreichen der korrekten Orientierung, diese um die Fluktuationen des Beschleunigungsmessers und des Magnetometers schwanken.
Wenn die Konvergenzgeschwindigkeit auf 0 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Gyroskopdaten. Dies ergibt sehr gleichmäßige Bewegungen aber Fehler des Gyroskops werden nicht korrigiert. Wenn die Konvergenzgeschwindigkeit über 500 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Beschleunigungsmesser- und Magnetometerdaten. In diesem Fall sind die Bewegungen abrupt und die Werte werden schwanken. Es treten aber keine akkumulativen Fehler auf.
In Anwendungen mit hohen Winkelgeschwindigkeiten wird eine hohe Konvergenzgeschwindigkeit empfohlen, so dass Fehler des Gyroskops schnell korrigiert werden können. In Anwendungen mit langsamen Bewegungen wird entsprechend eine geringe Konvergenzgeschwindigkeit empfohlen. Es ist möglich die Konvergenzgeschwindigkeit spontan zu ändern. Dadurch ist es möglich (und empfohlen) direkt vor einer abrupten Bewegung die Konvergenzgeschwindigkeit zu erhöhen und im Anschluss wieder zu verringern.
Um ein Gefühl für einen guten Wert, für die Konvergenzgeschwindigkeit, in deiner Anwendung zu bekommen ist es ratsam im Brick Viewer verschiedenste Werte auszuprobieren.
BrickIMU.
getConvergenceSpeed
()¶Rückgabe: |
|
---|
Gibt die Konvergenzgeschwindigkeit zurück, wie von setConvergenceSpeed()
gesetzt.
BrickIMU.
getAcceleration
()¶Rückgabeobjekt: |
|
---|
Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X, Y und Z-Achse zurück.
Wenn die kalibrierten Beschleunigungen periodisch abgefragt werden soll, wird
empfohlen den AccelerationCallback
Callback zu nutzen und die Periode mit
setAccelerationPeriod()
vorzugeben.
BrickIMU.
getMagneticField
()¶Rückgabeobjekt: |
|
---|
Gibt das kalibrierte Magnetfeld des Magnetometers mit den X-, Y- und Z-Komponenten zurück.
Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen
den MagneticFieldCallback
Callback zu nutzen und die Periode mit
setMagneticFieldPeriod()
vorzugeben.
BrickIMU.
getAngularVelocity
()¶Rückgabeobjekt: |
|
---|
Gibt die kalibrierten Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in °/14,375s zurück. (Um den Wert in °/s zu erhalten ist es notwendig durch 14,375 zu teilen)
Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird
empfohlen den AngularVelocityCallback
Callback zu nutzen und die Periode mit
setAngularVelocityPeriod()
vorzugeben.
BrickIMU.
getAllData
()¶Rückgabeobjekt: |
|
---|
Gibt die Daten von getAcceleration()
, getMagneticField()
und getAngularVelocity()
sowie die Temperatur des IMU Brick zurück.
Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den
AllDataCallback
Callback zu nutzen und die Periode mit
setAllDataPeriod()
vorzugeben.
BrickIMU.
getIMUTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur des IMU Brick zurück.
BrickIMU.
setAccelerationRange
(short range)¶Parameter: |
|
---|
Bisher nicht implementiert.
BrickIMU.
getAccelerationRange
()¶Rückgabe: |
|
---|
Bisher nicht implementiert.
BrickIMU.
setMagnetometerRange
(short range)¶Parameter: |
|
---|
Bisher nicht implementiert.
BrickIMU.
getMagnetometerRange
()¶Rückgabe: |
|
---|
Bisher nicht implementiert.
BrickIMU.
setCalibration
(short typ, short[] data)¶Parameter: |
|
---|
Es sind folgende verschiedene Kalibrierungen möglich:
Typ | Beschreibung | Werte |
---|---|---|
0 | Beschleunigungsmesser Verstärkung | [mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0] |
1 | Beschleunigungsmesser Versatz | [bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0] |
2 | Magnetometer Verstärkung | [mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0] |
3 | Magnetometer Versatz | [bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0] |
4 | Gyroskop Verstärkung | [mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0] |
5 | Gyroskop Versatz | [bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0] |
Die Kalibrierung mittels Verstärkung und Versatz wird über folgende Formel realisiert:
new_value = (bias + orig_value) * gain_mul / gain_div
Für die Implementierung einer eigenen Kalibriersoftware sollte beachtet werden, dass zuerst die bisherige Kalibrierung rückgängig gemacht werden muss (Versatz auf 0 und Verstärkung auf 1/1 setzen) und das über mehrere tausend Werte gemittelt werden sollte um ein benutzbares Ergebnis zu erhalten.
Der Versatz des Gyroskops ist sehr temperaturabhängig und daher muss die
Kalibrierung des Versatzes mit zwei unterschiedlichen Temperaturen erfolgen.
Die Werte xl
, yl
, zl
und temp l
sind der Versatz für x
,
y
, z
und die zugehörige geringe Temperatur. Die Werte xh
, yh
,
zh
und temp h
sind entsprechend für eine höhere Temperatur. Die
Temperaturdifferenz sollte mindestens 5°C betragen. Die übliche
Betriebstemperatur des IMU Brick sollte einer der Kalibrierpunkte sein.
Bemerkung
Wir empfehlen dringend den Brick Viewer zur Kalibrierung des IMU Brick zu verwenden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für typ:
BrickIMU.
getCalibration
(short typ)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Kalibrierung für den ausgewählten Typ zurück, wie von
setCalibration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für typ:
BrickIMU.
orientationCalculationOn
()¶Aktiviert die Orientierungsberechnungen des IMU Brick.
Standardmäßig sind die Berechnungen an.
Neu in Version 2.0.2 (Firmware).
BrickIMU.
orientationCalculationOff
()¶Deaktiviert die Orientierungsberechnungen des IMU Brick.
Wenn die Berechnungen deaktiviert sind, gibt getOrientation()
solange
den letzten berechneten Wer zurück bis die Berechnungen wieder
aktiviert werden.
Die trigonometrischen Funktionen die zur Berechnung der Orientierung benötigt werden sind sehr teuer. Wir empfehlen die Orientierungsberechnungen zu deaktivieren wenn sie nicht benötigt werden. Dadurch wird mehr Rechenzeit für den Sensorfusions-Algorithmus freigegeben.
Standardmäßig sind die Berechnungen an.
Neu in Version 2.0.2 (Firmware).
BrickIMU.
isOrientationCalculationOn
()¶Rückgabe: |
|
---|
Gibt zurück ob die Orientierungsberechnungen des IMU Brick aktiv sind.
Neu in Version 2.0.2 (Firmware).
BrickIMU.
setSPITFPBaudrateConfig
(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)¶Parameter: |
|
---|
Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.
Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.
Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.
In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.
Die maximale Baudrate kann pro Port mit der Funktion setSPITFPBaudrate()
.
gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate
wie von setSPITFPBaudrate()
gesetzt statisch verwendet.
Neu in Version 2.3.5 (Firmware).
BrickIMU.
getSPITFPBaudrateConfig
()¶Rückgabeobjekt: |
|
---|
Gibt die Baudratenkonfiguration zurück, siehe setSPITFPBaudrateConfig()
.
Neu in Version 2.3.5 (Firmware).
BrickIMU.
getSendTimeoutCount
(short communicationMethod)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück
Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.
Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für communicationMethod:
Neu in Version 2.3.3 (Firmware).
BrickIMU.
setSPITFPBaudrate
(char brickletPort, long baudrate)¶Parameter: |
|
---|
Setzt die Baudrate eines spezifischen Bricklet Ports .
Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden.
Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist
(siehe getSPITFPErrorCount()
) kann die Baudrate verringert werden.
Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion
die maximale Baudrate (siehe setSPITFPBaudrateConfig()
).
EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.
Neu in Version 2.3.3 (Firmware).
BrickIMU.
getSPITFPBaudrate
(char brickletPort)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Baudrate für einen Bricklet Port zurück, siehe
setSPITFPBaudrate()
.
Neu in Version 2.3.3 (Firmware).
BrickIMU.
getSPITFPErrorCount
(char brickletPort)¶Parameter: |
|
---|---|
Rückgabeobjekt: |
|
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.
Neu in Version 2.3.3 (Firmware).
BrickIMU.
enableStatusLED
()¶Aktiviert die Status LED.
Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.
Der Standardzustand ist aktiviert.
Neu in Version 2.3.1 (Firmware).
BrickIMU.
disableStatusLED
()¶Deaktiviert die Status LED.
Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.
Der Standardzustand ist aktiviert.
Neu in Version 2.3.1 (Firmware).
BrickIMU.
isStatusLEDEnabled
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die Status LED aktiviert ist, false sonst.
Neu in Version 2.3.1 (Firmware).
BrickIMU.
getChipTemperature
()¶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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickIMU.
reset
()¶Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.
Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.
BrickIMU.
getIdentity
()¶Rückgabeobjekt: |
|
---|
Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.
BrickIMU.
setAccelerationPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AccelerationCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
BrickIMU.
getAccelerationPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAccelerationPeriod()
gesetzt.
BrickIMU.
setMagneticFieldPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der MagneticFieldCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
BrickIMU.
getMagneticFieldPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setMagneticFieldPeriod()
gesetzt.
BrickIMU.
setAngularVelocityPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AngularVelocityCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
BrickIMU.
getAngularVelocityPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAngularVelocityPeriod()
gesetzt.
BrickIMU.
setAllDataPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AllDataCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
BrickIMU.
getAllDataPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAllDataPeriod()
gesetzt.
BrickIMU.
setOrientationPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der OrientationCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
BrickIMU.
getOrientationPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setOrientationPeriod()
gesetzt.
BrickIMU.
setQuaternionPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der QuaternionCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
BrickIMU.
getQuaternionPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setQuaternionPeriod()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:
function my_callback(e)
fprintf('Parameter: %s\n', e.param);
end
set(device, 'ExampleCallback', @(h, e) my_callback(e));
Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:
function my_callback(e)
fprintf("Parameter: %s\n", e.param);
end
device.addExampleCallback(@my_callback);
Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.
Die Parameter des Callbacks werden der Callback-Funktion als Felder der
Struktur e
übergeben. Diese ist von der java.util.EventObject
Klasse
abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden
Strukturfeldern werden unterhalb 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.
BrickIMU.
AccelerationCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setAccelerationPeriod()
, ausgelöst. Die Parameter sind die
Beschleunigungen der X, Y und Z-Achse.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addAccelerationCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAccelerationCallback()
wieder entfernt werden.
BrickIMU.
MagneticFieldCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setMagneticFieldPeriod()
, ausgelöst. Die Parameter sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addMagneticFieldCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeMagneticFieldCallback()
wieder entfernt werden.
BrickIMU.
AngularVelocityCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setAngularVelocityPeriod()
, ausgelöst. Die Parameter sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addAngularVelocityCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAngularVelocityCallback()
wieder entfernt werden.
BrickIMU.
AllDataCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit setAllDataPeriod()
,
ausgelöst. Die Parameter sind die Beschleunigungen, Magnetfeldkomponenten
und die Winkelgeschwindigkeiten der X, Y und Z-Achse sowie die Temperatur
des IMU Brick.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addAllDataCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeAllDataCallback()
wieder entfernt werden.
BrickIMU.
OrientationCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit setOrientationPeriod()
,
ausgelöst. Die Parameter sind die Orientierung (Roll-, Nick-, Gierwinkel) des
IMU Brick in Eulerwinkeln. Siehe getOrientation()
für Details.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addOrientationCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeOrientationCallback()
wieder entfernt werden.
BrickIMU.
QuaternionCallback
¶Event-Objekt: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit setQuaternionPeriod()
,
ausgelöst. Die Parameter sind die Orientierung (x, y, z, w) des
IMU Brick in Quaternionen. Siehe getQuaternion()
für Details.
In MATLAB kann die set()
Function verwendet werden um diesem Callback eine
Callback-Function zuzuweisen.
In Octave kann diesem Callback mit addQuaternionCallback()
eine Callback-Function
hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit
removeQuaternionCallback()
wieder entfernt werden.
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.
BrickIMU.
getAPIVersion
()¶Rückgabeobjekt: |
|
---|
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.
BrickIMU.
getResponseExpected
(byte functionId)¶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:
BrickIMU.
setResponseExpected
(byte functionId, boolean responseExpected)¶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:
BrickIMU.
setResponseExpectedAll
(boolean responseExpected)¶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.
BrickIMU.
getProtocol1BrickletName
(char port)¶Parameter: |
|
---|---|
Rückgabeobjekt: |
|
Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.
Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.
BrickIMU.
writeBrickletPlugin
(char port, short offset, short[] chunk)¶Parameter: |
|
---|
Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickIMU.
readBrickletPlugin
(char port, short offset)¶Parameter: |
|
---|---|
Rückgabe: |
|
Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickIMU.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um einen IMU Brick zu identifizieren.
Die getIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickIMU.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IMU Brick dar.