C# - IMU Brick¶

Simple¶

Download (ExampleSimple.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XXYYZZ"; // Change XXYYZZ to the UID of your IMU Brick

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickIMU imu = new BrickIMU(UID, ipcon); // Create device object

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

        // Get current quaternion
        float x, y, z, w;
        imu.GetQuaternion(out x, out y, out z, out w);

        Console.WriteLine("Quaternion [X]: " + x);
        Console.WriteLine("Quaternion [Y]: " + y);
        Console.WriteLine("Quaternion [Z]: " + z);
        Console.WriteLine("Quaternion [W]: " + w);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback¶

Download (ExampleCallback.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XXYYZZ"; // Change XXYYZZ to the UID of your IMU Brick

    // Callback function for quaternion callback
    static void QuaternionCB(BrickIMU sender, float x, float y, float z, float w)
    {
        Console.WriteLine("Quaternion [X]: " + x);
        Console.WriteLine("Quaternion [Y]: " + y);
        Console.WriteLine("Quaternion [Z]: " + z);
        Console.WriteLine("Quaternion [W]: " + w);
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickIMU imu = new BrickIMU(UID, ipcon); // Create device object

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

        // Register quaternion callback to function QuaternionCB
        imu.QuaternionCallback += QuaternionCB;

        // Set period for quaternion callback to 1s (1000ms)
        imu.SetQuaternionPeriod(1000);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Grundfunktionen¶

class BrickIMU(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	imu – Typ: BrickIMU

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

BrickIMU imu = new BrickIMU("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

void BrickIMU.GetOrientation(out short roll, out short pitch, out short yaw)¶

Ausgabeparameter:	roll – Typ: short, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] pitch – Typ: short, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] yaw – Typ: short, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000]

Gibt die aktuelle Orientierung (Roll-, Nick-, Gierwinkel) des IMU Brick in Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren.

Wir empfehlen die Verwendung von Quaternionen stattdessen.

Die Reihenfolge in denen die Orientierungswerte angewandt werden sollten, ist Roll-, Nick-, Gierwinkel.

Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den OrientationCallback Callback zu nutzen und die Periode mit SetOrientationPeriod() vorzugeben.

void BrickIMU.GetQuaternion(out float x, out float y, out float z, out float w)¶

Ausgabeparameter:	x – Typ: float, Wertebereich: [-1.0f bis 1.0f] y – Typ: float, Wertebereich: [-1.0f bis 1.0f] z – Typ: float, Wertebereich: [-1.0f bis 1.0f] w – Typ: float, Wertebereich: [-1.0f bis 1.0f]

Gibt die aktuelle Orientierung (x, y, z, w) des IMU Brick als Quaterinonen zurück.

Die Umrechnung von Quaternionen in Eulerwinkel ist mit folgender Formel möglich:

xAngle = atan2(2*y*w - 2*x*z, 1 - 2*y*y - 2*z*z)
yAngle = atan2(2*x*w - 2*y*z, 1 - 2*x*x - 2*z*z)
zAngle =  asin(2*x*y + 2*z*w)

Es ist auch möglich unabhängige Winkel zu berechen. Yaw, Pitch und Roll in einem rechtshändigen Fahrzeugkoordinatensystem nach DIN70000 können wie folgt berechnet werden:

yaw   =  atan2(2*x*y + 2*w*z, w*w + x*x - y*y - z*z)
pitch = -asin(2*w*y - 2*x*z)
roll  = -atan2(2*y*z + 2*w*x, -w*w + x*x + y*y - z*z))

Diese Umrechnung ist irreversibel aufgrund der kardanischen Blockade.

Die Umrechnung von Quaternionen in eine OpenGL Transformationsmatrix ist mit folgender Formel möglich:

matrix = [[1 - 2*(y*y + z*z),     2*(x*y - w*z),     2*(x*z + w*y), 0],
          [    2*(x*y + w*z), 1 - 2*(x*x + z*z),     2*(y*z - w*x), 0],
          [    2*(x*z - w*y),     2*(y*z + w*x), 1 - 2*(x*x + y*y), 0],
          [                0,                 0,                 0, 1]]

Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den QuaternionCallback Callback zu nutzen und die Periode mit SetQuaternionPeriod() vorzugeben.

void BrickIMU.LedsOn()¶

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

void BrickIMU.LedsOff()¶

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

bool BrickIMU.AreLedsOn()¶

Rückgabe:	leds – Typ: bool, Standardwert: true

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

void BrickIMU.SetConvergenceSpeed(int speed)¶

Parameter:	speed – Typ: int, Einheit: 1 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 30

Setzt die Konvergenzgeschwindigkeit des IMU Brick. Die Konvergenzgeschwindigkeit bestimmt wie die unterschiedlichen Sensormessungen vereinigt werden.

Wenn die Orientierung des IMU Brick eine Abweichung von 10° hat und die Konvergenzgeschwindigkeit auf 20°/s konfiguriert ist, dann dauert es 0,5s bis die Orientierung korrigiert ist. Bei einer zu hohen Konvergenzgeschwindigkeit wird nach Erreichen der korrekten Orientierung, diese um die Fluktuationen des Beschleunigungsmessers und des Magnetometers schwanken.

Wenn die Konvergenzgeschwindigkeit auf 0 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Gyroskopdaten. Dies ergibt sehr gleichmäßige Bewegungen aber Fehler des Gyroskops werden nicht korrigiert. Wenn die Konvergenzgeschwindigkeit über 500 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Beschleunigungsmesser- und Magnetometerdaten. In diesem Fall sind die Bewegungen abrupt und die Werte werden schwanken. Es treten aber keine akkumulativen Fehler auf.

In Anwendungen mit hohen Winkelgeschwindigkeiten wird eine hohe Konvergenzgeschwindigkeit empfohlen, so dass Fehler des Gyroskops schnell korrigiert werden können. In Anwendungen mit langsamen Bewegungen wird entsprechend eine geringe Konvergenzgeschwindigkeit empfohlen. Es ist möglich die Konvergenzgeschwindigkeit spontan zu ändern. Dadurch ist es möglich (und empfohlen) direkt vor einer abrupten Bewegung die Konvergenzgeschwindigkeit zu erhöhen und im Anschluss wieder zu verringern.

Um ein Gefühl für einen guten Wert, für die Konvergenzgeschwindigkeit, in deiner Anwendung zu bekommen ist es ratsam im Brick Viewer verschiedenste Werte auszuprobieren.

int BrickIMU.GetConvergenceSpeed()¶

Rückgabe:	speed – Typ: int, Einheit: 1 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 30

Gibt die Konvergenzgeschwindigkeit zurück, wie von SetConvergenceSpeed() gesetzt.

Fortgeschrittene Funktionen¶

void BrickIMU.GetAcceleration(out short x, out short y, out short z)¶

Ausgabeparameter:	x – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] y – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] z – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1]

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X, Y und Z-Achse zurück.

