Spezifikationen / Modbus Protokoll / API / Bricklets / IMU Bricklet 3.0

Modbus - IMU Bricklet 3.0¶

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

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletIMUV3.get_orientation¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760] roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren. Wir empfehlen daher stattdessen Quaternionen zu verwenden, wenn die absolute Lage im Raum bestimmt werden soll.

Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ORIENTATION Callback zu nutzen und die Periode mit set_orientation_callback_configuration vorzugeben.

BrickletIMUV3.get_linear_acceleration¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit set_sensor_configuration konfiguriert wurde.

Die lineare Beschleunigung ist die Beschleunigung in jede der drei Achsen. Der Einfluss von Erdbeschleunigung ist entfernt.

Es ist auch möglich einen Vektor der Erdbeschleunigung zu bekommen, siehe get_gravity_vector

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den CALLBACK_LINEAR_ACCELERATION Callback zu nutzen und die Periode mit set_linear_acceleration_callback_configuration vorzugeben.

BrickletIMUV3.get_gravity_vector¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] y – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] z – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse zurück.

Die Erdbeschleunigung ist die Beschleunigung die auf Grund von Schwerkraft entsteht. Einflüsse von linearen Beschleunigungen sind entfernt.

Es ist auch möglich die lineare Beschleunigung zu bekommen, siehe get_linear_acceleration

Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen den CALLBACK_GRAVITY_VECTOR Callback zu nutzen und die Periode mit set_gravity_vector_callback_configuration vorzugeben.

BrickletIMUV3.get_quaternion¶

Funktions-ID:	8
Anfrage:	keine Nutzdaten
Antwort:	w – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] x – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] y – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] z – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]

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

Die Rückgabewerte müssen mit 16383 (14 Bit) dividiert werden, um in den üblichen Wertebereich für Quaternionen (-1,0 bis +1,0) gebracht zu werden.

Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_QUATERNION Callback zu nutzen und die Periode mit set_quaternion_callback_configuration vorzugeben.

BrickletIMUV3.get_all_data¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	acceleration – Typ: int16[3] 0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? magnetic_field – Typ: int16[3] 0: x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] angular_velocity – Typ: int16[3] 0: x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? 1: y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? 2: z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? euler_angle – Typ: int16[3] 0: heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] quaternion – Typ: int16[4] 0: w – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 1: x – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 2: y – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 3: z – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] linear_acceleration – Typ: int16[3] 0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? gravity_vector – Typ: int16[3] 0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127] calibration_status – Typ: uint8, Wertebereich: [0 bis 255]

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

Beschleunigung (see get_acceleration)
Magnetfeld (see get_magnetic_field)
Winkelgeschwindigkeit (see get_angular_velocity)
Eulerwinkel (see get_orientation)
Quaternion (see get_quaternion)
Lineare Beschleunigung (see get_linear_acceleration)
Erdbeschleunigungsvektor (see get_gravity_vector)
Temperatur (see get_temperature)
Kalibrierungsstatus (siehe unten)

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

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

Ein Wert von 0 bedeutet "nicht kalibriert" und ein Wert von 3 bedeutet "vollständig kalibriert". Normalerweise kann der Kalibrierungsstatus vollständig ignoriert werden. Er wird vom Brick Viewer im Kalibrierungsfenster benutzt und nur für die initiale Kalibrierung benötigt. Mehr Information zur Kalibrierung des IMU Bricks gibt es im Kalibrierungsfenster.

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

Fortgeschrittene Funktionen¶

BrickletIMUV3.get_acceleration¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit set_sensor_configuration konfiguriert wurde.

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit set_acceleration_callback_configuration vorzugeben.

BrickletIMUV3.get_magnetic_field¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

Gibt das kalibrierte Magnetfeld des Magnetometers für die X-, Y- und Z-Komponenten zurück.

Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen den CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit set_magnetic_field_callback_configuration vorzugeben.

BrickletIMUV3.get_angular_velocity¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit set_sensor_configuration konfiguriert wurde.

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ANGULAR_VELOCITY Callback zu nutzen und die Periode mit set_angular_velocity_callback_configuration vorzugeben.

BrickletIMUV3.get_temperature¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]

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

BrickletIMUV3.save_calibration¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	calibration_done – Typ: bool

Ein Aufruf dieser Funktion speichert die aktuelle Kalibrierung damit sie beim nächsten Neustart des IMU Brick als Startpunkt für die kontinuierliche Kalibrierung genutzt werden kann.

Ein Rückgabewert von true bedeutet das die Kalibrierung genutzt werden konnte und false bedeutet das die Kalibrierung nicht genutzt werden konnte (dies passiert wenn der Kalibrierungsstatus nicht "fully calibrated" ist).

Diese Funktion wird vom Kalibrierungsfenster des Brick Viewer benutzt. Sie sollte in einem normalen Benutzerprogramm nicht aufgerufen werden müssen.

