C/C++ - Accelerometer Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_accelerometer_v2.h"

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

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

    // Create device object
    AccelerometerV2 a;
    accelerometer_v2_create(&a, UID, &ipcon);

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

    // Get current acceleration
    int32_t x, y, z;
    if(accelerometer_v2_get_acceleration(&a, &x, &y, &z) < 0) {
        fprintf(stderr, "Could not get acceleration, probably timeout\n");
        return 1;
    }

    printf("Acceleration [X]: %f g\n", x/10000.0);
    printf("Acceleration [Y]: %f g\n", y/10000.0);
    printf("Acceleration [Z]: %f g\n", z/10000.0);

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

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_accelerometer_v2.h"

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

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

    printf("Acceleration [X]: %f g\n", x/10000.0);
    printf("Acceleration [Y]: %f g\n", y/10000.0);
    printf("Acceleration [Z]: %f g\n", z/10000.0);
    printf("\n");
}

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

    // Create device object
    AccelerometerV2 a;
    accelerometer_v2_create(&a, UID, &ipcon);

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

    // Register acceleration callback to function cb_acceleration
    accelerometer_v2_register_callback(&a,
                                       ACCELEROMETER_V2_CALLBACK_ACCELERATION,
                                       (void (*)(void))cb_acceleration,
                                       NULL);

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

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

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void accelerometer_v2_create(AccelerometerV2 *accelerometer_v2, const char *uid, IPConnection *ipcon)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

AccelerometerV2 accelerometer_v2;
accelerometer_v2_create(&accelerometer_v2, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void accelerometer_v2_destroy(AccelerometerV2 *accelerometer_v2)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *

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

int accelerometer_v2_get_acceleration(AccelerometerV2 *accelerometer_v2, int32_t *ret_x, int32_t *ret_y, int32_t *ret_z)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_x – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_y – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_z – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_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²), nicht zu verwechseln mit Gramm.

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

int accelerometer_v2_set_configuration(AccelerometerV2 *accelerometer_v2, uint8_t data_rate, uint8_t full_scale)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • full_scale – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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 Standardwerte sind 100Hz Datenrate und ±2g Wertebereich.

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

Für data_rate:

  • ACCELEROMETER_V2_DATA_RATE_0_781HZ = 0
  • ACCELEROMETER_V2_DATA_RATE_1_563HZ = 1
  • ACCELEROMETER_V2_DATA_RATE_3_125HZ = 2
  • ACCELEROMETER_V2_DATA_RATE_6_2512HZ = 3
  • ACCELEROMETER_V2_DATA_RATE_12_5HZ = 4
  • ACCELEROMETER_V2_DATA_RATE_25HZ = 5
  • ACCELEROMETER_V2_DATA_RATE_50HZ = 6
  • ACCELEROMETER_V2_DATA_RATE_100HZ = 7
  • ACCELEROMETER_V2_DATA_RATE_200HZ = 8
  • ACCELEROMETER_V2_DATA_RATE_400HZ = 9
  • ACCELEROMETER_V2_DATA_RATE_800HZ = 10
  • ACCELEROMETER_V2_DATA_RATE_1600HZ = 11
  • ACCELEROMETER_V2_DATA_RATE_3200HZ = 12
  • ACCELEROMETER_V2_DATA_RATE_6400HZ = 13
  • ACCELEROMETER_V2_DATA_RATE_12800HZ = 14
  • ACCELEROMETER_V2_DATA_RATE_25600HZ = 15

Für full_scale:

  • ACCELEROMETER_V2_FULL_SCALE_2G = 0
  • ACCELEROMETER_V2_FULL_SCALE_4G = 1
  • ACCELEROMETER_V2_FULL_SCALE_8G = 2
int accelerometer_v2_get_configuration(AccelerometerV2 *accelerometer_v2, uint8_t *ret_data_rate, uint8_t *ret_full_scale)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_data_rate – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_full_scale – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_data_rate:

  • ACCELEROMETER_V2_DATA_RATE_0_781HZ = 0
  • ACCELEROMETER_V2_DATA_RATE_1_563HZ = 1
  • ACCELEROMETER_V2_DATA_RATE_3_125HZ = 2
  • ACCELEROMETER_V2_DATA_RATE_6_2512HZ = 3
  • ACCELEROMETER_V2_DATA_RATE_12_5HZ = 4
  • ACCELEROMETER_V2_DATA_RATE_25HZ = 5
  • ACCELEROMETER_V2_DATA_RATE_50HZ = 6
  • ACCELEROMETER_V2_DATA_RATE_100HZ = 7
  • ACCELEROMETER_V2_DATA_RATE_200HZ = 8
  • ACCELEROMETER_V2_DATA_RATE_400HZ = 9
  • ACCELEROMETER_V2_DATA_RATE_800HZ = 10
  • ACCELEROMETER_V2_DATA_RATE_1600HZ = 11
  • ACCELEROMETER_V2_DATA_RATE_3200HZ = 12
  • ACCELEROMETER_V2_DATA_RATE_6400HZ = 13
  • ACCELEROMETER_V2_DATA_RATE_12800HZ = 14
  • ACCELEROMETER_V2_DATA_RATE_25600HZ = 15

