Spezifikationen / Modbus Protokoll / API / Bricks (Abgekündigt) / IMU Brick

Modbus - IMU Brick¶

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

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickIMU.get_orientation¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	roll – Typ: int16, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] pitch – Typ: int16, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] yaw – Typ: int16, 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 CALLBACK_ORIENTATION Callback zu nutzen und die Periode mit set_orientation_period vorzugeben.

BrickIMU.get_quaternion¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: float, Wertebereich: [-1.0 bis 1.0] y – Typ: float, Wertebereich: [-1.0 bis 1.0] z – Typ: float, Wertebereich: [-1.0 bis 1.0] w – Typ: float, Wertebereich: [-1.0 bis 1.0]

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 CALLBACK_QUATERNION Callback zu nutzen und die Periode mit set_quaternion_period vorzugeben.

BrickIMU.leds_on¶

Funktions-ID:	8
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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

BrickIMU.leds_off¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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

BrickIMU.are_leds_on¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	leds – Typ: bool, Standardwert: true

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

BrickIMU.set_convergence_speed¶

Funktions-ID:	15
Anfrage:	speed – Typ: uint16, Einheit: 1 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 30
Antwort:	keine Antwort

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.

BrickIMU.get_convergence_speed¶

Funktions-ID:	16
Anfrage:	keine Nutzdaten
Antwort:	speed – Typ: uint16, Einheit: 1 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 30

Gibt die Konvergenzgeschwindigkeit zurück, wie von set_convergence_speed gesetzt.

Fortgeschrittene Funktionen¶

BrickIMU.get_acceleration¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit set_acceleration_period vorzugeben.

BrickIMU.get_magnetic_field¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] y – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] z – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit set_magnetic_field_period vorzugeben.

BrickIMU.get_angular_velocity¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] y – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] z – Typ: int16, 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 CALLBACK_ANGULAR_VELOCITY Callback zu nutzen und die Periode mit set_angular_velocity_period vorzugeben.

BrickIMU.get_all_data¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	acc_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] acc_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] acc_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] mag_x – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] mag_y – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] mag_z – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ang_x – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ang_y – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ang_z – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Daten von get_acceleration, get_magnetic_field und get_angular_velocity sowie die Temperatur des IMU Brick zurück.

Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ALL_DATA Callback zu nutzen und die Periode mit set_all_data_period vorzugeben.

BrickIMU.get_imu_temperature¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur des IMU Brick zurück.

BrickIMU.set_acceleration_range¶

Funktions-ID:	11
Anfrage:	range – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

Bisher nicht implementiert.

BrickIMU.get_acceleration_range¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	range – Typ: uint8, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

BrickIMU.set_magnetometer_range¶

Funktions-ID:	13
Anfrage:	range – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

Bisher nicht implementiert.

BrickIMU.get_magnetometer_range¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	range – Typ: uint8, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

BrickIMU.set_calibration¶

Funktions-ID:	17
Anfrage:	typ – Typ: uint8, Wertebereich: Siehe Bedeutungen data – Typ: int16[10], Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für typ:

0 = Accelerometer Gain
1 = Accelerometer Bias
2 = Magnetometer Gain
3 = Magnetometer Bias
4 = Gyroscope Gain
5 = Gyroscope Bias

BrickIMU.get_calibration¶

Funktions-ID:	18
Anfrage:	typ – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	data – Typ: int16[10], Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für typ:

0 = Accelerometer Gain
1 = Accelerometer Bias
2 = Magnetometer Gain
3 = Magnetometer Bias
4 = Gyroscope Gain
5 = Gyroscope Bias

BrickIMU.orientation_calculation_on¶

Funktions-ID:	37
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert die Orientierungsberechnungen des IMU Brick.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

BrickIMU.orientation_calculation_off¶

Funktions-ID:	38
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert die Orientierungsberechnungen des IMU Brick.

Wenn die Berechnungen deaktiviert sind, gibt get_orientation 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.is_orientation_calculation_on¶

Funktions-ID:	39
Anfrage:	keine Nutzdaten
Antwort:	orientation_calculation_on – Typ: bool, Standardwert: true

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

Neu in Version 2.0.2 (Firmware).

BrickIMU.set_spitfp_baudrate_config¶

Funktions-ID:	231
Anfrage:	enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Antwort:	keine Antwort

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 set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.3.5 (Firmware).

BrickIMU.get_spitfp_baudrate_config¶

Funktions-ID:	232
Anfrage:	keine Nutzdaten
Antwort:	enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config.

Neu in Version 2.3.5 (Firmware).

BrickIMU.get_send_timeout_count¶

Funktions-ID:	233
Anfrage:	communication_method – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	timeout_count – Typ: uint32, Wertebereich: [0 bis 2³² - 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.

Neu in Version 2.3.3 (Firmware).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für communication_method:

0 = None
1 = USB
2 = SPI Stack
3 = Chibi
4 = RS485
5 = WIFI
6 = Ethernet
7 = WIFI V2

BrickIMU.set_spitfp_baudrate¶

Funktions-ID:	234
Anfrage:	bricklet_port – Typ: char, Wertebereich: ['a' bis 'b'] baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Antwort:	keine Antwort

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 get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe set_spitfp_baudrate_config).

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