BrickletIMUV3.set_sensor_configuration¶

Funktions-ID:	11
Anfrage:	magnetometer_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 5 gyroscope_range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 gyroscope_bandwidth – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 7 accelerometer_range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 accelerometer_bandwidth – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

Setzt die verfügbaren Sensor-Konfigurationen für Magnetometer, Gyroskop und Beschleunigungssensor. Der Beschleunigungssensor-Wertebereich ist in allen Fusion-Modi wählbar, während alle anderen Konfigurationen im Fusion-Modus automatisch kontrolliert werden.

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

Für magnetometer_rate:

0 = 2Hz
1 = 6Hz
2 = 8Hz
3 = 10Hz
4 = 15Hz
5 = 20Hz
6 = 25Hz
7 = 30Hz

Für gyroscope_range:

0 = 2000DPS
1 = 1000DPS
2 = 500DPS
3 = 250DPS
4 = 125DPS

Für gyroscope_bandwidth:

0 = 523Hz
1 = 230Hz
2 = 116Hz
3 = 47Hz
4 = 23Hz
5 = 12Hz
6 = 64Hz
7 = 32Hz

Für accelerometer_range:

0 = 2G
1 = 4G
2 = 8G
3 = 16G

Für accelerometer_bandwidth:

0 = 7,81Hz
1 = 15,63Hz
2 = 31,25Hz
3 = 62,5Hz
4 = 125Hz
5 = 250Hz
6 = 500Hz
7 = 1000Hz

BrickletIMUV3.get_sensor_configuration¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	magnetometer_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 5 gyroscope_range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 gyroscope_bandwidth – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 7 accelerometer_range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 accelerometer_bandwidth – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Sensor-Konfiguration zurück, wie von set_sensor_configuration gesetzt.

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

Für magnetometer_rate:

0 = 2Hz
1 = 6Hz
2 = 8Hz
3 = 10Hz
4 = 15Hz
5 = 20Hz
6 = 25Hz
7 = 30Hz

Für gyroscope_range:

0 = 2000DPS
1 = 1000DPS
2 = 500DPS
3 = 250DPS
4 = 125DPS

Für gyroscope_bandwidth:

0 = 523Hz
1 = 230Hz
2 = 116Hz
3 = 47Hz
4 = 23Hz
5 = 12Hz
6 = 64Hz
7 = 32Hz

Für accelerometer_range:

0 = 2G
1 = 4G
2 = 8G
3 = 16G

Für accelerometer_bandwidth:

0 = 7,81Hz
1 = 15,63Hz
2 = 31,25Hz
3 = 62,5Hz
4 = 125Hz
5 = 250Hz
6 = 500Hz
7 = 1000Hz

BrickletIMUV3.set_sensor_fusion_mode¶

Funktions-ID:	13
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1
Antwort:	keine Antwort

Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen get_acceleration, get_magnetic_field und get_angular_velocity unkalibrierte und umkompensierte Sensorwerte zurück. Alle anderen Sensordaten-Getter geben keine Daten zurück.

Seit Firmware Version 2.0.6 kann auch ein Fusion-Modus ohne Magnetometer ausgewählt werden. In diesem Modus wird die Orientierung relativ berechnet (mit Magnetometer ist sie absolut in Bezug auf die Erde). Allerdings kann die Berechnung in diesem Fall nicht von störenden Magnetfeldern beeinflusst werden.

Seit Firmware Version 2.0.13 kann auch ein Fusion-Modus ohne schnelle Magnetometer-Kalibrierung ausgewählt werden. Dieser Modus ist der gleiche wie der "normale" Fusion-Modus, aber die schnelle Magnetometer-Kalibrierung ist aus. D.h. die Orientierung zu finden mag beim ersten start länger dauern, allerdings mag es sein das kleine magnetische einflüsse die automatische Kalibrierung nicht so stark stören.

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

Für mode:

0 = Off
1 = On
2 = On Without Magnetometer
3 = On Without Fast Magnetometer Calibration

BrickletIMUV3.get_sensor_fusion_mode¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1

Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von set_sensor_fusion_mode gesetzt.

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

Für mode:

0 = Off
1 = On
2 = On Without Magnetometer
3 = On Without Fast Magnetometer Calibration

BrickletIMUV3.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletIMUV3.set_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletIMUV3.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletIMUV3.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °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 hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletIMUV3.reset¶

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

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletIMUV3.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] 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 das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden.

Konfigurationsfunktionen für Callbacks¶

BrickletIMUV3.set_acceleration_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_acceleration_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_acceleration_callback_configuration gesetzt.

BrickletIMUV3.set_magnetic_field_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_MAGNETIC_FIELD Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_magnetic_field_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_magnetic_field_callback_configuration gesetzt.

