Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / Industrial Dual Analog In Bricklet 2.0

C/C++ for Microcontrollers - Industrial Dual Analog In Bricklet 2.0¶

This is the description of the C/C++ for Microcontrollers API bindings for the Industrial Dual Analog In Bricklet 2.0. General information and technical specifications for the Industrial Dual Analog In Bricklet 2.0 are summarized in its hardware description.

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

Examples¶

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

Simple¶

Download (example_simple.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_industrial_dual_analog_in_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_IndustrialDualAnalogInV2 idai;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_industrial_dual_analog_in_v2_create(&idai, NULL, hal), "create device object");

    // Get current voltage from channel 0
    int32_t voltage;
    check(tf_industrial_dual_analog_in_v2_get_voltage(&idai, 0,
                                                      &voltage), "get voltage from channel 0");

    tf_hal_printf("Voltage (Channel 0): %d 1/%d V\n", voltage, 1000);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_industrial_dual_analog_in_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

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

    tf_hal_printf("Channel: %I8u\n", channel);
    tf_hal_printf("Voltage: %d 1/%d V\n", voltage, 1000);
    tf_hal_printf("\n");
}

static TF_IndustrialDualAnalogInV2 idai;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_industrial_dual_analog_in_v2_create(&idai, NULL, hal), "create device object");

    // Register voltage callback to function voltage_handler
    tf_industrial_dual_analog_in_v2_register_voltage_callback(&idai,
                                                              voltage_handler,
                                                              NULL);

    // Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
    tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration(&idai, 0, 1000, false, 'x', 0, 0);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Threshold¶

Download (example_threshold.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_industrial_dual_analog_in_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

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

    tf_hal_printf("Channel: %I8u\n", channel);
    tf_hal_printf("Voltage: %d 1/%d V\n", voltage, 1000);
    tf_hal_printf("\n");
}

static TF_IndustrialDualAnalogInV2 idai;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_industrial_dual_analog_in_v2_create(&idai, NULL, hal), "create device object");

    // Register voltage callback to function voltage_handler
    tf_industrial_dual_analog_in_v2_register_voltage_callback(&idai,
                                                              voltage_handler,
                                                              NULL);

    // Configure threshold for voltage (channel 0) "greater than 10 V"
    // with a debounce period of 10s (10000ms)
    tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration(&idai, 0, 10000, false, '>', 10*1000, 0);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Most functions of the C/C++ bindings for microcontrollers return an error code (e_code).

Possible error codes are:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_LOCKED = -12
TF_E_PORT_NOT_FOUND = -13

(as defined in errors.h) as well as the errors returned from the hardware abstraction layer (HAL) that is used.

Use :cpp:func`tf_hal_strerror` (defined in the HAL's header file) to get an error string for 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. The bindings will not write to an output parameter if NULL or nullptr is passed. This can be used to ignore outputs that you are not interested in.

None of the functions listed below are thread-safe. See the API bindings description for details.

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¶

int tf_industrial_dual_analog_in_v2_create(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

Creates the device object industrial_dual_analog_in_v2 with the optional unique device ID or port name uid_or_port_name and adds it to the HAL hal:

TF_IndustrialDualAnalogInV2 industrial_dual_analog_in_v2;
tf_industrial_dual_analog_in_v2_create(&industrial_dual_analog_in_v2, NULL, &hal);

Normally uid_or_port_name can stay NULL. For more details about this see section UID or Port Name.

int tf_industrial_dual_analog_in_v2_destroy(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Returns:	e_code – Type: int

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

int tf_industrial_dual_analog_in_v2_get_voltage(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t *ret_voltage)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1]
Output Parameters:	ret_voltage – Type: int32_t, Unit: 1 mV, Range: [-35000 to 35000]
Returns:	e_code – Type: int

Returns the voltage for the given channel.

If you want to get the value periodically, it is recommended to use the Voltage callback. You can set the callback configuration with tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration().

int tf_industrial_dual_analog_in_v2_set_channel_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint8_t config)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1] config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with tf_industrial_dual_analog_in_v2_set_channel_led_status_config().

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_dual_analog_in_v2_get_channel_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint8_t *ret_config)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1]
Output Parameters:	ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Returns the channel LED configuration as set by tf_industrial_dual_analog_in_v2_set_channel_led_config()

The following constants are available for this function:

For ret_config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_dual_analog_in_v2_set_channel_led_status_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t min, int32_t max, uint8_t config)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1] min – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 10000 config – Type: uint8_t, Range: See constants, Default: 1
Returns:	e_code – Type: int

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see tf_industrial_dual_analog_in_v2_set_channel_led_config().

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the "max" parameter to the threshold value in mV below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V.