BrickIMU.get_spitfp_baudrate¶

Funktions-ID:	235
Anfrage:	bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:	baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe set_spitfp_baudrate.

Neu in Version 2.3.3 (Firmware).

BrickIMU.get_spitfp_error_count¶

Funktions-ID:	237
Anfrage:	bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 2³² - 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).

BrickIMU.enable_status_led¶

Funktions-ID:	238
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.disable_status_led¶

Funktions-ID:	239
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.is_status_led_enabled¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

BrickIMU.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

BrickIMU.reset¶

Funktions-ID:	243
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['0' bis '8'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 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.

Konfigurationsfunktionen für Callbacks¶

BrickIMU.set_acceleration_period¶

Funktions-ID:	19
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

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

BrickIMU.get_acceleration_period¶

Funktions-ID:	20
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_acceleration_period gesetzt.

BrickIMU.set_magnetic_field_period¶

Funktions-ID:	21
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

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

BrickIMU.get_magnetic_field_period¶

Funktions-ID:	22
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_magnetic_field_period gesetzt.

BrickIMU.set_angular_velocity_period¶

Funktions-ID:	23
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

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

BrickIMU.get_angular_velocity_period¶

Funktions-ID:	24
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_angular_velocity_period gesetzt.

BrickIMU.set_all_data_period¶

Funktions-ID:	25
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

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

BrickIMU.get_all_data_period¶

Funktions-ID:	26
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_all_data_period gesetzt.

BrickIMU.set_orientation_period¶

Funktions-ID:	27
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

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

BrickIMU.get_orientation_period¶

Funktions-ID:	28
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_orientation_period gesetzt.

BrickIMU.set_quaternion_period¶

Funktions-ID:	29
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

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

BrickIMU.get_quaternion_period¶

Funktions-ID:	30
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_quaternion_period gesetzt.

Callbacks¶

BrickIMU.CALLBACK_ACCELERATION¶

Funktions-ID:	31
Antwort:	x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_acceleration_period, ausgelöst. Die Rückgabewerte sind die Beschleunigungen der X, Y und Z-Achse.

BrickIMU.CALLBACK_MAGNETIC_FIELD¶

Funktions-ID:	32
Antwort:	x – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] y – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] z – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_magnetic_field_period, ausgelöst. Die Rückgabewerte sind die Magnetfeldkomponenten der X, Y und Z-Achse.

BrickIMU.CALLBACK_ANGULAR_VELOCITY¶

Funktions-ID:	33
Antwort:	x – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] y – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] z – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]

Dieser Callback wird mit der Periode, wie gesetzt mit set_angular_velocity_period, ausgelöst. Die Rückgabewerte sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

BrickIMU.CALLBACK_ALL_DATA¶

Funktions-ID:

Funktions-ID:	34
Antwort:	acc_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] acc_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] acc_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] mag_x – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] mag_y – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] mag_z – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ang_x – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ang_y – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ang_z – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Antwort:

acc_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
acc_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
acc_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
mag_x – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
mag_y – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
mag_z – Typ: int16, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
ang_x – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
ang_y – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
ang_z – Typ: int16, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
temperature – Typ: int16, Einheit: 1/100 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_all_data_period, ausgelöst. Die Rückgabewerte sind die Beschleunigungen, Magnetfeldkomponenten und die Winkelgeschwindigkeiten der X, Y und Z-Achse sowie die Temperatur des IMU Brick.

BrickIMU.CALLBACK_ORIENTATION¶

Funktions-ID:	35
Antwort:	roll – Typ: int16, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] pitch – Typ: int16, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] yaw – Typ: int16, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000]

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

BrickIMU.CALLBACK_QUATERNION¶

Funktions-ID:	36
Antwort:	x – Typ: float, Wertebereich: [-1.0 bis 1.0] y – Typ: float, Wertebereich: [-1.0 bis 1.0] z – Typ: float, Wertebereich: [-1.0 bis 1.0] w – Typ: float, Wertebereich: [-1.0 bis 1.0]

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

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.

BrickIMU.get_protocol1_bricklet_name¶

Funktions-ID:	241
Anfrage:	port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:	protocol_version – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] name – Typ: char[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.

BrickIMU.write_bricklet_plugin¶

Funktions-ID:	246
Anfrage:	port – Typ: char, Wertebereich: ['a' bis 'b'] offset – Typ: uint8, Wertebereich: [0 bis 255] chunk – Typ: uint8[32], Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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.

BrickIMU.read_bricklet_plugin¶

Funktions-ID:	247
Anfrage:	port – Typ: char, Wertebereich: ['a' bis 'b'] offset – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	chunk – Typ: uint8[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.