Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricks (Abgekündigt) / IMU Brick

C/C++ - IMU Brick¶

Dies ist die Beschreibung der C/C++ API Bindings für den IMU Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 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 "brick_imu.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your IMU Brick

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

    // Create device object
    IMU imu;
    imu_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
    float x, y, z, w;
    if(imu_get_quaternion(&imu, &x, &y, &z, &w) < 0) {
        fprintf(stderr, "Could not get quaternion, probably timeout\n");
        return 1;
    }

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

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "brick_imu.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your IMU Brick

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

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

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

    // Create device object
    IMU imu;
    imu_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_register_callback(&imu,
                          IMU_CALLBACK_QUATERNION,
                          (void (*)(void))cb_quaternion,
                          NULL);

    // Set period for quaternion callback to 1s (1000ms)
    imu_set_quaternion_period(&imu, 1000);

    printf("Press key to exit\n");
    getchar();
    imu_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_create(IMU *imu, const char *uid, IPConnection *ipcon)¶

Parameter:	imu – Typ: IMU * uid – Typ: const char * ipcon – Typ: IPConnection *

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

IMU imu;
imu_create(&imu, "YOUR_DEVICE_UID", &ipcon);

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

void imu_destroy(IMU *imu)¶

Parameter:	imu – Typ: IMU *

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

int imu_get_orientation(IMU *imu, int16_t *ret_roll, int16_t *ret_pitch, int16_t *ret_yaw)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_roll – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] ret_pitch – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] ret_yaw – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Orientierung (Roll-, Nick-, Gierwinkel) des IMU Brick in Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren.

Wir empfehlen die Verwendung von Quaternionen stattdessen.

Die Reihenfolge in denen die Orientierungswerte angewandt werden sollten, ist Roll-, Nick-, Gierwinkel.

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

int imu_get_quaternion(IMU *imu, float *ret_x, float *ret_y, float *ret_z, float *ret_w)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_x – Typ: float, Wertebereich: [-1.0f bis 1.0f] ret_y – Typ: float, Wertebereich: [-1.0f bis 1.0f] ret_z – Typ: float, Wertebereich: [-1.0f bis 1.0f] ret_w – Typ: float, Wertebereich: [-1.0f bis 1.0f]
Rückgabe:	e_code – Typ: int

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

Die Umrechnung von Quaternionen in Eulerwinkel ist mit folgender Formel möglich:

xAngle = atan2(2*y*w - 2*x*z, 1 - 2*y*y - 2*z*z)
yAngle = atan2(2*x*w - 2*y*z, 1 - 2*x*x - 2*z*z)
zAngle =  asin(2*x*y + 2*z*w)

Es ist auch möglich unabhängige Winkel zu berechen. Yaw, Pitch und Roll in einem rechtshändigen Fahrzeugkoordinatensystem nach DIN70000 können wie folgt berechnet werden:

yaw   =  atan2(2*x*y + 2*w*z, w*w + x*x - y*y - z*z)
pitch = -asin(2*w*y - 2*x*z)
roll  = -atan2(2*y*z + 2*w*x, -w*w + x*x + y*y - z*z))

Diese Umrechnung ist irreversibel aufgrund der kardanischen Blockade.

Die Umrechnung von Quaternionen in eine OpenGL Transformationsmatrix ist mit folgender Formel möglich:

matrix = [[1 - 2*(y*y + z*z),     2*(x*y - w*z),     2*(x*z + w*y), 0],
          [    2*(x*y + w*z), 1 - 2*(x*x + z*z),     2*(y*z - w*x), 0],
          [    2*(x*z - w*y),     2*(y*z + w*x), 1 - 2*(x*x + y*y), 0],
          [                0,                 0,                 0, 1]]

Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den IMU_CALLBACK_QUATERNION Callback zu nutzen und die Periode mit imu_set_quaternion_period() vorzugeben.

