Spezifikationen / Modbus Protokoll / API / Bricks / IMU Brick 2.0

Modbus - IMU Brick 2.0¶

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

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.leds_on¶

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

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

BrickIMUV2.leds_off¶

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

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

BrickIMUV2.are_leds_on¶

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

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

Fortgeschrittene Funktionen¶

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.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_period vorzugeben.

BrickIMUV2.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_period vorzugeben.

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

BrickIMUV2.save_calibration¶

Funktions-ID:	13
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.

BrickIMUV2.set_sensor_configuration¶

Funktions-ID:	41
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.

Neu in Version 2.0.5 (Firmware).

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

BrickIMUV2.get_sensor_configuration¶

Funktions-ID:	42
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.

Neu in Version 2.0.5 (Firmware).

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

BrickIMUV2.set_sensor_fusion_mode¶

Funktions-ID:	43
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.

Neu in Version 2.0.5 (Firmware).

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

BrickIMUV2.get_sensor_fusion_mode¶

Funktions-ID:	44
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.

Neu in Version 2.0.5 (Firmware).

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

BrickIMUV2.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.0.10 (Firmware).

BrickIMUV2.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.0.10 (Firmware).

BrickIMUV2.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.0.7 (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

BrickIMUV2.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.0.5 (Firmware).

BrickIMUV2.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.0.5 (Firmware).

BrickIMUV2.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.0.5 (Firmware).

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

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

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

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

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

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

BrickIMUV2.set_acceleration_period¶

Funktions-ID:	14
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.

BrickIMUV2.get_acceleration_period¶

Funktions-ID:	15
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.

BrickIMUV2.set_magnetic_field_period¶

Funktions-ID:	16
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.

BrickIMUV2.get_magnetic_field_period¶

Funktions-ID:	17
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.

BrickIMUV2.set_angular_velocity_period¶

Funktions-ID:	18
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.

BrickIMUV2.get_angular_velocity_period¶

Funktions-ID:	19
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.

BrickIMUV2.set_temperature_period¶

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

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

BrickIMUV2.get_temperature_period¶

Funktions-ID:	21
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_temperature_period gesetzt.

BrickIMUV2.set_orientation_period¶

Funktions-ID:	22
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.

BrickIMUV2.get_orientation_period¶

Funktions-ID:	23
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.

BrickIMUV2.set_linear_acceleration_period¶

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

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

BrickIMUV2.get_linear_acceleration_period¶

Funktions-ID:	25
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_linear_acceleration_period gesetzt.

BrickIMUV2.set_gravity_vector_period¶

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

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

BrickIMUV2.get_gravity_vector_period¶

Funktions-ID:	27
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_gravity_vector_period gesetzt.

BrickIMUV2.set_quaternion_period¶

Funktions-ID:	28
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.

BrickIMUV2.get_quaternion_period¶

Funktions-ID:	29
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.

BrickIMUV2.set_all_data_period¶

Funktions-ID:	30
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.

BrickIMUV2.get_all_data_period¶

Funktions-ID:	31
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.

Callbacks¶

BrickIMUV2.CALLBACK_ACCELERATION¶

Funktions-ID:	32
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_period, ausgelöst. Die Rückgabewerte sind die Beschleunigungen der X, Y und Z-Achse.

BrickIMUV2.CALLBACK_MAGNETIC_FIELD¶

Funktions-ID:	33
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_period, ausgelöst. Die Rückgabewerte sind die Magnetfeldkomponenten der X, Y und Z-Achse.

BrickIMUV2.CALLBACK_ANGULAR_VELOCITY¶

Funktions-ID:	34
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_period, ausgelöst. Die Rückgabewerte sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

BrickIMUV2.CALLBACK_TEMPERATURE¶

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

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

BrickIMUV2.CALLBACK_LINEAR_ACCELERATION¶

Funktions-ID:	36
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_period, ausgelöst. Die Rückgabewert sind die linearen Beschleunigungen der X, Y und Z-Achse.

BrickIMUV2.CALLBACK_GRAVITY_VECTOR¶

Funktions-ID:	37
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_period, ausgelöst. Die Rückgabewert sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.

BrickIMUV2.CALLBACK_ORIENTATION¶

Funktions-ID:	38
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_period, ausgelöst. Die Rückgabewerte sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe get_orientation für Details.

BrickIMUV2.CALLBACK_QUATERNION¶

Funktions-ID:	39
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_period, ausgelöst. Die Rückgabewerte sind die Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe get_quaternion für Details.

BrickIMUV2.CALLBACK_ALL_DATA¶

Funktions-ID:

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_period, 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.

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

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

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