Wenn die kalibrierten Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den AccelerationCallback Callback zu nutzen und die Periode mit SetAccelerationPeriod() vorzugeben.

void BrickIMU.GetMagneticField(out short x, out short y, out short z)¶

Ausgabeparameter:	x – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] y – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] z – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1]

Gibt das kalibrierte Magnetfeld des Magnetometers mit den X-, Y- und Z-Komponenten zurück.

Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen den MagneticFieldCallback Callback zu nutzen und die Periode mit SetMagneticFieldPeriod() vorzugeben.

void BrickIMU.GetAngularVelocity(out short x, out short y, out short z)¶

Ausgabeparameter:	x – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] y – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] z – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]

Gibt die kalibrierten Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in °/14,375s zurück. (Um den Wert in °/s zu erhalten ist es notwendig durch 14,375 zu teilen)

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den AngularVelocityCallback Callback zu nutzen und die Periode mit SetAngularVelocityPeriod() vorzugeben.

void BrickIMU.GetAllData(out short accX, out short accY, out short accZ, out short magX, out short magY, out short magZ, out short angX, out short angY, out short angZ, out short temperature)¶

Ausgabeparameter:

accX – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] accY – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] accZ – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] magX – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] magY – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] magZ – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] angX – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] angY – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] angZ – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Daten von GetAcceleration(), GetMagneticField() und GetAngularVelocity() sowie die Temperatur des IMU Brick zurück.

Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den AllDataCallback Callback zu nutzen und die Periode mit SetAllDataPeriod() vorzugeben.

short BrickIMU.GetIMUTemperature()¶

Rückgabe:	temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur des IMU Brick zurück.

