Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / IMU Bricklet 3.0

C/C++ für Mikrocontroller - IMU Bricklet 3.0¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings 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.

Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_imu_v3.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_IMUV3 imu;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_imu_v3_create(&imu, NULL, hal), "create device object");

    // Get current quaternion
    int16_t w, x, y, z;
    check(tf_imu_v3_get_quaternion(&imu, &w, &x, &y, &z), "get quaternion");

    tf_hal_printf("Quaternion [W]: %d 1/%d\n", w, 16383);
    tf_hal_printf("Quaternion [X]: %d 1/%d\n", x, 16383);
    tf_hal_printf("Quaternion [Y]: %d 1/%d\n", y, 16383);
    tf_hal_printf("Quaternion [Z]: %d 1/%d\n", z, 16383);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_imu_v3.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

// Callback function for quaternion callback
static void quaternion_handler(TF_IMUV3 *device, int16_t w, int16_t x, int16_t y,
                               int16_t z, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Quaternion [W]: %d 1/%d\n", w, 16383);
    tf_hal_printf("Quaternion [X]: %d 1/%d\n", x, 16383);
    tf_hal_printf("Quaternion [Y]: %d 1/%d\n", y, 16383);
    tf_hal_printf("Quaternion [Z]: %d 1/%d\n", z, 16383);
    tf_hal_printf("\n");
}

static TF_IMUV3 imu;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_imu_v3_create(&imu, NULL, hal), "create device object");

    // Register quaternion callback to function quaternion_handler
    tf_imu_v3_register_quaternion_callback(&imu,
                                           quaternion_handler,
                                           NULL);

    // Set period for quaternion callback to 0.1s (100ms)
    tf_imu_v3_set_quaternion_callback_configuration(&imu, 100, false);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

All Data¶

Download (example_all_data.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_imu_v3.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

// Callback function for all data callback
static void all_data_handler(TF_IMUV3 *device, int16_t acceleration[3],
                             int16_t magnetic_field[3], int16_t angular_velocity[3],
                             int16_t euler_angle[3], int16_t quaternion[4],
                             int16_t linear_acceleration[3], int16_t gravity_vector[3],
                             int8_t temperature, uint8_t calibration_status,
                             void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Acceleration [X]: %d 1/%d m/s²\n", acceleration[0], 100);
    tf_hal_printf("Acceleration [Y]: %d 1/%d m/s²\n", acceleration[1], 100);
    tf_hal_printf("Acceleration [Z]: %d 1/%d m/s²\n", acceleration[2], 100);
    tf_hal_printf("Magnetic Field [X]: %d 1/%d µT\n", magnetic_field[0], 16);
    tf_hal_printf("Magnetic Field [Y]: %d 1/%d µT\n", magnetic_field[1], 16);
    tf_hal_printf("Magnetic Field [Z]: %d 1/%d µT\n", magnetic_field[2], 16);
    tf_hal_printf("Angular Velocity [X]: %d 1/%d °/s\n", angular_velocity[0], 16);
    tf_hal_printf("Angular Velocity [Y]: %d 1/%d °/s\n", angular_velocity[1], 16);
    tf_hal_printf("Angular Velocity [Z]: %d 1/%d °/s\n", angular_velocity[2], 16);
    tf_hal_printf("Euler Angle [Heading]: %d 1/%d °\n", euler_angle[0], 16);
    tf_hal_printf("Euler Angle [Roll]: %d 1/%d °\n", euler_angle[1], 16);
    tf_hal_printf("Euler Angle [Pitch]: %d 1/%d °\n", euler_angle[2], 16);
    tf_hal_printf("Quaternion [W]: %d 1/%d\n", quaternion[0], 16383);
    tf_hal_printf("Quaternion [X]: %d 1/%d\n", quaternion[1], 16383);
    tf_hal_printf("Quaternion [Y]: %d 1/%d\n", quaternion[2], 16383);
    tf_hal_printf("Quaternion [Z]: %d 1/%d\n", quaternion[3], 16383);
    tf_hal_printf("Linear Acceleration [X]: %d 1/%d m/s²\n", linear_acceleration[0], 100);
    tf_hal_printf("Linear Acceleration [Y]: %d 1/%d m/s²\n", linear_acceleration[1], 100);
    tf_hal_printf("Linear Acceleration [Z]: %d 1/%d m/s²\n", linear_acceleration[2], 100);
    tf_hal_printf("Gravity Vector [X]: %d 1/%d m/s²\n", gravity_vector[0], 100);
    tf_hal_printf("Gravity Vector [Y]: %d 1/%d m/s²\n", gravity_vector[1], 100);
    tf_hal_printf("Gravity Vector [Z]: %d 1/%d m/s²\n", gravity_vector[2], 100);
    tf_hal_printf("Temperature: %I8d °C\n", temperature);
    tf_hal_printf("Calibration Status: %I8u\n", calibration_status);
    tf_hal_printf("\n");
}

static TF_IMUV3 imu;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_imu_v3_create(&imu, NULL, hal), "create device object");

    // Register all data callback to function all_data_handler
    tf_imu_v3_register_all_data_callback(&imu,
                                         all_data_handler,
                                         NULL);

    // Set period for all data callback to 0.1s (100ms)
    tf_imu_v3_set_all_data_callback_configuration(&imu, 100, false);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_imu_v3_create(TF_IMUV3 *imu_v3, const char *uid, TF_HAL *hal)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt imu_v3 mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_IMUV3 imu_v3;
