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

C/C++ für Mikrocontroller - Accelerometer Bricklet 2.0¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer 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).

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_accelerometer_v2.h"

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

static TF_AccelerometerV2 a;

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

    // Get current acceleration
    int32_t x, y, z;
    check(tf_accelerometer_v2_get_acceleration(&a, &x, &y, &z), "get acceleration");

    tf_hal_printf("Acceleration [X]: %d 1/%d g\n", x, 10000);
    tf_hal_printf("Acceleration [Y]: %d 1/%d g\n", y, 10000);
    tf_hal_printf("Acceleration [Z]: %d 1/%d g\n", z, 10000);
}

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_accelerometer_v2.h"

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

// Callback function for acceleration callback
static void acceleration_handler(TF_AccelerometerV2 *device, int32_t x, int32_t y,
                                 int32_t z, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Acceleration [X]: %d 1/%d g\n", x, 10000);
    tf_hal_printf("Acceleration [Y]: %d 1/%d g\n", y, 10000);
    tf_hal_printf("Acceleration [Z]: %d 1/%d g\n", z, 10000);
    tf_hal_printf("\n");
}

static TF_AccelerometerV2 a;

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

    // Register acceleration callback to function acceleration_handler
    tf_accelerometer_v2_register_acceleration_callback(&a,
                                                       acceleration_handler,
                                                       NULL);

    // Set period for acceleration callback to 1s (1000ms)
    tf_accelerometer_v2_set_acceleration_callback_configuration(&a, 1000, false);
}

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

API¶

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

Mögliche Fehlercodes sind:

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

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

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

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

Grundfunktionen¶

int tf_accelerometer_v2_create(TF_AccelerometerV2 *accelerometer_v2, const char *uid, TF_HAL *hal)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

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