void BrickIMU.SetAccelerationRange(byte range)¶

Parameter:	range – Typ: byte, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

byte BrickIMU.GetAccelerationRange()¶

Rückgabe:	range – Typ: byte, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

void BrickIMU.SetMagnetometerRange(byte range)¶

Parameter:	range – Typ: byte, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

byte BrickIMU.GetMagnetometerRange()¶

Rückgabe:	range – Typ: byte, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

void BrickIMU.SetCalibration(byte typ, short[] data)¶

Parameter:	typ – Typ: byte, Wertebereich: Siehe Konstanten data – Typ: short[], Länge: 10, Wertebereich: [-215 bis 215 - 1]

Es sind folgende verschiedene Kalibrierungen möglich:

Typ	Beschreibung	Werte
0	Beschleunigungsmesser Verstärkung	[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]
1	Beschleunigungsmesser Versatz	[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]
2	Magnetometer Verstärkung	[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]
3	Magnetometer Versatz	[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]
4	Gyroskop Verstärkung	[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]
5	Gyroskop Versatz	[bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0]

Die Kalibrierung mittels Verstärkung und Versatz wird über folgende Formel realisiert:

new_value = (bias + orig_value) * gain_mul / gain_div

Für die Implementierung einer eigenen Kalibriersoftware sollte beachtet werden, dass zuerst die bisherige Kalibrierung rückgängig gemacht werden muss (Versatz auf 0 und Verstärkung auf 1/1 setzen) und das über mehrere tausend Werte gemittelt werden sollte um ein benutzbares Ergebnis zu erhalten.

Der Versatz des Gyroskops ist sehr temperaturabhängig und daher muss die Kalibrierung des Versatzes mit zwei unterschiedlichen Temperaturen erfolgen. Die Werte xl, yl, zl und temp l sind der Versatz für x, y, z und die zugehörige geringe Temperatur. Die Werte xh, yh, zh und temp h sind entsprechend für eine höhere Temperatur. Die Temperaturdifferenz sollte mindestens 5°C betragen. Die übliche Betriebstemperatur des IMU Brick sollte einer der Kalibrierpunkte sein.

Bemerkung

Wir empfehlen dringend den Brick Viewer zur Kalibrierung des IMU Brick zu verwenden.

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

Für typ:

• BrickIMU.CALIBRATION_TYPE_ACCELEROMETER_GAIN = 0
• BrickIMU.CALIBRATION_TYPE_ACCELEROMETER_BIAS = 1
• BrickIMU.CALIBRATION_TYPE_MAGNETOMETER_GAIN = 2
• BrickIMU.CALIBRATION_TYPE_MAGNETOMETER_BIAS = 3
• BrickIMU.CALIBRATION_TYPE_GYROSCOPE_GAIN = 4
• BrickIMU.CALIBRATION_TYPE_GYROSCOPE_BIAS = 5

short[] BrickIMU.GetCalibration(byte typ)¶

Parameter:	typ – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	data – Typ: short[], Länge: 10, Wertebereich: [-215 bis 215 - 1]

Gibt die Kalibrierung für den ausgewählten Typ zurück, wie von SetCalibration() gesetzt.

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

Für typ:

• BrickIMU.CALIBRATION_TYPE_ACCELEROMETER_GAIN = 0
• BrickIMU.CALIBRATION_TYPE_ACCELEROMETER_BIAS = 1
• BrickIMU.CALIBRATION_TYPE_MAGNETOMETER_GAIN = 2
• BrickIMU.CALIBRATION_TYPE_MAGNETOMETER_BIAS = 3
• BrickIMU.CALIBRATION_TYPE_GYROSCOPE_GAIN = 4
• BrickIMU.CALIBRATION_TYPE_GYROSCOPE_BIAS = 5

void BrickIMU.OrientationCalculationOn()¶

Aktiviert die Orientierungsberechnungen des IMU Brick.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

void BrickIMU.OrientationCalculationOff()¶

Deaktiviert die Orientierungsberechnungen des IMU Brick.

Wenn die Berechnungen deaktiviert sind, gibt GetOrientation() solange den letzten berechneten Wer zurück bis die Berechnungen wieder aktiviert werden.

