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

C/C++ for Microcontrollers - Industrial Digital In 4 Bricklet 2.0¶

This is the description of the C/C++ for Microcontrollers API bindings for the Industrial Digital In 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital In 4 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_digital_in_4_v2.h"

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

static TF_IndustrialDigitalIn4V2 idi4;

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

    // Get current value
    bool value[4];
    check(tf_industrial_digital_in_4_v2_get_value(&idi4, value), "get value");

    tf_hal_printf("Channel 0: %s\n", value[0] ? "true" : "false");
    tf_hal_printf("Channel 1: %s\n", value[1] ? "true" : "false");
    tf_hal_printf("Channel 2: %s\n", value[2] ? "true" : "false");
    tf_hal_printf("Channel 3: %s\n", value[3] ? "true" : "false");
}

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

Edge Count¶

Download (example_edge_count.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_digital_in_4_v2.h"

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

static TF_IndustrialDigitalIn4V2 idi4;

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

    // Configure rising edge count (channel 3) with 10ms debounce
    check(tf_industrial_digital_in_4_v2_set_edge_count_configuration(&idi4, 3, 0,
                                                                     10), "call set_edge_count_configuration");

    // Get edge count 10 times with 1s delay
    int i;
    for (i = 0; i < 10; ++i) {
        tf_hal_sleep_us(hal, 1000 * 1000);

        // Get current edge count
        uint32_t count;
        check(tf_industrial_digital_in_4_v2_get_edge_count(&idi4, 3, false,
                                                           &count), "get edge count");

        tf_hal_printf("Count: %I32u\n", count);
    }
}

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

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

// Callback function for value callback
static void value_handler(TF_IndustrialDigitalIn4V2 *device, uint8_t channel,
                          bool changed, bool value, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    if (channel == TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0) {
        tf_hal_printf("Channel: 0\n");
    } else if (channel == TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1) {
        tf_hal_printf("Channel: 1\n");
    } else if (channel == TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2) {
        tf_hal_printf("Channel: 2\n");
    } else if (channel == TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3) {
        tf_hal_printf("Channel: 3\n");
    }

    tf_hal_printf("Changed: %s\n", changed ? "true" : "false");
    tf_hal_printf("Value: %s\n", value ? "true" : "false");
    tf_hal_printf("\n");
}

static TF_IndustrialDigitalIn4V2 idi4;

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

    // Register value callback to function value_handler
    tf_industrial_digital_in_4_v2_register_value_callback(&idi4,
                                                          value_handler,
                                                          NULL);

    // Set period for value (channel 1) callback to 0.1s (100ms)
    tf_industrial_digital_in_4_v2_set_value_callback_configuration(&idi4, 1, 100, false);
}

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.

Basic Functions¶

