C/C++ for Microcontrollers - Industrial Counter Bricklet¶

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

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

static TF_IndustrialCounter ic;

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

    // Get current counter from channel 0
    int64_t counter;
    check(tf_industrial_counter_get_counter(&ic, TF_INDUSTRIAL_COUNTER_CHANNEL_0,
                                            &counter), "get counter from channel 0");

    tf_hal_printf("Counter (Channel 0): %I64d\n", counter);

    // Get current signal data from channel 0
    uint16_t duty_cycle; uint64_t period; uint32_t frequency; bool value;
    check(tf_industrial_counter_get_signal_data(&ic, TF_INDUSTRIAL_COUNTER_CHANNEL_0,
                                                &duty_cycle, &period, &frequency,
                                                &value), "get signal data from channel 0");

    tf_hal_printf("Duty Cycle (Channel 0): %d 1/%d %%\n", duty_cycle, 100);
    tf_hal_printf("Period (Channel 0): %I64u ns\n", period);
    tf_hal_printf("Frequency (Channel 0): %d 1/%d Hz\n", frequency, 1000);
    tf_hal_printf("Value (Channel 0): %s\n", value ? "true" : "false");
}

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

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

// Callback function for all counter callback
static void all_counter_handler(TF_IndustrialCounter *device, int64_t counter[4],
                                void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Counter (Channel 0): %I64d\n", counter[0]);
    tf_hal_printf("Counter (Channel 1): %I64d\n", counter[1]);
    tf_hal_printf("Counter (Channel 2): %I64d\n", counter[2]);
    tf_hal_printf("Counter (Channel 3): %I64d\n", counter[3]);
    tf_hal_printf("\n");
}

static TF_IndustrialCounter ic;

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

    // Register all counter callback to function all_counter_handler
    tf_industrial_counter_register_all_counter_callback(&ic,
                                                        all_counter_handler,
                                                        NULL);

    // Set period for all counter callback to 1s (1000ms)
    tf_industrial_counter_set_all_counter_callback_configuration(&ic, 1000, true);
}

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_counter_create(TF_IndustrialCounter *industrial_counter, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_IndustrialCounter industrial_counter;
tf_industrial_counter_create(&industrial_counter, NULL, &hal);

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

int tf_industrial_counter_destroy(TF_IndustrialCounter *industrial_counter)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
Returns:	e_code – Type: int

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

int tf_industrial_counter_get_counter(TF_IndustrialCounter *industrial_counter, uint8_t channel, int64_t *ret_counter)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants
Output Parameters:	ret_counter – Type: int64_t, Range: [-2⁴⁷ to 2⁴⁷ - 1]
Returns:	e_code – Type: int

Returns the current counter value for the given channel.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_get_all_counter(TF_IndustrialCounter *industrial_counter, int64_t ret_counter[4])¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
Output Parameters:	ret_counter – Type: int64_t[4], Range: [-2⁴⁷ to 2⁴⁷ - 1]
Returns:	e_code – Type: int

Returns the current counter values for all four channels.

int tf_industrial_counter_set_counter(TF_IndustrialCounter *industrial_counter, uint8_t channel, int64_t counter)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants counter – Type: int64_t, Range: [-2⁴⁷ to 2⁴⁷ - 1]
Returns:	e_code – Type: int

Sets the counter value for the given channel.

The default value for the counters on startup is 0.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_set_all_counter(TF_IndustrialCounter *industrial_counter, const int64_t counter[4])¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * counter – Type: const int64_t[4], Range: [-2⁴⁷ to 2⁴⁷ - 1]
Returns:	e_code – Type: int

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

int tf_industrial_counter_get_signal_data(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint16_t *ret_duty_cycle, uint64_t *ret_period, uint32_t *ret_frequency, bool *ret_value)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants
Output Parameters:	ret_duty_cycle – Type: uint16_t, Unit: 1/100 %, Range: [0 to 10000] ret_period – Type: uint64_t, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] ret_frequency – Type: uint32_t, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] ret_value – Type: bool
Returns:	e_code – Type: int

