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

C/C++ für Mikrocontroller - Compass Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das Compass Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Compass Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

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

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

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

static TF_Compass c;

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

    // Get current heading
    int16_t heading;
    check(tf_compass_get_heading(&c, &heading), "get heading");

    tf_hal_printf("Heading: %d 1/%d °\n", heading, 10);
}

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

Callback¶

Download (example_callback.c)

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

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

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

// Callback function for heading callback
static void heading_handler(TF_Compass *device, int16_t heading, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Heading: %d 1/%d °\n", heading, 10);
}

static TF_Compass c;

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

    // Register heading callback to function heading_handler
    tf_compass_register_heading_callback(&c,
                                         heading_handler,
                                         NULL);

    // Set period for heading callback to 0.1s (100ms) without a threshold
    tf_compass_set_heading_callback_configuration(&c, 100, false, 'x', 0, 0);
}

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

API¶

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

Mögliche Fehlercodes sind:

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

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

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

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

Grundfunktionen¶

int tf_compass_create(TF_Compass *compass, const char *uid, TF_HAL *hal)¶

Parameter:	compass – Typ: TF_Compass * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_Compass compass;
tf_compass_create(&compass, NULL, &ipcon);

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

int tf_compass_destroy(TF_Compass *compass)¶

Parameter:	compass – Typ: TF_Compass *
Rückgabe:	e_code – Typ: int

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

int tf_compass_get_heading(TF_Compass *compass, int16_t *ret_heading)¶

Parameter:	compass – Typ: TF_Compass *
Ausgabeparameter:	ret_heading – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [0 bis 3600]
Rückgabe:	e_code – Typ: int

Gibt die Richtung zurück (Norden = 0 Grad, Osten = 90 Grad).

Alternativ kann die Funktion tf_compass_get_magnetic_flux_density() genutzt werden um die Richtung per heading = atan2(y, x) * 180 / PI zu bestimmen.

Wenn der Wert periodisch benötigt wird, kann auch der Heading Callback verwendet werden. Der Callback wird mit der Funktion tf_compass_set_heading_callback_configuration() konfiguriert.

int tf_compass_get_magnetic_flux_density(TF_Compass *compass, int32_t *ret_x, int32_t *ret_y, int32_t *ret_z)¶

Parameter:	compass – Typ: TF_Compass *
Ausgabeparameter:	ret_x – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] ret_y – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] ret_z – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]
Rückgabe:	e_code – Typ: int

Gibt die magnetische Flussdichte (magnetische Induktion) für alle drei Achsen zurück.

Wenn der Wert periodisch benötigt wird, kann auch der Magnetic Flux Density Callback verwendet werden. Der Callback wird mit der Funktion tf_compass_set_magnetic_flux_density_callback_configuration() konfiguriert.

int tf_compass_set_configuration(TF_Compass *compass, uint8_t data_rate, bool background_calibration)¶

Parameter:	compass – Typ: TF_Compass * data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 background_calibration – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Konfiguriert die Datenrate und Hintergrundkalibrierung:

Data Rate: Setzt die Datenrate des eingesetzten Magnetometers. Je niedriger die Datenrate ist, desto weniger Rauschen befindet sich auf den Daten.
Background Calibration: Aktiviert die automatische Hintergrundkalibrierung, wenn auf true gesetzt. Wenn die Hintergrundkalibrierung aktiviert ist, ändert das Bricklet einmal pro Sekunde die Erfassungspolarität, um damit automatisch temperaturabhängige Offsets zu entfernen. Das Ändern der Polarität dauert ungefähr 20ms. Daher werden einmal pro Sekunde für 20ms keine neuen Daten generiert, wenn die Kalibrierung aktiviert ist. Wir empfehlen die Kalibrierung nur zu deaktivieren, falls diese 20ms Auszeit ein großes Problem in der Anwendung des Bricklets darstellen.

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

Für data_rate:

TF_COMPASS_DATA_RATE_100HZ = 0
TF_COMPASS_DATA_RATE_200HZ = 1
TF_COMPASS_DATA_RATE_400HZ = 2
TF_COMPASS_DATA_RATE_600HZ = 3

int tf_compass_get_configuration(TF_Compass *compass, uint8_t *ret_data_rate, bool *ret_background_calibration)¶

