Dies ist die Beschreibung der C/C++ API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Accelerometer Bricklet
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Accelerometer a;
accelerometer_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
int16_t x, y, z;
if(accelerometer_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/1000.0);
printf("Acceleration [Y]: %f g\n", y/1000.0);
printf("Acceleration [Z]: %f g\n", z/1000.0);
printf("Press key to exit\n");
getchar();
accelerometer_destroy(&a);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
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 51 52 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_accelerometer.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Accelerometer Bricklet
// Callback function for acceleration callback
void cb_acceleration(int16_t x, int16_t y, int16_t z, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Acceleration [X]: %f g\n", x/1000.0);
printf("Acceleration [Y]: %f g\n", y/1000.0);
printf("Acceleration [Z]: %f g\n", z/1000.0);
printf("\n");
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Accelerometer a;
accelerometer_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_register_callback(&a,
ACCELEROMETER_CALLBACK_ACCELERATION,
(void (*)(void))cb_acceleration,
NULL);
// Set period for acceleration callback to 1s (1000ms)
// Note: The acceleration callback is only called every second
// if the acceleration has changed since the last call!
accelerometer_set_acceleration_callback_period(&a, 1000);
printf("Press key to exit\n");
getchar();
accelerometer_destroy(&a);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
Download (example_threshold.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 51 52 53 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_accelerometer.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Accelerometer Bricklet
// Callback function for acceleration reached callback
void cb_acceleration_reached(int16_t x, int16_t y, int16_t z, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Acceleration [X]: %f g\n", x/1000.0);
printf("Acceleration [Y]: %f g\n", y/1000.0);
printf("Acceleration [Z]: %f g\n", z/1000.0);
printf("\n");
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Accelerometer a;
accelerometer_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 threshold callbacks with a debounce time of 10 seconds (10000ms)
accelerometer_set_debounce_period(&a, 10000);
// Register acceleration reached callback to function cb_acceleration_reached
accelerometer_register_callback(&a,
ACCELEROMETER_CALLBACK_ACCELERATION_REACHED,
(void (*)(void))cb_acceleration_reached,
NULL);
// Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
accelerometer_set_acceleration_callback_threshold(&a, '>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
printf("Press key to exit\n");
getchar();
accelerometer_destroy(&a);
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
return 0;
}
|
Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code
)
zurück. Vom Gerät zurückgegebene Daten werden, wenn eine
Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter
sind mit dem ret_
Präfix gekennzeichnet.
Mögliche Fehlercodes sind:
wie in ip_connection.h
definiert.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
accelerometer_create
(Accelerometer *accelerometer, const char *uid, IPConnection *ipcon)¶Parameter: |
|
---|
Erzeugt ein Geräteobjekt accelerometer
mit der eindeutigen Geräte ID uid
und
fügt es der IP Connection ipcon
hinzu:
Accelerometer accelerometer;
accelerometer_create(&accelerometer, "YOUR_DEVICE_UID", &ipcon);
Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.
accelerometer_destroy
(Accelerometer *accelerometer)¶Parameter: |
|
---|
Entfernt das Geräteobjekt accelerometer
von dessen IP Connection und zerstört es.
Das Geräteobjekt kann hiernach nicht mehr verwendet werden.
accelerometer_get_acceleration
(Accelerometer *accelerometer, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/1000 (1gₙ = 9,80665m/s²). Der Wertebereich
wird mit accelerometer_set_configuration()
konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen
den ACCELEROMETER_CALLBACK_ACCELERATION
Callback zu nutzen und die Periode mit
accelerometer_set_acceleration_callback_period()
vorzugeben.
accelerometer_get_temperature
(Accelerometer *accelerometer, int16_t *ret_temperature)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Temperatur des Beschleunigungssensors zurück.
accelerometer_led_on
(Accelerometer *accelerometer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert die LED auf dem Bricklet.
accelerometer_led_off
(Accelerometer *accelerometer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Deaktiviert die LED auf dem Bricklet.
accelerometer_is_led_on
(Accelerometer *accelerometer, bool *ret_on)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
accelerometer_set_configuration
(Accelerometer *accelerometer, uint8_t data_rate, uint8_t full_scale, uint8_t filter_bandwidth)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:
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:
Für full_scale:
Für filter_bandwidth:
accelerometer_get_configuration
(Accelerometer *accelerometer, uint8_t *ret_data_rate, uint8_t *ret_full_scale, uint8_t *ret_filter_bandwidth)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Konfiguration zurück, wie von accelerometer_set_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_data_rate:
Für ret_full_scale:
Für ret_filter_bandwidth:
accelerometer_get_identity
(Accelerometer *accelerometer, 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: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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.
accelerometer_register_callback
(Accelerometer *accelerometer, int16_t callback_id, void (*function)(void), void *user_data)¶Parameter: |
|
---|
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.
accelerometer_set_acceleration_callback_period
(Accelerometer *accelerometer, uint32_t period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der ACCELEROMETER_CALLBACK_ACCELERATION
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der ACCELEROMETER_CALLBACK_ACCELERATION
Callback wird nur ausgelöst, wenn sich die Acceleration
seit der letzten Auslösung geändert hat.
accelerometer_get_acceleration_callback_period
(Accelerometer *accelerometer, uint32_t *ret_period)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Periode zurück, wie von accelerometer_set_acceleration_callback_period()
gesetzt.
accelerometer_set_acceleration_callback_threshold
(Accelerometer *accelerometer, char option, int16_t min_x, int16_t max_x, int16_t min_y, int16_t max_y, int16_t min_z, int16_t max_z)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den ACCELEROMETER_CALLBACK_ACCELERATION_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
accelerometer_get_acceleration_callback_threshold
(Accelerometer *accelerometer, char *ret_option, int16_t *ret_min_x, int16_t *ret_max_x, int16_t *ret_min_y, int16_t *ret_max_y, int16_t *ret_min_z, int16_t *ret_max_z)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt den Schwellwert zurück, wie von accelerometer_set_acceleration_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für ret_option:
accelerometer_set_debounce_period
(Accelerometer *accelerometer, uint32_t debounce)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
accelerometer_get_debounce_period
(Accelerometer *accelerometer, uint32_t *ret_debounce)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Entprellperiode zurück, wie von accelerometer_set_debounce_period()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten
vom Gerät zu erhalten. Die Registrierung kann mit der accelerometer_register_callback()
Funktion durchgeführt werden:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } accelerometer_register_callback(&accelerometer, ACCELEROMETER_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_CALLBACK_ACCELERATION
¶void callback(int16_t x, int16_t y, int16_t z, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
accelerometer_set_acceleration_callback_period()
, ausgelöst. Die Parameter
sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit accelerometer_set_configuration()
konfiguriert.
Der ACCELEROMETER_CALLBACK_ACCELERATION
Callback wird nur ausgelöst, wenn sich die Beschleunigung
seit der letzten Auslösung geändert hat.
ACCELEROMETER_CALLBACK_ACCELERATION_REACHED
¶void callback(int16_t x, int16_t y, int16_t z, void *user_data)
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
accelerometer_set_acceleration_callback_threshold()
gesetzt, erreicht wird.
Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit accelerometer_set_configuration()
konfiguriert.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit accelerometer_set_debounce_period()
gesetzt, ausgelöst.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
accelerometer_get_api_version
(Accelerometer *accelerometer, uint8_t ret_api_version[3])¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
accelerometer_get_response_expected
(Accelerometer *accelerometer, uint8_t function_id, bool *ret_response_expected)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Rückgabe: |
|
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_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_set_response_expected
(Accelerometer *accelerometer, uint8_t function_id, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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_set_response_expected_all
(Accelerometer *accelerometer, bool response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
ACCELEROMETER_DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Accelerometer Bricklet zu identifizieren.
Die accelerometer_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_DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.