Dies ist die Beschreibung der Java API Bindings für den IMU Brick 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 2.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.BrickIMUV2;
import com.tinkerforge.BrickIMUV2.Quaternion;
public class ExampleSimple {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XXYYZZ to the UID of your IMU Brick 2.0
private static final String UID = "XXYYZZ";
// 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
BrickIMUV2 imu = new BrickIMUV2(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.BrickIMUV2;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XXYYZZ to the UID of your IMU Brick 2.0
private static final String UID = "XXYYZZ";
// 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
BrickIMUV2 imu = new BrickIMUV2(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 BrickIMUV2.QuaternionListener() {
public void quaternion(short w, short x, short y, short 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.setQuaternionPeriod(100);
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 61 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickIMUV2;
public class ExampleAllData {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XXYYZZ to the UID of your IMU Brick 2.0
private static final String UID = "XXYYZZ";
// 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
BrickIMUV2 imu = new BrickIMUV2(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 BrickIMUV2.AllDataListener() {
public void allData(short[] acceleration, short[] magneticField,
short[] angularVelocity, short[] eulerAngle,
short[] quaternion, short[] linearAcceleration,
short[] gravityVector, byte temperature,
short 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.setAllDataPeriod(100);
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.
BrickIMUV2
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickIMUV2 imuV2 = new BrickIMUV2("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickIMUV2.
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
setOrientationPeriod()
vorzugeben.
BrickIMUV2.
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
setLinearAccelerationPeriod()
vorzugeben.
BrickIMUV2.
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
setGravityVectorPeriod()
vorzugeben.
BrickIMUV2.
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
setQuaternionPeriod()
vorzugeben.
BrickIMUV2.
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
setAllDataPeriod()
vorzugeben.
BrickIMUV2.
ledsOn
()¶Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
BrickIMUV2.
ledsOff
()¶Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.
BrickIMUV2.
areLedsOn
()¶Rückgabe: |
|
---|
Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.
BrickIMUV2.
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
setAccelerationPeriod()
vorzugeben.
BrickIMUV2.
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
setMagneticFieldPeriod()
vorzugeben.
BrickIMUV2.
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
setAngularVelocityPeriod()
vorzugeben.
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
setSensorConfiguration
(short magnetometerRate, short gyroscopeRange, short gyroscopeBandwidth, short accelerometerRange, short 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:
Neu in Version 2.0.5 (Firmware).
BrickIMUV2.
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:
Neu in Version 2.0.5 (Firmware).
BrickIMUV2.
setSensorFusionMode
(short 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:
Neu in Version 2.0.5 (Firmware).
BrickIMUV2.
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:
Neu in Version 2.0.5 (Firmware).
BrickIMUV2.
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.0.10 (Firmware).
BrickIMUV2.
getSPITFPBaudrateConfig
()¶Rückgabeobjekt: |
|
---|
Gibt die Baudratenkonfiguration zurück, siehe setSPITFPBaudrateConfig()
.
Neu in Version 2.0.10 (Firmware).
BrickIMUV2.
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.0.7 (Firmware).
BrickIMUV2.
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.0.5 (Firmware).
BrickIMUV2.
getSPITFPBaudrate
(char brickletPort)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Baudrate für einen Bricklet Port zurück, siehe
setSPITFPBaudrate()
.
Neu in Version 2.0.5 (Firmware).
BrickIMUV2.
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.0.5 (Firmware).
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
isStatusLEDEnabled
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die Status LED aktiviert ist, false sonst.
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
setAccelerationPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AccelerationListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getAccelerationPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAccelerationPeriod()
gesetzt.
BrickIMUV2.
setMagneticFieldPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der MagneticFieldListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getMagneticFieldPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setMagneticFieldPeriod()
gesetzt.
BrickIMUV2.
setAngularVelocityPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AngularVelocityListener
Listener
ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getAngularVelocityPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAngularVelocityPeriod()
gesetzt.
BrickIMUV2.
setTemperaturePeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der TemperatureListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getTemperaturePeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setTemperaturePeriod()
gesetzt.
BrickIMUV2.
setOrientationPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der OrientationListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getOrientationPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setOrientationPeriod()
gesetzt.
BrickIMUV2.
setLinearAccelerationPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der LinearAccelerationListener
Listener
ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getLinearAccelerationPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setLinearAccelerationPeriod()
gesetzt.
BrickIMUV2.
setGravityVectorPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der GravityVectorListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getGravityVectorPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setGravityVectorPeriod()
gesetzt.
BrickIMUV2.
setQuaternionPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der QuaternionListener
Listener ausgelöst
wird. Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getQuaternionPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setQuaternionPeriod()
gesetzt.
BrickIMUV2.
setAllDataPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AllDataListener
Listener ausgelöst wird.
Ein Wert von 0 deaktiviert den Listener.
BrickIMUV2.
getAllDataPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAllDataPeriod()
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 BrickIMUV2.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.
BrickIMUV2.
AccelerationListener
()¶Dieser Listener kann mit der Funktion addAccelerationListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAccelerationListener()
wieder
entfernt werden.
acceleration
(short x, short y, short z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setAccelerationPeriod()
, ausgelöst. Die Parameter sind die
Beschleunigungen der X, Y und Z-Achse.
BrickIMUV2.
MagneticFieldListener
()¶Dieser Listener kann mit der Funktion addMagneticFieldListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeMagneticFieldListener()
wieder
entfernt werden.
magneticField
(short x, short y, short z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setMagneticFieldPeriod()
, ausgelöst. Die Parameter sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
BrickIMUV2.
AngularVelocityListener
()¶Dieser Listener kann mit der Funktion addAngularVelocityListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAngularVelocityListener()
wieder
entfernt werden.
angularVelocity
(short x, short y, short z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setAngularVelocityPeriod()
, ausgelöst. Die Parameter sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
BrickIMUV2.
TemperatureListener
()¶Dieser Listener kann mit der Funktion addTemperatureListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeTemperatureListener()
wieder
entfernt werden.
temperature
(byte temperature)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setTemperaturePeriod()
, ausgelöst. Der Parameter ist die
Temperatur.
BrickIMUV2.
LinearAccelerationListener
()¶Dieser Listener kann mit der Funktion addLinearAccelerationListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeLinearAccelerationListener()
wieder
entfernt werden.
linearAcceleration
(short x, short y, short z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setLinearAccelerationPeriod()
, ausgelöst. Die Parameter sind
die linearen Beschleunigungen der X, Y und Z-Achse.
BrickIMUV2.
GravityVectorListener
()¶Dieser Listener kann mit der Funktion addGravityVectorListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeGravityVectorListener()
wieder
entfernt werden.
gravityVector
(short x, short y, short z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setGravityVectorPeriod()
, ausgelöst. Die Parameter sind die
Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.
BrickIMUV2.
OrientationListener
()¶Dieser Listener kann mit der Funktion addOrientationListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeOrientationListener()
wieder
entfernt werden.
orientation
(short heading, short roll, short pitch)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setOrientationPeriod()
, ausgelöst. Die Parameter sind die
Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe
getOrientation()
für Details.
BrickIMUV2.
QuaternionListener
()¶Dieser Listener kann mit der Funktion addQuaternionListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeQuaternionListener()
wieder
entfernt werden.
quaternion
(short w, short x, short y, short z)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setQuaternionPeriod()
, ausgelöst. Die Parameter sind die
Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe
getQuaternion()
für Details.
BrickIMUV2.
AllDataListener
()¶Dieser Listener kann mit der Funktion addAllDataListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAllDataListener()
wieder
entfernt werden.
allData
(short[] acceleration, short[] magneticField, short[] angularVelocity, short[] eulerAngle, short[] quaternion, short[] linearAcceleration, short[] gravityVector, byte temperature, short calibrationStatus)Parameter: |
|
---|
Dieser Listener wird mit der Periode, wie gesetzt mit
setAllDataPeriod()
, 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.
BrickIMUV2.
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.
BrickIMUV2.
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:
BrickIMUV2.
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:
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
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.
BrickIMUV2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um einen IMU Brick 2.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.
BrickIMUV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.