tf_imu_v3_create(&imu_v3, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_imu_v3_destroy(TF_IMUV3 *imu_v3)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Rückgabe:	e_code – Typ: int

Entfernt das Geräteobjekt imu_v3 von dessen HAL und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int tf_imu_v3_get_orientation(TF_IMUV3 *imu_v3, int16_t *ret_heading, int16_t *ret_roll, int16_t *ret_pitch)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_heading – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [0 bis 5760] ret_roll – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] ret_pitch – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]
Rückgabe:	e_code – Typ: int

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 Orientation Callback zu nutzen und die Periode mit tf_imu_v3_set_orientation_callback_configuration() vorzugeben.

int tf_imu_v3_get_linear_acceleration(TF_IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? ret_y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? ret_z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ?
Rückgabe:	e_code – Typ: int

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit tf_imu_v3_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 tf_imu_v3_get_gravity_vector()

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

int tf_imu_v3_get_gravity_vector(TF_IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] ret_y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] ret_z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]
Rückgabe:	e_code – Typ: int

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 tf_imu_v3_get_linear_acceleration()

Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen den Gravity Vector Callback zu nutzen und die Periode mit tf_imu_v3_set_gravity_vector_callback_configuration() vorzugeben.

int tf_imu_v3_get_quaternion(TF_IMUV3 *imu_v3, int16_t *ret_w, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_w – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] ret_x – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] ret_y – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] ret_z – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
Rückgabe:	e_code – Typ: int

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 Quaternion Callback zu nutzen und die Periode mit tf_imu_v3_set_quaternion_callback_configuration() vorzugeben.

int tf_imu_v3_get_all_data(TF_IMUV3 *imu_v3, int16_t ret_acceleration[3], int16_t ret_magnetic_field[3], int16_t ret_angular_velocity[3], int16_t ret_euler_angle[3], int16_t ret_quaternion[4], int16_t ret_linear_acceleration[3], int16_t ret_gravity_vector[3], int8_t *ret_temperature, uint8_t *ret_calibration_status)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_acceleration – Typ: int16_t[3] 0: x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? ret_magnetic_field – Typ: int16_t[3] 0: x – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: y – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: z – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] ret_angular_velocity – Typ: int16_t[3] 0: x – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? 1: y – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? 2: z – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? ret_euler_angle – Typ: int16_t[3] 0: heading – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: roll – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: pitch – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] ret_quaternion – Typ: int16_t[4] 0: w – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 1: x – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 2: y – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 3: z – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] ret_linear_acceleration – Typ: int16_t[3] 0: x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? ret_gravity_vector – Typ: int16_t[3] 0: x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 1: y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 2: z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] ret_temperature – Typ: int8_t, Einheit: 1 °C, Wertebereich: [-128 bis 127] ret_calibration_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

