Python - IMU Brick 2.0

Dies ist die Beschreibung der Python API Bindings 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.

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your IMU Brick 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_imu_v2 import BrickIMUV2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    imu = BrickIMUV2(UID, ipcon) # Create device object

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

    # Get current quaternion
    w, x, y, z = imu.get_quaternion()

    print("Quaternion [W]: " + str(w/16383.0))
    print("Quaternion [X]: " + str(x/16383.0))
    print("Quaternion [Y]: " + str(y/16383.0))
    print("Quaternion [Z]: " + str(z/16383.0))

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Callback

Download (example_callback.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your IMU Brick 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_imu_v2 import BrickIMUV2

# Callback function for quaternion callback
def cb_quaternion(w, x, y, z):
    print("Quaternion [W]: " + str(w/16383.0))
    print("Quaternion [X]: " + str(x/16383.0))
    print("Quaternion [Y]: " + str(y/16383.0))
    print("Quaternion [Z]: " + str(z/16383.0))
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    imu = BrickIMUV2(UID, ipcon) # Create device object

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

    # Register quaternion callback to function cb_quaternion
    imu.register_callback(imu.CALLBACK_QUATERNION, cb_quaternion)

    # Set period for quaternion callback to 0.1s (100ms)
    imu.set_quaternion_period(100)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

All Data

Download (example_all_data.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XXYYZZ" # Change XXYYZZ to the UID of your IMU Brick 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_imu_v2 import BrickIMUV2

# Callback function for all data callback
def cb_all_data(acceleration, magnetic_field, angular_velocity, euler_angle, quaternion,
                linear_acceleration, gravity_vector, temperature, calibration_status):
    print("Acceleration [X]: " + str(acceleration[0]/100.0) + " m/s²")
    print("Acceleration [Y]: " + str(acceleration[1]/100.0) + " m/s²")
    print("Acceleration [Z]: " + str(acceleration[2]/100.0) + " m/s²")
    print("Magnetic Field [X]: " + str(magnetic_field[0]/16.0) + " µT")
    print("Magnetic Field [Y]: " + str(magnetic_field[1]/16.0) + " µT")
    print("Magnetic Field [Z]: " + str(magnetic_field[2]/16.0) + " µT")
    print("Angular Velocity [X]: " + str(angular_velocity[0]/16.0) + " °/s")
    print("Angular Velocity [Y]: " + str(angular_velocity[1]/16.0) + " °/s")
    print("Angular Velocity [Z]: " + str(angular_velocity[2]/16.0) + " °/s")
    print("Euler Angle [X]: " + str(euler_angle[0]/16.0) + " °")
    print("Euler Angle [Y]: " + str(euler_angle[1]/16.0) + " °")
    print("Euler Angle [Z]: " + str(euler_angle[2]/16.0) + " °")
    print("Quaternion [W]: " + str(quaternion[0]/16383.0))
    print("Quaternion [X]: " + str(quaternion[1]/16383.0))
    print("Quaternion [Y]: " + str(quaternion[2]/16383.0))
    print("Quaternion [Z]: " + str(quaternion[3]/16383.0))
    print("Linear Acceleration [X]: " + str(linear_acceleration[0]/100.0) + " m/s²")
    print("Linear Acceleration [Y]: " + str(linear_acceleration[1]/100.0) + " m/s²")
    print("Linear Acceleration [Z]: " + str(linear_acceleration[2]/100.0) + " m/s²")
    print("Gravity Vector [X]: " + str(gravity_vector[0]/100.0) + " m/s²")
    print("Gravity Vector [Y]: " + str(gravity_vector[1]/100.0) + " m/s²")
    print("Gravity Vector [Z]: " + str(gravity_vector[2]/100.0) + " m/s²")
    print("Temperature: " + str(temperature) + " °C")
    print("Calibration Status: " + format(calibration_status, "08b"))
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    imu = BrickIMUV2(UID, ipcon) # Create device object

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

    # Register all data callback to function cb_all_data
    imu.register_callback(imu.CALLBACK_ALL_DATA, cb_all_data)

    # Set period for all data callback to 0.1s (100ms)
    imu.set_all_data_period(100)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

API

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

  • Error.TIMEOUT = -1
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickIMUV2(uid, ipcon)
Parameter:
  • uid -- string
  • ipcon -- IPConnection

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

imu_v2 = BrickIMUV2("YOUR_DEVICE_UID", ipcon)

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

BrickIMUV2.get_orientation()
Rückgabetyp:(int, int, int)

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln (in 1/16 °) 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.

Die Rotationswinkel haben den folgenden Wertebereich:

  • Gierwinkel: 0° bis 360°
  • Rollwinkel: -90° bis +90°
  • Nickwinkel: -180° bis +180°

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

Das zurückgegebene namedtuple enthält die Variablen heading, roll und pitch.

BrickIMUV2.get_linear_acceleration()
Rückgabetyp:(int, int, int)

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse in 1/100 m/s² zurück.

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.

Das zurückgegebene namedtuple enthält die Variablen x, y und z.

BrickIMUV2.get_gravity_vector()
Rückgabetyp:(int, int, int)

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse in 1/100 m/s² 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.

Das zurückgegebene namedtuple enthält die Variablen x, y und z.

BrickIMUV2.get_quaternion()
Rückgabetyp:(int, int, int, int)

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

Die zurückgegebenen Werte 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.

Das zurückgegebene namedtuple enthält die Variablen w, x, y und z.

BrickIMUV2.get_all_data()
Rückgabetyp:([int, int, int], [int, int, int], [int, int, int], [int, int, int], [int, int, int, int], [int, int, int], [int, int, int], int, int)

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

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.

Das zurückgegebene namedtuple enthält die Variablen acceleration, magnetic_field, angular_velocity, euler_angle, quaternion, linear_acceleration, gravity_vector, temperature und calibration_status.

BrickIMUV2.leds_on()
Rückgabetyp:None

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

BrickIMUV2.leds_off()
Rückgabetyp:None

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

BrickIMUV2.are_leds_on()
Rückgabetyp:bool

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

Fortgeschrittene Funktionen

BrickIMUV2.get_acceleration()
Rückgabetyp:(int, int, int)

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse in 1/100 m/s².

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

Das zurückgegebene namedtuple enthält die Variablen x, y und z.

BrickIMUV2.get_magnetic_field()
Rückgabetyp:(int, int, int)

Gibt das kalibrierte magnetische Feld des Magnetometers mit den X-, Y- und Z-Komponenten in 1/16 µT zurück (Microtesla).

Wenn das magnetische Feld periodisch abgefragt werden soll, wird empfohlen den CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit set_magnetic_field_period() vorzugeben.

Das zurückgegebene namedtuple enthält die Variablen x, y und z.

BrickIMUV2.get_angular_velocity()
Rückgabetyp:(int, int, int)

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in 1/16 °/s zurück.

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.

Das zurückgegebene namedtuple enthält die Variablen x, y und z.

BrickIMUV2.get_temperature()
Rückgabetyp:int

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

BrickIMUV2.save_calibration()
Rückgabetyp: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(magnetometer_rate, gyroscope_range, gyroscope_bandwidth, accelerometer_range, accelerometer_bandwidth)
Parameter:
  • magnetometer_rate -- int
  • gyroscope_range -- int
  • gyroscope_bandwidth -- int
  • accelerometer_range -- int
  • accelerometer_bandwidth -- int
Rückgabetyp:

None

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 Standardwerte sind:

  • Magnetometer-Rate 20Hz
  • Gyroskop-Wertebereich 2000°/s
  • Gyroskop-Bandweite 32Hz
  • Beschleunigungssensor-Wertebereich +/-4G
  • Beschleunigungssensor-Bandweite 62.5Hz

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

  • BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7
  • BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7
  • BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2.ACCELEROMETER_RANGE_16G = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

BrickIMUV2.get_sensor_configuration()
Rückgabetyp:(int, int, int, int, int)

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

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

  • BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7
  • BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7
  • BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2.ACCELEROMETER_RANGE_16G = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

Neu in Version 2.0.5 (Firmware).

Das zurückgegebene namedtuple enthält die Variablen magnetometer_rate, gyroscope_range, gyroscope_bandwidth, accelerometer_range und accelerometer_bandwidth.

BrickIMUV2.set_sensor_fusion_mode(mode)
Parameter:mode -- int
Rückgabetyp:None

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.

Standardmäßig ist der Fusion-Modus aktiviert.

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

  • BrickIMUV2.SENSOR_FUSION_OFF = 0
  • BrickIMUV2.SENSOR_FUSION_ON = 1
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

BrickIMUV2.get_sensor_fusion_mode()
Rückgabetyp:int

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

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

  • BrickIMUV2.SENSOR_FUSION_OFF = 0
  • BrickIMUV2.SENSOR_FUSION_ON = 1
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

Neu in Version 2.0.5 (Firmware).

BrickIMUV2.get_api_version()
Rückgabetyp:[int, int, int]

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

BrickIMUV2.get_response_expected(function_id)
Parameter:function_id -- int
Rückgabetyp:bool

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

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

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

Siehe set_response_expected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickIMUV2.set_response_expected(function_id, response_expected)
Parameter:
  • function_id -- int
  • response_expected -- bool
Rückgabetyp:

None

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

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

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

  • BrickIMUV2.FUNCTION_LEDS_ON = 10
  • BrickIMUV2.FUNCTION_LEDS_OFF = 11
  • BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
  • BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
  • BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
  • BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
  • BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickIMUV2.FUNCTION_RESET = 243
BrickIMUV2.set_response_expected_all(response_expected)
Parameter:response_expected -- bool
Rückgabetyp:None

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

BrickIMUV2.set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate)
Parameter:
  • enable_dynamic_baudrate -- bool
  • minimum_dynamic_baudrate -- int
Rückgabetyp:

None

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.

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

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

Neu in Version 2.0.10 (Firmware).

BrickIMUV2.get_spitfp_baudrate_config()
Rückgabetyp:(bool, int)

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config().

Neu in Version 2.0.10 (Firmware).

Das zurückgegebene namedtuple enthält die Variablen enable_dynamic_baudrate und minimum_dynamic_baudrate.

BrickIMUV2.get_send_timeout_count(communication_method)
Parameter:communication_method -- int
Rückgabetyp:int

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

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

Neu in Version 2.0.7 (Firmware).

BrickIMUV2.set_spitfp_baudrate(bricklet_port, baudrate)
Parameter:
  • bricklet_port -- chr
  • baudrate -- int
Rückgabetyp:

None

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

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe 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.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.0.5 (Firmware).

BrickIMUV2.get_spitfp_baudrate(bricklet_port)
Parameter:bricklet_port -- chr
Rückgabetyp:int

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(bricklet_port)
Parameter:bricklet_port -- chr
Rückgabetyp:(int, int, int, int)

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

Das zurückgegebene namedtuple enthält die Variablen error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickIMUV2.enable_status_led()
Rückgabetyp:None

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()
Rückgabetyp:None

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()
Rückgabetyp:bool

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

BrickIMUV2.get_protocol1_bricklet_name(port)
Parameter:port -- chr
Rückgabetyp:(int, [int, int, int], str)

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.

Das zurückgegebene namedtuple enthält die Variablen protocol_version, firmware_version und name.

BrickIMUV2.get_chip_temperature()
Rückgabetyp:int

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

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

BrickIMUV2.reset()
Rückgabetyp:None

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()
Rückgabetyp:(str, str, chr, [int, int, int], [int, int, int], int)

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann '0'-'8' (Stack Position) sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Das zurückgegebene namedtuple enthält die Variablen uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickIMUV2.register_callback(callback_id, function)
Parameter:
  • callback_id -- int
  • function -- callable
Rückgabetyp:

None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickIMUV2.set_acceleration_period(period)
Parameter:period -- int
Rückgabetyp:None

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

Der Standardwert ist 0.

BrickIMUV2.get_acceleration_period()
Rückgabetyp:int

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

BrickIMUV2.set_magnetic_field_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_magnetic_field_period()
Rückgabetyp:int

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

BrickIMUV2.set_angular_velocity_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_angular_velocity_period()
Rückgabetyp:int

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

BrickIMUV2.set_temperature_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_temperature_period()
Rückgabetyp:int

Gibt die Periode zurück, wie von set_temperature_period() gesetzt.

BrickIMUV2.set_orientation_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_orientation_period()
Rückgabetyp:int

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

BrickIMUV2.set_linear_acceleration_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_linear_acceleration_period()
Rückgabetyp:int

Gibt die Periode zurück, wie von set_linear_acceleration_period() gesetzt.

BrickIMUV2.set_gravity_vector_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_gravity_vector_period()
Rückgabetyp:int

Gibt die Periode zurück, wie von set_gravity_vector_period() gesetzt.

BrickIMUV2.set_quaternion_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_quaternion_period()
Rückgabetyp:int

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

BrickIMUV2.set_all_data_period(period)
Parameter:period -- int
Rückgabetyp:None

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

BrickIMUV2.get_all_data_period()
Rückgabetyp:int

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

imu_v2.register_callback(BrickIMUV2.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickIMUV2.CALLBACK_ACCELERATION
Parameter:
  • x -- int
  • y -- int
  • z -- int

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

BrickIMUV2.CALLBACK_MAGNETIC_FIELD
Parameter:
  • x -- int
  • y -- int
  • z -- int

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

BrickIMUV2.CALLBACK_ANGULAR_VELOCITY
Parameter:
  • x -- int
  • y -- int
  • z -- int

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

BrickIMUV2.CALLBACK_TEMPERATURE
Parameter:temperature -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set_temperature_period(), ausgelöst. Der Parameter ist die Temperatur.

BrickIMUV2.CALLBACK_LINEAR_ACCELERATION
Parameter:
  • x -- int
  • y -- int
  • z -- int

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

BrickIMUV2.CALLBACK_GRAVITY_VECTOR
Parameter:
  • x -- int
  • y -- int
  • z -- int

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

BrickIMUV2.CALLBACK_ORIENTATION
Parameter:
  • heading -- int
  • roll -- int
  • pitch -- int

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

BrickIMUV2.CALLBACK_QUATERNION
Parameter:
  • w -- int
  • x -- int
  • y -- int
  • z -- int

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

BrickIMUV2.CALLBACK_ALL_DATA
Parameter:
  • acceleration -- [int, int, int]
  • magnetic_field -- [int, int, int]
  • angular_velocity -- [int, int, int]
  • euler_angle -- [int, int, int]
  • quaternion -- [int, int, int, int]
  • linear_acceleration -- [int, int, int]
  • gravity_vector -- [int, int, int]
  • temperature -- int
  • calibration_status -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set_all_data_period(), ausgelöst. Die Parameter sind die gleichen wie bei get_all_data().

Konstanten

BrickIMUV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen IMU Brick 2.0 zu identifizieren.

Die get_identity() Funktion und der CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickIMUV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.