BrickletIMUV3.set_angular_velocity_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_ANGULAR_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_angular_velocity_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_angular_velocity_callback_configuration gesetzt.

BrickletIMUV3.set_temperature_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_temperature_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_temperature_callback_configuration gesetzt.

BrickletIMUV3.set_orientation_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_ORIENTATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_orientation_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_orientation_callback_configuration gesetzt.

BrickletIMUV3.set_linear_acceleration_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_LINEAR_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_linear_acceleration_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_linear_acceleration_callback_configuration gesetzt.

BrickletIMUV3.set_gravity_vector_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_GRAVITY_VECTOR Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_gravity_vector_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_gravity_vector_callback_configuration gesetzt.

BrickletIMUV3.set_quaternion_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_QUATERNION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_quaternion_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_quaternion_callback_configuration gesetzt.

BrickletIMUV3.set_all_data_callback_configuration¶

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

Die Periode ist die Periode mit der der CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3.get_all_data_callback_configuration¶

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

Gibt die Callback-Konfiguration zurück, wie mittels set_all_data_callback_configuration gesetzt.

Callbacks¶

BrickletIMUV3.CALLBACK_ACCELERATION¶

Funktions-ID:	33
Antwort:	x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

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

BrickletIMUV3.CALLBACK_MAGNETIC_FIELD¶

Funktions-ID:	34
Antwort:	x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

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

BrickletIMUV3.CALLBACK_ANGULAR_VELOCITY¶

Funktions-ID:	35
Antwort:	x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?

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

BrickletIMUV3.CALLBACK_TEMPERATURE¶

Funktions-ID:	36
Antwort:	temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Dieser Callback wird mit der Periode, wie gesetzt mit set_temperature_callback_configuration, ausgelöst. Der Rückgabewert ist die Temperatur.

BrickletIMUV3.CALLBACK_LINEAR_ACCELERATION¶

Funktions-ID:	37
Antwort:	x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

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

BrickletIMUV3.CALLBACK_GRAVITY_VECTOR¶

Funktions-ID:	38
Antwort:	x – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] y – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] z – Typ: int16, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]

Dieser Callback wird mit der Periode, wie gesetzt mit set_gravity_vector_callback_configuration, ausgelöst. Die Rückgabewert sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.

BrickletIMUV3.CALLBACK_ORIENTATION¶

Funktions-ID:	39
Antwort:	heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760] roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

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

BrickletIMUV3.CALLBACK_QUATERNION¶

Funktions-ID:	40
Antwort:	w – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] x – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] y – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] z – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]

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

BrickletIMUV3.CALLBACK_ALL_DATA¶

Funktions-ID:

Funktions-ID:	41
Antwort:	acceleration – Typ: int16[3] 0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? magnetic_field – Typ: int16[3] 0: x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] angular_velocity – Typ: int16[3] 0: x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? 1: y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? 2: z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ? euler_angle – Typ: int16[3] 0: heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] quaternion – Typ: int16[4] 0: w – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 1: x – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 2: y – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 3: z – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] linear_acceleration – Typ: int16[3] 0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? gravity_vector – Typ: int16[3] 0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ? temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127] calibration_status – Typ: uint8, Wertebereich: [0 bis 255]

Antwort:

acceleration – Typ: int16[3]

0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?
1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?
2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

magnetic_field – Typ: int16[3]

0: x – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
1: y – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
2: z – Typ: int16, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

angular_velocity – Typ: int16[3]

0: x – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
1: y – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?
2: z – Typ: int16, Einheit: 1/16 °/s, Wertebereich: ?

euler_angle – Typ: int16[3]

0: heading – Typ: int16, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
1: roll – Typ: int16, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
2: pitch – Typ: int16, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

quaternion – Typ: int16[4]

0: w – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
1: x – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
2: y – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
3: z – Typ: int16, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]

linear_acceleration – Typ: int16[3]

0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?
1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?
2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

gravity_vector – Typ: int16[3]

0: x – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?
1: y – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?
2: z – Typ: int16, Einheit: 1 cm/s², Wertebereich: ?

temperature – Typ: int8, Einheit: 1 °C, Wertebereich: [-128 bis 127]
calibration_status – Typ: uint8, Wertebereich: [0 bis 255]

Dieser Callback wird mit der Periode, wie gesetzt mit set_all_data_callback_configuration, ausgelöst. Die Rückgabewert sind die gleichen wie bei get_all_data.

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.

BrickletIMUV3.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

Für status:

0 = OK
1 = Invalid Mode
2 = No Change
3 = Entry Function Not Present
4 = Device Identifier Incorrect
5 = CRC Mismatch

BrickletIMUV3.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

BrickletIMUV3.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIMUV3.write_firmware¶

Funktions-ID:	238
Anfrage:	data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIMUV3.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletIMUV3.read_uid¶

Funktions-ID:	249
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.