MATLAB/Octave - IMU Brick 2.0

Dies ist die Beschreibung der MATLAB/Octave 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 MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

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.BrickIMUV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your IMU Brick 2.0

    ipcon = IPConnection(); % Create IP connection
    imu = handle(BrickIMUV2(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 [W]: %g\n', quaternion.w/16383.0);
    fprintf('Quaternion [X]: %g\n', quaternion.x/16383.0);
    fprintf('Quaternion [Y]: %g\n', quaternion.y/16383.0);
    fprintf('Quaternion [Z]: %g\n', quaternion.z/16383.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

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.BrickIMUV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your IMU Brick 2.0

    ipcon = IPConnection(); % Create IP connection
    imu = handle(BrickIMUV2(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 0.1s (100ms)
    imu.setQuaternionPeriod(100);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for quaternion callback
function cb_quaternion(e)
    fprintf('Quaternion [W]: %g\n', e.w/16383.0);
    fprintf('Quaternion [X]: %g\n', e.x/16383.0);
    fprintf('Quaternion [Y]: %g\n', e.y/16383.0);
    fprintf('Quaternion [Z]: %g\n', e.z/16383.0);
    fprintf('\n');
end

All Data (MATLAB)

Download (matlab_example_all_data.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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
function matlab_example_all_data()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickIMUV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your IMU Brick 2.0

    ipcon = IPConnection(); % Create IP connection
    imu = handle(BrickIMUV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register all data callback to function cb_all_data
    set(imu, 'AllDataCallback', @(h, e) cb_all_data(e));

    % Set period for all data callback to 0.1s (100ms)
    imu.setAllDataPeriod(100);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for all data callback
function cb_all_data(e)
    fprintf('Acceleration [X]: %g m/s²\n', e.acceleration(1)/100.0);
    fprintf('Acceleration [Y]: %g m/s²\n', e.acceleration(2)/100.0);
    fprintf('Acceleration [Z]: %g m/s²\n', e.acceleration(3)/100.0);
    fprintf('Magnetic Field [X]: %g µT\n', e.magneticField(1)/16.0);
    fprintf('Magnetic Field [Y]: %g µT\n', e.magneticField(2)/16.0);
    fprintf('Magnetic Field [Z]: %g µT\n', e.magneticField(3)/16.0);
    fprintf('Angular Velocity [X]: %g °/s\n', e.angularVelocity(1)/16.0);
    fprintf('Angular Velocity [Y]: %g °/s\n', e.angularVelocity(2)/16.0);
    fprintf('Angular Velocity [Z]: %g °/s\n', e.angularVelocity(3)/16.0);
    fprintf('Euler Angle [Heading]: %g °\n', e.eulerAngle(1)/16.0);
    fprintf('Euler Angle [Roll]: %g °\n', e.eulerAngle(2)/16.0);
    fprintf('Euler Angle [Pitch]: %g °\n', e.eulerAngle(3)/16.0);
    fprintf('Quaternion [W]: %g\n', e.quaternion(1)/16383.0);
    fprintf('Quaternion [X]: %g\n', e.quaternion(2)/16383.0);
    fprintf('Quaternion [Y]: %g\n', e.quaternion(3)/16383.0);
    fprintf('Quaternion [Z]: %g\n', e.quaternion(4)/16383.0);
    fprintf('Linear Acceleration [X]: %g m/s²\n', e.linearAcceleration(1)/100.0);
    fprintf('Linear Acceleration [Y]: %g m/s²\n', e.linearAcceleration(2)/100.0);
    fprintf('Linear Acceleration [Z]: %g m/s²\n', e.linearAcceleration(3)/100.0);
    fprintf('Gravity Vector [X]: %g m/s²\n', e.gravityVector(1)/100.0);
    fprintf('Gravity Vector [Y]: %g m/s²\n', e.gravityVector(2)/100.0);
    fprintf('Gravity Vector [Z]: %g m/s²\n', e.gravityVector(3)/100.0);
    fprintf('Temperature: %i °C\n', e.temperature);
    fprintf('Calibration Status: %s\n', dec2bin(e.calibrationStatus));
    fprintf('\n');
end

Simple (Octave)

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
25
26
27
28
29
30
31
32
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XXYYZZ"; % Change XXYYZZ to the UID of your IMU Brick 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    imu = javaObject("com.tinkerforge.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 = imu.getQuaternion();

    fprintf("Quaternion [W]: %g\n", java2int(quaternion.w)/16383.0);
    fprintf("Quaternion [X]: %g\n", java2int(quaternion.x)/16383.0);
    fprintf("Quaternion [Y]: %g\n", java2int(quaternion.y)/16383.0);
    fprintf("Quaternion [Z]: %g\n", java2int(quaternion.z)/16383.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Callback (Octave)

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
32
33
34
35
36
37
38
39
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XXYYZZ"; % Change XXYYZZ to the UID of your IMU Brick 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    imu = javaObject("com.tinkerforge.BrickIMUV2", 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 0.1s (100ms)
    imu.setQuaternionPeriod(100);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for quaternion callback
function cb_quaternion(e)
    fprintf("Quaternion [W]: %g\n", java2int(e.w)/16383.0);
    fprintf("Quaternion [X]: %g\n", java2int(e.x)/16383.0);
    fprintf("Quaternion [Y]: %g\n", java2int(e.y)/16383.0);
    fprintf("Quaternion [Z]: %g\n", java2int(e.z)/16383.0);
    fprintf("\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

All Data (Octave)

Download (octave_example_all_data.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
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
function octave_example_all_data()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XXYYZZ"; % Change XXYYZZ to the UID of your IMU Brick 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    imu = javaObject("com.tinkerforge.BrickIMUV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register all data callback to function cb_all_data
    imu.addAllDataCallback(@cb_all_data);

    % Set period for all data callback to 0.1s (100ms)
    imu.setAllDataPeriod(100);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for all data callback
function cb_all_data(e)
    fprintf("Acceleration [X]: %g m/s²\n", java2int(e.acceleration(1))/100.0);
    fprintf("Acceleration [Y]: %g m/s²\n", java2int(e.acceleration(2))/100.0);
    fprintf("Acceleration [Z]: %g m/s²\n", java2int(e.acceleration(3))/100.0);
    fprintf("Magnetic Field [X]: %g µT\n", java2int(e.magneticField(1))/16.0);
    fprintf("Magnetic Field [Y]: %g µT\n", java2int(e.magneticField(2))/16.0);
    fprintf("Magnetic Field [Z]: %g µT\n", java2int(e.magneticField(3))/16.0);
    fprintf("Angular Velocity [X]: %g °/s\n", java2int(e.angularVelocity(1))/16.0);
    fprintf("Angular Velocity [Y]: %g °/s\n", java2int(e.angularVelocity(2))/16.0);
    fprintf("Angular Velocity [Z]: %g °/s\n", java2int(e.angularVelocity(3))/16.0);
    fprintf("Euler Angle [Heading]: %g °\n", java2int(e.eulerAngle(1))/16.0);
    fprintf("Euler Angle [Roll]: %g °\n", java2int(e.eulerAngle(2))/16.0);
    fprintf("Euler Angle [Pitch]: %g °\n", java2int(e.eulerAngle(3))/16.0);
    fprintf("Quaternion [W]: %g\n", java2int(e.quaternion(1))/16383.0);
    fprintf("Quaternion [X]: %g\n", java2int(e.quaternion(2))/16383.0);
    fprintf("Quaternion [Y]: %g\n", java2int(e.quaternion(3))/16383.0);
    fprintf("Quaternion [Z]: %g\n", java2int(e.quaternion(4))/16383.0);
    fprintf("Linear Acceleration [X]: %g m/s²\n", java2int(e.linearAcceleration(1))/100.0);
    fprintf("Linear Acceleration [Y]: %g m/s²\n", java2int(e.linearAcceleration(2))/100.0);
    fprintf("Linear Acceleration [Z]: %g m/s²\n", java2int(e.linearAcceleration(3))/100.0);
    fprintf("Gravity Vector [X]: %g m/s²\n", java2int(e.gravityVector(1))/100.0);
    fprintf("Gravity Vector [Y]: %g m/s²\n", java2int(e.gravityVector(2))/100.0);
    fprintf("Gravity Vector [Z]: %g m/s²\n", java2int(e.gravityVector(3))/100.0);
    fprintf("Temperature: %d °C\n", java2int(e.temperature));
    fprintf("Calibration Status: %s\n", dec2bin(java2int(e.calibrationStatus)));
    fprintf("\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

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.

Grundfunktionen

class BrickIMUV2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • imuV2 – Typ: BrickIMUV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickIMUV2;

imuV2 = BrickIMUV2("YOUR_DEVICE_UID", ipcon);

In Octave:

imuV2 = java_new("com.tinkerforge.BrickIMUV2", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickIMUV2.Orientation BrickIMUV2.getOrientation()
Rückgabeobjekt:
  • heading – Typ: short, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
  • roll – Typ: short, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
  • pitch – Typ: short, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

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 OrientationCallback Callback zu nutzen und die Periode mit setOrientationPeriod() vorzugeben.

BrickIMUV2.LinearAcceleration BrickIMUV2.getLinearAcceleration()
Rückgabeobjekt:
  • x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?

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 LinearAccelerationCallback Callback zu nutzen und die Periode mit setLinearAccelerationPeriod() vorzugeben.

BrickIMUV2.GravityVector BrickIMUV2.getGravityVector()
Rückgabeobjekt:
  • x – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • y – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • z – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]

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 GravityVectorCallback Callback zu nutzen und die Periode mit setGravityVectorPeriod() vorzugeben.

BrickIMUV2.Quaternion BrickIMUV2.getQuaternion()
Rückgabeobjekt:
  • w – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • x – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • y – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • z – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]

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 QuaternionCallback Callback zu nutzen und die Periode mit setQuaternionPeriod() vorzugeben.

BrickIMUV2.AllData BrickIMUV2.getAllData()
Rückgabeobjekt:
  • acceleration – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • magneticField – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 2: y – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 3: z – Typ: short, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
  • angularVelocity – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
  • eulerAngle – Typ: short[], Länge: 3
    • 1: heading – Typ: short, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
    • 2: roll – Typ: short, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
    • 3: pitch – Typ: short, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
  • quaternion – Typ: short[], Länge: 4
    • 1: w – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 2: x – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 3: y – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 4: z – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • linearAcceleration – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • gravityVector – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
    • 2: y – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
    • 3: z – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • temperature – Typ: byte, Einheit: 1 °C, Wertebereich: [-128 bis 127]
  • calibrationStatus – Typ: short, Wertebereich: [0 bis 255]

Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.

Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.

  • Bit 0-1: Magnetometer
  • Bit 2-3: Beschleunigungsmesser
  • Bit 4-5: Gyroskop
  • Bit 6-7: System

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 AllDataCallback Callback zu nutzen und die Periode mit setAllDataPeriod() vorzugeben.

void BrickIMUV2.ledsOn()

Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

void BrickIMUV2.ledsOff()

Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

boolean BrickIMUV2.areLedsOn()
Rückgabe:
  • leds – Typ: boolean, Standardwert: true

Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.

Fortgeschrittene Funktionen

BrickIMUV2.Acceleration BrickIMUV2.getAcceleration()
Rückgabeobjekt:
  • x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?

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 AccelerationCallback Callback zu nutzen und die Periode mit setAccelerationPeriod() vorzugeben.

BrickIMUV2.MagneticField BrickIMUV2.getMagneticField()
Rückgabeobjekt:
  • x – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • y – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • z – Typ: short, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

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 MagneticFieldCallback Callback zu nutzen und die Periode mit setMagneticFieldPeriod() vorzugeben.

BrickIMUV2.AngularVelocity BrickIMUV2.getAngularVelocity()
Rückgabeobjekt:
  • x – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
  • y – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
  • z – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?

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 AngularVelocityCallback Callback zu nutzen und die Periode mit setAngularVelocityPeriod() vorzugeben.

byte BrickIMUV2.getTemperature()
Rückgabe:
  • temperature – Typ: byte, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.

boolean BrickIMUV2.saveCalibration()
Rückgabe:
  • calibrationDone – Typ: boolean

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.

void BrickIMUV2.setSensorConfiguration(short magnetometerRate, short gyroscopeRange, short gyroscopeBandwidth, short accelerometerRange, short accelerometerBandwidth)
Parameter:
  • magnetometerRate – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 5
  • gyroscopeRange – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gyroscopeBandwidth – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 7
  • accelerometerRange – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1
  • accelerometerBandwidth – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7

Für gyroscopeRange:

  • BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4

Für gyroscopeBandwidth:

  • BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7

Für accelerometerRange:

  • BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2.ACCELEROMETER_RANGE_16G = 3

Für accelerometerBandwidth:

  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

BrickIMUV2.SensorConfiguration BrickIMUV2.getSensorConfiguration()
Rückgabeobjekt:
  • magnetometerRate – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 5
  • gyroscopeRange – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gyroscopeBandwidth – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 7
  • accelerometerRange – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1
  • accelerometerBandwidth – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Sensor-Konfiguration zurück, wie von setSensorConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für magnetometerRate:

  • BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7

Für gyroscopeRange:

  • BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4

Für gyroscopeBandwidth:

  • BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7

Für accelerometerRange:

  • BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2.ACCELEROMETER_RANGE_16G = 3

Für accelerometerBandwidth:

  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

void BrickIMUV2.setSensorFusionMode(short mode)
Parameter:
  • mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

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:

  • BrickIMUV2.SENSOR_FUSION_OFF = 0
  • BrickIMUV2.SENSOR_FUSION_ON = 1
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

short BrickIMUV2.getSensorFusionMode()
Rückgabe:
  • mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

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:

  • BrickIMUV2.SENSOR_FUSION_OFF = 0
  • BrickIMUV2.SENSOR_FUSION_ON = 1
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

void BrickIMUV2.setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)
Parameter:
  • enableDynamicBaudrate – Typ: boolean, Standardwert: true
  • minimumDynamicBaudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

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.SPITFPBaudrateConfig BrickIMUV2.getSPITFPBaudrateConfig()
Rückgabeobjekt:
  • enableDynamicBaudrate – Typ: boolean, Standardwert: true
  • minimumDynamicBaudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe setSPITFPBaudrateConfig().

Neu in Version 2.0.10 (Firmware).

long BrickIMUV2.getSendTimeoutCount(short communicationMethod)
Parameter:
  • communicationMethod – Typ: short, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeoutCount – Typ: long, Wertebereich: [0 bis 232 - 1]

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:

  • BrickIMUV2.COMMUNICATION_METHOD_NONE = 0
  • BrickIMUV2.COMMUNICATION_METHOD_USB = 1
  • BrickIMUV2.COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickIMUV2.COMMUNICATION_METHOD_CHIBI = 3
  • BrickIMUV2.COMMUNICATION_METHOD_RS485 = 4
  • BrickIMUV2.COMMUNICATION_METHOD_WIFI = 5
  • BrickIMUV2.COMMUNICATION_METHOD_ETHERNET = 6
  • BrickIMUV2.COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.0.7 (Firmware).

void BrickIMUV2.setSPITFPBaudrate(char brickletPort, long baudrate)
Parameter:
  • brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

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).

long BrickIMUV2.getSPITFPBaudrate(char brickletPort)
Parameter:
  • brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabe:
  • baudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe setSPITFPBaudrate().

Neu in Version 2.0.5 (Firmware).

BrickIMUV2.SPITFPErrorCount BrickIMUV2.getSPITFPErrorCount(char brickletPort)
Parameter:
  • brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabeobjekt:
  • errorCountACKChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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).

void 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.

void 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.

boolean BrickIMUV2.isStatusLEDEnabled()
Rückgabe:
  • enabled – Typ: boolean, Standardwert: true

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

BrickIMUV2.Protocol1BrickletName BrickIMUV2.getProtocol1BrickletName(char port)
Parameter:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabeobjekt:
  • protocolVersion – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • name – Typ: String, Länge: bis zu 40

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.

short BrickIMUV2.getChipTemperature()
Rückgabe:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]

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.

void 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.Identity BrickIMUV2.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['0' bis '8']
  • hardwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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.

Konfigurationsfunktionen für Callbacks

void BrickIMUV2.setAccelerationPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der AccelerationCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getAccelerationPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAccelerationPeriod() gesetzt.

void BrickIMUV2.setMagneticFieldPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der MagneticFieldCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getMagneticFieldPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setMagneticFieldPeriod() gesetzt.

void BrickIMUV2.setAngularVelocityPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der AngularVelocityCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getAngularVelocityPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAngularVelocityPeriod() gesetzt.

void BrickIMUV2.setTemperaturePeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der TemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getTemperaturePeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setTemperaturePeriod() gesetzt.

void BrickIMUV2.setOrientationPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der OrientationCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getOrientationPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setOrientationPeriod() gesetzt.

void BrickIMUV2.setLinearAccelerationPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der LinearAccelerationCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getLinearAccelerationPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setLinearAccelerationPeriod() gesetzt.

void BrickIMUV2.setGravityVectorPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der GravityVectorCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getGravityVectorPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setGravityVectorPeriod() gesetzt.

void BrickIMUV2.setQuaternionPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der QuaternionCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getQuaternionPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setQuaternionPeriod() gesetzt.

void BrickIMUV2.setAllDataPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der AllDataCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

long BrickIMUV2.getAllDataPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAllDataPeriod() gesetzt.

Callbacks

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.

callback BrickIMUV2.AccelerationCallback
Event-Objekt:
  • x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?

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 werde. Eine hinzugefügter Callback-Function kann mit removeAccelerationCallback() wieder entfernt werden.

callback BrickIMUV2.MagneticFieldCallback
Event-Objekt:
  • x – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • y – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
  • z – Typ: short, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

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 werde. Eine hinzugefügter Callback-Function kann mit removeMagneticFieldCallback() wieder entfernt werden.

callback BrickIMUV2.AngularVelocityCallback
Event-Objekt:
  • x – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
  • y – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
  • z – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?

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 werde. Eine hinzugefügter Callback-Function kann mit removeAngularVelocityCallback() wieder entfernt werden.

callback BrickIMUV2.TemperatureCallback
Event-Objekt:
  • temperature – Typ: byte, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Dieser Callback wird mit der Periode, wie gesetzt mit setTemperaturePeriod(), ausgelöst. Der Parameter ist die Temperatur.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addTemperatureCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeTemperatureCallback() wieder entfernt werden.

callback BrickIMUV2.LinearAccelerationCallback
Event-Objekt:
  • x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit setLinearAccelerationPeriod(), ausgelöst. Die Parameter sind die linearen 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 addLinearAccelerationCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeLinearAccelerationCallback() wieder entfernt werden.

callback BrickIMUV2.GravityVectorCallback
Event-Objekt:
  • x – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • y – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]
  • z – Typ: short, Einheit: 1 cm/s, Wertebereich: [-981 bis 981]

Dieser Callback wird mit der Periode, wie gesetzt mit setGravityVectorPeriod(), ausgelöst. Die Parameter sind die Erdbeschleunigungsvektor-Werte 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 addGravityVectorCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeGravityVectorCallback() wieder entfernt werden.

callback BrickIMUV2.OrientationCallback
Event-Objekt:
  • heading – Typ: short, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
  • roll – Typ: short, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
  • pitch – Typ: short, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

Dieser Callback 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.

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 werde. Eine hinzugefügter Callback-Function kann mit removeOrientationCallback() wieder entfernt werden.

callback BrickIMUV2.QuaternionCallback
Event-Objekt:
  • w – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • x – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • y – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • z – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]

Dieser Callback 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.

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 werde. Eine hinzugefügter Callback-Function kann mit removeQuaternionCallback() wieder entfernt werden.

callback BrickIMUV2.AllDataCallback
Event-Objekt:
  • acceleration – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • magneticField – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 2: y – Typ: short, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
    • 3: z – Typ: short, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
  • angularVelocity – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1/16 °/s, Wertebereich: ?
  • eulerAngle – Typ: short[], Länge: 3
    • 1: heading – Typ: short, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
    • 2: roll – Typ: short, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
    • 3: pitch – Typ: short, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
  • quaternion – Typ: short[], Länge: 4
    • 1: w – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 2: x – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 3: y – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 4: z – Typ: short, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • linearAcceleration – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • gravityVector – Typ: short[], Länge: 3
    • 1: x – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 2: y – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
    • 3: z – Typ: short, Einheit: 1 cm/s, Wertebereich: ?
  • temperature – Typ: byte, Einheit: 1 °C, Wertebereich: [-128 bis 127]
  • calibrationStatus – Typ: short, Wertebereich: [0 bis 255]

Dieser Callback wird mit der Periode, wie gesetzt mit setAllDataPeriod(), ausgelöst. Die Parameter sind die gleichen wie bei getAllData().

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 werde. Eine hinzugefügter Callback-Function kann mit removeAllDataCallback() wieder entfernt werden.

Virtuelle Funktionen

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.

short[] BrickIMUV2.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]

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.

boolean BrickIMUV2.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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:

  • BrickIMUV2.FUNCTION_LEDS_ON = 10
  • BrickIMUV2.FUNCTION_LEDS_OFF = 11
  • BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
  • BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
  • BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
  • BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
  • BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickIMUV2.FUNCTION_RESET = 243
void BrickIMUV2.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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:

  • BrickIMUV2.FUNCTION_LEDS_ON = 10
  • BrickIMUV2.FUNCTION_LEDS_OFF = 11
  • BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
  • BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
  • BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
  • BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
  • BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickIMUV2.FUNCTION_RESET = 243
void BrickIMUV2.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

int BrickIMUV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen IMU Brick 2.0 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.

String BrickIMUV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.