int imu_leds_on(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

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

int imu_leds_off(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

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

int imu_are_leds_on(IMU *imu, bool *ret_leds)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_leds – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

int imu_set_convergence_speed(IMU *imu, uint16_t speed)¶

Parameter:	imu – Typ: IMU * speed – Typ: uint16_t, Einheit: 1 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 30
Rückgabe:	e_code – Typ: int

Setzt die Konvergenzgeschwindigkeit des IMU Brick. Die Konvergenzgeschwindigkeit bestimmt wie die unterschiedlichen Sensormessungen vereinigt werden.

Wenn die Orientierung des IMU Brick eine Abweichung von 10° hat und die Konvergenzgeschwindigkeit auf 20°/s konfiguriert ist, dann dauert es 0,5s bis die Orientierung korrigiert ist. Bei einer zu hohen Konvergenzgeschwindigkeit wird nach Erreichen der korrekten Orientierung, diese um die Fluktuationen des Beschleunigungsmessers und des Magnetometers schwanken.

Wenn die Konvergenzgeschwindigkeit auf 0 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Gyroskopdaten. Dies ergibt sehr gleichmäßige Bewegungen aber Fehler des Gyroskops werden nicht korrigiert. Wenn die Konvergenzgeschwindigkeit über 500 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Beschleunigungsmesser- und Magnetometerdaten. In diesem Fall sind die Bewegungen abrupt und die Werte werden schwanken. Es treten aber keine akkumulativen Fehler auf.

In Anwendungen mit hohen Winkelgeschwindigkeiten wird eine hohe Konvergenzgeschwindigkeit empfohlen, so dass Fehler des Gyroskops schnell korrigiert werden können. In Anwendungen mit langsamen Bewegungen wird entsprechend eine geringe Konvergenzgeschwindigkeit empfohlen. Es ist möglich die Konvergenzgeschwindigkeit spontan zu ändern. Dadurch ist es möglich (und empfohlen) direkt vor einer abrupten Bewegung die Konvergenzgeschwindigkeit zu erhöhen und im Anschluss wieder zu verringern.

Um ein Gefühl für einen guten Wert, für die Konvergenzgeschwindigkeit, in deiner Anwendung zu bekommen ist es ratsam im Brick Viewer verschiedenste Werte auszuprobieren.

int imu_get_convergence_speed(IMU *imu, uint16_t *ret_speed)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_speed – Typ: uint16_t, Einheit: 1 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 30
Rückgabe:	e_code – Typ: int

Gibt die Konvergenzgeschwindigkeit zurück, wie von imu_set_convergence_speed() gesetzt.

Fortgeschrittene Funktionen¶

int imu_get_acceleration(IMU *imu, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_y – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_z – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X, Y und Z-Achse zurück.

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

int imu_get_magnetic_field(IMU *imu, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_y – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_z – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt das kalibrierte Magnetfeld des Magnetometers mit den X-, Y- und Z-Komponenten zurück.

Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen den IMU_CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit imu_set_magnetic_field_period() vorzugeben.

int imu_get_angular_velocity(IMU *imu, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_x – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ret_y – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ret_z – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
Rückgabe:	e_code – Typ: int

Gibt die kalibrierten Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in °/14,375s zurück. (Um den Wert in °/s zu erhalten ist es notwendig durch 14,375 zu teilen)

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

int imu_get_all_data(IMU *imu, int16_t *ret_acc_x, int16_t *ret_acc_y, int16_t *ret_acc_z, int16_t *ret_mag_x, int16_t *ret_mag_y, int16_t *ret_mag_z, int16_t *ret_ang_x, int16_t *ret_ang_y, int16_t *ret_ang_z, int16_t *ret_temperature)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_acc_x – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_acc_y – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_acc_z – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_mag_x – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_mag_y – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_mag_z – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_ang_x – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ret_ang_y – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ret_ang_z – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ret_temperature – Typ: int16_t, Einheit: 1/100 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Daten von imu_get_acceleration(), imu_get_magnetic_field() und imu_get_angular_velocity() sowie die Temperatur des IMU Brick zurück.

Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den IMU_CALLBACK_ALL_DATA Callback zu nutzen und die Periode mit imu_set_all_data_period() vorzugeben.

int imu_get_imu_temperature(IMU *imu, int16_t *ret_temperature)¶

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

Gibt die Temperatur des IMU Brick zurück.

int imu_set_acceleration_range(IMU *imu, uint8_t range)¶

Parameter:	imu – Typ: IMU * range – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Bisher nicht implementiert.

int imu_get_acceleration_range(IMU *imu, uint8_t *ret_range)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_range – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Bisher nicht implementiert.

int imu_set_magnetometer_range(IMU *imu, uint8_t range)¶

Parameter:	imu – Typ: IMU * range – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Bisher nicht implementiert.

int imu_get_magnetometer_range(IMU *imu, uint8_t *ret_range)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_range – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Bisher nicht implementiert.

int imu_set_calibration(IMU *imu, uint8_t typ, int16_t data[10])¶

Parameter:	imu – Typ: IMU * typ – Typ: uint8_t, Wertebereich: Siehe Konstanten data – Typ: int16_t[10], Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Es sind folgende verschiedene Kalibrierungen möglich:

Typ	Beschreibung	Werte
0	Beschleunigungsmesser Verstärkung	`[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]`
1	Beschleunigungsmesser Versatz	`[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]`
2	Magnetometer Verstärkung	`[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]`
3	Magnetometer Versatz	`[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]`
4	Gyroskop Verstärkung	`[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]`
5	Gyroskop Versatz	`[bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0]`

Die Kalibrierung mittels Verstärkung und Versatz wird über folgende Formel realisiert:

new_value = (bias + orig_value) * gain_mul / gain_div

Für die Implementierung einer eigenen Kalibriersoftware sollte beachtet werden, dass zuerst die bisherige Kalibrierung rückgängig gemacht werden muss (Versatz auf 0 und Verstärkung auf 1/1 setzen) und das über mehrere tausend Werte gemittelt werden sollte um ein benutzbares Ergebnis zu erhalten.

Der Versatz des Gyroskops ist sehr temperaturabhängig und daher muss die Kalibrierung des Versatzes mit zwei unterschiedlichen Temperaturen erfolgen. Die Werte xl, yl, zl und temp l sind der Versatz für x, y, z und die zugehörige geringe Temperatur. Die Werte xh, yh, zh und temp h sind entsprechend für eine höhere Temperatur. Die Temperaturdifferenz sollte mindestens 5°C betragen. Die übliche Betriebstemperatur des IMU Brick sollte einer der Kalibrierpunkte sein.

Bemerkung

Wir empfehlen dringend den Brick Viewer zur Kalibrierung des IMU Brick zu verwenden.

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

Für typ:

IMU_CALIBRATION_TYPE_ACCELEROMETER_GAIN = 0
IMU_CALIBRATION_TYPE_ACCELEROMETER_BIAS = 1
IMU_CALIBRATION_TYPE_MAGNETOMETER_GAIN = 2
IMU_CALIBRATION_TYPE_MAGNETOMETER_BIAS = 3
IMU_CALIBRATION_TYPE_GYROSCOPE_GAIN = 4
IMU_CALIBRATION_TYPE_GYROSCOPE_BIAS = 5

int imu_get_calibration(IMU *imu, uint8_t typ, int16_t ret_data[10])¶

Parameter:	imu – Typ: IMU * typ – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_data – Typ: int16_t[10], Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Kalibrierung für den ausgewählten Typ zurück, wie von imu_set_calibration() gesetzt.

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

Für typ:

IMU_CALIBRATION_TYPE_ACCELEROMETER_GAIN = 0
IMU_CALIBRATION_TYPE_ACCELEROMETER_BIAS = 1
IMU_CALIBRATION_TYPE_MAGNETOMETER_GAIN = 2
IMU_CALIBRATION_TYPE_MAGNETOMETER_BIAS = 3
IMU_CALIBRATION_TYPE_GYROSCOPE_GAIN = 4
IMU_CALIBRATION_TYPE_GYROSCOPE_BIAS = 5

int imu_orientation_calculation_on(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

Aktiviert die Orientierungsberechnungen des IMU Brick.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

int imu_orientation_calculation_off(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

Deaktiviert die Orientierungsberechnungen des IMU Brick.

Wenn die Berechnungen deaktiviert sind, gibt imu_get_orientation() solange den letzten berechneten Wer zurück bis die Berechnungen wieder aktiviert werden.

Die trigonometrischen Funktionen die zur Berechnung der Orientierung benötigt werden sind sehr teuer. Wir empfehlen die Orientierungsberechnungen zu deaktivieren wenn sie nicht benötigt werden. Dadurch wird mehr Rechenzeit für den Sensorfusions-Algorithmus freigegeben.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

int imu_is_orientation_calculation_on(IMU *imu, bool *ret_orientation_calculation_on)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_orientation_calculation_on – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Gibt zurück ob die Orientierungsberechnungen des IMU Brick aktiv sind.

Neu in Version 2.0.2 (Firmware).

int imu_set_spitfp_baudrate_config(IMU *imu, bool enable_dynamic_baudrate, uint32_t minimum_dynamic_baudrate)¶

Parameter:	imu – Typ: IMU * enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:	e_code – Typ: int

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion imu_set_spitfp_baudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von imu_set_spitfp_baudrate() gesetzt statisch verwendet.

Neu in Version 2.3.5 (Firmware).

int imu_get_spitfp_baudrate_config(IMU *imu, bool *ret_enable_dynamic_baudrate, uint32_t *ret_minimum_dynamic_baudrate)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_enable_dynamic_baudrate – Typ: bool, Standardwert: true ret_minimum_dynamic_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:	e_code – Typ: int

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

Neu in Version 2.3.5 (Firmware).

int imu_get_send_timeout_count(IMU *imu, uint8_t communication_method, uint32_t *ret_timeout_count)¶

Parameter:	imu – Typ: IMU * communication_method – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_timeout_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

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

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

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

Für communication_method:

IMU_COMMUNICATION_METHOD_NONE = 0
IMU_COMMUNICATION_METHOD_USB = 1
IMU_COMMUNICATION_METHOD_SPI_STACK = 2
IMU_COMMUNICATION_METHOD_CHIBI = 3
IMU_COMMUNICATION_METHOD_RS485 = 4
IMU_COMMUNICATION_METHOD_WIFI = 5
IMU_COMMUNICATION_METHOD_ETHERNET = 6
IMU_COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.3 (Firmware).

int imu_set_spitfp_baudrate(IMU *imu, char bricklet_port, uint32_t baudrate)¶

Parameter:	imu – Typ: IMU * bricklet_port – Typ: char, Wertebereich: ['a' bis 'b'] baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:	e_code – Typ: int

Setzt die Baudrate eines spezifischen Bricklet Ports .

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe imu_get_spitfp_error_count()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe imu_set_spitfp_baudrate_config()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Neu in Version 2.3.3 (Firmware).

int imu_get_spitfp_baudrate(IMU *imu, char bricklet_port, uint32_t *ret_baudrate)¶

Parameter:	imu – Typ: IMU * bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	ret_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:	e_code – Typ: int

Gibt die Baudrate für einen Bricklet Port zurück, siehe imu_set_spitfp_baudrate().

Neu in Version 2.3.3 (Firmware).

int imu_get_spitfp_error_count(IMU *imu, char bricklet_port, 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 – Typ: IMU * bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

int imu_enable_status_led(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

int imu_disable_status_led(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

int imu_is_status_led_enabled(IMU *imu, bool *ret_enabled)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

Neu in Version 2.3.1 (Firmware).

int imu_get_chip_temperature(IMU *imu, int16_t *ret_temperature)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1/10 °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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int imu_reset(IMU *imu)¶

Parameter:	imu – Typ: IMU *
Rückgabe:	e_code – Typ: int

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

int imu_get_identity(IMU *imu, 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 – Typ: IMU *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['0' bis '8'] 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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

Konfigurationsfunktionen für Callbacks¶

void imu_register_callback(IMU *imu, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	imu – Typ: IMU * 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_set_acceleration_period(IMU *imu, uint32_t period)¶

Parameter:	imu – Typ: IMU * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_get_acceleration_period(IMU *imu, uint32_t *ret_period)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_set_magnetic_field_period(IMU *imu, uint32_t period)¶

Parameter:	imu – Typ: IMU * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_get_magnetic_field_period(IMU *imu, uint32_t *ret_period)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_set_angular_velocity_period(IMU *imu, uint32_t period)¶

Parameter:	imu – Typ: IMU * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_get_angular_velocity_period(IMU *imu, uint32_t *ret_period)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_set_all_data_period(IMU *imu, uint32_t period)¶

Parameter:	imu – Typ: IMU * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_get_all_data_period(IMU *imu, uint32_t *ret_period)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_set_orientation_period(IMU *imu, uint32_t period)¶

Parameter:	imu – Typ: IMU * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_get_orientation_period(IMU *imu, uint32_t *ret_period)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_set_quaternion_period(IMU *imu, uint32_t period)¶

Parameter:	imu – Typ: IMU * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int imu_get_quaternion_period(IMU *imu, uint32_t *ret_period)¶

Parameter:	imu – Typ: IMU *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der imu_register_callback() Funktion durchgeführt werden:

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

imu_register_callback(&imu,
                      IMU_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_CALLBACK_ACCELERATION¶

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

Callback-Parameter:	x – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] y – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] z – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] user_data – Typ: void *

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

IMU_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/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] y – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] z – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] user_data – Typ: void *

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

IMU_CALLBACK_ANGULAR_VELOCITY¶

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

Callback-Parameter:	x – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] y – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] z – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] user_data – Typ: void *

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

IMU_CALLBACK_ALL_DATA¶

void callback(int16_t acc_x, int16_t acc_y, int16_t acc_z, int16_t mag_x, int16_t mag_y, int16_t mag_z, int16_t ang_x, int16_t ang_y, int16_t ang_z, int16_t temperature, void *user_data)

Callback-Parameter:

acc_x – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
acc_y – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
acc_z – Typ: int16_t, Einheit: 1/1000 gₙ, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
mag_x – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
mag_y – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
mag_z – Typ: int16_t, Einheit: 1/10 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
ang_x – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
ang_y – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
ang_z – Typ: int16_t, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]
temperature – Typ: int16_t, Einheit: 1/100 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit imu_set_all_data_period(), ausgelöst. Die Parameter sind die Beschleunigungen, Magnetfeldkomponenten und die Winkelgeschwindigkeiten der X, Y und Z-Achse sowie die Temperatur des IMU Brick.

IMU_CALLBACK_ORIENTATION¶

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

Callback-Parameter:	roll – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] pitch – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] yaw – Typ: int16_t, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] user_data – Typ: void *

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

