Software / API Bindings / C/C++ / API Reference and Examples / Bricklets (Discontinued) / Distance US Bricklet

C/C++ - Distance US Bricklet¶

This is the description of the C/C++ API bindings for the Distance US Bricklet. General information and technical specifications for the Distance US Bricklet are summarized in its hardware description.

An installation guide for the C/C++ API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_distance_us.h"

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

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

    // Create device object
    DistanceUS dus;
    distance_us_create(&dus, 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 distance value
    uint16_t distance;
    if(distance_us_get_distance_value(&dus, &distance) < 0) {
        fprintf(stderr, "Could not get distance value, probably timeout\n");
        return 1;
    }

    printf("Distance Value: %u\n", distance);

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_distance_us.h"

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

// Callback function for distance value callback
void cb_distance(uint16_t distance, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Distance Value: %u\n", distance);
}

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

    // Create device object
    DistanceUS dus;
    distance_us_create(&dus, 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 distance value callback to function cb_distance
    distance_us_register_callback(&dus,
                                  DISTANCE_US_CALLBACK_DISTANCE,
                                  (void (*)(void))cb_distance,
                                  NULL);

    // Set period for distance value callback to 0.2s (200ms)
    // Note: The distance value callback is only called every 0.2 seconds
    //       if the distance value has changed since the last call!
    distance_us_set_distance_callback_period(&dus, 200);

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

Threshold¶

Download (example_threshold.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_distance_us.h"

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

// Callback function for distance value reached callback
void cb_distance_reached(uint16_t distance, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Distance Value: %u\n", distance);
}

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

    // Create device object
    DistanceUS dus;
    distance_us_create(&dus, 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)
    distance_us_set_debounce_period(&dus, 10000);

    // Register distance value reached callback to function cb_distance_reached
    distance_us_register_callback(&dus,
                                  DISTANCE_US_CALLBACK_DISTANCE_REACHED,
                                  (void (*)(void))cb_distance_reached,
                                  NULL);

    // Configure threshold for distance value "smaller than 200"
    distance_us_set_distance_callback_threshold(&dus, '<', 200, 0);

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

API¶

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:

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 (unused since C/C++ bindings version 2.0.0)
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
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions¶

void distance_us_create(DistanceUS *distance_us, const char *uid, IPConnection *ipcon)¶

Parameters:	distance_us – Type: DistanceUS * uid – Type: const char * ipcon – Type: IPConnection *

Creates the device object distance_us with the unique device ID uid and adds it to the IPConnection ipcon:

DistanceUS distance_us;
distance_us_create(&distance_us, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected.

void distance_us_destroy(DistanceUS *distance_us)¶

Parameters:	distance_us – Type: DistanceUS *

Removes the device object distance_us from its IPConnection and destroys it. The device object cannot be used anymore afterwards.

int distance_us_get_distance_value(DistanceUS *distance_us, uint16_t *ret_distance)¶

Parameters:	distance_us – Type: DistanceUS *
Output Parameters:	ret_distance – Type: uint16_t, Range: [0 to 2¹² - 1]
Returns:	e_code – Type: int

Returns the current distance value measured by the sensor. A small value corresponds to a small distance, a big value corresponds to a big distance. The relation between the measured distance value and the actual distance is affected by the 5V supply voltage (deviations in the supply voltage result in deviations in the distance values) and is non-linear (resolution is bigger at close range).

If you want to get the distance value periodically, it is recommended to use the DISTANCE_US_CALLBACK_DISTANCE callback and set the period with distance_us_set_distance_callback_period().

Advanced Functions¶

int distance_us_set_moving_average(DistanceUS *distance_us, uint8_t average)¶

Parameters:	distance_us – Type: DistanceUS * average – Type: uint8_t, Range: [0 to 100], Default: 20
Returns:	e_code – Type: int

Sets the length of a moving averaging for the distance value.

Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

int distance_us_get_moving_average(DistanceUS *distance_us, uint8_t *ret_average)¶

Parameters:	distance_us – Type: DistanceUS *
Output Parameters:	ret_average – Type: uint8_t, Range: [0 to 100], Default: 20
Returns:	e_code – Type: int

Returns the length moving average as set by distance_us_set_moving_average().

int distance_us_get_identity(DistanceUS *distance_us, 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:	distance_us – Type: DistanceUS *
Output Parameters:	ret_uid – Type: char[8] ret_connected_uid – Type: char[8] ret_position – Type: char, Range: ['a' to 'h', 'z'] ret_hardware_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255] ret_firmware_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255] ret_device_identifier – Type: uint16_t, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

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.

Callback Configuration Functions¶

void distance_us_register_callback(DistanceUS *distance_us, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameters:	distance_us – Type: DistanceUS * callback_id – Type: int16_t function – Type: void ()(void) user_data* – Type: void *

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.

int distance_us_set_distance_callback_period(DistanceUS *distance_us, uint32_t period)¶

Parameters:	distance_us – Type: DistanceUS * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	e_code – Type: int

Sets the period with which the DISTANCE_US_CALLBACK_DISTANCE callback is triggered periodically. A value of 0 turns the callback off.

Der DISTANCE_US_CALLBACK_DISTANCE callback is only triggered if the distance value has changed since the last triggering.

int distance_us_get_distance_callback_period(DistanceUS *distance_us, uint32_t *ret_period)¶

Parameters:	distance_us – Type: DistanceUS *
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	e_code – Type: int

Returns the period as set by distance_us_set_distance_callback_period().

int distance_us_set_distance_callback_threshold(DistanceUS *distance_us, char option, uint16_t min, uint16_t max)¶

Parameters:	distance_us – Type: DistanceUS * option – Type: char, Range: See constants, Default: 'x' min – Type: uint16_t, Range: [0 to 2¹² - 1] max – Type: uint16_t, Range: [0 to 2¹² - 1]
Returns:	e_code – Type: int

Sets the thresholds for the DISTANCE_US_CALLBACK_DISTANCE_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the distance value is outside the min and max values
'i'	Callback is triggered when the distance value is inside the min and max values
'<'	Callback is triggered when the distance value is smaller than the min value (max is ignored)
'>'	Callback is triggered when the distance value is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

DISTANCE_US_THRESHOLD_OPTION_OFF = 'x'
DISTANCE_US_THRESHOLD_OPTION_OUTSIDE = 'o'
DISTANCE_US_THRESHOLD_OPTION_INSIDE = 'i'
DISTANCE_US_THRESHOLD_OPTION_SMALLER = '<'
DISTANCE_US_THRESHOLD_OPTION_GREATER = '>'

int distance_us_get_distance_callback_threshold(DistanceUS *distance_us, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)¶

Parameters:	distance_us – Type: DistanceUS *
Output Parameters:	ret_option – Type: char, Range: See constants, Default: 'x' ret_min – Type: uint16_t, Range: [0 to 2¹² - 1] ret_max – Type: uint16_t, Range: [0 to 2¹² - 1]
Returns:	e_code – Type: int

Returns the threshold as set by distance_us_set_distance_callback_threshold().

The following constants are available for this function:

For ret_option:

DISTANCE_US_THRESHOLD_OPTION_OFF = 'x'
DISTANCE_US_THRESHOLD_OPTION_OUTSIDE = 'o'
DISTANCE_US_THRESHOLD_OPTION_INSIDE = 'i'
DISTANCE_US_THRESHOLD_OPTION_SMALLER = '<'
DISTANCE_US_THRESHOLD_OPTION_GREATER = '>'

int distance_us_set_debounce_period(DistanceUS *distance_us, uint32_t debounce)¶

Parameters:	distance_us – Type: DistanceUS * debounce – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Returns:	e_code – Type: int

Sets the period with which the threshold callbacks

DISTANCE_US_CALLBACK_DISTANCE_REACHED,

are triggered, if the thresholds

distance_us_set_distance_callback_threshold(),

keep being reached.

int distance_us_get_debounce_period(DistanceUS *distance_us, uint32_t *ret_debounce)¶

Parameters:	distance_us – Type: DistanceUS *
Output Parameters:	ret_debounce – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Returns:	e_code – Type: int

Returns the debounce period as set by distance_us_set_debounce_period().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the distance_us_register_callback() function:

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

distance_us_register_callback(&distance_us,
                              DISTANCE_US_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.

DISTANCE_US_CALLBACK_DISTANCE¶

void callback(uint16_t distance, void *user_data)

Callback Parameters:	distance – Type: uint16_t, Range: [0 to 2¹² - 1] user_data – Type: void *

This callback is triggered periodically with the period that is set by distance_us_set_distance_callback_period(). The parameter is the distance value of the sensor.

The DISTANCE_US_CALLBACK_DISTANCE callback is only triggered if the distance value has changed since the last triggering.

DISTANCE_US_CALLBACK_DISTANCE_REACHED¶

void callback(uint16_t distance, void *user_data)

Callback Parameters:	distance – Type: uint16_t, Range: [0 to 2¹² - 1] user_data – Type: void *

This callback is triggered when the threshold as set by distance_us_set_distance_callback_threshold() is reached. The parameter is the distance value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by distance_us_set_debounce_period().

Virtual Functions¶

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.

int distance_us_get_api_version(DistanceUS *distance_us, uint8_t ret_api_version[3])¶

Parameters:	distance_us – Type: DistanceUS *
Output Parameters:	ret_api_version – Type: uint8_t[3] 0: major – Type: uint8_t, Range: [0 to 255] 1: minor – Type: uint8_t, Range: [0 to 255] 2: revision – Type: uint8_t, Range: [0 to 255]
Returns:	e_code – Type: int

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.

int distance_us_get_response_expected(DistanceUS *distance_us, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	distance_us – Type: DistanceUS * function_id – Type: uint8_t, Range: See constants
Output Parameters:	ret_response_expected – Type: bool
Returns:	e_code – Type: int

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 distance_us_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:

DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
DISTANCE_US_FUNCTION_SET_DEBOUNCE_PERIOD = 6
DISTANCE_US_FUNCTION_SET_MOVING_AVERAGE = 10

int distance_us_set_response_expected(DistanceUS *distance_us, uint8_t function_id, bool response_expected)¶

Parameters:	distance_us – Type: DistanceUS * function_id – Type: uint8_t, Range: See constants response_expected – Type: bool
Returns:	e_code – Type: int

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.

The following constants are available for this function:

For function_id:

DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
DISTANCE_US_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
DISTANCE_US_FUNCTION_SET_DEBOUNCE_PERIOD = 6
DISTANCE_US_FUNCTION_SET_MOVING_AVERAGE = 10

int distance_us_set_response_expected_all(DistanceUS *distance_us, bool response_expected)¶

Parameters:	distance_us – Type: DistanceUS * response_expected – Type: bool
Returns:	e_code – Type: int

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

DISTANCE_US_DEVICE_IDENTIFIER¶

This constant is used to identify a Distance US Bricklet.

The distance_us_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.

DISTANCE_US_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Distance US Bricklet.