Returns the signal data (duty cycle, period, frequency and value) for the given channel.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_get_all_signal_data(TF_IndustrialCounter *industrial_counter, uint16_t ret_duty_cycle[4], uint64_t ret_period[4], uint32_t ret_frequency[4], bool ret_value[4])¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
Output Parameters:	ret_duty_cycle – Type: uint16_t[4], Unit: 1/100 %, Range: [0 to 10000] ret_period – Type: uint64_t[4], Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] ret_frequency – Type: uint32_t[4], Unit: 1/1000 Hz, Range: [0 to 2³² - 1] ret_value – Type: bool[4]
Returns:	e_code – Type: int

Returns the signal data (duty cycle, period, frequency and value) for all four channels.

int tf_industrial_counter_set_counter_active(TF_IndustrialCounter *industrial_counter, uint8_t channel, bool active)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants active – Type: bool, Default: true
Returns:	e_code – Type: int

Activates/deactivates the counter of the given channel.

true = activate, false = deactivate.

By default all channels are activated.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_set_all_counter_active(TF_IndustrialCounter *industrial_counter, const bool active[4])¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * active – Type: const bool[4], Default: {true, true, true, true}
Returns:	e_code – Type: int

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

int tf_industrial_counter_get_counter_active(TF_IndustrialCounter *industrial_counter, uint8_t channel, bool *ret_active)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants
Output Parameters:	ret_active – Type: bool, Default: true
Returns:	e_code – Type: int

Returns the activation state of the given channel.

true = activated, false = deactivated.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

int tf_industrial_counter_get_all_counter_active(TF_IndustrialCounter *industrial_counter, bool ret_active[4])¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
Output Parameters:	ret_active – Type: bool[4], Default: {true, true, true, true}
Returns:	e_code – Type: int

Returns the activation state of all four channels.

true = activated, false = deactivated.

int tf_industrial_counter_set_counter_configuration(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t count_edge, uint8_t count_direction, uint8_t duty_cycle_prescaler, uint8_t frequency_integration_time)¶

Parameters:

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants count_edge – Type: uint8_t, Range: See constants, Default: 0 count_direction – Type: uint8_t, Range: See constants, Default: 0 duty_cycle_prescaler – Type: uint8_t, Range: See constants, Default: 0 frequency_integration_time – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

industrial_counter – Type: TF_IndustrialCounter *
channel – Type: uint8_t, Range: See constants
count_edge – Type: uint8_t, Range: See constants, Default: 0
count_direction – Type: uint8_t, Range: See constants, Default: 0
duty_cycle_prescaler – Type: uint8_t, Range: See constants, Default: 0
frequency_integration_time – Type: uint8_t, Range: See constants, Default: 3

Returns:

e_code – Type: int

Sets the counter configuration for the given channel.

Count Edge: Counter can count on rising, falling or both edges.
Count Direction: Counter can count up or down. You can also use another channel as direction input, see here for details.
Duty Cycle Prescaler: Sets a divider for the internal clock. See here for details.
Frequency Integration Time: Sets the integration time for the frequency measurement. See here for details.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For count_edge:

TF_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

For count_direction:

TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

For duty_cycle_prescaler:

TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

For frequency_integration_time:

TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

int tf_industrial_counter_get_counter_configuration(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t *ret_count_edge, uint8_t *ret_count_direction, uint8_t *ret_duty_cycle_prescaler, uint8_t *ret_frequency_integration_time)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * channel – Type: uint8_t, Range: See constants
Output Parameters:	ret_count_edge – Type: uint8_t, Range: See constants, Default: 0 ret_count_direction – Type: uint8_t, Range: See constants, Default: 0 ret_duty_cycle_prescaler – Type: uint8_t, Range: See constants, Default: 0 ret_frequency_integration_time – Type: uint8_t, Range: See constants, Default: 3
Returns:	e_code – Type: int

Returns the counter configuration as set by tf_industrial_counter_set_counter_configuration().

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For ret_count_edge:

TF_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
TF_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

For ret_count_direction:

TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
TF_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

For ret_duty_cycle_prescaler:

TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
TF_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

For ret_frequency_integration_time:

TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
TF_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

int tf_industrial_counter_set_channel_led_config(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t config)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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.

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For config:

TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int tf_industrial_counter_get_channel_led_config(TF_IndustrialCounter *industrial_counter, uint8_t channel, uint8_t *ret_config)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_counter_set_channel_led_config()