Für ret_full_scale:

  • ACCELEROMETER_V2_FULL_SCALE_2G = 0
  • ACCELEROMETER_V2_FULL_SCALE_4G = 1
  • ACCELEROMETER_V2_FULL_SCALE_8G = 2
int accelerometer_v2_set_info_led_config(AccelerometerV2 *accelerometer_v2, uint8_t config)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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:

  • ACCELEROMETER_V2_INFO_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_INFO_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
int accelerometer_v2_get_info_led_config(AccelerometerV2 *accelerometer_v2, uint8_t *ret_config)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • ACCELEROMETER_V2_INFO_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_INFO_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
int accelerometer_v2_set_continuous_acceleration_configuration(AccelerometerV2 *accelerometer_v2, bool enable_x, bool enable_y, bool enable_z, uint8_t resolution)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • enable_x – Typ: bool
  • enable_y – Typ: bool
  • enable_z – Typ: bool
  • resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die ACCELEROMETER_V2_CALLBACK_CONTINUOUS_ACCELERATION_16_BIT oder ACCELEROMETER_V2_CALLBACK_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 ACCELEROMETER_V2_CALLBACK_CONTINUOUS_ACCELERATION_8_BIT-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der ACCELEROMETER_V2_CALLBACK_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 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 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 ACCELEROMETER_V2_CALLBACK_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:

  • ACCELEROMETER_V2_RESOLUTION_8BIT = 0
  • ACCELEROMETER_V2_RESOLUTION_16BIT = 1
int accelerometer_v2_get_continuous_acceleration_configuration(AccelerometerV2 *accelerometer_v2, bool *ret_enable_x, bool *ret_enable_y, bool *ret_enable_z, uint8_t *ret_resolution)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_enable_x – Typ: bool
  • ret_enable_y – Typ: bool
  • ret_enable_z – Typ: bool
  • ret_resolution – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_resolution:

  • ACCELEROMETER_V2_RESOLUTION_8BIT = 0
  • ACCELEROMETER_V2_RESOLUTION_16BIT = 1

Fortgeschrittene Funktionen

int accelerometer_v2_set_filter_configuration(AccelerometerV2 *accelerometer_v2, uint8_t iir_bypass, uint8_t low_pass_filter)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • iir_bypass – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • low_pass_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Konfiguriert den IIR Bypass Filter Modus und die Low Pass Filter Roll Off Corner Frequenz.

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

Accelerometer filter

Standardmäßig wird der Filter angewendet und die Frequenz ist ein Neuntel der Ausgabe-Datenrate.

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

Für iir_bypass:

  • ACCELEROMETER_V2_IIR_BYPASS_APPLIED = 0
  • ACCELEROMETER_V2_IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

  • ACCELEROMETER_V2_LOW_PASS_FILTER_NINTH = 0
  • ACCELEROMETER_V2_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

int accelerometer_v2_get_filter_configuration(AccelerometerV2 *accelerometer_v2, uint8_t *ret_iir_bypass, uint8_t *ret_low_pass_filter)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_iir_bypass – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_low_pass_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_iir_bypass:

  • ACCELEROMETER_V2_IIR_BYPASS_APPLIED = 0
  • ACCELEROMETER_V2_IIR_BYPASS_BYPASSED = 1

Für ret_low_pass_filter:

  • ACCELEROMETER_V2_LOW_PASS_FILTER_NINTH = 0
  • ACCELEROMETER_V2_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

