C/C++ - IMU Bricklet 3.0¶

Dies ist die Beschreibung der C/C++ 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++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_imu_v3.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your IMU Bricklet 3.0

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    IMUV3 imu;
    imu_v3_create(&imu, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current quaternion
    int16_t w, x, y, z;
    if(imu_v3_get_quaternion(&imu, &w, &x, &y, &z) < 0) {
        fprintf(stderr, "Could not get quaternion, probably timeout\n");
        return 1;
    }

    printf("Quaternion [W]: %f\n", w/16383.0);
    printf("Quaternion [X]: %f\n", x/16383.0);
    printf("Quaternion [Y]: %f\n", y/16383.0);
    printf("Quaternion [Z]: %f\n", z/16383.0);

    printf("Press key to exit\n");
    getchar();
    imu_v3_destroy(&imu);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_imu_v3.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your IMU Bricklet 3.0

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

    printf("Quaternion [W]: %f\n", w/16383.0);
    printf("Quaternion [X]: %f\n", x/16383.0);
    printf("Quaternion [Y]: %f\n", y/16383.0);
    printf("Quaternion [Z]: %f\n", z/16383.0);
    printf("\n");
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    IMUV3 imu;
    imu_v3_create(&imu, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register quaternion callback to function cb_quaternion
    imu_v3_register_callback(&imu,
                             IMU_V3_CALLBACK_QUATERNION,
                             (void (*)(void))cb_quaternion,
                             NULL);

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

    printf("Press key to exit\n");
    getchar();
    imu_v3_destroy(&imu);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

All Data¶

Download (example_all_data.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_imu_v3.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your IMU Bricklet 3.0

// Callback function for all data callback
void cb_all_data(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)user_data; // avoid unused parameter warning

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

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    IMUV3 imu;
    imu_v3_create(&imu, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register all data callback to function cb_all_data
    imu_v3_register_callback(&imu,
                             IMU_V3_CALLBACK_ALL_DATA,
                             (void (*)(void))cb_all_data,
                             NULL);

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

    printf("Press key to exit\n");
    getchar();
    imu_v3_destroy(&imu);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

E_OK = 0
E_TIMEOUT = -1
E_NO_STREAM_SOCKET = -2
E_HOSTNAME_INVALID = -3
E_NO_CONNECT = -4
E_NO_THREAD = -5
E_NOT_ADDED = -6 (seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void imu_v3_create(IMUV3 *imu_v3, const char *uid, IPConnection *ipcon)¶

Parameter:	imu_v3 – Typ: IMUV3 * uid – Typ: const char * ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt imu_v3 mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

IMUV3 imu_v3;
imu_v3_create(&imu_v3, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void imu_v3_destroy(IMUV3 *imu_v3)¶

Parameter:	imu_v3 – Typ: IMUV3 *

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

int imu_v3_get_orientation(IMUV3 *imu_v3, int16_t *ret_heading, int16_t *ret_roll, int16_t *ret_pitch)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_ORIENTATION Callback zu nutzen und die Periode mit imu_v3_set_orientation_callback_configuration() vorzugeben.

int imu_v3_get_linear_acceleration(IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: 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 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 imu_v3_get_gravity_vector()

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

int imu_v3_get_gravity_vector(IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_get_linear_acceleration()

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

int imu_v3_get_quaternion(IMUV3 *imu_v3, int16_t *ret_w, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_QUATERNION Callback zu nutzen und die Periode mit imu_v3_set_quaternion_callback_configuration() vorzugeben.

int imu_v3_get_all_data(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: 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 imu_v3_get_acceleration())
Magnetfeld (see imu_v3_get_magnetic_field())
Winkelgeschwindigkeit (see imu_v3_get_angular_velocity())
Eulerwinkel (see imu_v3_get_orientation())
Quaternion (see imu_v3_get_quaternion())
Lineare Beschleunigung (see imu_v3_get_linear_acceleration())
Erdbeschleunigungsvektor (see imu_v3_get_gravity_vector())
Temperatur (see 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 IMU_V3_CALLBACK_ALL_DATA Callback zu nutzen und die Periode mit imu_v3_set_all_data_callback_configuration() vorzugeben.

Fortgeschrittene Funktionen¶

int imu_v3_get_acceleration(IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_sensor_configuration() konfiguriert wurde.

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

int imu_v3_get_magnetic_field(IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit imu_v3_set_magnetic_field_callback_configuration() vorzugeben.

int imu_v3_get_angular_velocity(IMUV3 *imu_v3, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_sensor_configuration() konfiguriert wurde.

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

int imu_v3_get_temperature(IMUV3 *imu_v3, int8_t *ret_temperature)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_save_calibration(IMUV3 *imu_v3, bool *ret_calibration_done)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_sensor_configuration(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: 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: 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:

IMU_V3_MAGNETOMETER_RATE_2HZ = 0
IMU_V3_MAGNETOMETER_RATE_6HZ = 1
IMU_V3_MAGNETOMETER_RATE_8HZ = 2
IMU_V3_MAGNETOMETER_RATE_10HZ = 3
IMU_V3_MAGNETOMETER_RATE_15HZ = 4
IMU_V3_MAGNETOMETER_RATE_20HZ = 5
IMU_V3_MAGNETOMETER_RATE_25HZ = 6
IMU_V3_MAGNETOMETER_RATE_30HZ = 7

Für gyroscope_range:

IMU_V3_GYROSCOPE_RANGE_2000DPS = 0
IMU_V3_GYROSCOPE_RANGE_1000DPS = 1
IMU_V3_GYROSCOPE_RANGE_500DPS = 2
IMU_V3_GYROSCOPE_RANGE_250DPS = 3
IMU_V3_GYROSCOPE_RANGE_125DPS = 4

Für gyroscope_bandwidth:

IMU_V3_GYROSCOPE_BANDWIDTH_523HZ = 0
IMU_V3_GYROSCOPE_BANDWIDTH_230HZ = 1
IMU_V3_GYROSCOPE_BANDWIDTH_116HZ = 2
IMU_V3_GYROSCOPE_BANDWIDTH_47HZ = 3
IMU_V3_GYROSCOPE_BANDWIDTH_23HZ = 4
IMU_V3_GYROSCOPE_BANDWIDTH_12HZ = 5
IMU_V3_GYROSCOPE_BANDWIDTH_64HZ = 6
IMU_V3_GYROSCOPE_BANDWIDTH_32HZ = 7

Für accelerometer_range:

IMU_V3_ACCELEROMETER_RANGE_2G = 0
IMU_V3_ACCELEROMETER_RANGE_4G = 1
IMU_V3_ACCELEROMETER_RANGE_8G = 2
IMU_V3_ACCELEROMETER_RANGE_16G = 3

Für accelerometer_bandwidth:

IMU_V3_ACCELEROMETER_BANDWIDTH_7_81HZ = 0
IMU_V3_ACCELEROMETER_BANDWIDTH_15_63HZ = 1
IMU_V3_ACCELEROMETER_BANDWIDTH_31_25HZ = 2
IMU_V3_ACCELEROMETER_BANDWIDTH_62_5HZ = 3
IMU_V3_ACCELEROMETER_BANDWIDTH_125HZ = 4
IMU_V3_ACCELEROMETER_BANDWIDTH_250HZ = 5
IMU_V3_ACCELEROMETER_BANDWIDTH_500HZ = 6
IMU_V3_ACCELEROMETER_BANDWIDTH_1000HZ = 7

int imu_v3_get_sensor_configuration(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: 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 imu_v3_set_sensor_configuration() gesetzt.

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

Für ret_magnetometer_rate:

IMU_V3_MAGNETOMETER_RATE_2HZ = 0
IMU_V3_MAGNETOMETER_RATE_6HZ = 1
IMU_V3_MAGNETOMETER_RATE_8HZ = 2
IMU_V3_MAGNETOMETER_RATE_10HZ = 3
IMU_V3_MAGNETOMETER_RATE_15HZ = 4
IMU_V3_MAGNETOMETER_RATE_20HZ = 5
IMU_V3_MAGNETOMETER_RATE_25HZ = 6
IMU_V3_MAGNETOMETER_RATE_30HZ = 7

Für ret_gyroscope_range:

IMU_V3_GYROSCOPE_RANGE_2000DPS = 0
IMU_V3_GYROSCOPE_RANGE_1000DPS = 1
IMU_V3_GYROSCOPE_RANGE_500DPS = 2
IMU_V3_GYROSCOPE_RANGE_250DPS = 3
IMU_V3_GYROSCOPE_RANGE_125DPS = 4

Für ret_gyroscope_bandwidth:

IMU_V3_GYROSCOPE_BANDWIDTH_523HZ = 0
IMU_V3_GYROSCOPE_BANDWIDTH_230HZ = 1
IMU_V3_GYROSCOPE_BANDWIDTH_116HZ = 2
IMU_V3_GYROSCOPE_BANDWIDTH_47HZ = 3
IMU_V3_GYROSCOPE_BANDWIDTH_23HZ = 4
IMU_V3_GYROSCOPE_BANDWIDTH_12HZ = 5
IMU_V3_GYROSCOPE_BANDWIDTH_64HZ = 6
IMU_V3_GYROSCOPE_BANDWIDTH_32HZ = 7

Für ret_accelerometer_range:

IMU_V3_ACCELEROMETER_RANGE_2G = 0
IMU_V3_ACCELEROMETER_RANGE_4G = 1
IMU_V3_ACCELEROMETER_RANGE_8G = 2
IMU_V3_ACCELEROMETER_RANGE_16G = 3

Für ret_accelerometer_bandwidth:

IMU_V3_ACCELEROMETER_BANDWIDTH_7_81HZ = 0
IMU_V3_ACCELEROMETER_BANDWIDTH_15_63HZ = 1
IMU_V3_ACCELEROMETER_BANDWIDTH_31_25HZ = 2
IMU_V3_ACCELEROMETER_BANDWIDTH_62_5HZ = 3
IMU_V3_ACCELEROMETER_BANDWIDTH_125HZ = 4
IMU_V3_ACCELEROMETER_BANDWIDTH_250HZ = 5
IMU_V3_ACCELEROMETER_BANDWIDTH_500HZ = 6
IMU_V3_ACCELEROMETER_BANDWIDTH_1000HZ = 7

int imu_v3_set_sensor_fusion_mode(IMUV3 *imu_v3, uint8_t mode)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_get_acceleration(), imu_v3_get_magnetic_field() und 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:

IMU_V3_SENSOR_FUSION_OFF = 0
IMU_V3_SENSOR_FUSION_ON = 1
IMU_V3_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
IMU_V3_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

int imu_v3_get_sensor_fusion_mode(IMUV3 *imu_v3, uint8_t *ret_mode)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_sensor_fusion_mode() gesetzt.

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

Für ret_mode:

IMU_V3_SENSOR_FUSION_OFF = 0
IMU_V3_SENSOR_FUSION_ON = 1
IMU_V3_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
IMU_V3_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

int imu_v3_get_spitfp_error_count(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: 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 imu_v3_set_status_led_config(IMUV3 *imu_v3, uint8_t config)¶

Parameter:	imu_v3 – Typ: 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:

IMU_V3_STATUS_LED_CONFIG_OFF = 0
IMU_V3_STATUS_LED_CONFIG_ON = 1
IMU_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
IMU_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3

int imu_v3_get_status_led_config(IMUV3 *imu_v3, uint8_t *ret_config)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_status_led_config() gesetzt.

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

Für ret_config:

IMU_V3_STATUS_LED_CONFIG_OFF = 0
IMU_V3_STATUS_LED_CONFIG_ON = 1
IMU_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
IMU_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3

int imu_v3_get_chip_temperature(IMUV3 *imu_v3, int16_t *ret_temperature)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_reset(IMUV3 *imu_v3)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_get_identity(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: 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¶

void imu_v3_register_callback(IMUV3 *imu_v3, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	imu_v3 – Typ: IMUV3 * callback_id – Typ: int16_t function – Typ: void ()(void) user_data* – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

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

int imu_v3_set_acceleration_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

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

int imu_v3_get_acceleration_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_acceleration_callback_configuration() gesetzt.

int imu_v3_set_magnetic_field_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_MAGNETIC_FIELD Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_magnetic_field_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_magnetic_field_callback_configuration() gesetzt.

int imu_v3_set_angular_velocity_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_ANGULAR_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_angular_velocity_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_angular_velocity_callback_configuration() gesetzt.

int imu_v3_set_temperature_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_temperature_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_temperature_callback_configuration() gesetzt.

int imu_v3_set_orientation_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_ORIENTATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_orientation_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_orientation_callback_configuration() gesetzt.

int imu_v3_set_linear_acceleration_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_LINEAR_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_linear_acceleration_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_linear_acceleration_callback_configuration() gesetzt.

int imu_v3_set_gravity_vector_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_GRAVITY_VECTOR Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_gravity_vector_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_gravity_vector_callback_configuration() gesetzt.

int imu_v3_set_quaternion_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_QUATERNION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_quaternion_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_quaternion_callback_configuration() gesetzt.

int imu_v3_set_all_data_callback_configuration(IMUV3 *imu_v3, uint32_t period, bool value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 IMU_V3_CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int imu_v3_get_all_data_callback_configuration(IMUV3 *imu_v3, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	imu_v3 – Typ: 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 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 imu_v3_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

imu_v3_register_callback(&imu_v3,
                         IMU_V3_CALLBACK_EXAMPLE,
                         (void (*)(void))my_callback,
                         NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen 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.

IMU_V3_CALLBACK_ACCELERATION¶

void callback(int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	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 imu_v3_set_acceleration_callback_configuration(), ausgelöst. Die Parameter sind die Beschleunigungen der X, Y und Z-Achse.

IMU_V3_CALLBACK_MAGNETIC_FIELD¶

void callback(int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	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 imu_v3_set_magnetic_field_callback_configuration(), ausgelöst. Die Parameter sind die Magnetfeldkomponenten der X, Y und Z-Achse.

IMU_V3_CALLBACK_ANGULAR_VELOCITY¶

void callback(int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	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 imu_v3_set_angular_velocity_callback_configuration(), ausgelöst. Die Parameter sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

IMU_V3_CALLBACK_TEMPERATURE¶

void callback(int8_t temperature, void *user_data)

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

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

IMU_V3_CALLBACK_LINEAR_ACCELERATION¶

void callback(int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	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 imu_v3_set_linear_acceleration_callback_configuration(), ausgelöst. Die Parameter sind die linearen Beschleunigungen der X, Y und Z-Achse.

IMU_V3_CALLBACK_GRAVITY_VECTOR¶

void callback(int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	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 imu_v3_set_gravity_vector_callback_configuration(), ausgelöst. Die Parameter sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.

IMU_V3_CALLBACK_ORIENTATION¶

void callback(int16_t heading, int16_t roll, int16_t pitch, void *user_data)

Callback-Parameter:	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 imu_v3_set_orientation_callback_configuration(), ausgelöst. Die Parameter sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe imu_v3_get_orientation() für Details.

IMU_V3_CALLBACK_QUATERNION¶

void callback(int16_t w, int16_t x, int16_t y, int16_t z, void *user_data)

Callback-Parameter:	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 imu_v3_set_quaternion_callback_configuration(), ausgelöst. Die Parameter sind die Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe imu_v3_get_quaternion() für Details.

IMU_V3_CALLBACK_ALL_DATA¶

void callback(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:

Callback-Parameter:	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 *

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 imu_v3_set_all_data_callback_configuration(), ausgelöst. Die Parameter sind die gleichen wie bei imu_v3_get_all_data().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int imu_v3_get_api_version(IMUV3 *imu_v3, uint8_t ret_api_version[3])¶

Parameter:	imu_v3 – Typ: IMUV3 *
Ausgabeparameter:	ret_api_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]
Rückgabe:	e_code – Typ: int

Gibt die Version der API Definition 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.

int imu_v3_get_response_expected(IMUV3 *imu_v3, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	imu_v3 – Typ: 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 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:

IMU_V3_FUNCTION_SET_SENSOR_CONFIGURATION = 11
IMU_V3_FUNCTION_SET_SENSOR_FUSION_MODE = 13
IMU_V3_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 15
IMU_V3_FUNCTION_SET_MAGNETIC_FIELD_CALLBACK_CONFIGURATION = 17
IMU_V3_FUNCTION_SET_ANGULAR_VELOCITY_CALLBACK_CONFIGURATION = 19
IMU_V3_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 21
IMU_V3_FUNCTION_SET_ORIENTATION_CALLBACK_CONFIGURATION = 23
IMU_V3_FUNCTION_SET_LINEAR_ACCELERATION_CALLBACK_CONFIGURATION = 25
IMU_V3_FUNCTION_SET_GRAVITY_VECTOR_CALLBACK_CONFIGURATION = 27
IMU_V3_FUNCTION_SET_QUATERNION_CALLBACK_CONFIGURATION = 29
IMU_V3_FUNCTION_SET_ALL_DATA_CALLBACK_CONFIGURATION = 31
IMU_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
IMU_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
IMU_V3_FUNCTION_RESET = 243
IMU_V3_FUNCTION_WRITE_UID = 248

int imu_v3_set_response_expected(IMUV3 *imu_v3, uint8_t function_id, bool response_expected)¶

Parameter:	imu_v3 – Typ: 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:

IMU_V3_FUNCTION_SET_SENSOR_CONFIGURATION = 11
IMU_V3_FUNCTION_SET_SENSOR_FUSION_MODE = 13
IMU_V3_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 15
IMU_V3_FUNCTION_SET_MAGNETIC_FIELD_CALLBACK_CONFIGURATION = 17
IMU_V3_FUNCTION_SET_ANGULAR_VELOCITY_CALLBACK_CONFIGURATION = 19
IMU_V3_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 21
IMU_V3_FUNCTION_SET_ORIENTATION_CALLBACK_CONFIGURATION = 23
IMU_V3_FUNCTION_SET_LINEAR_ACCELERATION_CALLBACK_CONFIGURATION = 25
IMU_V3_FUNCTION_SET_GRAVITY_VECTOR_CALLBACK_CONFIGURATION = 27
IMU_V3_FUNCTION_SET_QUATERNION_CALLBACK_CONFIGURATION = 29
IMU_V3_FUNCTION_SET_ALL_DATA_CALLBACK_CONFIGURATION = 31
IMU_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
IMU_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
IMU_V3_FUNCTION_RESET = 243
IMU_V3_FUNCTION_WRITE_UID = 248

int imu_v3_set_response_expected_all(IMUV3 *imu_v3, bool response_expected)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_set_bootloader_mode(IMUV3 *imu_v3, uint8_t mode, uint8_t *ret_status)¶

Parameter:	imu_v3 – Typ: 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:

IMU_V3_BOOTLOADER_MODE_BOOTLOADER = 0
IMU_V3_BOOTLOADER_MODE_FIRMWARE = 1
IMU_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

IMU_V3_BOOTLOADER_STATUS_OK = 0
IMU_V3_BOOTLOADER_STATUS_INVALID_MODE = 1
IMU_V3_BOOTLOADER_STATUS_NO_CHANGE = 2
IMU_V3_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
IMU_V3_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
IMU_V3_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int imu_v3_get_bootloader_mode(IMUV3 *imu_v3, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

IMU_V3_BOOTLOADER_MODE_BOOTLOADER = 0
IMU_V3_BOOTLOADER_MODE_FIRMWARE = 1
IMU_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
IMU_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int imu_v3_set_write_firmware_pointer(IMUV3 *imu_v3, uint32_t pointer)¶

Parameter:	imu_v3 – Typ: 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 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 imu_v3_write_firmware(IMUV3 *imu_v3, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	imu_v3 – Typ: IMUV3 * data – Typ: 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 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 imu_v3_write_uid(IMUV3 *imu_v3, uint32_t uid)¶

Parameter:	imu_v3 – Typ: 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 imu_v3_read_uid(IMUV3 *imu_v3, uint32_t *ret_uid)¶

Parameter:	imu_v3 – Typ: 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¶

IMU_V3_DEVICE_IDENTIFIER¶

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

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

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