Beschleunigung (see tf_imu_v3_get_acceleration())
Magnetfeld (see tf_imu_v3_get_magnetic_field())
Winkelgeschwindigkeit (see tf_imu_v3_get_angular_velocity())
Eulerwinkel (see tf_imu_v3_get_orientation())
Quaternion (see tf_imu_v3_get_quaternion())
Lineare Beschleunigung (see tf_imu_v3_get_linear_acceleration())
Erdbeschleunigungsvektor (see tf_imu_v3_get_gravity_vector())
Temperatur (see tf_imu_v3_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 All Data Callback zu nutzen und die Periode mit tf_imu_v3_set_all_data_callback_configuration() vorzugeben.

Fortgeschrittene Funktionen¶

int tf_imu_v3_get_acceleration(TF_IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? ret_y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? ret_z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ?
Rückgabe:	e_code – Typ: int

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

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

int tf_imu_v3_get_magnetic_field(TF_IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] ret_y – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] ret_z – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]
Rückgabe:	e_code – Typ: int

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 Magnetic Field Callback zu nutzen und die Periode mit tf_imu_v3_set_magnetic_field_callback_configuration() vorzugeben.

int tf_imu_v3_get_angular_velocity(TF_IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? ret_y – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? ret_z – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ?
Rückgabe:	e_code – Typ: int

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

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den Angular Velocity Callback zu nutzen und die Periode mit tf_imu_v3_set_angular_velocity_callback_configuration() vorzugeben.

int tf_imu_v3_get_temperature(TF_IMUV3 *imu_v3, int8_t *ret_temperature)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_temperature – Typ: int8_t, Einheit: 1 °C, Wertebereich: [-128 bis 127]
Rückgabe:	e_code – Typ: int

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

int tf_imu_v3_save_calibration(TF_IMUV3 *imu_v3, bool *ret_calibration_done)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_calibration_done – Typ: bool
Rückgabe:	e_code – Typ: int

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.

int tf_imu_v3_set_sensor_configuration(TF_IMUV3 *imu_v3, uint8_t magnetometer_rate, uint8_t gyroscope_range, uint8_t gyroscope_bandwidth, uint8_t accelerometer_range, uint8_t accelerometer_bandwidth)¶

Parameter:

Parameter:	imu_v3 – Typ: TF_IMUV3 * magnetometer_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 5 gyroscope_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 gyroscope_bandwidth – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 7 accelerometer_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 accelerometer_bandwidth – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

imu_v3 – Typ: TF_IMUV3 *
magnetometer_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 5
gyroscope_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
gyroscope_bandwidth – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 7
accelerometer_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
accelerometer_bandwidth – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3

Rückgabe:

e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für magnetometer_rate:

TF_IMU_V3_MAGNETOMETER_RATE_2HZ = 0
TF_IMU_V3_MAGNETOMETER_RATE_6HZ = 1
TF_IMU_V3_MAGNETOMETER_RATE_8HZ = 2
TF_IMU_V3_MAGNETOMETER_RATE_10HZ = 3
TF_IMU_V3_MAGNETOMETER_RATE_15HZ = 4
TF_IMU_V3_MAGNETOMETER_RATE_20HZ = 5
TF_IMU_V3_MAGNETOMETER_RATE_25HZ = 6
TF_IMU_V3_MAGNETOMETER_RATE_30HZ = 7

Für gyroscope_range:

TF_IMU_V3_GYROSCOPE_RANGE_2000DPS = 0
TF_IMU_V3_GYROSCOPE_RANGE_1000DPS = 1
TF_IMU_V3_GYROSCOPE_RANGE_500DPS = 2
TF_IMU_V3_GYROSCOPE_RANGE_250DPS = 3
TF_IMU_V3_GYROSCOPE_RANGE_125DPS = 4

Für gyroscope_bandwidth:

TF_IMU_V3_GYROSCOPE_BANDWIDTH_523HZ = 0
TF_IMU_V3_GYROSCOPE_BANDWIDTH_230HZ = 1
TF_IMU_V3_GYROSCOPE_BANDWIDTH_116HZ = 2
TF_IMU_V3_GYROSCOPE_BANDWIDTH_47HZ = 3
TF_IMU_V3_GYROSCOPE_BANDWIDTH_23HZ = 4
TF_IMU_V3_GYROSCOPE_BANDWIDTH_12HZ = 5
TF_IMU_V3_GYROSCOPE_BANDWIDTH_64HZ = 6
TF_IMU_V3_GYROSCOPE_BANDWIDTH_32HZ = 7

Für accelerometer_range:

TF_IMU_V3_ACCELEROMETER_RANGE_2G = 0
TF_IMU_V3_ACCELEROMETER_RANGE_4G = 1
TF_IMU_V3_ACCELEROMETER_RANGE_8G = 2
TF_IMU_V3_ACCELEROMETER_RANGE_16G = 3

Für accelerometer_bandwidth:

TF_IMU_V3_ACCELEROMETER_BANDWIDTH_7_81HZ = 0
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_15_63HZ = 1
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_31_25HZ = 2
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_62_5HZ = 3
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_125HZ = 4
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_250HZ = 5
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_500HZ = 6
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_1000HZ = 7

int tf_imu_v3_get_sensor_configuration(TF_IMUV3 *imu_v3, uint8_t *ret_magnetometer_rate, uint8_t *ret_gyroscope_range, uint8_t *ret_gyroscope_bandwidth, uint8_t *ret_accelerometer_range, uint8_t *ret_accelerometer_bandwidth)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_magnetometer_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 5 ret_gyroscope_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_gyroscope_bandwidth – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 7 ret_accelerometer_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 ret_accelerometer_bandwidth – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_magnetometer_rate:

TF_IMU_V3_MAGNETOMETER_RATE_2HZ = 0
TF_IMU_V3_MAGNETOMETER_RATE_6HZ = 1
TF_IMU_V3_MAGNETOMETER_RATE_8HZ = 2
TF_IMU_V3_MAGNETOMETER_RATE_10HZ = 3
TF_IMU_V3_MAGNETOMETER_RATE_15HZ = 4
TF_IMU_V3_MAGNETOMETER_RATE_20HZ = 5
TF_IMU_V3_MAGNETOMETER_RATE_25HZ = 6
TF_IMU_V3_MAGNETOMETER_RATE_30HZ = 7

Für ret_gyroscope_range:

TF_IMU_V3_GYROSCOPE_RANGE_2000DPS = 0
TF_IMU_V3_GYROSCOPE_RANGE_1000DPS = 1
TF_IMU_V3_GYROSCOPE_RANGE_500DPS = 2
TF_IMU_V3_GYROSCOPE_RANGE_250DPS = 3
TF_IMU_V3_GYROSCOPE_RANGE_125DPS = 4

Für ret_gyroscope_bandwidth:

TF_IMU_V3_GYROSCOPE_BANDWIDTH_523HZ = 0
TF_IMU_V3_GYROSCOPE_BANDWIDTH_230HZ = 1
TF_IMU_V3_GYROSCOPE_BANDWIDTH_116HZ = 2
TF_IMU_V3_GYROSCOPE_BANDWIDTH_47HZ = 3
TF_IMU_V3_GYROSCOPE_BANDWIDTH_23HZ = 4
TF_IMU_V3_GYROSCOPE_BANDWIDTH_12HZ = 5
TF_IMU_V3_GYROSCOPE_BANDWIDTH_64HZ = 6
TF_IMU_V3_GYROSCOPE_BANDWIDTH_32HZ = 7

Für ret_accelerometer_range:

TF_IMU_V3_ACCELEROMETER_RANGE_2G = 0
TF_IMU_V3_ACCELEROMETER_RANGE_4G = 1
TF_IMU_V3_ACCELEROMETER_RANGE_8G = 2
TF_IMU_V3_ACCELEROMETER_RANGE_16G = 3

Für ret_accelerometer_bandwidth:

TF_IMU_V3_ACCELEROMETER_BANDWIDTH_7_81HZ = 0
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_15_63HZ = 1
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_31_25HZ = 2
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_62_5HZ = 3
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_125HZ = 4
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_250HZ = 5
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_500HZ = 6
TF_IMU_V3_ACCELEROMETER_BANDWIDTH_1000HZ = 7

int tf_imu_v3_set_sensor_fusion_mode(TF_IMUV3 *imu_v3, uint8_t mode)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen tf_imu_v3_get_acceleration(), tf_imu_v3_get_magnetic_field() und tf_imu_v3_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 Konstanten sind für diese Funktion verfügbar:

Für mode:

TF_IMU_V3_SENSOR_FUSION_OFF = 0
TF_IMU_V3_SENSOR_FUSION_ON = 1
TF_IMU_V3_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
TF_IMU_V3_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

int tf_imu_v3_get_sensor_fusion_mode(TF_IMUV3 *imu_v3, uint8_t *ret_mode)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

TF_IMU_V3_SENSOR_FUSION_OFF = 0
TF_IMU_V3_SENSOR_FUSION_ON = 1
TF_IMU_V3_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
TF_IMU_V3_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

int tf_imu_v3_get_spitfp_error_count(TF_IMUV3 *imu_v3, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: 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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int tf_imu_v3_set_status_led_config(TF_IMUV3 *imu_v3, uint8_t config)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für config:

TF_IMU_V3_STATUS_LED_CONFIG_OFF = 0
TF_IMU_V3_STATUS_LED_CONFIG_ON = 1
TF_IMU_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_IMU_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_imu_v3_get_status_led_config(TF_IMUV3 *imu_v3, uint8_t *ret_config)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_imu_v3_set_status_led_config() gesetzt.

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

Für ret_config:

TF_IMU_V3_STATUS_LED_CONFIG_OFF = 0
TF_IMU_V3_STATUS_LED_CONFIG_ON = 1
TF_IMU_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_IMU_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_imu_v3_get_chip_temperature(TF_IMUV3 *imu_v3, int16_t *ret_temperature)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_imu_v3_reset(TF_IMUV3 *imu_v3)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Rückgabe:	e_code – Typ: int

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.

int tf_imu_v3_get_identity(TF_IMUV3 *imu_v3, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

int tf_imu_v3_set_acceleration_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_acceleration_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_acceleration_callback_configuration() gesetzt.

int tf_imu_v3_set_magnetic_field_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_magnetic_field_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_magnetic_field_callback_configuration() gesetzt.

int tf_imu_v3_set_angular_velocity_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_angular_velocity_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_angular_velocity_callback_configuration() gesetzt.

int tf_imu_v3_set_temperature_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_temperature_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_temperature_callback_configuration() gesetzt.

int tf_imu_v3_set_orientation_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_orientation_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_orientation_callback_configuration() gesetzt.

int tf_imu_v3_set_linear_acceleration_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_linear_acceleration_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_linear_acceleration_callback_configuration() gesetzt.

int tf_imu_v3_set_gravity_vector_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_gravity_vector_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_gravity_vector_callback_configuration() gesetzt.

int tf_imu_v3_set_quaternion_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_quaternion_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_quaternion_callback_configuration() gesetzt.

int tf_imu_v3_set_all_data_callback_configuration(TF_IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_imu_v3_get_all_data_callback_configuration(TF_IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_imu_v3_set_all_data_callback_configuration() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_imu_v3_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_imu_v3_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_imu_v3_register_acceleration_callback(TF_IMUV3 *imu_v3, TF_IMUV3_AccelerationHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? user_data – Typ: void *

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

int tf_imu_v3_register_magnetic_field_callback(TF_IMUV3 *imu_v3, TF_IMUV3_MagneticFieldHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * x – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] y – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] z – Typ: int16_t, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] user_data – Typ: void *

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

int tf_imu_v3_register_angular_velocity_callback(TF_IMUV3 *imu_v3, TF_IMUV3_AngularVelocityHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * x – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? y – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? z – Typ: int16_t, Einheit: 1/16 °/s, Wertebereich: ? user_data – Typ: void *

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

int tf_imu_v3_register_temperature_callback(TF_IMUV3 *imu_v3, TF_IMUV3_TemperatureHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int8_t temperature, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * temperature – Typ: int8_t, Einheit: 1 °C, Wertebereich: [-128 bis 127] user_data – Typ: void *

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

int tf_imu_v3_register_linear_acceleration_callback(TF_IMUV3 *imu_v3, TF_IMUV3_LinearAccelerationHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: ? user_data – Typ: void *

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

int tf_imu_v3_register_gravity_vector_callback(TF_IMUV3 *imu_v3, TF_IMUV3_GravityVectorHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * x – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] y – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] z – Typ: int16_t, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] user_data – Typ: void *

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

int tf_imu_v3_register_orientation_callback(TF_IMUV3 *imu_v3, TF_IMUV3_OrientationHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t heading, int16_t roll, int16_t pitch, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * heading – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [0 bis 5760] roll – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] pitch – Typ: int16_t, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] user_data – Typ: void *

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

int tf_imu_v3_register_quaternion_callback(TF_IMUV3 *imu_v3, TF_IMUV3_QuaternionHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t w, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	imu_v3 – Typ: TF_IMUV3 * w – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] x – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] y – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] z – Typ: int16_t, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] user_data – Typ: void *

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

int tf_imu_v3_register_all_data_callback(TF_IMUV3 *imu_v3, TF_IMUV3_AllDataHandler handler, void *user_data)¶

void handler(TF_IMUV3 *imu_v3, int16_t acceleration[3], int16_t magnetic_field[3], int16_t angular_velocity[3], int16_t euler_angle[3], int16_t quaternion[4], int16_t linear_acceleration[3], int16_t gravity_vector[3], int8_t temperature, uint8_t calibration_status, void *user_data)

Callback-Parameter:

imu_v3 – Typ: TF_IMUV3 *
acceleration – Typ: int16_t[3]

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

magnetic_field – Typ: int16_t[3]

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

angular_velocity – Typ: int16_t[3]

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

euler_angle – Typ: int16_t[3]

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

quaternion – Typ: int16_t[4]

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

linear_acceleration – Typ: int16_t[3]

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

gravity_vector – Typ: int16_t[3]

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

temperature – Typ: int8_t, Einheit: 1 °C, Wertebereich: [-128 bis 127]
calibration_status – Typ: uint8_t, Wertebereich: [0 bis 255]
user_data – Typ: void *

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

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_imu_v3_get_response_expected(TF_IMUV3 *imu_v3, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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

Für function_id:

TF_IMU_V3_FUNCTION_SET_SENSOR_CONFIGURATION = 11
TF_IMU_V3_FUNCTION_SET_SENSOR_FUSION_MODE = 13
TF_IMU_V3_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 15
TF_IMU_V3_FUNCTION_SET_MAGNETIC_FIELD_CALLBACK_CONFIGURATION = 17
TF_IMU_V3_FUNCTION_SET_ANGULAR_VELOCITY_CALLBACK_CONFIGURATION = 19
TF_IMU_V3_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 21
TF_IMU_V3_FUNCTION_SET_ORIENTATION_CALLBACK_CONFIGURATION = 23
TF_IMU_V3_FUNCTION_SET_LINEAR_ACCELERATION_CALLBACK_CONFIGURATION = 25
TF_IMU_V3_FUNCTION_SET_GRAVITY_VECTOR_CALLBACK_CONFIGURATION = 27
TF_IMU_V3_FUNCTION_SET_QUATERNION_CALLBACK_CONFIGURATION = 29
TF_IMU_V3_FUNCTION_SET_ALL_DATA_CALLBACK_CONFIGURATION = 31
TF_IMU_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_IMU_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_IMU_V3_FUNCTION_RESET = 243
TF_IMU_V3_FUNCTION_WRITE_UID = 248

int tf_imu_v3_set_response_expected(TF_IMUV3 *imu_v3, uint8_t function_id, bool response_expected)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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

Für function_id:

TF_IMU_V3_FUNCTION_SET_SENSOR_CONFIGURATION = 11
TF_IMU_V3_FUNCTION_SET_SENSOR_FUSION_MODE = 13
TF_IMU_V3_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 15
TF_IMU_V3_FUNCTION_SET_MAGNETIC_FIELD_CALLBACK_CONFIGURATION = 17
TF_IMU_V3_FUNCTION_SET_ANGULAR_VELOCITY_CALLBACK_CONFIGURATION = 19
TF_IMU_V3_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 21
TF_IMU_V3_FUNCTION_SET_ORIENTATION_CALLBACK_CONFIGURATION = 23
TF_IMU_V3_FUNCTION_SET_LINEAR_ACCELERATION_CALLBACK_CONFIGURATION = 25
TF_IMU_V3_FUNCTION_SET_GRAVITY_VECTOR_CALLBACK_CONFIGURATION = 27
TF_IMU_V3_FUNCTION_SET_QUATERNION_CALLBACK_CONFIGURATION = 29
TF_IMU_V3_FUNCTION_SET_ALL_DATA_CALLBACK_CONFIGURATION = 31
TF_IMU_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_IMU_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_IMU_V3_FUNCTION_RESET = 243
TF_IMU_V3_FUNCTION_WRITE_UID = 248

int tf_imu_v3_set_response_expected_all(TF_IMUV3 *imu_v3, bool response_expected)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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.

int tf_imu_v3_set_bootloader_mode(TF_IMUV3 *imu_v3, uint8_t mode, uint8_t *ret_status)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für mode:

TF_IMU_V3_BOOTLOADER_MODE_BOOTLOADER = 0
TF_IMU_V3_BOOTLOADER_MODE_FIRMWARE = 1
TF_IMU_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_IMU_V3_BOOTLOADER_STATUS_OK = 0
TF_IMU_V3_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_IMU_V3_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_IMU_V3_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_IMU_V3_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_IMU_V3_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_imu_v3_get_bootloader_mode(TF_IMUV3 *imu_v3, uint8_t *ret_mode)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe tf_imu_v3_set_bootloader_mode().

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

Für ret_mode:

TF_IMU_V3_BOOTLOADER_MODE_BOOTLOADER = 0
TF_IMU_V3_BOOTLOADER_MODE_FIRMWARE = 1
TF_IMU_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_imu_v3_set_write_firmware_pointer(TF_IMUV3 *imu_v3, uint32_t pointer)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_imu_v3_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.

int tf_imu_v3_write_firmware(TF_IMUV3 *imu_v3, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_imu_v3_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.

int tf_imu_v3_write_uid(TF_IMUV3 *imu_v3, uint32_t uid)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_imu_v3_read_uid(TF_IMUV3 *imu_v3, uint32_t *ret_uid)¶

Parameter:	imu_v3 – Typ: TF_IMUV3 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

TF_IMU_V3_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein IMU Bricklet 3.0 zu identifizieren.

Die Funktionen tf_imu_v3_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_IMU_V3_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines IMU Bricklet 3.0 dar.