Dies ist die Beschreibung der Java 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 Java 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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIMUV3;
import com.tinkerforge.BrickletIMUV3.Quaternion;
public class ExampleSimple {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your IMU Bricklet 3.0
private static final String UID = "XYZ";
// Note: To make the example code cleaner we do not handle exceptions. Exceptions
// you might normally want to catch are described in the documentation
public static void main(String args[]) throws Exception {
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletIMUV3 imu = new BrickletIMUV3(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current quaternion
Quaternion quaternion = imu.getQuaternion(); // Can throw com.tinkerforge.TimeoutException
System.out.println("Quaternion [W]: " + quaternion.w/16383.0);
System.out.println("Quaternion [X]: " + quaternion.x/16383.0);
System.out.println("Quaternion [Y]: " + quaternion.y/16383.0);
System.out.println("Quaternion [Z]: " + quaternion.z/16383.0);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleCallback.java)
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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIMUV3;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your IMU Bricklet 3.0
private static final String UID = "XYZ";
// Note: To make the example code cleaner we do not handle exceptions. Exceptions
// you might normally want to catch are described in the documentation
public static void main(String args[]) throws Exception {
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletIMUV3 imu = new BrickletIMUV3(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add quaternion listener
imu.addQuaternionListener(new BrickletIMUV3.QuaternionListener() {
public void quaternion(int w, int x, int y, int z) {
System.out.println("Quaternion [W]: " + w/16383.0);
System.out.println("Quaternion [X]: " + x/16383.0);
System.out.println("Quaternion [Y]: " + y/16383.0);
System.out.println("Quaternion [Z]: " + z/16383.0);
System.out.println("");
}
});
// Set period for quaternion callback to 0.1s (100ms)
imu.setQuaternionCallbackConfiguration(100, false);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Download (ExampleAllData.java)
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 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIMUV3;
public class ExampleAllData {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your IMU Bricklet 3.0
private static final String UID = "XYZ";
// Note: To make the example code cleaner we do not handle exceptions. Exceptions
// you might normally want to catch are described in the documentation
public static void main(String args[]) throws Exception {
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletIMUV3 imu = new BrickletIMUV3(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Add all data listener
imu.addAllDataListener(new BrickletIMUV3.AllDataListener() {
public void allData(int[] acceleration, int[] magneticField,
int[] angularVelocity, int[] eulerAngle, int[] quaternion,
int[] linearAcceleration, int[] gravityVector,
int temperature, int calibrationStatus) {
System.out.println("Acceleration [X]: " + acceleration[0]/100.0 + " m/s²");
System.out.println("Acceleration [Y]: " + acceleration[1]/100.0 + " m/s²");
System.out.println("Acceleration [Z]: " + acceleration[2]/100.0 + " m/s²");
System.out.println("Magnetic Field [X]: " + magneticField[0]/16.0 + " µT");
System.out.println("Magnetic Field [Y]: " + magneticField[1]/16.0 + " µT");
System.out.println("Magnetic Field [Z]: " + magneticField[2]/16.0 + " µT");
System.out.println("Angular Velocity [X]: " + angularVelocity[0]/16.0 + " °/s");
System.out.println("Angular Velocity [Y]: " + angularVelocity[1]/16.0 + " °/s");
System.out.println("Angular Velocity [Z]: " + angularVelocity[2]/16.0 + " °/s");
System.out.println("Euler Angle [Heading]: " + eulerAngle[0]/16.0 + " °");
System.out.println("Euler Angle [Roll]: " + eulerAngle[1]/16.0 + " °");
System.out.println("Euler Angle [Pitch]: " + eulerAngle[2]/16.0 + " °");
System.out.println("Quaternion [W]: " + quaternion[0]/16383.0);
System.out.println("Quaternion [X]: " + quaternion[1]/16383.0);
System.out.println("Quaternion [Y]: " + quaternion[2]/16383.0);
System.out.println("Quaternion [Z]: " + quaternion[3]/16383.0);
System.out.println("Linear Acceleration [X]: " + linearAcceleration[0]/100.0 + " m/s²");
System.out.println("Linear Acceleration [Y]: " + linearAcceleration[1]/100.0 + " m/s²");
System.out.println("Linear Acceleration [Z]: " + linearAcceleration[2]/100.0 + " m/s²");
System.out.println("Gravity Vector [X]: " + gravityVector[0]/100.0 + " m/s²");
System.out.println("Gravity Vector [Y]: " + gravityVector[1]/100.0 + " m/s²");
System.out.println("Gravity Vector [Z]: " + gravityVector[2]/100.0 + " m/s²");
System.out.println("Temperature: " + temperature + " °C");
System.out.println("Calibration Status: " + Integer.toBinaryString(calibrationStatus));
System.out.println("");
}
});
// Set period for all data callback to 0.1s (100ms)
imu.setAllDataCallbackConfiguration(100, false);
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
Prinzipiell kann jede Methode der Java 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 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.
BrickletIMUV3
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletIMUV3 imuV3 = new BrickletIMUV3("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletIMUV3.
getOrientation
()¶Rückgabeobjekt: |
|
---|
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
OrientationListener
Listener zu nutzen und die Periode mit
setOrientationCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getLinearAcceleration
()¶Rückgabeobjekt: |
|
---|
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 LinearAccelerationListener
Listener zu nutzen und die Periode mit
setLinearAccelerationCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getGravityVector
()¶Rückgabeobjekt: |
|
---|
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 GravityVectorListener
Listener zu nutzen und die Periode mit
setGravityVectorCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getQuaternion
()¶Rückgabeobjekt: |
|
---|
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
QuaternionListener
Listener zu nutzen und die Periode mit
setQuaternionCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getAllData
()¶Rückgabeobjekt: |
|
---|
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
AllDataListener
Listener zu nutzen und die Periode mit
setAllDataCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getAcceleration
()¶Rückgabeobjekt: |
|
---|
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 AccelerationListener
Listener zu nutzen und die Periode mit
setAccelerationCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getMagneticField
()¶Rückgabeobjekt: |
|
---|
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 MagneticFieldListener
Listener zu nutzen und die Periode mit
setMagneticFieldCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getAngularVelocity
()¶Rückgabeobjekt: |
|
---|
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 AngularVelocityListener
Listener zu nutzen und die Periode mit
setAngularVelocityCallbackConfiguration()
vorzugeben.
BrickletIMUV3.
getTemperature
()¶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.
BrickletIMUV3.
saveCalibration
()¶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.
BrickletIMUV3.
setSensorConfiguration
(int magnetometerRate, int gyroscopeRange, int gyroscopeBandwidth, int accelerometerRange, int accelerometerBandwidth)¶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:
BrickletIMUV3.
getSensorConfiguration
()¶Rückgabeobjekt: |
|
---|
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:
BrickletIMUV3.
setSensorFusionMode
(int mode)¶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:
BrickletIMUV3.
getSensorFusionMode
()¶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:
BrickletIMUV3.
getSPITFPErrorCount
()¶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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletIMUV3.
setStatusLEDConfig
(int config)¶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:
BrickletIMUV3.
getStatusLEDConfig
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von setStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletIMUV3.
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 hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletIMUV3.
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.
BrickletIMUV3.
getIdentity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletIMUV3.
setAccelerationCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der AccelerationListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getAccelerationCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setAccelerationCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setMagneticFieldCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der MagneticFieldListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getMagneticFieldCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setMagneticFieldCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setAngularVelocityCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der AngularVelocityListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getAngularVelocityCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setAngularVelocityCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setTemperatureCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der TemperatureListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getTemperatureCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setTemperatureCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setOrientationCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der OrientationListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getOrientationCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setOrientationCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setLinearAccelerationCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der LinearAccelerationListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getLinearAccelerationCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setLinearAccelerationCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setGravityVectorCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der GravityVectorListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getGravityVectorCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setGravityVectorCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setQuaternionCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der QuaternionListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getQuaternionCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setQuaternionCallbackConfiguration()
gesetzt.
BrickletIMUV3.
setAllDataCallbackConfiguration
(long period, boolean valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der AllDataListener
Listener
ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletIMUV3.
getAllDataCallbackConfiguration
()¶Rückgabeobjekt: |
|
---|
Gibt die Listener-Konfiguration zurück, wie mittels setAllDataCallbackConfiguration()
gesetzt.
Listener können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit add*Listener()
Funktionen eines Geräteobjekts durchgeführt werden.
Der Parameter ist ein Listener Klassen Objekt, z.B.:
device.addExampleListener(new BrickletIMUV3.ExampleListener() {
public void property(int value) {
System.out.println("Value: " + value);
}
});
Die verfügbaren Listener Klassen mit den Methoden welche überschrieben
werden können werden unterhalb beschrieben. Es ist möglich mehrere
Listener hinzuzufügen und auch mit einem korrespondierenden
remove*Listener()
wieder zu entfernen.
Bemerkung
Listener 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.
BrickletIMUV3.
AccelerationListener
()¶Dieser Listener kann mit der Funktion addAccelerationListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAccelerationListener()
wieder
entfernt werden.
acceleration
(int x, int y, int z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setAccelerationCallbackConfiguration()
, ausgelöst. Die Parameter sind die
Beschleunigungen der X, Y und Z-Achse.
BrickletIMUV3.
MagneticFieldListener
()¶Dieser Listener kann mit der Funktion addMagneticFieldListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeMagneticFieldListener()
wieder
entfernt werden.
magneticField
(int x, int y, int z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setMagneticFieldCallbackConfiguration()
, ausgelöst. Die Parameter sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
BrickletIMUV3.
AngularVelocityListener
()¶Dieser Listener kann mit der Funktion addAngularVelocityListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAngularVelocityListener()
wieder
entfernt werden.
angularVelocity
(int x, int y, int z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setAngularVelocityCallbackConfiguration()
, ausgelöst. Die Parameter sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
BrickletIMUV3.
TemperatureListener
()¶Dieser Listener kann mit der Funktion addTemperatureListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeTemperatureListener()
wieder
entfernt werden.
temperature
(int temperature)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setTemperatureCallbackConfiguration()
, ausgelöst. Der Parameter ist die
Temperatur.
BrickletIMUV3.
LinearAccelerationListener
()¶Dieser Listener kann mit der Funktion addLinearAccelerationListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeLinearAccelerationListener()
wieder
entfernt werden.
linearAcceleration
(int x, int y, int z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setLinearAccelerationCallbackConfiguration()
, ausgelöst. Die Parameter sind
die linearen Beschleunigungen der X, Y und Z-Achse.
BrickletIMUV3.
GravityVectorListener
()¶Dieser Listener kann mit der Funktion addGravityVectorListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeGravityVectorListener()
wieder
entfernt werden.
gravityVector
(int x, int y, int z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setGravityVectorCallbackConfiguration()
, ausgelöst. Die Parameter sind die
Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.
BrickletIMUV3.
OrientationListener
()¶Dieser Listener kann mit der Funktion addOrientationListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeOrientationListener()
wieder
entfernt werden.
orientation
(int heading, int roll, int pitch)Parameter: |
|
---|
Dieser Listener 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.
BrickletIMUV3.
QuaternionListener
()¶Dieser Listener kann mit der Funktion addQuaternionListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeQuaternionListener()
wieder
entfernt werden.
quaternion
(int w, int x, int y, int z)Parameter: |
|
---|
Dieser Listener 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.
BrickletIMUV3.
AllDataListener
()¶Dieser Listener kann mit der Funktion addAllDataListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAllDataListener()
wieder
entfernt werden.
allData
(int[] acceleration, int[] magneticField, int[] angularVelocity, int[] eulerAngle, int[] quaternion, int[] linearAcceleration, int[] gravityVector, int temperature, int calibrationStatus)Parameter: |
|
---|
Dieser Listener 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.
BrickletIMUV3.
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.
BrickletIMUV3.
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 Listeners 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:
BrickletIMUV3.
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 Listeners (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:
BrickletIMUV3.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners 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.
BrickletIMUV3.
setBootloaderMode
(int mode)¶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:
BrickletIMUV3.
getBootloaderMode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletIMUV3.
setWriteFirmwarePointer
(long pointer)¶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.
BrickletIMUV3.
writeFirmware
(int[] data)¶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.
BrickletIMUV3.
writeUID
(long uid)¶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.
BrickletIMUV3.
readUID
()¶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.
BrickletIMUV3.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein IMU Bricklet 3.0 zu identifizieren.
Die getIdentity()
Funktion und der
IPConnection.EnumerateListener
Listener der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletIMUV3.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IMU Bricklet 3.0 dar.