Die trigonometrischen Funktionen die zur Berechnung der Orientierung benötigt werden sind sehr teuer. Wir empfehlen die Orientierungsberechnungen zu deaktivieren wenn sie nicht benötigt werden. Dadurch wird mehr Rechenzeit für den Sensorfusions-Algorithmus freigegeben.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

bool BrickIMU.IsOrientationCalculationOn()¶

Rückgabe:	orientationCalculationOn – Typ: bool, Standardwert: true

Gibt zurück ob die Orientierungsberechnungen des IMU Brick aktiv sind.

Neu in Version 2.0.2 (Firmware).

void BrickIMU.SetSPITFPBaudrateConfig(bool enableDynamicBaudrate, long minimumDynamicBaudrate)¶

Parameter:	enableDynamicBaudrate – Typ: bool, 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.3.5 (Firmware).

void BrickIMU.GetSPITFPBaudrateConfig(out bool enableDynamicBaudrate, out long minimumDynamicBaudrate)¶

Ausgabeparameter:	enableDynamicBaudrate – Typ: bool, 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.3.5 (Firmware).

long BrickIMU.GetSendTimeoutCount(byte communicationMethod)¶

Parameter:	communicationMethod – Typ: byte, 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:

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

Neu in Version 2.3.3 (Firmware).

void BrickIMU.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.3.3 (Firmware).

long BrickIMU.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.3.3 (Firmware).

void BrickIMU.GetSPITFPErrorCount(char brickletPort, out long errorCountACKChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)¶

Parameter:	brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	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.3.3 (Firmware).

void BrickIMU.EnableStatusLED()¶

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

void BrickIMU.DisableStatusLED()¶

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

bool BrickIMU.IsStatusLEDEnabled()¶

Rückgabe:	enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

short BrickIMU.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 BrickIMU.Reset()¶

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

void BrickIMU.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Ausgabeparameter:

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: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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 BrickIMU.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 BrickIMU.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 BrickIMU.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 BrickIMU.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 BrickIMU.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 BrickIMU.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 BrickIMU.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 BrickIMU.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.

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickIMU sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

imu.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

event BrickIMU.AccelerationCallback(BrickIMU sender, short x, short y, short z)¶

Callback-Parameter:	sender – Typ: BrickIMU x – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] y – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] z – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAccelerationPeriod(), ausgelöst. Die Parameter sind die Beschleunigungen der X, Y und Z-Achse.

event BrickIMU.MagneticFieldCallback(BrickIMU sender, short x, short y, short z)¶

Callback-Parameter:	sender – Typ: BrickIMU x – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] y – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] z – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetMagneticFieldPeriod(), ausgelöst. Die Parameter sind die Magnetfeldkomponenten der X, Y und Z-Achse.

event BrickIMU.AngularVelocityCallback(BrickIMU sender, short x, short y, short z)¶

Callback-Parameter:	sender – Typ: BrickIMU x – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] y – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] z – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAngularVelocityPeriod(), ausgelöst. Die Parameter sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

event BrickIMU.AllDataCallback(BrickIMU sender, short accX, short accY, short accZ, short magX, short magY, short magZ, short angX, short angY, short angZ, short temperature)¶

Callback-Parameter:

sender – Typ: BrickIMU accX – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] accY – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] accZ – Typ: short, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] magX – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] magY – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] magZ – Typ: short, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] angX – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] angY – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] angZ – Typ: short, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAllDataPeriod(), ausgelöst. Die Parameter sind die Beschleunigungen, Magnetfeldkomponenten und die Winkelgeschwindigkeiten der X, Y und Z-Achse sowie die Temperatur des IMU Brick.

event BrickIMU.OrientationCallback(BrickIMU sender, short roll, short pitch, short yaw)¶

Callback-Parameter:	sender – Typ: BrickIMU roll – Typ: short, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] pitch – Typ: short, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] yaw – Typ: short, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetOrientationPeriod(), ausgelöst. Die Parameter sind die Orientierung (Roll-, Nick-, Gierwinkel) des IMU Brick in Eulerwinkeln. Siehe GetOrientation() für Details.

event BrickIMU.QuaternionCallback(BrickIMU sender, float x, float y, float z, float w)¶

Callback-Parameter:	sender – Typ: BrickIMU x – Typ: float, Wertebereich: [-1.0f bis 1.0f] y – Typ: float, Wertebereich: [-1.0f bis 1.0f] z – Typ: float, Wertebereich: [-1.0f bis 1.0f] w – Typ: float, Wertebereich: [-1.0f bis 1.0f]