Parameter:	compass – Typ: TF_Compass *
Ausgabeparameter:	ret_data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_background_calibration – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

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

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

Für ret_data_rate:

TF_COMPASS_DATA_RATE_100HZ = 0
TF_COMPASS_DATA_RATE_200HZ = 1
TF_COMPASS_DATA_RATE_400HZ = 2
TF_COMPASS_DATA_RATE_600HZ = 3

Fortgeschrittene Funktionen¶

int tf_compass_set_calibration(TF_Compass *compass, const int16_t offset[3], const int16_t gain[3])¶

Parameter:

Parameter:	compass – Typ: TF_Compass * offset – Typ: const int16_t[3] 0: x – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 1: y – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 2: z – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] gain – Typ: const int16_t[3] 0: x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 1: y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 2: z – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

compass – Typ: TF_Compass *
offset – Typ: const int16_t[3]

0: x – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
1: y – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
2: z – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

gain – Typ: const int16_t[3]

0: x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
1: y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
2: z – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Rückgabe:

e_code – Typ: int

Setzt Offset und Gain für alle drei Achsen.

Das Bricklet ist ab Werk kalibriert. Wenn eine Rekalibrierung durchgeführt werden soll, empfehlen wir dafür den Brick Viewer zu nutzen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal durchgeführt werden.

int tf_compass_get_calibration(TF_Compass *compass, int16_t ret_offset[3], int16_t ret_gain[3])¶

Parameter:	compass – Typ: TF_Compass *
Ausgabeparameter:	ret_offset – Typ: int16_t[3] 0: x – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 1: y – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 2: z – Typ: int16_t, Einheit: 1/100 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_gain – Typ: int16_t[3] 0: x – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 1: y – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] 2: z – Typ: int16_t, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

Gibt die Kalibrierungsparameter zurück, wie von tf_compass_set_calibration() gesetzt.

int tf_compass_get_spitfp_error_count(TF_Compass *compass, 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:	compass – Typ: TF_Compass *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int tf_compass_set_status_led_config(TF_Compass *compass, uint8_t config)¶

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

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

TF_COMPASS_STATUS_LED_CONFIG_OFF = 0
TF_COMPASS_STATUS_LED_CONFIG_ON = 1
TF_COMPASS_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_COMPASS_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_compass_get_status_led_config(TF_Compass *compass, uint8_t *ret_config)¶

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

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

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

Für ret_config:

TF_COMPASS_STATUS_LED_CONFIG_OFF = 0
TF_COMPASS_STATUS_LED_CONFIG_ON = 1
TF_COMPASS_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_COMPASS_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_compass_get_chip_temperature(TF_Compass *compass, int16_t *ret_temperature)¶

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

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

int tf_compass_reset(TF_Compass *compass)¶

Parameter:	compass – Typ: TF_Compass *
Rückgabe:	e_code – Typ: int

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

int tf_compass_get_identity(TF_Compass *compass, 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:	compass – Typ: TF_Compass *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks¶

int tf_compass_set_heading_callback_configuration(TF_Compass *compass, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)¶

Parameter:

Parameter:	compass – Typ: TF_Compass * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

compass – Typ: TF_Compass *
period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
value_has_to_change – Typ: bool, Standardwert: false
option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
max – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Rückgabe:

e_code – Typ: int

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den Heading Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

TF_COMPASS_THRESHOLD_OPTION_OFF = 'x'
TF_COMPASS_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_COMPASS_THRESHOLD_OPTION_INSIDE = 'i'
TF_COMPASS_THRESHOLD_OPTION_SMALLER = '<'
TF_COMPASS_THRESHOLD_OPTION_GREATER = '>'

int tf_compass_get_heading_callback_configuration(TF_Compass *compass, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)¶

Parameter:	compass – Typ: TF_Compass *
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 ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' ret_min – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_max – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

TF_COMPASS_THRESHOLD_OPTION_OFF = 'x'
TF_COMPASS_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_COMPASS_THRESHOLD_OPTION_INSIDE = 'i'
TF_COMPASS_THRESHOLD_OPTION_SMALLER = '<'
TF_COMPASS_THRESHOLD_OPTION_GREATER = '>'

int tf_compass_set_magnetic_flux_density_callback_configuration(TF_Compass *compass, uint32_t period, bool value_has_to_change)¶

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

Die Periode ist die Periode mit der der Magnetic Flux Density Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

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

int tf_compass_get_magnetic_flux_density_callback_configuration(TF_Compass *compass, uint32_t *ret_period, bool *ret_value_has_to_change)¶

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

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

Callbacks¶

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

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

Bemerkung

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

Warnung

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

int tf_compass_register_heading_callback(TF_Compass *compass, TF_Compass_HeadingHandler handler, void *user_data)¶

void handler(TF_Compass *compass, int16_t heading, void *user_data)

Callback-Parameter:	compass – Typ: TF_Compass * heading – Typ: int16_t, Einheit: 1/10 °, Wertebereich: [0 bis 3600] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_compass_set_heading_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie tf_compass_get_heading().

int tf_compass_register_magnetic_flux_density_callback(TF_Compass *compass, TF_Compass_MagneticFluxDensityHandler handler, void *user_data)¶

void handler(TF_Compass *compass, int32_t x, int32_t y, int32_t z, void *user_data)

Callback-Parameter:	compass – Typ: TF_Compass * x – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] y – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] z – Typ: int32_t, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_compass_set_magnetic_flux_density_callback_configuration() gesetzten Konfiguration

