This is the description of the C/C++ API bindings for the Analog In Bricklet 2.0. General information and technical specifications for the Analog In Bricklet 2.0 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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_analog_in_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Analog In Bricklet 2.0
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
AnalogInV2 ai;
analog_in_v2_create(&ai, 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 voltage
uint16_t voltage;
if(analog_in_v2_get_voltage(&ai, &voltage) < 0) {
fprintf(stderr, "Could not get voltage, probably timeout\n");
return 1;
}
printf("Voltage: %f V\n", voltage/1000.0);
printf("Press key to exit\n");
getchar();
analog_in_v2_destroy(&ai);
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_analog_in_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Analog In Bricklet 2.0
// Callback function for voltage callback
void cb_voltage(uint16_t voltage, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Voltage: %f V\n", voltage/1000.0);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
AnalogInV2 ai;
analog_in_v2_create(&ai, 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 voltage callback to function cb_voltage
analog_in_v2_register_callback(&ai,
ANALOG_IN_V2_CALLBACK_VOLTAGE,
(void (*)(void))cb_voltage,
NULL);
// Set period for voltage callback to 1s (1000ms)
// Note: The voltage callback is only called every second
// if the voltage has changed since the last call!
analog_in_v2_set_voltage_callback_period(&ai, 1000);
printf("Press key to exit\n");
getchar();
analog_in_v2_destroy(&ai);
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_analog_in_v2.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Analog In Bricklet 2.0
// Callback function for voltage reached callback
void cb_voltage_reached(uint16_t voltage, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Voltage: %f V\n", voltage/1000.0);
}
int main(void) {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
AnalogInV2 ai;
analog_in_v2_create(&ai, 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)
analog_in_v2_set_debounce_period(&ai, 10000);
// Register voltage reached callback to function cb_voltage_reached
analog_in_v2_register_callback(&ai,
ANALOG_IN_V2_CALLBACK_VOLTAGE_REACHED,
(void (*)(void))cb_voltage_reached,
NULL);
// Configure threshold for voltage "smaller than 5 V"
analog_in_v2_set_voltage_callback_threshold(&ai, '<', 5*1000, 0);
printf("Press key to exit\n");
getchar();
analog_in_v2_destroy(&ai);
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.
analog_in_v2_create
(AnalogInV2 *analog_in_v2, const char *uid, IPConnection *ipcon)¶Parameters: |
|
---|
Creates the device object analog_in_v2
with the unique device ID uid
and adds
it to the IPConnection ipcon
:
AnalogInV2 analog_in_v2;
analog_in_v2_create(&analog_in_v2, "YOUR_DEVICE_UID", &ipcon);
This device object can be used after the IP connection has been connected.
analog_in_v2_destroy
(AnalogInV2 *analog_in_v2)¶Parameters: |
|
---|
Removes the device object analog_in_v2
from its IPConnection and destroys it.
The device object cannot be used anymore afterwards.
analog_in_v2_get_voltage
(AnalogInV2 *analog_in_v2, uint16_t *ret_voltage)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the measured voltage. The resolution is approximately 10mV.
If you want to get the voltage periodically, it is recommended to use the
ANALOG_IN_V2_CALLBACK_VOLTAGE
callback and set the period with
analog_in_v2_set_voltage_callback_period()
.
analog_in_v2_get_analog_value
(AnalogInV2 *analog_in_v2, uint16_t *ret_value)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the value as read by a 12-bit analog-to-digital converter.
If you want the analog value periodically, it is recommended to use the
ANALOG_IN_V2_CALLBACK_ANALOG_VALUE
callback and set the period with
analog_in_v2_set_analog_value_callback_period()
.
analog_in_v2_set_moving_average
(AnalogInV2 *analog_in_v2, uint8_t average)¶Parameters: |
|
---|---|
Returns: |
|
Sets the length of a moving averaging for the voltage.
Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.
analog_in_v2_get_moving_average
(AnalogInV2 *analog_in_v2, uint8_t *ret_average)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the length of the moving average as set by analog_in_v2_set_moving_average()
.
analog_in_v2_get_identity
(AnalogInV2 *analog_in_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)¶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.
analog_in_v2_register_callback
(AnalogInV2 *analog_in_v2, 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.
analog_in_v2_set_voltage_callback_period
(AnalogInV2 *analog_in_v2, uint32_t period)¶Parameters: |
|
---|---|
Returns: |
|
Sets the period with which the ANALOG_IN_V2_CALLBACK_VOLTAGE
callback is triggered
periodically. A value of 0 turns the callback off.
The ANALOG_IN_V2_CALLBACK_VOLTAGE
callback is only triggered if the voltage has changed since
the last triggering.
analog_in_v2_get_voltage_callback_period
(AnalogInV2 *analog_in_v2, uint32_t *ret_period)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the period as set by analog_in_v2_set_voltage_callback_period()
.
analog_in_v2_set_analog_value_callback_period
(AnalogInV2 *analog_in_v2, uint32_t period)¶Parameters: |
|
---|---|
Returns: |
|
Sets the period with which the ANALOG_IN_V2_CALLBACK_ANALOG_VALUE
callback is triggered
periodically. A value of 0 turns the callback off.
The ANALOG_IN_V2_CALLBACK_ANALOG_VALUE
callback is only triggered if the analog value has
changed since the last triggering.
analog_in_v2_get_analog_value_callback_period
(AnalogInV2 *analog_in_v2, uint32_t *ret_period)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the period as set by analog_in_v2_set_analog_value_callback_period()
.
analog_in_v2_set_voltage_callback_threshold
(AnalogInV2 *analog_in_v2, char option, uint16_t min, uint16_t max)¶Parameters: |
|
---|---|
Returns: |
|
Sets the thresholds for the ANALOG_IN_V2_CALLBACK_VOLTAGE_REACHED
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the voltage is outside the min and max values |
'i' | Callback is triggered when the voltage is inside the min and max values |
'<' | Callback is triggered when the voltage is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the voltage is greater than the min value (max is ignored) |
The following constants are available for this function:
For option:
analog_in_v2_get_voltage_callback_threshold
(AnalogInV2 *analog_in_v2, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the threshold as set by analog_in_v2_set_voltage_callback_threshold()
.
The following constants are available for this function:
For ret_option:
analog_in_v2_set_analog_value_callback_threshold
(AnalogInV2 *analog_in_v2, char option, uint16_t min, uint16_t max)¶Parameters: |
|
---|---|
Returns: |
|
Sets the thresholds for the ANALOG_IN_V2_CALLBACK_ANALOG_VALUE_REACHED
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the analog value is outside the min and max values |
'i' | Callback is triggered when the analog value is inside the min and max values |
'<' | Callback is triggered when the analog value is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the analog value is greater than the min value (max is ignored) |
The following constants are available for this function:
For option:
analog_in_v2_get_analog_value_callback_threshold
(AnalogInV2 *analog_in_v2, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the threshold as set by analog_in_v2_set_analog_value_callback_threshold()
.
The following constants are available for this function:
For ret_option:
analog_in_v2_set_debounce_period
(AnalogInV2 *analog_in_v2, uint32_t debounce)¶Parameters: |
|
---|---|
Returns: |
|
Sets the period with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
analog_in_v2_get_debounce_period
(AnalogInV2 *analog_in_v2, uint32_t *ret_debounce)¶Parameters: |
|
---|---|
Output Parameters: |
|
Returns: |
|
Returns the debounce period as set by analog_in_v2_set_debounce_period()
.
Callbacks can be registered to receive time critical or recurring data from the
device. The registration is done with the analog_in_v2_register_callback()
function:
void my_callback(int value, void *user_data) { printf("Value: %d\n", value); } analog_in_v2_register_callback(&analog_in_v2, ANALOG_IN_V2_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.
ANALOG_IN_V2_CALLBACK_VOLTAGE
¶void callback(uint16_t voltage, void *user_data)
Callback Parameters: |
|
---|
This callback is triggered periodically with the period that is set by
analog_in_v2_set_voltage_callback_period()
. The parameter is the voltage of the
sensor.
Der ANALOG_IN_V2_CALLBACK_VOLTAGE
callback is only triggered if the voltage has changed since
the last triggering.
ANALOG_IN_V2_CALLBACK_ANALOG_VALUE
¶void callback(uint16_t value, void *user_data)
Callback Parameters: |
|
---|
This callback is triggered periodically with the period that is set by
analog_in_v2_set_analog_value_callback_period()
. The parameter is the analog
value of the sensor.
The ANALOG_IN_V2_CALLBACK_ANALOG_VALUE
callback is only triggered if the voltage has changed
since the last triggering.
ANALOG_IN_V2_CALLBACK_VOLTAGE_REACHED
¶void callback(uint16_t voltage, void *user_data)
Callback Parameters: |
|
---|
This callback is triggered when the threshold as set by
analog_in_v2_set_voltage_callback_threshold()
is reached.
The parameter is the voltage of the sensor.
If the threshold keeps being reached, the callback is triggered periodically
with the period as set by analog_in_v2_set_debounce_period()
.
ANALOG_IN_V2_CALLBACK_ANALOG_VALUE_REACHED
¶void callback(uint16_t value, void *user_data)
Callback Parameters: |
|
---|
This callback is triggered when the threshold as set by
analog_in_v2_set_analog_value_callback_threshold()
is reached.
The parameter is the analog value of the sensor.
If the threshold keeps being reached, the callback is triggered periodically
with the period as set by analog_in_v2_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.
analog_in_v2_get_api_version
(AnalogInV2 *analog_in_v2, 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.
analog_in_v2_get_response_expected
(AnalogInV2 *analog_in_v2, 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
analog_in_v2_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:
analog_in_v2_set_response_expected
(AnalogInV2 *analog_in_v2, 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:
analog_in_v2_set_response_expected_all
(AnalogInV2 *analog_in_v2, bool response_expected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
ANALOG_IN_V2_DEVICE_IDENTIFIER
¶This constant is used to identify a Analog In Bricklet 2.0.
The analog_in_v2_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.
ANALOG_IN_V2_DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Analog In Bricklet 2.0.