Mathematica - IMU Brick

Dies ist die Beschreibung der Mathematica API Bindings für den IMU Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Mathematica API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your IMU Brick*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
imu=NETNew["Tinkerforge.BrickIMU",uid,ipcon]
ipcon@Connect[host,port]

(*Get current quaternion*)
x=0;y=0;z=0;w=0
imu@GetQuaternion[x,y,z,w]

Print["Quaternion [X]: "<>ToString[x]]
Print["Quaternion [Y]: "<>ToString[y]]
Print["Quaternion [Z]: "<>ToString[z]]
Print["Quaternion [W]: "<>ToString[w]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[imu]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your IMU Brick*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
imu=NETNew["Tinkerforge.BrickIMU",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for quaternion callback*)
QuaternionCB[sender_,x_,y_,z_,w_]:=
 Module[{},
  Print["Quaternion [X]: "<>ToString[x]];
  Print["Quaternion [Y]: "<>ToString[y]];
  Print["Quaternion [Z]: "<>ToString[z]];
  Print["Quaternion [W]: "<>ToString[w]]
 ]

AddEventHandler[imu@QuaternionCallback,QuaternionCB]

(*Set period for quaternion callback to 1s (1000ms)*)
imu@SetQuaternionPeriod[1000]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[imu]
ReleaseNETObject[ipcon]

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.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.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickIMU[uid, ipcon] → imu
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • imu -- NETObject[BrickIMU]

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

imu=NETNew["Tinkerforge.BrickIMU","YOUR_DEVICE_UID",ipcon]

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

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickIMU@GetOrientation[out roll, out pitch, out yaw] → Null
Parameter:
  • roll -- Integer
  • pitch -- Integer
  • yaw -- Integer

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

Wir empfehlen die Verwendung von Quaternionen stattdessen.

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

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

BrickIMU@GetQuaternion[out x, out y, out z, out w] → Null
Parameter:
  • x -- Real
  • y -- Real
  • z -- Real
  • w -- Real

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

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

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

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

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

Diese Umrechnung ist irreversibel aufgrund der kardanischen Blockade.

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

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

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

BrickIMU@LedsOn[] → Null

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

BrickIMU@LedsOff[] → Null

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

BrickIMU@AreLedsOn[] → leds
Rückgabe:
  • leds -- True/False

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

BrickIMU@SetConvergenceSpeed[speed] → Null
Parameter:
  • speed -- Integer

Setzt die Konvergenzgeschwindigkeit des IMU Brick in °/s. Die Konvergenzgeschwindigkeit bestimmt wie die unterschiedlichen Sensormessungen vereinigt werden.

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

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

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

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

BrickIMU@GetConvergenceSpeed[] → speed
Rückgabe:
  • speed -- Integer

Gibt die Konvergenzgeschwindigkeit zurück, wie von SetConvergenceSpeed[] gesetzt.

Fortgeschrittene Funktionen

BrickIMU@GetAcceleration[out x, out y, out z] → Null
Parameter:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X, Y und Z-Achse in g/1000 zurück (1g = 9,80665m/s²).

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

BrickIMU@GetMagneticField[out x, out y, out z] → Null
Parameter:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Gibt das kalibrierte magnetische Feld des Magnetometers mit den X-, Y- und Z-Komponenten in mG zurück (Milligauss oder Nanotesla).

Wenn das magnetische Feld periodisch abgefragt werden soll, wird empfohlen den MagneticFieldCallback Callback zu nutzen und die Periode mit SetMagneticFieldPeriod[] vorzugeben.

BrickIMU@GetAngularVelocity[out x, out y, out z] → Null
Parameter:
  • x -- Integer
  • y -- Integer
  • z -- Integer

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

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

BrickIMU@GetAllData[out accX, out accY, out accZ, out magX, out magY, out magZ, out angX, out angY, out angZ, out temperature] → Null
Parameter:
  • accX -- Integer
  • accY -- Integer
  • accZ -- Integer
  • magX -- Integer
  • magY -- Integer
  • magZ -- Integer
  • angX -- Integer
  • angY -- Integer
  • angZ -- Integer
  • temperature -- Integer

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

Die Temperatur wird in °C/100 ausgegeben.

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

BrickIMU@GetIMUTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

Gibt die Temperatur (in °C/100) des IMU Brick zurück.

BrickIMU@SetAccelerationRange[range] → Null
Parameter:
  • range -- Integer

Bisher nicht implementiert.

BrickIMU@GetAccelerationRange[] → range
Rückgabe:
  • range -- Integer

Bisher nicht implementiert.

BrickIMU@SetMagnetometerRange[range] → Null
Parameter:
  • range -- Integer

Bisher nicht implementiert.

BrickIMU@GetMagnetometerRange[] → range
Rückgabe:
  • range -- Integer

Bisher nicht implementiert.

BrickIMU@SetCalibration[typ, {data1, data2, ..., data10}] → Null
Parameter:
  • typ -- Integer
  • datai -- Integer

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:

  • BrickIMU`CALIBRATIONUTYPEUACCELEROMETERUGAIN = 0
  • BrickIMU`CALIBRATIONUTYPEUACCELEROMETERUBIAS = 1
  • BrickIMU`CALIBRATIONUTYPEUMAGNETOMETERUGAIN = 2
  • BrickIMU`CALIBRATIONUTYPEUMAGNETOMETERUBIAS = 3
  • BrickIMU`CALIBRATIONUTYPEUGYROSCOPEUGAIN = 4
  • BrickIMU`CALIBRATIONUTYPEUGYROSCOPEUBIAS = 5
BrickIMU@GetCalibration[typ] → {data1, data2, ..., data10}
Parameter:
  • typ -- Integer
Rückgabe:
  • datai -- Integer

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:

  • BrickIMU`CALIBRATIONUTYPEUACCELEROMETERUGAIN = 0
  • BrickIMU`CALIBRATIONUTYPEUACCELEROMETERUBIAS = 1
  • BrickIMU`CALIBRATIONUTYPEUMAGNETOMETERUGAIN = 2
  • BrickIMU`CALIBRATIONUTYPEUMAGNETOMETERUBIAS = 3
  • BrickIMU`CALIBRATIONUTYPEUGYROSCOPEUGAIN = 4
  • BrickIMU`CALIBRATIONUTYPEUGYROSCOPEUBIAS = 5
BrickIMU@OrientationCalculationOn[] → Null

Aktiviert die Orientierungsberechnungen des IMU Brick.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

BrickIMU@OrientationCalculationOff[] → Null

Deaktiviert die Orientierungsberechnungen des IMU Brick.

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

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

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

BrickIMU@IsOrientationCalculationOn[] → orientationCalculationOn
Rückgabe:
  • orientationCalculationOn -- True/False

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

Neu in Version 2.0.2 (Firmware).

BrickIMU@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickIMU@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- True/False

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:

  • BrickIMU`FUNCTIONULEDSUON = 8
  • BrickIMU`FUNCTIONULEDSUOFF = 9
  • BrickIMU`FUNCTIONUSETUACCELERATIONURANGE = 11
  • BrickIMU`FUNCTIONUSETUMAGNETOMETERURANGE = 13
  • BrickIMU`FUNCTIONUSETUCONVERGENCEUSPEED = 15
  • BrickIMU`FUNCTIONUSETUCALIBRATION = 17
  • BrickIMU`FUNCTIONUSETUACCELERATIONUPERIOD = 19
  • BrickIMU`FUNCTIONUSETUMAGNETICUFIELDUPERIOD = 21
  • BrickIMU`FUNCTIONUSETUANGULARUVELOCITYUPERIOD = 23
  • BrickIMU`FUNCTIONUSETUALLUDATAUPERIOD = 25
  • BrickIMU`FUNCTIONUSETUORIENTATIONUPERIOD = 27
  • BrickIMU`FUNCTIONUSETUQUATERNIONUPERIOD = 29
  • BrickIMU`FUNCTIONUORIENTATIONUCALCULATIONUON = 37
  • BrickIMU`FUNCTIONUORIENTATIONUCALCULATIONUOFF = 38
  • BrickIMU`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickIMU`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickIMU`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickIMU`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickIMU`FUNCTIONURESET = 243
BrickIMU@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- True/False

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

  • BrickIMU`FUNCTIONULEDSUON = 8
  • BrickIMU`FUNCTIONULEDSUOFF = 9
  • BrickIMU`FUNCTIONUSETUACCELERATIONURANGE = 11
  • BrickIMU`FUNCTIONUSETUMAGNETOMETERURANGE = 13
  • BrickIMU`FUNCTIONUSETUCONVERGENCEUSPEED = 15
  • BrickIMU`FUNCTIONUSETUCALIBRATION = 17
  • BrickIMU`FUNCTIONUSETUACCELERATIONUPERIOD = 19
  • BrickIMU`FUNCTIONUSETUMAGNETICUFIELDUPERIOD = 21
  • BrickIMU`FUNCTIONUSETUANGULARUVELOCITYUPERIOD = 23
  • BrickIMU`FUNCTIONUSETUALLUDATAUPERIOD = 25
  • BrickIMU`FUNCTIONUSETUORIENTATIONUPERIOD = 27
  • BrickIMU`FUNCTIONUSETUQUATERNIONUPERIOD = 29
  • BrickIMU`FUNCTIONUORIENTATIONUCALCULATIONUON = 37
  • BrickIMU`FUNCTIONUORIENTATIONUCALCULATIONUOFF = 38
  • BrickIMU`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickIMU`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickIMU`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickIMU`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickIMU`FUNCTIONURESET = 243
BrickIMU@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickIMU@SetSPITFPBaudrateConfig[enableDynamicBaudrate, minimumDynamicBaudrate] → Null
Parameter:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

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.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.3.5 (Firmware).

BrickIMU@GetSPITFPBaudrateConfig[out enableDynamicBaudrate, out minimumDynamicBaudrate] → Null
Parameter:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig[].

Neu in Version 2.3.5 (Firmware).

BrickIMU@GetSendTimeoutCount[communicationMethod] → timeoutCount
Parameter:
  • communicationMethod -- Integer
Rückgabe:
  • timeoutCount -- Integer

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:

  • BrickIMU`COMMUNICATIONUMETHODUNONE = 0
  • BrickIMU`COMMUNICATIONUMETHODUUSB = 1
  • BrickIMU`COMMUNICATIONUMETHODUSPIUSTACK = 2
  • BrickIMU`COMMUNICATIONUMETHODUCHIBI = 3
  • BrickIMU`COMMUNICATIONUMETHODURS485 = 4
  • BrickIMU`COMMUNICATIONUMETHODUWIFI = 5
  • BrickIMU`COMMUNICATIONUMETHODUETHERNET = 6
  • BrickIMU`COMMUNICATIONUMETHODUWIFIUV2 = 7

Neu in Version 2.3.3 (Firmware).

BrickIMU@SetSPITFPBaudrate[brickletPort, baudrate] → Null
Parameter:
  • brickletPort -- Integer
  • baudrate -- Integer

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

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.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.3.3 (Firmware).

BrickIMU@GetSPITFPBaudrate[brickletPort] → baudrate
Parameter:
  • brickletPort -- Integer
Rückgabe:
  • baudrate -- Integer

Gibt die Baudrate für einen Bricklet Port zurück, siehe SetSPITFPBaudrate[].

Neu in Version 2.3.3 (Firmware).

BrickIMU@GetSPITFPErrorCount[brickletPort, out errorCountACKChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameter:
  • brickletPort -- Integer
  • errorCountACKChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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

BrickIMU@EnableStatusLED[] → Null

Aktiviert die Status LED.

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

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickIMU@DisableStatusLED[] → Null

Deaktiviert die Status LED.

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

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickIMU@IsStatusLEDEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

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

Neu in Version 2.3.1 (Firmware).

BrickIMU@GetProtocol1BrickletName[port, out protocolVersion, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out name] → Null
Parameter:
  • port -- Integer
  • protocolVersion -- Integer
  • firmwareVersioni -- Integer
  • name -- String

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

BrickIMU@GetChipTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

Gibt die Temperatur in °C/10, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickIMU@Reset[] → Null

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

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

BrickIMU@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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 kann '0'-'8' (Stack Position) sein.

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

BrickIMU@SetAccelerationPeriod[period] → Null
Parameter:
  • period -- Integer

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

Der Standardwert ist 0.

BrickIMU@GetAccelerationPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetAccelerationPeriod[] gesetzt.

BrickIMU@SetMagneticFieldPeriod[period] → Null
Parameter:
  • period -- Integer

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

BrickIMU@GetMagneticFieldPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetMagneticFieldPeriod[] gesetzt.

BrickIMU@SetAngularVelocityPeriod[period] → Null
Parameter:
  • period -- Integer

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

BrickIMU@GetAngularVelocityPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetAngularVelocityPeriod[] gesetzt.

BrickIMU@SetAllDataPeriod[period] → Null
Parameter:
  • period -- Integer

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

BrickIMU@GetAllDataPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetAllDataPeriod[] gesetzt.

BrickIMU@SetOrientationPeriod[period] → Null
Parameter:
  • period -- Integer

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

BrickIMU@GetOrientationPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetOrientationPeriod[] gesetzt.

BrickIMU@SetQuaternionPeriod[period] → Null
Parameter:
  • period -- Integer

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

BrickIMU@GetQuaternionPeriod[] → period
Rückgabe:
  • period -- Integer

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 erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[imu@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten 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.

event BrickIMU@AccelerationCallback[sender, x, y, z]
Parameter:
  • sender -- NETObject[BrickIMU]
  • x -- Integer
  • y -- Integer
  • z -- Integer

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[sender, x, y, z]
Parameter:
  • sender -- NETObject[BrickIMU]
  • x -- Integer
  • y -- Integer
  • z -- Integer

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[sender, x, y, z]
Parameter:
  • sender -- NETObject[BrickIMU]
  • x -- Integer
  • y -- Integer
  • z -- Integer

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[sender, accX, accY, accZ, magX, magY, magZ, angX, angY, angZ, temperature]
Parameter:
  • sender -- NETObject[BrickIMU]
  • accX -- Integer
  • accY -- Integer
  • accZ -- Integer
  • magX -- Integer
  • magY -- Integer
  • magZ -- Integer
  • angX -- Integer
  • angY -- Integer
  • angZ -- Integer
  • temperature -- Integer

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[sender, roll, pitch, yaw]
Parameter:
  • sender -- NETObject[BrickIMU]
  • roll -- Integer
  • pitch -- Integer
  • yaw -- Integer

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[sender, x, y, z, w]
Parameter:
  • sender -- NETObject[BrickIMU]
  • x -- Real
  • y -- Real
  • z -- Real
  • w -- Real

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.

Konstanten

BrickIMU`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um einen IMU Brick zu identifizieren.

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

BrickIMU`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines IMU Brick dar.