This is the description of the C/C++ API bindings for the Line Bricklet. General information and technical specifications for the Line 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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_line.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change to your UID
int main() {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Line line;
line_create(&line, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
exit(1);
}
// Don't use device before ipcon is connected
// Get current reflectivity
uint16_t reflectivity;
if(line_get_reflectivity(&line, &reflectivity) < 0) {
fprintf(stderr, "Could not get value, probably timeout\n");
exit(1);
}
printf("Reflectivity: %d\n", reflectivity);
printf("Press key to exit\n");
getchar();
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
}
|
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_line.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change to your UID
// Callback function for reflectivity
void cb_reflectivity(uint16_t reflectivity, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Reflectivity: %d\n", reflectivity);
}
int main() {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Line line;
line_create(&line, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
exit(1);
}
// Don't use device before ipcon is connected
// Set Period for reflectivity callback to 1s (1000ms)
// Note: The reflectivity callback is only called every second if the
// reflectivity has changed since the last call!
line_set_reflectivity_callback_period(&line, 1000);
// Register reflectivity callback to function cb_reflectivity
line_register_callback(&line,
LINE_CALLBACK_REFLECTIVITY,
(void *)cb_reflectivity,
NULL);
printf("Press key to exit\n");
getchar();
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
}
|
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 | #include <stdio.h>
#include "ip_connection.h"
#include "bricklet_line.h"
#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change to your UID
// Callback for reflectivity greater than 2000
void cb_reached(uint16_t reflectivity, void *user_data) {
(void)user_data; // avoid unused parameter warning
printf("Reflectivity: %d\n", reflectivity);
}
int main() {
// Create IP connection
IPConnection ipcon;
ipcon_create(&ipcon);
// Create device object
Line line;
line_create(&line, UID, &ipcon);
// Connect to brickd
if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
fprintf(stderr, "Could not connect\n");
exit(1);
}
// Don't use device before ipcon is connected
// Get threshold callbacks with a debounce time of 1 seconds (1000ms)
line_set_debounce_period(&line, 1000);
// Register threshold reached callback to function cb_reached
line_register_callback(&line,
LINE_CALLBACK_REFLECTIVITY_REACHED,
(void *)cb_reached,
NULL);
// Configure threshold for "greater than 2000"
line_set_reflectivity_callback_threshold(&line, '>', 2000, 0);
printf("Press key to exit\n");
getchar();
ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
}
|
Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via call by reference. 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.
Creates the device object line with the unique device ID uid and adds it to the IPConnection ipcon:
Line line;
line_create(&line, "YOUR_DEVICE_UID", &ipcon);
This device object can be used after the IP connection has been connected (see examples above).
Removes the device object line from its IPConnection and destroys it. The device object cannot be used anymore afterwards.
Returns the currently measured reflectivity. The reflectivity is a value between 0 (not reflective) and 4095 (very reflective).
Usually black has a low reflectivity while white has a high reflectivity.
If you want to get the reflectivity periodically, it is recommended to use the callback LINE_CALLBACK_REFLECTIVITY and set the period with line_set_reflectivity_callback_period().
Returns the version of the API definition (major, minor, revision) 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.
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 line_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 send and errors are silently ignored, because they cannot be detected.
See line_set_response_expected() for the list of function ID defines available for this function.
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 and callbacks it is always disabled.
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 send and errors are silently ignored, because they cannot be detected.
The following function ID defines are available for this function:
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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' or 'd'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
Registers a callback with ID id to the function callback. The user_data will be given as a parameter of the callback.
The available IDs with corresponding function signatures are listed below.
Sets the period in ms with which the LINE_CALLBACK_REFLECTIVITY callback is triggered periodically. A value of 0 turns the callback off.
LINE_CALLBACK_REFLECTIVITY is only triggered if the reflectivity has changed since the last triggering.
The default value is 0.
Returns the period as set by line_set_reflectivity_callback_period().
Sets the thresholds for the LINE_CALLBACK_REFLECTIVITY_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the reflectivity is outside the min and max values |
'i' | Callback is triggered when the reflectivity is inside the min and max values |
'<' | Callback is triggered when the reflectivity is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the reflectivity is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following defines are available for this function:
Returns the threshold as set by line_set_reflectivity_callback_threshold().
The following defines are available for this function:
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Returns the debounce period as set by line_set_debounce_period().
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the line_register_callback() function. The parameters consist of the device object, the callback ID, the callback function and optional user data:
void my_callback(int p, void *user_data) { printf("parameter: %d\n", p); } line_register_callback(&line, LINE_CALLBACK_EXAMPLE, (void *)my_callback, NULL);
The available constants with corresponding callback 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.
void callback(uint16_t reflectivity, void *user_data)
This callback is triggered periodically with the period that is set by line_set_reflectivity_callback_period(). The parameter is the reflectivity of the sensor.
LINE_CALLBACK_REFLECTIVITY is only triggered if the reflectivity has changed since the last triggering.
void callback(uint16_t reflectivity, void *user_data)
This callback is triggered when the threshold as set by line_set_reflectivity_callback_threshold() is reached. The parameter is the reflectivity of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by line_set_debounce_period().
This constant is used to identify a Line Bricklet.
The line_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.