IMU_CALLBACK_QUATERNION¶

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

Callback-Parameter:	x – Typ: float, Wertebereich: [-1.0f bis 1.0f] y – Typ: float, Wertebereich: [-1.0f bis 1.0f] z – Typ: float, Wertebereich: [-1.0f bis 1.0f] w – Typ: float, Wertebereich: [-1.0f bis 1.0f] user_data – Typ: void *

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

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_get_api_version(IMU *imu, uint8_t ret_api_version[3])¶

Parameter:	imu – Typ: IMU *
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_get_response_expected(IMU *imu, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	imu – Typ: IMU * 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_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_FUNCTION_LEDS_ON = 8
IMU_FUNCTION_LEDS_OFF = 9
IMU_FUNCTION_SET_ACCELERATION_RANGE = 11
IMU_FUNCTION_SET_MAGNETOMETER_RANGE = 13
IMU_FUNCTION_SET_CONVERGENCE_SPEED = 15
IMU_FUNCTION_SET_CALIBRATION = 17
IMU_FUNCTION_SET_ACCELERATION_PERIOD = 19
IMU_FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 21
IMU_FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 23
IMU_FUNCTION_SET_ALL_DATA_PERIOD = 25
IMU_FUNCTION_SET_ORIENTATION_PERIOD = 27
IMU_FUNCTION_SET_QUATERNION_PERIOD = 29
IMU_FUNCTION_ORIENTATION_CALCULATION_ON = 37
IMU_FUNCTION_ORIENTATION_CALCULATION_OFF = 38
IMU_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
IMU_FUNCTION_SET_SPITFP_BAUDRATE = 234
IMU_FUNCTION_ENABLE_STATUS_LED = 238
IMU_FUNCTION_DISABLE_STATUS_LED = 239
IMU_FUNCTION_RESET = 243
IMU_FUNCTION_WRITE_BRICKLET_PLUGIN = 246

int imu_set_response_expected(IMU *imu, uint8_t function_id, bool response_expected)¶

Parameter:	imu – Typ: IMU * 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_FUNCTION_LEDS_ON = 8
IMU_FUNCTION_LEDS_OFF = 9
IMU_FUNCTION_SET_ACCELERATION_RANGE = 11
IMU_FUNCTION_SET_MAGNETOMETER_RANGE = 13
IMU_FUNCTION_SET_CONVERGENCE_SPEED = 15
IMU_FUNCTION_SET_CALIBRATION = 17
IMU_FUNCTION_SET_ACCELERATION_PERIOD = 19
IMU_FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 21
IMU_FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 23
IMU_FUNCTION_SET_ALL_DATA_PERIOD = 25
IMU_FUNCTION_SET_ORIENTATION_PERIOD = 27
IMU_FUNCTION_SET_QUATERNION_PERIOD = 29
IMU_FUNCTION_ORIENTATION_CALCULATION_ON = 37
IMU_FUNCTION_ORIENTATION_CALCULATION_OFF = 38
IMU_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
IMU_FUNCTION_SET_SPITFP_BAUDRATE = 234
IMU_FUNCTION_ENABLE_STATUS_LED = 238
IMU_FUNCTION_DISABLE_STATUS_LED = 239
IMU_FUNCTION_RESET = 243
IMU_FUNCTION_WRITE_BRICKLET_PLUGIN = 246

int imu_set_response_expected_all(IMU *imu, bool response_expected)¶

Parameter:	imu – Typ: IMU * 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_get_protocol1_bricklet_name(IMU *imu, char port, uint8_t *ret_protocol_version, uint8_t ret_firmware_version[3], char ret_name[40])¶

Parameter:	imu – Typ: IMU * port – Typ: char, Wertebereich: ['a' bis 'b']
Ausgabeparameter:	ret_protocol_version – 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_name – Typ: char[40]
Rückgabe:	e_code – Typ: int

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

int imu_write_bricklet_plugin(IMU *imu, char port, uint8_t offset, uint8_t chunk[32])¶

Parameter:	imu – Typ: IMU * port – Typ: char, Wertebereich: ['a' bis 'b'] offset – Typ: uint8_t, Wertebereich: [0 bis 255] chunk – Typ: uint8_t[32], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

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

int imu_read_bricklet_plugin(IMU *imu, char port, uint8_t offset, uint8_t ret_chunk[32])¶

Parameter:	imu – Typ: IMU * port – Typ: char, Wertebereich: ['a' bis 'b'] offset – Typ: uint8_t, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_chunk – Typ: uint8_t[32], Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

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

Konstanten¶

IMU_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen IMU Brick zu identifizieren.

Die imu_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_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines IMU Brick dar.