TF_AccelerometerV2 accelerometer_v2;
tf_accelerometer_v2_create(&accelerometer_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_accelerometer_v2_destroy(TF_AccelerometerV2 *accelerometer_v2)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
Rückgabe:	e_code – Typ: int

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

int tf_accelerometer_v2_get_acceleration(TF_AccelerometerV2 *accelerometer_v2, int32_t *ret_x, int32_t *ret_y, int32_t *ret_z)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
Ausgabeparameter:	ret_x – Typ: int32_t, Einheit: 1/10000 gₙ, Wertebereich: ? ret_y – Typ: int32_t, Einheit: 1/10000 gₙ, Wertebereich: ? ret_z – Typ: int32_t, Einheit: 1/10000 gₙ, Wertebereich: ?
Rückgabe:	e_code – Typ: int

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/10000 (1gₙ = 9,80665m/s²). Der Wertebereich wird mit tf_accelerometer_v2_set_configuration() konfiguriert.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den Acceleration Callback zu nutzen und die Periode mit tf_accelerometer_v2_set_acceleration_callback_configuration() vorzugeben.

int tf_accelerometer_v2_set_configuration(TF_AccelerometerV2 *accelerometer_v2, uint8_t data_rate, uint8_t full_scale)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 7 full_scale – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert die Datenrate und den Wertebereich. Mögliche Konfigurationswerte sind:

Datenrate zwischen 0,781Hz und 25600Hz.
Wertebereich von ±2g bis zu ±8g.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

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

Für data_rate:

TF_ACCELEROMETER_V2_DATA_RATE_0_781HZ = 0
TF_ACCELEROMETER_V2_DATA_RATE_1_563HZ = 1
TF_ACCELEROMETER_V2_DATA_RATE_3_125HZ = 2
TF_ACCELEROMETER_V2_DATA_RATE_6_2512HZ = 3
TF_ACCELEROMETER_V2_DATA_RATE_12_5HZ = 4
TF_ACCELEROMETER_V2_DATA_RATE_25HZ = 5
TF_ACCELEROMETER_V2_DATA_RATE_50HZ = 6
TF_ACCELEROMETER_V2_DATA_RATE_100HZ = 7
TF_ACCELEROMETER_V2_DATA_RATE_200HZ = 8
TF_ACCELEROMETER_V2_DATA_RATE_400HZ = 9
TF_ACCELEROMETER_V2_DATA_RATE_800HZ = 10
TF_ACCELEROMETER_V2_DATA_RATE_1600HZ = 11
TF_ACCELEROMETER_V2_DATA_RATE_3200HZ = 12
TF_ACCELEROMETER_V2_DATA_RATE_6400HZ = 13
TF_ACCELEROMETER_V2_DATA_RATE_12800HZ = 14
TF_ACCELEROMETER_V2_DATA_RATE_25600HZ = 15

Für full_scale:

TF_ACCELEROMETER_V2_FULL_SCALE_2G = 0
TF_ACCELEROMETER_V2_FULL_SCALE_4G = 1
TF_ACCELEROMETER_V2_FULL_SCALE_8G = 2

int tf_accelerometer_v2_get_configuration(TF_AccelerometerV2 *accelerometer_v2, uint8_t *ret_data_rate, uint8_t *ret_full_scale)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
Ausgabeparameter:	ret_data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 7 ret_full_scale – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_data_rate:

TF_ACCELEROMETER_V2_DATA_RATE_0_781HZ = 0
TF_ACCELEROMETER_V2_DATA_RATE_1_563HZ = 1
TF_ACCELEROMETER_V2_DATA_RATE_3_125HZ = 2
TF_ACCELEROMETER_V2_DATA_RATE_6_2512HZ = 3
TF_ACCELEROMETER_V2_DATA_RATE_12_5HZ = 4
TF_ACCELEROMETER_V2_DATA_RATE_25HZ = 5
TF_ACCELEROMETER_V2_DATA_RATE_50HZ = 6
TF_ACCELEROMETER_V2_DATA_RATE_100HZ = 7
TF_ACCELEROMETER_V2_DATA_RATE_200HZ = 8
TF_ACCELEROMETER_V2_DATA_RATE_400HZ = 9
TF_ACCELEROMETER_V2_DATA_RATE_800HZ = 10
TF_ACCELEROMETER_V2_DATA_RATE_1600HZ = 11
TF_ACCELEROMETER_V2_DATA_RATE_3200HZ = 12
TF_ACCELEROMETER_V2_DATA_RATE_6400HZ = 13
TF_ACCELEROMETER_V2_DATA_RATE_12800HZ = 14
TF_ACCELEROMETER_V2_DATA_RATE_25600HZ = 15

Für ret_full_scale:

TF_ACCELEROMETER_V2_FULL_SCALE_2G = 0
TF_ACCELEROMETER_V2_FULL_SCALE_4G = 1
TF_ACCELEROMETER_V2_FULL_SCALE_8G = 2

int tf_accelerometer_v2_set_info_led_config(TF_AccelerometerV2 *accelerometer_v2, uint8_t config)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

Für config:

TF_ACCELEROMETER_V2_INFO_LED_CONFIG_OFF = 0
TF_ACCELEROMETER_V2_INFO_LED_CONFIG_ON = 1
TF_ACCELEROMETER_V2_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

int tf_accelerometer_v2_get_info_led_config(TF_AccelerometerV2 *accelerometer_v2, uint8_t *ret_config)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die LED-Konfiguration zurück, wie von tf_accelerometer_v2_set_info_led_config() gesetzt.

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

Für ret_config:

TF_ACCELEROMETER_V2_INFO_LED_CONFIG_OFF = 0
TF_ACCELEROMETER_V2_INFO_LED_CONFIG_ON = 1
TF_ACCELEROMETER_V2_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

Fortgeschrittene Funktionen¶

int tf_accelerometer_v2_set_filter_configuration(TF_AccelerometerV2 *accelerometer_v2, uint8_t iir_bypass, uint8_t low_pass_filter)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * iir_bypass – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 low_pass_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert den IIR Bypass Filter Modus und die Grenzfrequenz des Tiefpassfilters.

Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe oder ein Neuntel der Ausgabe-Datenrate sein.

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

Für iir_bypass:

TF_ACCELEROMETER_V2_IIR_BYPASS_APPLIED = 0
TF_ACCELEROMETER_V2_IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

TF_ACCELEROMETER_V2_LOW_PASS_FILTER_NINTH = 0
TF_ACCELEROMETER_V2_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

int tf_accelerometer_v2_get_filter_configuration(TF_AccelerometerV2 *accelerometer_v2, uint8_t *ret_iir_bypass, uint8_t *ret_low_pass_filter)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
Ausgabeparameter:	ret_iir_bypass – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_low_pass_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_iir_bypass:

TF_ACCELEROMETER_V2_IIR_BYPASS_APPLIED = 0
TF_ACCELEROMETER_V2_IIR_BYPASS_BYPASSED = 1

Für ret_low_pass_filter:

TF_ACCELEROMETER_V2_LOW_PASS_FILTER_NINTH = 0
TF_ACCELEROMETER_V2_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

int tf_accelerometer_v2_get_spitfp_error_count(TF_AccelerometerV2 *accelerometer_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:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_accelerometer_v2_set_status_led_config(TF_AccelerometerV2 *accelerometer_v2, uint8_t config)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_ACCELEROMETER_V2_STATUS_LED_CONFIG_OFF = 0
TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_ON = 1
TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_accelerometer_v2_get_status_led_config(TF_AccelerometerV2 *accelerometer_v2, uint8_t *ret_config)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_accelerometer_v2_set_status_led_config() gesetzt.

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

Für ret_config:

TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_OFF = 0
TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_ON = 1
TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_accelerometer_v2_get_chip_temperature(TF_AccelerometerV2 *accelerometer_v2, int16_t *ret_temperature)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_accelerometer_v2_reset(TF_AccelerometerV2 *accelerometer_v2)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_accelerometer_v2_get_identity(TF_AccelerometerV2 *accelerometer_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:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_accelerometer_v2_set_acceleration_callback_configuration(TF_AccelerometerV2 *accelerometer_v2, uint32_t period, bool value_has_to_change)¶

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

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

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

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

Wenn dieser Callback aktiviert ist, werden der Continuous Acceleration 16 Bit Callback und Continuous Acceleration 8 Bit Callback automatisch deaktiviert.

int tf_accelerometer_v2_get_acceleration_callback_configuration(TF_AccelerometerV2 *accelerometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_accelerometer_v2_set_acceleration_callback_configuration() gesetzt.

int tf_accelerometer_v2_set_continuous_acceleration_configuration(TF_AccelerometerV2 *accelerometer_v2, bool enable_x, bool enable_y, bool enable_z, uint8_t resolution)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * enable_x – Typ: bool, Standardwert: false enable_y – Typ: bool, Standardwert: false enable_z – Typ: bool, Standardwert: false resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die Continuous Acceleration 16 Bit oder Continuous Acceleration 8 Bit Callbacks genutzt werden.

Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.

Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung, wird der Continuous Acceleration 8 Bit-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der Continuous Acceleration 16 Bit-Callback aktiviert.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von tf_accelerometer_v2_get_acceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem eingestellten Wertebereich (siehe tf_accelerometer_v2_set_configuration()):

16-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
16-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
16-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024

Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:

8-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
8-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
8-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024

Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der "Continuous Callbacks" genutzt wird, wird der Acceleration-Callback automatisch deaktiviert.

Der maximale Durchsatz hängt von der Konfiguration ab:

Anzahl aktiviert Achsen	Durchsatz 8-Bit	Durchsatz 16-Bit
1	25600Hz	25600Hz
2	25600Hz	15000Hz
3	20000Hz	10000Hz

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

Für resolution:

TF_ACCELEROMETER_V2_RESOLUTION_8BIT = 0
TF_ACCELEROMETER_V2_RESOLUTION_16BIT = 1

int tf_accelerometer_v2_get_continuous_acceleration_configuration(TF_AccelerometerV2 *accelerometer_v2, bool *ret_enable_x, bool *ret_enable_y, bool *ret_enable_z, uint8_t *ret_resolution)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
Ausgabeparameter:	ret_enable_x – Typ: bool, Standardwert: false ret_enable_y – Typ: bool, Standardwert: false ret_enable_z – Typ: bool, Standardwert: false ret_resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels tf_accelerometer_v2_set_continuous_acceleration_configuration() gesetzt.

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

Für ret_resolution:

TF_ACCELEROMETER_V2_RESOLUTION_8BIT = 0
TF_ACCELEROMETER_V2_RESOLUTION_16BIT = 1

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_accelerometer_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_accelerometer_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_accelerometer_v2_register_acceleration_callback(TF_AccelerometerV2 *accelerometer_v2, TF_AccelerometerV2_AccelerationHandler handler, void *user_data)¶

void handler(TF_AccelerometerV2 *accelerometer_v2, int32_t x, int32_t y, int32_t z, void *user_data)

Callback-Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * x – Typ: int32_t, Einheit: 1/10000 gₙ, Wertebereich: ? y – Typ: int32_t, Einheit: 1/10000 gₙ, Wertebereich: ? z – Typ: int32_t, Einheit: 1/10000 gₙ, Wertebereich: ? user_data – Typ: void *

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

Die Parameter sind die gleichen wie tf_accelerometer_v2_get_acceleration().

int tf_accelerometer_v2_register_continuous_acceleration_16_bit_callback(TF_AccelerometerV2 *accelerometer_v2, TF_AccelerometerV2_ContinuousAcceleration16BitHandler handler, void *user_data)¶

void handler(TF_AccelerometerV2 *accelerometer_v2, int16_t acceleration[30], void *user_data)

Callback-Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * acceleration – Typ: int16_t[30], Einheit: ? gₙ, Wertebereich: ? user_data – Typ: void *

Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate kann mit der Funktion tf_accelerometer_v2_set_configuration() eingestellt werden und der Callback kann per tf_accelerometer_v2_set_continuous_acceleration_configuration() aktiviert werden.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von tf_accelerometer_v2_get_acceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe tf_accelerometer_v2_set_configuration()):

Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

x, y, z aktiviert: "x, y, z, ..." 10x wiederholt
x, z aktiviert: "x, z, ..." 15x wiederholt
y aktiviert: "y, ..." 30x wiederholt

int tf_accelerometer_v2_register_continuous_acceleration_8_bit_callback(TF_AccelerometerV2 *accelerometer_v2, TF_AccelerometerV2_ContinuousAcceleration8BitHandler handler, void *user_data)¶

void handler(TF_AccelerometerV2 *accelerometer_v2, int8_t acceleration[60], void *user_data)

Callback-Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * acceleration – Typ: int8_t[60], Einheit: ? gₙ, Wertebereich: ? user_data – Typ: void *

Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate kann mit der Funktion tf_accelerometer_v2_set_configuration() eingestellt werden und der Callback kann per tf_accelerometer_v2_set_continuous_acceleration_configuration() aktiviert werden.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von tf_accelerometer_v2_get_acceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe tf_accelerometer_v2_set_configuration()):

Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

x, y, z aktiviert: "x, y, z, ..." 20x wiederholt
x, z aktiviert: "x, z, ..." 30x wiederholt
y aktiviert: "y, ..." 60x wiederholt

Virtuelle Funktionen¶

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

int tf_accelerometer_v2_get_response_expected(TF_AccelerometerV2 *accelerometer_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_accelerometer_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_ACCELEROMETER_V2_FUNCTION_SET_CONFIGURATION = 2
TF_ACCELEROMETER_V2_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
TF_ACCELEROMETER_V2_FUNCTION_SET_INFO_LED_CONFIG = 6
TF_ACCELEROMETER_V2_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
TF_ACCELEROMETER_V2_FUNCTION_SET_FILTER_CONFIGURATION = 13
TF_ACCELEROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_ACCELEROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_ACCELEROMETER_V2_FUNCTION_RESET = 243
TF_ACCELEROMETER_V2_FUNCTION_WRITE_UID = 248

int tf_accelerometer_v2_set_response_expected(TF_AccelerometerV2 *accelerometer_v2, uint8_t function_id, bool response_expected)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_ACCELEROMETER_V2_FUNCTION_SET_CONFIGURATION = 2
TF_ACCELEROMETER_V2_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
TF_ACCELEROMETER_V2_FUNCTION_SET_INFO_LED_CONFIG = 6
TF_ACCELEROMETER_V2_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
TF_ACCELEROMETER_V2_FUNCTION_SET_FILTER_CONFIGURATION = 13
TF_ACCELEROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_ACCELEROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_ACCELEROMETER_V2_FUNCTION_RESET = 243
TF_ACCELEROMETER_V2_FUNCTION_WRITE_UID = 248

int tf_accelerometer_v2_set_response_expected_all(TF_AccelerometerV2 *accelerometer_v2, bool response_expected)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_accelerometer_v2_set_bootloader_mode(TF_AccelerometerV2 *accelerometer_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_ACCELEROMETER_V2_BOOTLOADER_STATUS_OK = 0
TF_ACCELEROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_ACCELEROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_ACCELEROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_ACCELEROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_ACCELEROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_accelerometer_v2_get_bootloader_mode(TF_AccelerometerV2 *accelerometer_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

TF_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_accelerometer_v2_set_write_firmware_pointer(TF_AccelerometerV2 *accelerometer_v2, uint32_t pointer)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_accelerometer_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_accelerometer_v2_write_firmware(TF_AccelerometerV2 *accelerometer_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_accelerometer_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_accelerometer_v2_write_uid(TF_AccelerometerV2 *accelerometer_v2, uint32_t uid)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 * 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_accelerometer_v2_read_uid(TF_AccelerometerV2 *accelerometer_v2, uint32_t *ret_uid)¶

Parameter:	accelerometer_v2 – Typ: TF_AccelerometerV2 *
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_ACCELEROMETER_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Accelerometer Bricklet 2.0 zu identifizieren.

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

TF_ACCELEROMETER_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.