Dieser Callback wird mit der Periode, wie gesetzt mit SetQuaternionPeriod(), ausgelöst. Die Parameter sind die Orientierung (x, y, z, w) des IMU Brick in Quaternionen. Siehe GetQuaternion() für Details.

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.

byte[] BrickIMU.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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.

bool BrickIMU.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

• BrickIMU.FUNCTION_LEDS_ON = 8
• BrickIMU.FUNCTION_LEDS_OFF = 9
• BrickIMU.FUNCTION_SET_ACCELERATION_RANGE = 11
• BrickIMU.FUNCTION_SET_MAGNETOMETER_RANGE = 13
• BrickIMU.FUNCTION_SET_CONVERGENCE_SPEED = 15
• BrickIMU.FUNCTION_SET_CALIBRATION = 17
• BrickIMU.FUNCTION_SET_ACCELERATION_PERIOD = 19
• BrickIMU.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 21
• BrickIMU.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 23
• BrickIMU.FUNCTION_SET_ALL_DATA_PERIOD = 25
• BrickIMU.FUNCTION_SET_ORIENTATION_PERIOD = 27
• BrickIMU.FUNCTION_SET_QUATERNION_PERIOD = 29
• BrickIMU.FUNCTION_ORIENTATION_CALCULATION_ON = 37
• BrickIMU.FUNCTION_ORIENTATION_CALCULATION_OFF = 38
• BrickIMU.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickIMU.FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickIMU.FUNCTION_ENABLE_STATUS_LED = 238
• BrickIMU.FUNCTION_DISABLE_STATUS_LED = 239
• BrickIMU.FUNCTION_RESET = 243
• BrickIMU.FUNCTION_WRITE_BRICKLET_PLUGIN = 246

void BrickIMU.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

• BrickIMU.FUNCTION_LEDS_ON = 8
• BrickIMU.FUNCTION_LEDS_OFF = 9
• BrickIMU.FUNCTION_SET_ACCELERATION_RANGE = 11
• BrickIMU.FUNCTION_SET_MAGNETOMETER_RANGE = 13
• BrickIMU.FUNCTION_SET_CONVERGENCE_SPEED = 15
• BrickIMU.FUNCTION_SET_CALIBRATION = 17
• BrickIMU.FUNCTION_SET_ACCELERATION_PERIOD = 19
• BrickIMU.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 21
• BrickIMU.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 23
• BrickIMU.FUNCTION_SET_ALL_DATA_PERIOD = 25
• BrickIMU.FUNCTION_SET_ORIENTATION_PERIOD = 27
• BrickIMU.FUNCTION_SET_QUATERNION_PERIOD = 29
• BrickIMU.FUNCTION_ORIENTATION_CALCULATION_ON = 37
• BrickIMU.FUNCTION_ORIENTATION_CALCULATION_OFF = 38
• BrickIMU.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickIMU.FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickIMU.FUNCTION_ENABLE_STATUS_LED = 238
• BrickIMU.FUNCTION_DISABLE_STATUS_LED = 239
• BrickIMU.FUNCTION_RESET = 243
• BrickIMU.FUNCTION_WRITE_BRICKLET_PLUGIN = 246

void BrickIMU.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

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

Interne Funktionen¶

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.

void BrickIMU.GetProtocol1BrickletName(char port, out byte protocolVersion, out byte[] firmwareVersion, out string name)¶

Parameter:	port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	protocolVersion – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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.

void BrickIMU.WriteBrickletPlugin(char port, byte offset, byte[] chunk)¶

Parameter:	port – Typ: char, Wertebereich: ['a' bis 'b'] offset – Typ: byte, Wertebereich: [0 bis 255] chunk – Typ: byte[], Länge: 32, Wertebereich: [0 bis 255]

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.

byte[] BrickIMU.ReadBrickletPlugin(char port, byte offset)¶

Parameter:	port – Typ: char, Wertebereich: ['a' bis 'b'] offset – Typ: byte, Wertebereich: [0 bis 255]
Rückgabe:	chunk – Typ: byte[], Länge: 32, Wertebereich: [0 bis 255]

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.

Konstanten¶

int BrickIMU.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen IMU Brick zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickIMU.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines IMU Brick dar.