int tf_industrial_digital_in_4_v2_create(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_IndustrialDigitalIn4V2 industrial_digital_in_4_v2;
tf_industrial_digital_in_4_v2_create(&industrial_digital_in_4_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_digital_in_4_v2_destroy(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
Returns:	e_code – Type: int

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

int tf_industrial_digital_in_4_v2_get_value(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool ret_value[4])¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
Output Parameters:	ret_value – Type: bool[4]
Returns:	e_code – Type: int

Returns the input value as bools, true refers to high and false refers to low.

int tf_industrial_digital_in_4_v2_set_channel_led_config(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t config)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants 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 is on if the channel is high and off otherwise.

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

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For config:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_digital_in_4_v2_get_channel_led_config(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t *ret_config)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants
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_digital_in_4_v2_set_channel_led_config()

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For ret_config:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

int tf_industrial_digital_in_4_v2_get_edge_count(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, bool reset_counter, uint32_t *ret_count)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants reset_counter – Type: bool
Output Parameters:	ret_count – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with tf_industrial_digital_in_4_v2_set_edge_count_configuration().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int tf_industrial_digital_in_4_v2_set_edge_count_configuration(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t edge_type, uint8_t debounce)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants edge_type – Type: uint8_t, Range: See constants, Default: 0 debounce – Type: uint8_t, Unit: 1 ms, Range: [0 to 255], Default: 100
Returns:	e_code – Type: int

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

0 = rising
1 = falling
2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For edge_type:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2

int tf_industrial_digital_in_4_v2_get_edge_count_configuration(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t *ret_edge_type, uint8_t *ret_debounce)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants
Output Parameters:	ret_edge_type – Type: uint8_t, Range: See constants, Default: 0 ret_debounce – Type: uint8_t, Unit: 1 ms, Range: [0 to 255], Default: 100
Returns:	e_code – Type: int

Returns the edge type and debounce time for the selected channel as set by tf_industrial_digital_in_4_v2_set_edge_count_configuration().

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For ret_edge_type:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2

int tf_industrial_digital_in_4_v2_get_spitfp_error_count(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_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_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_digital_in_4_v2_set_status_led_config(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t config)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_digital_in_4_v2_get_status_led_config(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t *ret_config)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_digital_in_4_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_digital_in_4_v2_get_chip_temperature(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, int16_t *ret_temperature)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_digital_in_4_v2_reset(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_digital_in_4_v2_get_identity(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_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_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_digital_in_4_v2_set_value_callback_configuration(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint32_t period, bool value_has_to_change)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants 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

This callback can be configured per channel.

The period is the period with which the Value 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.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int tf_industrial_digital_in_4_v2_get_value_callback_configuration(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants
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 for the given channel as set by tf_industrial_digital_in_4_v2_set_value_callback_configuration().

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int tf_industrial_digital_in_4_v2_set_all_value_callback_configuration(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t period, bool value_has_to_change)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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 Value callback is triggered periodically. A value of 0 turns the callback off.

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

int tf_industrial_digital_in_4_v2_get_all_value_callback_configuration(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_digital_in_4_v2_set_all_value_callback_configuration().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_industrial_digital_in_4_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_digital_in_4_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_digital_in_4_v2_register_value_callback(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, TF_IndustrialDigitalIn4V2_ValueHandler handler, void *user_data)¶

void handler(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, bool changed, bool value, void *user_data)

Callback Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * channel – Type: uint8_t, Range: See constants changed – Type: bool value – Type: bool user_data – Type: void *

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

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

int tf_industrial_digital_in_4_v2_register_all_value_callback(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, TF_IndustrialDigitalIn4V2_AllValueHandler handler, void *user_data)¶

void handler(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool changed[4], bool value[4], void *user_data)

Callback Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * changed – Type: bool[4] value – Type: bool[4] user_data – Type: void *

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

The parameters are the same as tf_industrial_digital_in_4_v2_get_value(). Additional the changed parameter is true if the value has changed since the last callback.

Virtual Functions¶

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

int tf_industrial_digital_in_4_v2_get_response_expected(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_digital_in_4_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_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_digital_in_4_v2_set_response_expected(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t function_id, bool response_expected)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243
TF_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248

int tf_industrial_digital_in_4_v2_set_response_expected_all(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool response_expected)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_digital_in_4_v2_set_bootloader_mode(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t mode, uint8_t *ret_status)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_OK = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_industrial_digital_in_4_v2_get_bootloader_mode(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t *ret_mode)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_industrial_digital_in_4_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_industrial_digital_in_4_v2_set_write_firmware_pointer(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t pointer)¶

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

Sets the firmware pointer for tf_industrial_digital_in_4_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_digital_in_4_v2_write_firmware(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_digital_in_4_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_digital_in_4_v2_write_uid(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t uid)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 * 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_digital_in_4_v2_read_uid(TF_IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t *ret_uid)¶

Parameters:	industrial_digital_in_4_v2 – Type: TF_IndustrialDigitalIn4V2 *
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_DIGITAL_IN_4_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Digital In 4 Bricklet 2.0.

The functions tf_industrial_digital_in_4_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_DIGITAL_IN_4_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.