The following constants are available for this function:

For channel:

TF_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For ret_config:

TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

int tf_industrial_counter_get_spitfp_error_count(TF_IndustrialCounter *industrial_counter, 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_counter – Type: TF_IndustrialCounter *
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_counter_set_status_led_config(TF_IndustrialCounter *industrial_counter, uint8_t config)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_COUNTER_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_counter_get_status_led_config(TF_IndustrialCounter *industrial_counter, uint8_t *ret_config)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
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_counter_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_OFF = 0
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_industrial_counter_get_chip_temperature(TF_IndustrialCounter *industrial_counter, int16_t *ret_temperature)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
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_counter_reset(TF_IndustrialCounter *industrial_counter)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
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_counter_get_identity(TF_IndustrialCounter *industrial_counter, 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_counter – Type: TF_IndustrialCounter *
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_counter_set_all_counter_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t period, bool value_has_to_change)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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 Counter 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.

int tf_industrial_counter_get_all_counter_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
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_counter_set_all_counter_callback_configuration().

int tf_industrial_counter_set_all_signal_data_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t period, bool value_has_to_change)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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 Signal Data 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_counter_get_all_signal_data_callback_configuration(TF_IndustrialCounter *industrial_counter, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
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_counter_set_all_signal_data_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_counter_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_counter_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_counter_register_all_counter_callback(TF_IndustrialCounter *industrial_counter, TF_IndustrialCounter_AllCounterHandler handler, void *user_data)¶

void handler(TF_IndustrialCounter *industrial_counter, int64_t counter[4], void *user_data)

Callback Parameters:	industrial_counter – Type: TF_IndustrialCounter * counter – Type: int64_t[4], Range: [-2⁴⁷ to 2⁴⁷ - 1] user_data – Type: void *

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

The parameters are the same as tf_industrial_counter_get_all_counter().

int tf_industrial_counter_register_all_signal_data_callback(TF_IndustrialCounter *industrial_counter, TF_IndustrialCounter_AllSignalDataHandler handler, void *user_data)¶

void handler(TF_IndustrialCounter *industrial_counter, uint16_t duty_cycle[4], uint64_t period[4], uint32_t frequency[4], bool value[4], void *user_data)

Callback Parameters:	industrial_counter – Type: TF_IndustrialCounter * duty_cycle – Type: uint16_t[4], Unit: 1/100 %, Range: [0 to 10000] period – Type: uint64_t[4], Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: uint32_t[4], Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: bool[4] user_data – Type: void *

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

The parameters are the same as tf_industrial_counter_get_all_signal_data().

Virtual Functions¶

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

int tf_industrial_counter_get_response_expected(TF_IndustrialCounter *industrial_counter, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_counter_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_COUNTER_FUNCTION_SET_COUNTER = 3
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
TF_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248

int tf_industrial_counter_set_response_expected(TF_IndustrialCounter *industrial_counter, uint8_t function_id, bool response_expected)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_COUNTER_FUNCTION_SET_COUNTER = 3
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
TF_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248

int tf_industrial_counter_set_response_expected_all(TF_IndustrialCounter *industrial_counter, bool response_expected)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_counter_set_bootloader_mode(TF_IndustrialCounter *industrial_counter, uint8_t mode, uint8_t *ret_status)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_OK = 0
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_industrial_counter_get_bootloader_mode(TF_IndustrialCounter *industrial_counter, uint8_t *ret_mode)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_industrial_counter_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_industrial_counter_set_write_firmware_pointer(TF_IndustrialCounter *industrial_counter, uint32_t pointer)¶

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

Sets the firmware pointer for tf_industrial_counter_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_counter_write_firmware(TF_IndustrialCounter *industrial_counter, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_counter_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_counter_write_uid(TF_IndustrialCounter *industrial_counter, uint32_t uid)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter * 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_counter_read_uid(TF_IndustrialCounter *industrial_counter, uint32_t *ret_uid)¶

Parameters:	industrial_counter – Type: TF_IndustrialCounter *
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_COUNTER_DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Counter Bricklet.

The functions tf_industrial_counter_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_COUNTER_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Counter Bricklet.