int accelerometer_v2_get_api_version(AccelerometerV2 *accelerometer_v2, uint8_t ret_api_version[3])
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int accelerometer_v2_get_response_expected(AccelerometerV2 *accelerometer_v2, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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 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:

  • ACCELEROMETER_V2_FUNCTION_SET_CONFIGURATION = 2
  • ACCELEROMETER_V2_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • ACCELEROMETER_V2_FUNCTION_SET_INFO_LED_CONFIG = 6
  • ACCELEROMETER_V2_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • ACCELEROMETER_V2_FUNCTION_SET_FILTER_CONFIGURATION = 13
  • ACCELEROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ACCELEROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ACCELEROMETER_V2_FUNCTION_RESET = 243
  • ACCELEROMETER_V2_FUNCTION_WRITE_UID = 248
int accelerometer_v2_set_response_expected(AccelerometerV2 *accelerometer_v2, uint8_t function_id, bool response_expected)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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.

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:

  • ACCELEROMETER_V2_FUNCTION_SET_CONFIGURATION = 2
  • ACCELEROMETER_V2_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • ACCELEROMETER_V2_FUNCTION_SET_INFO_LED_CONFIG = 6
  • ACCELEROMETER_V2_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • ACCELEROMETER_V2_FUNCTION_SET_FILTER_CONFIGURATION = 13
  • ACCELEROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ACCELEROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ACCELEROMETER_V2_FUNCTION_RESET = 243
  • ACCELEROMETER_V2_FUNCTION_WRITE_UID = 248
int accelerometer_v2_set_response_expected_all(AccelerometerV2 *accelerometer_v2, bool response_expected)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

int accelerometer_v2_get_spitfp_error_count(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: AccelerometerV2 *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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 accelerometer_v2_set_bootloader_mode(AccelerometerV2 *accelerometer_v2, uint8_t mode, uint8_t *ret_status)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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 Bootlodaer- 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:

  • ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • ACCELEROMETER_V2_BOOTLOADER_STATUS_OK = 0
  • ACCELEROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • ACCELEROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • ACCELEROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • ACCELEROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • ACCELEROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int accelerometer_v2_get_bootloader_mode(AccelerometerV2 *accelerometer_v2, uint8_t *ret_mode)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int accelerometer_v2_set_write_firmware_pointer(AccelerometerV2 *accelerometer_v2, uint32_t pointer)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • pointer – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für 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 accelerometer_v2_write_firmware(AccelerometerV2 *accelerometer_v2, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von 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 accelerometer_v2_set_status_led_config(AccelerometerV2 *accelerometer_v2, uint8_t config)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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:

  • ACCELEROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int accelerometer_v2_get_status_led_config(AccelerometerV2 *accelerometer_v2, uint8_t *ret_config)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • ACCELEROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • ACCELEROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int accelerometer_v2_get_chip_temperature(AccelerometerV2 *accelerometer_v2, int16_t *ret_temperature)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Temperatur in °C, 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 accelerometer_v2_reset(AccelerometerV2 *accelerometer_v2)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Rückgabe:
  • error_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 accelerometer_v2_write_uid(AccelerometerV2 *accelerometer_v2, uint32_t uid)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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 accelerometer_v2_read_uid(AccelerometerV2 *accelerometer_v2, uint32_t *ret_uid)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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.

int accelerometer_v2_get_identity(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: AccelerometerV2 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_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 kann 'a', 'b', 'c' oder 'd' sein.

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

Konfigurationsfunktionen für Callbacks

void accelerometer_v2_register_callback(AccelerometerV2 *accelerometer_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

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

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

int accelerometer_v2_set_acceleration_callback_configuration(AccelerometerV2 *accelerometer_v2, uint32_t period, bool value_has_to_change)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

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

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

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

Wenn dieser Callback aktiviert ist, werden der ACCELEROMETER_V2_CALLBACK_CONTINUOUS_ACCELERATION_16_BIT Callback und ACCELEROMETER_V2_CALLBACK_CONTINUOUS_ACCELERATION_8_BIT Callback automatisch deaktiviert.

int accelerometer_v2_get_acceleration_callback_configuration(AccelerometerV2 *accelerometer_v2, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameter:
  • accelerometer_v2 – Typ: AccelerometerV2 *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

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

Callbacks

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

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

accelerometer_v2_register_callback(&accelerometer_v2, ACCELEROMETER_V2_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

ACCELEROMETER_V2_CALLBACK_ACCELERATION
void callback(int32_t x, int32_t y, int32_t z, void *user_data)
Callback-Parameter:
  • x – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • y – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • z – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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

Die Parameter sind der gleiche wie accelerometer_v2_get_acceleration().

ACCELEROMETER_V2_CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
void callback(int16_t acceleration[30], void *user_data)
Callback-Parameter:
  • acceleration – Typ: int16_t[30], Wertebereich: [-215 bis 215 - 1]
  • user_data – Typ: void *

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

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 accelerometer_v2_get_acceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe 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 ..., x, y, z"
  • x, z aktiviert: "x, z, ... 15x ..., x, z"
  • y aktiviert: "y, ... 30x ..., y"
ACCELEROMETER_V2_CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
void callback(int8_t acceleration[60], void *user_data)
Callback-Parameter:
  • acceleration – Typ: int8_t[60], Wertebereich: [-128 bis 127]
  • user_data – Typ: void *

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

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 accelerometer_v2_get_acceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe 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 ..., x, y, z"
  • x, z aktiviert: "x, z, ... 30x ..., x, z"
  • y aktiviert: "y, ... 60x ..., y"

Konstanten

ACCELEROMETER_V2_DEVICE_IDENTIFIER

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

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

ACCELEROMETER_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.