Die Parameter sind der gleichen wie tf_compass_get_magnetic_flux_density().

Virtuelle Funktionen¶

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

int tf_compass_get_response_expected(TF_Compass *compass, uint8_t function_id, bool *ret_response_expected)¶

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

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

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

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

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

Für function_id:

TF_COMPASS_FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
TF_COMPASS_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
TF_COMPASS_FUNCTION_SET_CONFIGURATION = 9
TF_COMPASS_FUNCTION_SET_CALIBRATION = 11
TF_COMPASS_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_COMPASS_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_COMPASS_FUNCTION_RESET = 243
TF_COMPASS_FUNCTION_WRITE_UID = 248

int tf_compass_set_response_expected(TF_Compass *compass, uint8_t function_id, bool response_expected)¶

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

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

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

Für function_id:

TF_COMPASS_FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
TF_COMPASS_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
TF_COMPASS_FUNCTION_SET_CONFIGURATION = 9
TF_COMPASS_FUNCTION_SET_CALIBRATION = 11
TF_COMPASS_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_COMPASS_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_COMPASS_FUNCTION_RESET = 243
TF_COMPASS_FUNCTION_WRITE_UID = 248

int tf_compass_set_response_expected_all(TF_Compass *compass, bool response_expected)¶

Parameter:	compass – Typ: TF_Compass * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int tf_compass_set_bootloader_mode(TF_Compass *compass, uint8_t mode, uint8_t *ret_status)¶

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

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

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

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

Für mode:

TF_COMPASS_BOOTLOADER_MODE_BOOTLOADER = 0
TF_COMPASS_BOOTLOADER_MODE_FIRMWARE = 1
TF_COMPASS_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_COMPASS_BOOTLOADER_STATUS_OK = 0
TF_COMPASS_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_COMPASS_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_COMPASS_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_COMPASS_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_COMPASS_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_compass_get_bootloader_mode(TF_Compass *compass, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_COMPASS_BOOTLOADER_MODE_BOOTLOADER = 0
TF_COMPASS_BOOTLOADER_MODE_FIRMWARE = 1
TF_COMPASS_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_compass_set_write_firmware_pointer(TF_Compass *compass, uint32_t pointer)¶

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

Setzt den Firmware-Pointer für tf_compass_write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

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

int tf_compass_write_firmware(TF_Compass *compass, const uint8_t data[64], uint8_t *ret_status)¶

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

Schreibt 64 Bytes Firmware an die Position die vorher von tf_compass_set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

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

int tf_compass_write_uid(TF_Compass *compass, uint32_t uid)¶

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

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int tf_compass_read_uid(TF_Compass *compass, uint32_t *ret_uid)¶

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

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

Konstanten¶

TF_COMPASS_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Compass Bricklet zu identifizieren.

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

TF_COMPASS_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Compass Bricklet dar.