In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

The following constants are available for this function:

For config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

int tf_industrial_dual_analog_in_v2_get_channel_led_status_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t *ret_min, int32_t *ret_max, uint8_t *ret_config)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1]
Output Parameters:	ret_min – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 10000 ret_config – Type: uint8_t, Range: See constants, Default: 1
Returns:	e_code – Type: int

Returns the channel LED status configuration as set by tf_industrial_dual_analog_in_v2_set_channel_led_status_config().

The following constants are available for this function:

For ret_config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions¶

int tf_industrial_dual_analog_in_v2_set_sample_rate(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t rate)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * rate – Type: uint8_t, Range: See constants, Default: 6
Returns:	e_code – Type: int

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

For rate:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_976_SPS = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_488_SPS = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_244_SPS = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_122_SPS = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_61_SPS = 4
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_4_SPS = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_2_SPS = 6
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_1_SPS = 7

int tf_industrial_dual_analog_in_v2_get_sample_rate(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t *ret_rate)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_rate – Type: uint8_t, Range: See constants, Default: 6
Returns:	e_code – Type: int

Returns the sample rate as set by tf_industrial_dual_analog_in_v2_set_sample_rate().

The following constants are available for this function:

For ret_rate:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_976_SPS = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_488_SPS = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_244_SPS = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_122_SPS = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_61_SPS = 4
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_4_SPS = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_2_SPS = 6
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_SAMPLE_RATE_1_SPS = 7

int tf_industrial_dual_analog_in_v2_set_calibration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, const int32_t offset[2], const int32_t gain[2])¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * offset – Type: const int32_t[2], Range: [-2²³ to 2²³ - 1] gain – Type: const int32_t[2], Range: [-2²³ to 2²³ - 1]
Returns:	e_code – Type: int

Sets offset and gain of MCP3911 internal calibration registers.

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

int tf_industrial_dual_analog_in_v2_get_calibration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t ret_offset[2], int32_t ret_gain[2])¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_offset – Type: int32_t[2], Range: [-2²³ to 2²³ - 1] ret_gain – Type: int32_t[2], Range: [-2²³ to 2²³ - 1]
Returns:	e_code – Type: int

Returns the calibration as set by tf_industrial_dual_analog_in_v2_set_calibration().

int tf_industrial_dual_analog_in_v2_get_adc_values(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t ret_value[2])¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_value – Type: int32_t[2], Range: [-2²³ to 2²³ - 1]
Returns:	e_code – Type: int

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

int tf_industrial_dual_analog_in_v2_get_all_voltages(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t ret_voltages[2])¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_voltages – Type: int32_t[2], Unit: 1 mV, Range: [-35000 to 35000]
Returns:	e_code – Type: int

Returns the voltages for all channels.

If you want to get the value periodically, it is recommended to use the All Voltages callback. You can set the callback configuration with tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration().

New in version 2.0.6 (Plugin).

int tf_industrial_dual_analog_in_v2_get_spitfp_error_count(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_frame – Type: uint32_t, Range: [0 to 2³² - 1] ret_error_count_overflow – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

int tf_industrial_dual_analog_in_v2_set_status_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t config)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_dual_analog_in_v2_get_status_led_config(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t *ret_config)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Returns the configuration as set by tf_industrial_dual_analog_in_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_dual_analog_in_v2_get_chip_temperature(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int16_t *ret_temperature)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	e_code – Type: int

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

int tf_industrial_dual_analog_in_v2_reset(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Returns:	e_code – Type: int

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

int tf_industrial_dual_analog_in_v2_get_identity(TF_IndustrialDualAnalogInV2 *industrial_dual_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:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
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¶

int tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint32_t period, bool value_has_to_change, char option, int32_t min, int32_t max)¶

Parameters:

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1] period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
channel – Type: uint8_t, Range: [0 to 1]
period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
value_has_to_change – Type: bool, Default: false
option – Type: char, Range: See constants, Default: 'x'
min – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0
max – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns:

e_code – Type: int

The period is the period with which the Voltage callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the Voltage callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_industrial_dual_analog_in_v2_get_voltage_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int32_t *ret_min, int32_t *ret_max)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1]
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 ret_value_has_to_change – Type: bool, Default: false ret_option – Type: char, Range: See constants, Default: 'x' ret_min – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 ret_max – Type: int32_t, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration().

The following constants are available for this function:

For ret_option:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OFF = 'x'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_INSIDE = 'i'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_SMALLER = '<'
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_THRESHOLD_OPTION_GREATER = '>'

int tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t period, bool value_has_to_change)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false
Returns:	e_code – Type: int

The period is the period with which the All Voltages callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after at least one of the values has changed. If the values didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

New in version 2.0.6 (Plugin).

int tf_industrial_dual_analog_in_v2_get_all_voltages_callback_configuration(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 ret_value_has_to_change – Type: bool, Default: false
Returns:	e_code – Type: int

Returns the callback configuration as set by tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration().

New in version 2.0.6 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_industrial_dual_analog_in_v2_register_*_callback function. The user_data passed to the registration function as well as the device that triggered the callback are passed to the registered callback handler.

Only one handler can be registered to a callback at the same time. To deregister a callback, call the tf_industrial_dual_analog_in_v2_register_*_callback function with NULL as handler.

Note

Using callbacks for recurring events is preferred compared to using getters. Polling for a callback requires writing one byte only. See here Optimizing Performance.

Warning

Calling bindings function from inside a callback handler is not allowed. See here Thread safety.

int tf_industrial_dual_analog_in_v2_register_voltage_callback(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, TF_IndustrialDualAnalogInV2_VoltageHandler handler, void *user_data)¶

void handler(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t channel, int32_t voltage, void *user_data)

Callback Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * channel – Type: uint8_t, Range: [0 to 1] voltage – Type: int32_t, Unit: 1 mV, Range: [-35000 to 35000] user_data – Type: void *

This callback is triggered periodically according to the configuration set by tf_industrial_dual_analog_in_v2_set_voltage_callback_configuration().

The parameter is the same as tf_industrial_dual_analog_in_v2_get_voltage().

int tf_industrial_dual_analog_in_v2_register_all_voltages_callback(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, TF_IndustrialDualAnalogInV2_AllVoltagesHandler handler, void *user_data)¶

void handler(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, int32_t voltages[2], void *user_data)

Callback Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * voltages – Type: int32_t[2], Unit: 1 mV, Range: [-35000 to 35000] user_data – Type: void *

This callback is triggered periodically according to the configuration set by tf_industrial_dual_analog_in_v2_set_all_voltages_callback_configuration().

The parameters are the same as tf_industrial_dual_analog_in_v2_get_all_voltages().

New in version 2.0.6 (Plugin).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object.

int tf_industrial_dual_analog_in_v2_get_response_expected(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * 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 tf_industrial_dual_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:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_SAMPLE_RATE = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CALIBRATION = 7
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 10
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_dual_analog_in_v2_set_response_expected(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t function_id, bool response_expected)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * 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:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_SAMPLE_RATE = 5
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CALIBRATION = 7
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 10
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_dual_analog_in_v2_set_response_expected_all(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, bool response_expected)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * 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.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int tf_industrial_dual_analog_in_v2_set_bootloader_mode(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t mode, uint8_t *ret_status)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * mode – Type: uint8_t, Range: See constants
Output Parameters:	ret_status – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_OK = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_industrial_dual_analog_in_v2_get_bootloader_mode(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint8_t *ret_mode)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_industrial_dual_analog_in_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_industrial_dual_analog_in_v2_set_write_firmware_pointer(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t pointer)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Sets the firmware pointer for tf_industrial_dual_analog_in_v2_write_firmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int tf_industrial_dual_analog_in_v2_write_firmware(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * data – Type: const uint8_t[64], Range: [0 to 255]
Output Parameters:	ret_status – Type: uint8_t, Range: [0 to 255]
Returns:	e_code – Type: int

Writes 64 Bytes of firmware at the position as written by tf_industrial_dual_analog_in_v2_set_write_firmware_pointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int tf_industrial_dual_analog_in_v2_write_uid(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t uid)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 * uid – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

int tf_industrial_dual_analog_in_v2_read_uid(TF_IndustrialDualAnalogInV2 *industrial_dual_analog_in_v2, uint32_t *ret_uid)¶

Parameters:	industrial_dual_analog_in_v2 – Type: TF_IndustrialDualAnalogInV2 *
Output Parameters:	ret_uid – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_DEVICE_IDENTIFIER¶

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

The functions tf_industrial_dual_analog_in_v2_get_identity() and tf_hal_get_device_info() have a device_identifier output parameter to specify the Brick's or Bricklet's type.

TF_INDUSTRIAL_DUAL_ANALOG_IN_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Dual Analog In Bricklet 2.0.