Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Hall Effect Bricklet 2.0

C/C++ für Mikrocontroller - Hall Effect Bricklet 2.0¶

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

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Counter¶

Download (example_counter.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_hall_effect_v2.h"

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

static TF_HallEffectV2 he;

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

    // Get current count without counter reset
    uint32_t count;
    check(tf_hall_effect_v2_get_counter(&he, false,
                                        &count), "get count without counter reset");

    tf_hal_printf("Count: %I32u\n", count);
}

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

Magnetic Flux Density¶

Download (example_magnetic_flux_density.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_hall_effect_v2.h"

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

static TF_HallEffectV2 he;

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

    // Get current Magnetic Flux Density
    int16_t magnetic_flux_density;
    check(tf_hall_effect_v2_get_magnetic_flux_density(&he,
                                                      &magnetic_flux_density), "get Magnetic Flux Density");

    tf_hal_printf("Magnetic Flux Density: %I16d µT\n", magnetic_flux_density);
}

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

Counter Callback¶

Download (example_counter_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_hall_effect_v2.h"

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

// Callback function for counter callback
static void counter_handler(TF_HallEffectV2 *device, uint32_t counter, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Counter: %I32u\n", counter);
}

static TF_HallEffectV2 he;

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

    // Configure counter with ±3000µT threshold and 10ms debounce
    check(tf_hall_effect_v2_set_counter_config(&he, 3000, -3000,
                                               10000), "call set_counter_config");

    // Register counter callback to function counter_handler
    tf_hall_effect_v2_register_counter_callback(&he,
                                                counter_handler,
                                                NULL);

    // Set period for counter callback to 0.1s (100ms)
    tf_hall_effect_v2_set_counter_callback_configuration(&he, 100, true);
}

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_hall_effect_v2_create(TF_HallEffectV2 *hall_effect_v2, const char *uid, TF_HAL *hal)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_HallEffectV2 hall_effect_v2;
tf_hall_effect_v2_create(&hall_effect_v2, 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_hall_effect_v2_destroy(TF_HallEffectV2 *hall_effect_v2)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
Rückgabe:	e_code – Typ: int

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

int tf_hall_effect_v2_get_magnetic_flux_density(TF_HallEffectV2 *hall_effect_v2, int16_t *ret_magnetic_flux_density)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
Ausgabeparameter:	ret_magnetic_flux_density – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-7000 bis 7000]
Rückgabe:	e_code – Typ: int

Gibt die magnetische Flussdichte (magnetische Induktion) 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_hall_effect_v2_set_magnetic_flux_density_callback_configuration() konfiguriert.

int tf_hall_effect_v2_get_counter(TF_HallEffectV2 *hall_effect_v2, bool reset_counter, uint32_t *ret_count)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * reset_counter – Typ: bool
Ausgabeparameter:	ret_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Wert des Zählers zurück.

Die Schwellwerte (low/high) und Entprellzeit können per tf_hall_effect_v2_set_counter_config() eingestellt werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem Auslesen auf 0 zurückgesetzt.

Wenn der Zähler periodisch benötigt wird, kann auch der Counter Callback verwendet werden. Der Callback wird mit der Funktion tf_hall_effect_v2_set_counter_callback_configuration() konfiguriert.

int tf_hall_effect_v2_set_counter_config(TF_HallEffectV2 *hall_effect_v2, int16_t high_threshold, int16_t low_threshold, uint32_t debounce)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * high_threshold – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 2000 low_threshold – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: -2000 debounce – Typ: uint32_t, Einheit: 1 µs, Wertebereich: [0 bis 1000000], Standardwert: 100000
Rückgabe:	e_code – Typ: int

Setzt einen unteren und einen oberen Schwellwert (threshold) sowie eine Entprellzeit (debounce).

Wenn die gemessene magnetische Flussdichte über den oberen Schwellwert oder unter den unteren Schwellwert wandert, wird der Zählerstand des Zählers (siehe tf_hall_effect_v2_get_counter()) um 1 erhöht.

Die Entprellzeit ist die Minimalzeit zwischen zwei Zählererhöhungen.

int tf_hall_effect_v2_get_counter_config(TF_HallEffectV2 *hall_effect_v2, int16_t *ret_high_threshold, int16_t *ret_low_threshold, uint32_t *ret_debounce)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
Ausgabeparameter:	ret_high_threshold – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 2000 ret_low_threshold – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: -2000 ret_debounce – Typ: uint32_t, Einheit: 1 µs, Wertebereich: [0 bis 1000000], Standardwert: 100000
Rückgabe:	e_code – Typ: int

Gibt die Zähler-Konfiguration zurück, wie von tf_hall_effect_v2_set_counter_config() gesetzt.

Fortgeschrittene Funktionen¶

