Deutsch
English
Menu
Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / XMC1400 Breakout Bricklet

C/C++ for Microcontrollers - XMC1400 Breakout Bricklet

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

Gpio

Download (example_gpio.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// 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_xmc1400_breakout.h"

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

static TF_XMC1400Breakout xb;

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

    // Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
    int i;
    for (i = 0; i < 5; ++i) {
        tf_hal_sleep_us(hal, 1000 * 1000);
        check(tf_xmc1400_breakout_set_gpio_config(&xb, 1, 0,
                                                  TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL,
                                                  0, false), "call set_gpio_config");
        tf_hal_sleep_us(hal, 1000 * 1000);
        check(tf_xmc1400_breakout_set_gpio_config(&xb, 1, 0,
                                                  TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL,
                                                  0, true), "call set_gpio_config");
    }
}

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_xmc1400_breakout_create(TF_XMC1400Breakout *xmc1400_breakout, const char *uid_or_port_name, TF_HAL *hal)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • uid – Type: const char *
  • hal – Type: TF_HAL *
Returns:
  • e_code – Type: int

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

TF_XMC1400Breakout xmc1400_breakout;
tf_xmc1400_breakout_create(&xmc1400_breakout, NULL, &hal);

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

int tf_xmc1400_breakout_destroy(TF_XMC1400Breakout *xmc1400_breakout)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Returns:
  • e_code – Type: int

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

int tf_xmc1400_breakout_set_gpio_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t port, uint8_t pin, uint8_t mode, uint8_t input_hysteresis, bool output_level)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • port – Type: uint8_t, Range: [0 to 4]
  • pin – Type: uint8_t, Range: ?
  • mode – Type: uint8_t, Range: See constants
  • input_hysteresis – Type: uint8_t, Range: See constants
  • output_level – Type: bool
Returns:
  • e_code – Type: int

Example for a setter function. The values are the values that can be given to the XMC_GPIO_Init function. See communication.c in the firmware.

The following constants are available for this function:

For mode:

  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_TRISTATE = 0
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_PULL_DOWN = 1
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_PULL_UP = 2
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_SAMPLING = 3
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_TRISTATE = 4
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_PULL_DOWN = 5
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_PULL_UP = 6
  • TF_XMC1400_BREAKOUT_GPIO_MODE_INPUT_INVERTED_SAMPLING = 7
  • TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_PUSH_PULL = 8
  • TF_XMC1400_BREAKOUT_GPIO_MODE_OUTPUT_OPEN_DRAIN = 9

For input_hysteresis:

  • TF_XMC1400_BREAKOUT_GPIO_INPUT_HYSTERESIS_STANDARD = 0
  • TF_XMC1400_BREAKOUT_GPIO_INPUT_HYSTERESIS_LARGE = 4
int tf_xmc1400_breakout_get_gpio_input(TF_XMC1400Breakout *xmc1400_breakout, uint8_t port, uint8_t pin, bool *ret_value)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • port – Type: uint8_t, Range: [0 to 4]
  • pin – Type: uint8_t, Range: ?
Output Parameters:
  • ret_value – Type: bool
Returns:
  • e_code – Type: int

Example for a getter function. Returns the result of a XMC_GPIO_GetInput call for the given port/pin.

int tf_xmc1400_breakout_set_adc_channel_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t channel, bool enable)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • channel – Type: uint8_t, Range: [0 to 7]
  • enable – Type: bool
Returns:
  • e_code – Type: int

Enables a ADC channel for the ADC driver example (adc.c/adc.h).

There are 8 ADC channels and they correspond to the following pins:

  • Channel 0: P2_6
  • Channel 1: P2_8
  • Channel 2: P2_9
  • Channel 3: P2_10
  • Channel 4: P2_11
  • Channel 5: P2_0
  • Channel 6: P2_1
  • Channel 7: P2_2
int tf_xmc1400_breakout_get_adc_channel_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t channel, bool *ret_enable)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • channel – Type: uint8_t, Range: [0 to 7]
Output Parameters:
  • ret_enable – Type: bool
Returns:
  • e_code – Type: int

Returns the config for the given channel as set by tf_xmc1400_breakout_set_adc_channel_config().

int tf_xmc1400_breakout_get_adc_channel_value(TF_XMC1400Breakout *xmc1400_breakout, uint8_t channel, uint16_t *ret_value)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • channel – Type: uint8_t, Range: [0 to 7]
Output Parameters:
  • ret_value – Type: uint16_t, Range: [0 to 212 - 1]
Returns:
  • e_code – Type: int

Returns the 12-bit value of the given ADC channel of the ADC driver example.

int tf_xmc1400_breakout_get_adc_values(TF_XMC1400Breakout *xmc1400_breakout, uint16_t ret_values[8])
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_values – Type: uint16_t[8], Range: [0 to 212 - 1]
Returns:
  • e_code – Type: int

Returns the values for all 8 ADC channels of the adc driver example.

This example function also has a corresponding callback.

See tf_xmc1400_breakout_set_adc_values_callback_configuration() and ADC Values callback.

int tf_xmc1400_breakout_get_count(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_count)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_count – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Returns the value of the example count (see example.c).

This example function uses the "add_callback_value_function"-helper in the generator. The getter as well as the callback and callback configuration functions are auto-generated for the API as well as the firmware.

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

Advanced Functions

