C/C++ - Voltage/Current Bricklet

This is the description of the C/C++ API bindings for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current 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).

Callback

Download (example_callback.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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_voltage_current.h"

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

// Callback function for current callback
void cb_current(int32_t current, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Current: %f A\n", current/1000.0);
}

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

    // Create device object
    VoltageCurrent vc;
    voltage_current_create(&vc, 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 current callback to function cb_current
    voltage_current_register_callback(&vc,
                                      VOLTAGE_CURRENT_CALLBACK_CURRENT,
                                      (void (*)(void))cb_current,
                                      NULL);

    // Set period for current callback to 1s (1000ms)
    // Note: The current callback is only called every second
    //       if the current has changed since the last call!
    voltage_current_set_current_callback_period(&vc, 1000);

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

Simple

Download (example_simple.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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_voltage_current.h"

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

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

    // Create device object
    VoltageCurrent vc;
    voltage_current_create(&vc, 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
    int32_t voltage;
    if(voltage_current_get_voltage(&vc, &voltage) < 0) {
        fprintf(stderr, "Could not get voltage, probably timeout\n");
        return 1;
    }

    printf("Voltage: %f V\n", voltage/1000.0);

    // Get current current
    int32_t current;
    if(voltage_current_get_current(&vc, &current) < 0) {
        fprintf(stderr, "Could not get current, probably timeout\n");
        return 1;
    }

    printf("Current: %f A\n", current/1000.0);

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

Threshold

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_voltage_current.h"

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

// Callback function for power reached callback
void cb_power_reached(int32_t power, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Power: %f W\n", power/1000.0);
}

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

    // Create device object
    VoltageCurrent vc;
    voltage_current_create(&vc, 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)
    voltage_current_set_debounce_period(&vc, 10000);

    // Register power reached callback to function cb_power_reached
    voltage_current_register_callback(&vc,
                                      VOLTAGE_CURRENT_CALLBACK_POWER_REACHED,
                                      (void (*)(void))cb_power_reached,
                                      NULL);

    // Configure threshold for power "greater than 10 W"
    voltage_current_set_power_callback_threshold(&vc, '>', 10*1000, 0);

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

API

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

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void voltage_current_create(VoltageCurrent *voltage_current, const char *uid, IPConnection *ipcon)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

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

VoltageCurrent voltage_current;
voltage_current_create(&voltage_current, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected (see examples above).

void voltage_current_destroy(VoltageCurrent *voltage_current)
Parameters:
  • voltage_current – Type: VoltageCurrent *

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

int voltage_current_get_current(VoltageCurrent *voltage_current, int32_t *ret_current)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_current – Type: int32_t, Unit: 1 mA, Range: [-20000 to 20000]
Returns:
  • error_code – Type: int

Returns the current.

If you want to get the current periodically, it is recommended to use the VOLTAGE_CURRENT_CALLBACK_CURRENT callback and set the period with voltage_current_set_current_callback_period().

int voltage_current_get_voltage(VoltageCurrent *voltage_current, int32_t *ret_voltage)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_voltage – Type: int32_t, Unit: 1 mV, Range: [0 to 36000]
Returns:
  • error_code – Type: int

Returns the voltage.

If you want to get the voltage periodically, it is recommended to use the VOLTAGE_CURRENT_CALLBACK_VOLTAGE callback and set the period with voltage_current_set_voltage_callback_period().

int voltage_current_get_power(VoltageCurrent *voltage_current, int32_t *ret_power)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_power – Type: int32_t, Unit: 1 mW, Range: [0 to 720000]
Returns:
  • error_code – Type: int

Returns the power.

If you want to get the power periodically, it is recommended to use the VOLTAGE_CURRENT_CALLBACK_POWER callback and set the period with voltage_current_set_power_callback_period().

int voltage_current_set_configuration(VoltageCurrent *voltage_current, uint8_t averaging, uint8_t voltage_conversion_time, uint8_t current_conversion_time)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • averaging – Type: uint8_t, Range: See constants, Default: 3
  • voltage_conversion_time – Type: uint8_t, Range: See constants, Default: 4
  • current_conversion_time – Type: uint8_t, Range: See constants, Default: 4
Returns:
  • error_code – Type: int

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

The following constants are available for this function:

For averaging:

  • VOLTAGE_CURRENT_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_AVERAGING_1024 = 7

For voltage_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

For current_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7
int voltage_current_get_configuration(VoltageCurrent *voltage_current, uint8_t *ret_averaging, uint8_t *ret_voltage_conversion_time, uint8_t *ret_current_conversion_time)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_averaging – Type: uint8_t, Range: See constants, Default: 3
  • ret_voltage_conversion_time – Type: uint8_t, Range: See constants, Default: 4
  • ret_current_conversion_time – Type: uint8_t, Range: See constants, Default: 4
Returns:
  • error_code – Type: int

Returns the configuration as set by voltage_current_set_configuration().

The following constants are available for this function:

For ret_averaging:

  • VOLTAGE_CURRENT_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_AVERAGING_1024 = 7

For ret_voltage_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

For ret_current_conversion_time:

  • VOLTAGE_CURRENT_CONVERSION_TIME_140US = 0
  • VOLTAGE_CURRENT_CONVERSION_TIME_204US = 1
  • VOLTAGE_CURRENT_CONVERSION_TIME_332US = 2
  • VOLTAGE_CURRENT_CONVERSION_TIME_588US = 3
  • VOLTAGE_CURRENT_CONVERSION_TIME_1_1MS = 4
  • VOLTAGE_CURRENT_CONVERSION_TIME_2_116MS = 5
  • VOLTAGE_CURRENT_CONVERSION_TIME_4_156MS = 6
  • VOLTAGE_CURRENT_CONVERSION_TIME_8_244MS = 7

Advanced Functions

int voltage_current_set_calibration(VoltageCurrent *voltage_current, uint16_t gain_multiplier, uint16_t gain_divisor)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • gain_multiplier – Type: uint16_t, Range: [0 to 216 - 1]
  • gain_divisor – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • error_code – Type: int

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

int voltage_current_get_calibration(VoltageCurrent *voltage_current, uint16_t *ret_gain_multiplier, uint16_t *ret_gain_divisor)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_gain_multiplier – Type: uint16_t, Range: [0 to 216 - 1]
  • ret_gain_divisor – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • error_code – Type: int

Returns the calibration as set by voltage_current_set_calibration().

int voltage_current_get_identity(VoltageCurrent *voltage_current, 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:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_uid – Type: char[8]
  • ret_connected_uid – Type: char[8]
  • ret_position – Type: char, Range: ['a' to 'h', 'i', '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 216 - 1]
Returns:
  • error_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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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 voltage_current_register_callback(VoltageCurrent *voltage_current, int16_t callback_id, void (*function)(void), void *user_data)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • 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 voltage_current_set_current_callback_period(VoltageCurrent *voltage_current, uint32_t period)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • error_code – Type: int

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

The VOLTAGE_CURRENT_CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

int voltage_current_get_current_callback_period(VoltageCurrent *voltage_current, uint32_t *ret_period)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the period as set by voltage_current_set_current_callback_period().

int voltage_current_set_voltage_callback_period(VoltageCurrent *voltage_current, uint32_t period)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • error_code – Type: int

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

The VOLTAGE_CURRENT_CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

int voltage_current_get_voltage_callback_period(VoltageCurrent *voltage_current, uint32_t *ret_period)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the period as set by voltage_current_set_voltage_callback_period().

int voltage_current_set_power_callback_period(VoltageCurrent *voltage_current, uint32_t period)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • error_code – Type: int

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

The VOLTAGE_CURRENT_CALLBACK_POWER callback is only triggered if the power has changed since the last triggering.

int voltage_current_get_power_callback_period(VoltageCurrent *voltage_current, uint32_t *ret_period)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the period as set by voltage_current_get_power_callback_period().

int voltage_current_set_current_callback_threshold(VoltageCurrent *voltage_current, char option, int32_t min, int32_t max)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int32_t, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int32_t, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
Returns:
  • error_code – Type: int

Sets the thresholds for the VOLTAGE_CURRENT_CALLBACK_CURRENT_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_get_current_callback_threshold(VoltageCurrent *voltage_current, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_option – Type: char, Range: See constants, Default: 'x'
  • ret_min – Type: int32_t, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
  • ret_max – Type: int32_t, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the threshold as set by voltage_current_set_current_callback_threshold().

The following constants are available for this function:

For ret_option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_set_voltage_callback_threshold(VoltageCurrent *voltage_current, char option, int32_t min, int32_t max)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int32_t, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int32_t, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
Returns:
  • error_code – Type: int

Sets the thresholds for the VOLTAGE_CURRENT_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:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_get_voltage_callback_threshold(VoltageCurrent *voltage_current, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_option – Type: char, Range: See constants, Default: 'x'
  • ret_min – Type: int32_t, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
  • ret_max – Type: int32_t, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the threshold as set by voltage_current_set_voltage_callback_threshold().

The following constants are available for this function:

For ret_option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_set_power_callback_threshold(VoltageCurrent *voltage_current, char option, int32_t min, int32_t max)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int32_t, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int32_t, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
Returns:
  • error_code – Type: int

Sets the thresholds for the VOLTAGE_CURRENT_CALLBACK_POWER_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_get_power_callback_threshold(VoltageCurrent *voltage_current, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_option – Type: char, Range: See constants, Default: 'x'
  • ret_min – Type: int32_t, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
  • ret_max – Type: int32_t, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the threshold as set by voltage_current_set_power_callback_threshold().

The following constants are available for this function:

For ret_option:

  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_THRESHOLD_OPTION_GREATER = '>'
int voltage_current_set_debounce_period(VoltageCurrent *voltage_current, uint32_t debounce)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • debounce – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Returns:
  • error_code – Type: int

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

int voltage_current_get_debounce_period(VoltageCurrent *voltage_current, uint32_t *ret_debounce)
Parameters:
  • voltage_current – Type: VoltageCurrent *
Output Parameters:
  • ret_debounce – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Returns:
  • error_code – Type: int

Returns the debounce period as set by voltage_current_set_debounce_period().

Callbacks

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

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

voltage_current_register_callback(&voltage_current,
                                  VOLTAGE_CURRENT_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.

VOLTAGE_CURRENT_CALLBACK_CURRENT
void callback(int32_t current, void *user_data)
Callback Parameters:
  • current – Type: int32_t, Unit: 1 mA, Range: [-20000 to 20000]
  • user_data – Type: void *

This callback is triggered periodically with the period that is set by voltage_current_set_current_callback_period(). The parameter is the current of the sensor.

The VOLTAGE_CURRENT_CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

VOLTAGE_CURRENT_CALLBACK_VOLTAGE
void callback(int32_t voltage, void *user_data)
Callback Parameters:
  • voltage – Type: int32_t, Unit: 1 mV, Range: [0 to 36000]
  • user_data – Type: void *

This callback is triggered periodically with the period that is set by voltage_current_set_voltage_callback_period(). The parameter is the voltage of the sensor.

The VOLTAGE_CURRENT_CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

VOLTAGE_CURRENT_CALLBACK_POWER
void callback(int32_t power, void *user_data)
Callback Parameters:
  • power – Type: int32_t, Unit: 1 mW, Range: [0 to 720000]
  • user_data – Type: void *

This callback is triggered periodically with the period that is set by voltage_current_set_power_callback_period(). The parameter is the power of the sensor.

The VOLTAGE_CURRENT_CALLBACK_POWER callback is only triggered if the power has changed since the last triggering.

VOLTAGE_CURRENT_CALLBACK_CURRENT_REACHED
void callback(int32_t current, void *user_data)
Callback Parameters:
  • current – Type: int32_t, Unit: 1 mA, Range: [-20000 to 20000]
  • user_data – Type: void *

This callback is triggered when the threshold as set by voltage_current_set_current_callback_threshold() is reached. The parameter is the current of the sensor.

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

VOLTAGE_CURRENT_CALLBACK_VOLTAGE_REACHED
void callback(int32_t voltage, void *user_data)
Callback Parameters:
  • voltage – Type: int32_t, Unit: 1 mV, Range: [0 to 36000]
  • user_data – Type: void *

This callback is triggered when the threshold as set by voltage_current_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 voltage_current_set_debounce_period().

VOLTAGE_CURRENT_CALLBACK_POWER_REACHED
void callback(int32_t power, void *user_data)
Callback Parameters:
  • power – Type: int32_t, Unit: 1 mA, Range: [-20000 to 20000]
  • user_data – Type: void *

This callback is triggered when the threshold as set by voltage_current_set_power_callback_threshold() is reached. The parameter is the power of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by voltage_current_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 voltage_current_get_api_version(VoltageCurrent *voltage_current, uint8_t ret_api_version[3])
Parameters:
  • voltage_current – Type: VoltageCurrent *
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:
  • error_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 voltage_current_get_response_expected(VoltageCurrent *voltage_current, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • error_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 voltage_current_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.

The following constants are available for this function:

For function_id:

  • VOLTAGE_CURRENT_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 20
int voltage_current_set_response_expected(VoltageCurrent *voltage_current, uint8_t function_id, bool response_expected)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • error_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.

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 constants are available for this function:

For function_id:

  • VOLTAGE_CURRENT_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 20
int voltage_current_set_response_expected_all(VoltageCurrent *voltage_current, bool response_expected)
Parameters:
  • voltage_current – Type: VoltageCurrent *
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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

Constants

VOLTAGE_CURRENT_DEVICE_IDENTIFIER

This constant is used to identify a Voltage/Current Bricklet.

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

VOLTAGE_CURRENT_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Voltage/Current Bricklet.