int tf_hall_effect_v2_get_spitfp_error_count(TF_HallEffectV2 *hall_effect_v2, 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:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_hall_effect_v2_set_status_led_config(TF_HallEffectV2 *hall_effect_v2, uint8_t config)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_HALL_EFFECT_V2_STATUS_LED_CONFIG_OFF = 0
TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_ON = 1
TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_hall_effect_v2_get_status_led_config(TF_HallEffectV2 *hall_effect_v2, uint8_t *ret_config)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_hall_effect_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_OFF = 0
TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_ON = 1
TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_hall_effect_v2_get_chip_temperature(TF_HallEffectV2 *hall_effect_v2, int16_t *ret_temperature)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_hall_effect_v2_reset(TF_HallEffectV2 *hall_effect_v2)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_hall_effect_v2_get_identity(TF_HallEffectV2 *hall_effect_v2, 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:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_hall_effect_v2_set_magnetic_flux_density_callback_configuration(TF_HallEffectV2 *hall_effect_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)¶

Parameter:

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

hall_effect_v2 – Typ: TF_HallEffectV2 *
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 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
max – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

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.

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 Magnetic Flux Density 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_HALL_EFFECT_V2_THRESHOLD_OPTION_OFF = 'x'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_hall_effect_v2_get_magnetic_flux_density_callback_configuration(TF_HallEffectV2 *hall_effect_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 ret_max – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_option:

TF_HALL_EFFECT_V2_THRESHOLD_OPTION_OFF = 'x'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_HALL_EFFECT_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_hall_effect_v2_set_counter_callback_configuration(TF_HallEffectV2 *hall_effect_v2, uint32_t period, bool value_has_to_change)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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 Counter 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

int tf_hall_effect_v2_get_counter_callback_configuration(TF_HallEffectV2 *hall_effect_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_hall_effect_v2_set_counter_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_hall_effect_v2_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_hall_effect_v2_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_hall_effect_v2_register_magnetic_flux_density_callback(TF_HallEffectV2 *hall_effect_v2, TF_HallEffectV2_MagneticFluxDensityHandler handler, void *user_data)¶

void handler(TF_HallEffectV2 *hall_effect_v2, int16_t magnetic_flux_density, void *user_data)

Callback-Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * magnetic_flux_density – Typ: int16_t, Einheit: 1 µT, Wertebereich: [-7000 bis 7000] user_data – Typ: void *

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

Der Parameter ist der gleiche wie tf_hall_effect_v2_get_magnetic_flux_density().

int tf_hall_effect_v2_register_counter_callback(TF_HallEffectV2 *hall_effect_v2, TF_HallEffectV2_CounterHandler handler, void *user_data)¶

void handler(TF_HallEffectV2 *hall_effect_v2, uint32_t count, void *user_data)

Callback-Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

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

Der Zählerstand ist der gleiche, der auch per tf_hall_effect_v2_get_counter() abgefragt werden kann.

Virtuelle Funktionen¶

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

int tf_hall_effect_v2_get_response_expected(TF_HallEffectV2 *hall_effect_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_hall_effect_v2_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_HALL_EFFECT_V2_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
TF_HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CONFIG = 6
TF_HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
TF_HALL_EFFECT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_HALL_EFFECT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_HALL_EFFECT_V2_FUNCTION_RESET = 243
TF_HALL_EFFECT_V2_FUNCTION_WRITE_UID = 248

int tf_hall_effect_v2_set_response_expected(TF_HallEffectV2 *hall_effect_v2, uint8_t function_id, bool response_expected)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_HALL_EFFECT_V2_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
TF_HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CONFIG = 6
TF_HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
TF_HALL_EFFECT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_HALL_EFFECT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_HALL_EFFECT_V2_FUNCTION_RESET = 243
TF_HALL_EFFECT_V2_FUNCTION_WRITE_UID = 248

int tf_hall_effect_v2_set_response_expected_all(TF_HallEffectV2 *hall_effect_v2, bool response_expected)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_hall_effect_v2_set_bootloader_mode(TF_HallEffectV2 *hall_effect_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_HALL_EFFECT_V2_BOOTLOADER_STATUS_OK = 0
TF_HALL_EFFECT_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_HALL_EFFECT_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_HALL_EFFECT_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_HALL_EFFECT_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_HALL_EFFECT_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_hall_effect_v2_get_bootloader_mode(TF_HallEffectV2 *hall_effect_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_hall_effect_v2_set_write_firmware_pointer(TF_HallEffectV2 *hall_effect_v2, uint32_t pointer)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_hall_effect_v2_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_hall_effect_v2_write_firmware(TF_HallEffectV2 *hall_effect_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_hall_effect_v2_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_hall_effect_v2_write_uid(TF_HallEffectV2 *hall_effect_v2, uint32_t uid)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 * 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_hall_effect_v2_read_uid(TF_HallEffectV2 *hall_effect_v2, uint32_t *ret_uid)¶

Parameter:	hall_effect_v2 – Typ: TF_HallEffectV2 *
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_HALL_EFFECT_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Hall Effect Bricklet 2.0 zu identifizieren.

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

TF_HALL_EFFECT_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet 2.0 dar.