int tf_xmc1400_breakout_get_spitfp_error_count(TF_XMC1400Breakout *xmc1400_breakout, 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:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 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_xmc1400_breakout_set_status_led_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t config)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • 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_XMC1400_BREAKOUT_STATUS_LED_CONFIG_OFF = 0
  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_ON = 1
  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_xmc1400_breakout_get_status_led_config(TF_XMC1400Breakout *xmc1400_breakout, uint8_t *ret_config)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_xmc1400_breakout_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_OFF = 0
  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_ON = 1
  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_XMC1400_BREAKOUT_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_xmc1400_breakout_get_chip_temperature(TF_XMC1400Breakout *xmc1400_breakout, int16_t *ret_temperature)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 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_xmc1400_breakout_reset(TF_XMC1400Breakout *xmc1400_breakout)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
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_xmc1400_breakout_get_identity(TF_XMC1400Breakout *xmc1400_breakout, 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:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
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 216 - 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_xmc1400_breakout_set_adc_values_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t period, bool value_has_to_change)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • e_code – Type: int

The period is the period with which the ADC Values 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_xmc1400_breakout_get_adc_values_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 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_xmc1400_breakout_set_adc_values_callback_configuration().

int tf_xmc1400_breakout_set_count_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t period, bool value_has_to_change, char option, uint32_t min, uint32_t max)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: uint32_t, Range: [0 to 232 - 1], Default: 0
  • max – Type: uint32_t, Range: [0 to 232 - 1], Default: 0
Returns:
  • e_code – Type: int

The period is the period with which the Count 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 Count 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_XMC1400_BREAKOUT_THRESHOLD_OPTION_OFF = 'x'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_SMALLER = '<'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_GREATER = '>'
int tf_xmc1400_breakout_get_count_callback_configuration(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint32_t *ret_min, uint32_t *ret_max)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
  • ret_option – Type: char, Range: See constants, Default: 'x'
  • ret_min – Type: uint32_t, Range: [0 to 232 - 1], Default: 0
  • ret_max – Type: uint32_t, Range: [0 to 232 - 1], Default: 0
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_xmc1400_breakout_set_count_callback_configuration().

The following constants are available for this function:

For ret_option:

  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_OFF = 'x'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_INSIDE = 'i'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_SMALLER = '<'
  • TF_XMC1400_BREAKOUT_THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_xmc1400_breakout_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_xmc1400_breakout_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_xmc1400_breakout_register_adc_values_callback(TF_XMC1400Breakout *xmc1400_breakout, TF_XMC1400Breakout_ADCValuesHandler handler, void *user_data)
void handler(TF_XMC1400Breakout *xmc1400_breakout, uint16_t values[8], void *user_data)
Callback Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • values – Type: uint16_t[8], Range: [0 to 212 - 1]
  • user_data – Type: void *

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

The parameters are the same as tf_xmc1400_breakout_get_adc_values().

int tf_xmc1400_breakout_register_count_callback(TF_XMC1400Breakout *xmc1400_breakout, TF_XMC1400Breakout_CountHandler handler, void *user_data)
void handler(TF_XMC1400Breakout *xmc1400_breakout, uint32_t count, void *user_data)
Callback Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • count – Type: uint32_t, Range: [0 to 232 - 1]
  • user_data – Type: void *

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

The parameter is the same as tf_xmc1400_breakout_get_count().

Virtual Functions

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

int tf_xmc1400_breakout_get_response_expected(TF_XMC1400Breakout *xmc1400_breakout, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • 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_xmc1400_breakout_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_XMC1400_BREAKOUT_FUNCTION_SET_GPIO_CONFIG = 1
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_XMC1400_BREAKOUT_FUNCTION_RESET = 243
  • TF_XMC1400_BREAKOUT_FUNCTION_WRITE_UID = 248
int tf_xmc1400_breakout_set_response_expected(TF_XMC1400Breakout *xmc1400_breakout, uint8_t function_id, bool response_expected)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • 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.

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_XMC1400_BREAKOUT_FUNCTION_SET_GPIO_CONFIG = 1
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_XMC1400_BREAKOUT_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_XMC1400_BREAKOUT_FUNCTION_RESET = 243
  • TF_XMC1400_BREAKOUT_FUNCTION_WRITE_UID = 248
int tf_xmc1400_breakout_set_response_expected_all(TF_XMC1400Breakout *xmc1400_breakout, bool response_expected)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • 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_xmc1400_breakout_set_bootloader_mode(TF_XMC1400Breakout *xmc1400_breakout, uint8_t mode, uint8_t *ret_status)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • 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_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_OK = 0
  • TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_INVALID_MODE = 1
  • TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_NO_CHANGE = 2
  • TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • TF_XMC1400_BREAKOUT_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int tf_xmc1400_breakout_get_bootloader_mode(TF_XMC1400Breakout *xmc1400_breakout, uint8_t *ret_mode)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Returns the current bootloader mode, see tf_xmc1400_breakout_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_XMC1400_BREAKOUT_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int tf_xmc1400_breakout_set_write_firmware_pointer(TF_XMC1400Breakout *xmc1400_breakout, uint32_t pointer)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Sets the firmware pointer for tf_xmc1400_breakout_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_xmc1400_breakout_write_firmware(TF_XMC1400Breakout *xmc1400_breakout, const uint8_t data[64], uint8_t *ret_status)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • 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_xmc1400_breakout_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_xmc1400_breakout_write_uid(TF_XMC1400Breakout *xmc1400_breakout, uint32_t uid)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
  • uid – Type: uint32_t, Range: [0 to 232 - 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_xmc1400_breakout_read_uid(TF_XMC1400Breakout *xmc1400_breakout, uint32_t *ret_uid)
Parameters:
  • xmc1400_breakout – Type: TF_XMC1400Breakout *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

Constants

TF_XMC1400_BREAKOUT_DEVICE_IDENTIFIER

This constant is used to identify a XMC1400 Breakout Bricklet.

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

TF_XMC1400_BREAKOUT_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a XMC1400 Breakout Bricklet.