This is the description of the C/C++ API bindings for the Accelerometer Bricklet. General information and technical specifications for the Accelerometer Bricklet are summarized in its hardware description.
An installation guide for the C/C++ API bindings is part of their general description.
The example code below is 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;
}
|
Most functions of the C/C++ bindings return an error code (e_code
).
Data returned from the device, when a getter is called,
is handled via output parameters. These parameters are labeled with the
ret_
prefix.
Possible error codes are:
as defined in ip_connection.h
.
All functions listed below are thread-safe.
accelerometer_create
(Accelerometer *accelerometer, const char *uid, IPConnection *ipcon)¶Parameters: |
|
---|
Creates the device object accelerometer
with the unique device ID uid
and adds
it to the IPConnection ipcon
:
Accelerometer accelerometer;
accelerometer_create(&accelerometer, "YOUR_DEVICE_UID", &ipcon);
This device object can be used after the IP connection has been connected.
accelerometer_destroy
(Accelerometer *accelerometer)¶Parameters: |
|
---|
Removes the device object accelerometer
from its IPConnection and destroys it.
The device object cannot be used anymore afterwards.
accelerometer_get_acceleration
(Accelerometer *accelerometer, int16_t *ret_x, int16_t *ret_y, int16_t *ret_z)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the acceleration in x, y and z direction. The values
are given in gₙ/1000 (1gₙ = 9.80665m/s²). The range is
configured with accelerometer_set_configuration()
.
If you want to get the acceleration periodically, it is recommended
to use the ACCELEROMETER_CALLBACK_ACCELERATION
callback and set the period with
accelerometer_set_acceleration_callback_period()
.
accelerometer_get_temperature
(Accelerometer *accelerometer, int16_t *ret_temperature)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the temperature of the accelerometer.
accelerometer_led_on
(Accelerometer *accelerometer)¶Parameters: |
|
---|---|
Returns: |
|
Enables the LED on the Bricklet.
accelerometer_led_off
(Accelerometer *accelerometer)¶Parameters: |
|
---|---|
Returns: |
|
Disables the LED on the Bricklet.
accelerometer_is_led_on
(Accelerometer *accelerometer, bool *ret_on)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns true if the LED is enabled, false otherwise.
accelerometer_set_configuration
(Accelerometer *accelerometer, uint8_t data_rate, uint8_t full_scale, uint8_t filter_bandwidth)¶Parameters: |
|
---|---|
Returns: |
|
Configures the data rate, full scale range and filter bandwidth. Possible values are:
Decreasing data rate or full scale range will also decrease the noise on the data.
The following constants are available for this function:
For data_rate:
For full_scale:
For filter_bandwidth:
accelerometer_get_configuration
(Accelerometer *accelerometer, uint8_t *ret_data_rate, uint8_t *ret_full_scale, uint8_t *ret_filter_bandwidth)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the configuration as set by accelerometer_set_configuration()
.
The following constants are available for this function:
For ret_data_rate:
For ret_full_scale:
For 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)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.
The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
accelerometer_register_callback
(Accelerometer *accelerometer, int16_t callback_id, void (*function)(void), void *user_data)¶Parameters: |
|
---|
Registers the given function
with the given callback_id
. The
user_data
will be passed as the last parameter to the function
.
The available callback IDs with corresponding function signatures are listed below.
accelerometer_set_acceleration_callback_period
(Accelerometer *accelerometer, uint32_t period)¶Parameters: |
|
---|---|
Returns: |
|
Sets the period with which the ACCELEROMETER_CALLBACK_ACCELERATION
callback is triggered
periodically. A value of 0 turns the callback off.
The ACCELEROMETER_CALLBACK_ACCELERATION
callback is only triggered if the acceleration has
changed since the last triggering.
accelerometer_get_acceleration_callback_period
(Accelerometer *accelerometer, uint32_t *ret_period)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the period as set by accelerometer_set_acceleration_callback_period()
.
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)¶Parameters: |
|
---|---|
Returns: |
|
Sets the thresholds for the ACCELEROMETER_CALLBACK_ACCELERATION_REACHED
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the acceleration is outside the min and max values |
'i' | Callback is triggered when the acceleration is inside the min and max values |
'<' | Callback is triggered when the acceleration is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the acceleration is greater than the min value (max is ignored) |
The following constants are available for this function:
For 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)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the threshold as set by accelerometer_set_acceleration_callback_threshold()
.
The following constants are available for this function:
For ret_option:
accelerometer_set_debounce_period
(Accelerometer *accelerometer, uint32_t debounce)¶Parameters: |
|
---|---|
Returns: |
|
Sets the period with which the threshold callback
is triggered, if the threshold
keeps being reached.
accelerometer_get_debounce_period
(Accelerometer *accelerometer, uint32_t *ret_debounce)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the debounce period as set by accelerometer_set_debounce_period()
.
Callbacks can be registered to receive time critical or recurring data from the
device. The registration is done with the accelerometer_register_callback()
function:
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);
The available constants with corresponding function signatures are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
ACCELEROMETER_CALLBACK_ACCELERATION
¶void callback(int16_t x, int16_t y, int16_t z, void *user_data)
Callback Parameters: |
|
---|
This callback is triggered periodically with the period that is set by
accelerometer_set_acceleration_callback_period()
. The parameters are the
X, Y and Z acceleration. The range is
configured with accelerometer_set_configuration()
.
The ACCELEROMETER_CALLBACK_ACCELERATION
callback is only triggered if the acceleration has
changed since the last triggering.
ACCELEROMETER_CALLBACK_ACCELERATION_REACHED
¶void callback(int16_t x, int16_t y, int16_t z, void *user_data)
Callback Parameters: |
|
---|
This callback is triggered when the threshold as set by
accelerometer_set_acceleration_callback_threshold()
is reached.
The parameters are the X, Y and Z acceleration. The range is
configured with accelerometer_set_configuration()
.
If the threshold keeps being reached, the callback is triggered periodically
with the period as set by accelerometer_set_debounce_period()
.
Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.
accelerometer_get_api_version
(Accelerometer *accelerometer, uint8_t ret_api_version[3])¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.
accelerometer_get_response_expected
(Accelerometer *accelerometer, uint8_t function_id, bool *ret_response_expected)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.
For getter functions this is enabled by default and cannot be disabled,
because those functions will always send a response. For callback configuration
functions it is enabled by default too, but can be disabled by
accelerometer_set_response_expected()
. For setter functions it is disabled by default
and can be enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For function_id:
accelerometer_set_response_expected
(Accelerometer *accelerometer, uint8_t function_id, bool response_expected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For function_id:
accelerometer_set_response_expected_all
(Accelerometer *accelerometer, bool response_expected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
ACCELEROMETER_DEVICE_IDENTIFIER
¶This constant is used to identify a Accelerometer Bricklet.
The accelerometer_get_identity()
function and the IPCON_CALLBACK_ENUMERATE
callback of the IP Connection have a device_identifier
parameter to specify
the Brick's or Bricklet's type.
ACCELEROMETER_DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Accelerometer Bricklet.