C/C++ - Industrial Dual Analog In Bricklet

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

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

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet

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

    // Create device object
    IndustrialDualAnalogIn idai;
    industrial_dual_analog_in_create(&idai, 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 from channel 1
    int32_t voltage;
    if(industrial_dual_analog_in_get_voltage(&idai, 1, &voltage) < 0) {
        fprintf(stderr, "Could not get voltage from channel 1, probably timeout\n");
        return 1;
    }

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

    printf("Press key to exit\n");
    getchar();
    industrial_dual_analog_in_destroy(&idai);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 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
50
51
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_dual_analog_in.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet

// Callback function for voltage callback
void cb_voltage(uint8_t channel, int32_t voltage, void *user_data) {
    (void)user_data; // avoid unused parameter warning

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

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

    // Create device object
    IndustrialDualAnalogIn idai;
    industrial_dual_analog_in_create(&idai, 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
    industrial_dual_analog_in_register_callback(&idai,
                                                INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE,
                                                (void *)cb_voltage,
                                                NULL);

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

    printf("Press key to exit\n");
    getchar();
    industrial_dual_analog_in_destroy(&idai);
    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
51
52
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_dual_analog_in.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet

// Callback function for voltage reached callback
void cb_voltage_reached(uint8_t channel, int32_t voltage, void *user_data) {
    (void)user_data; // avoid unused parameter warning

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

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

    // Create device object
    IndustrialDualAnalogIn idai;
    industrial_dual_analog_in_create(&idai, 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)
    industrial_dual_analog_in_set_debounce_period(&idai, 10000);

    // Register voltage reached callback to function cb_voltage_reached
    industrial_dual_analog_in_register_callback(&idai,
                                                INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED,
                                                (void *)cb_voltage_reached,
                                                NULL);

    // Configure threshold for voltage (channel 1) "greater than 10 V"
    industrial_dual_analog_in_set_voltage_callback_threshold(&idai, 1, '>', 10*1000, 0);

    printf("Press key to exit\n");
    getchar();
    industrial_dual_analog_in_destroy(&idai);
    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 call by reference. 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 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

as defined in ip_connection.h.

All functions listed below are thread-safe.

The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.

Basic Functions

void industrial_dual_analog_in_create(IndustrialDualAnalogIn *industrial_dual_analog_in, const char *uid, IPConnection *ipcon)

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

IndustrialDualAnalogIn industrial_dual_analog_in;
industrial_dual_analog_in_create(&industrial_dual_analog_in, "YOUR_DEVICE_UID", &ipcon);

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

void industrial_dual_analog_in_destroy(IndustrialDualAnalogIn *industrial_dual_analog_in)

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

int industrial_dual_analog_in_get_voltage(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, int32_t *ret_voltage)

Returns the voltage for the given channel in mV.

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

Advanced Functions

int industrial_dual_analog_in_set_sample_rate(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t rate)

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

The default value is 6 (2 samples per second).

The following defines are available for this function:

  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
int industrial_dual_analog_in_get_sample_rate(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t *ret_rate)

Returns the sample rate as set by industrial_dual_analog_in_set_sample_rate().

The following defines are available for this function:

  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
int industrial_dual_analog_in_set_calibration(IndustrialDualAnalogIn *industrial_dual_analog_in, int32_t offset[2], int32_t gain[2])

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

int industrial_dual_analog_in_get_calibration(IndustrialDualAnalogIn *industrial_dual_analog_in, int32_t ret_offset[2], int32_t ret_gain[2])

Returns the calibration as set by industrial_dual_analog_in_set_calibration().

int industrial_dual_analog_in_get_adc_values(IndustrialDualAnalogIn *industrial_dual_analog_in, int32_t ret_value[2])

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see industrial_dual_analog_in_set_calibration().

int industrial_dual_analog_in_get_api_version(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t ret_api_version[3])

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.

int industrial_dual_analog_in_get_response_expected(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t function_id, bool *ret_response_expected)

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 industrial_dual_analog_in_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 industrial_dual_analog_in_set_response_expected() for the list of function ID defines available for this function.

int industrial_dual_analog_in_set_response_expected(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t function_id, bool response_expected)

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

  • INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_SAMPLE_RATE = 8
  • INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_CALIBRATION = 10
int industrial_dual_analog_in_set_response_expected_all(IndustrialDualAnalogIn *industrial_dual_analog_in, bool response_expected)

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

int industrial_dual_analog_in_get_identity(IndustrialDualAnalogIn *industrial_dual_analog_in, 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)

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.

Callback Configuration Functions

void industrial_dual_analog_in_register_callback(IndustrialDualAnalogIn *industrial_dual_analog_in, int16_t callback_id, void *function, void *user_data)

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 industrial_dual_analog_in_set_voltage_callback_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, uint32_t period)

Sets the period in ms with which the INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE callback is triggered periodically for the given channel. A value of 0 turns the callback off.

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

The default value is 0.

int industrial_dual_analog_in_get_voltage_callback_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, uint32_t *ret_period)

Returns the period as set by industrial_dual_analog_in_set_voltage_callback_period().

int industrial_dual_analog_in_set_voltage_callback_threshold(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, char option, int32_t min, int32_t max)

Sets the thresholds for the INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED callback for the given channel.

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 default value is ('x', 0, 0).

The following defines are available for this function:

  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
int industrial_dual_analog_in_get_voltage_callback_threshold(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, char *ret_option, int32_t *ret_min, int32_t *ret_max)

Returns the threshold as set by industrial_dual_analog_in_set_voltage_callback_threshold().

The following defines are available for this function:

  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
int industrial_dual_analog_in_set_debounce_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint32_t debounce)

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

int industrial_dual_analog_in_get_debounce_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint32_t *ret_debounce)

Returns the debounce period as set by industrial_dual_analog_in_set_debounce_period().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the industrial_dual_analog_in_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);
}

industrial_dual_analog_in_register_callback(&industrial_dual_analog_in, INDUSTRIAL_DUAL_ANALOG_IN_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.

INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE
void callback(uint8_t channel, int32_t voltage, void *user_data)

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

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

INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED
void callback(uint8_t channel, int32_t voltage, void *user_data)

This callback is triggered when the threshold as set by industrial_dual_analog_in_set_voltage_callback_threshold() is reached. The parameter is the voltage of the channel.

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

Constants

INDUSTRIAL_DUAL_ANALOG_IN_DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual Analog In Bricklet.

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

INDUSTRIAL_DUAL_ANALOG_IN_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual Analog In Bricklet.