Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / Multi Touch Bricklet 2.0

C/C++ for Microcontrollers - Multi Touch Bricklet 2.0¶

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

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

static TF_MultiTouchV2 mt;

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

    // Get current touch state
    bool state[13];
    check(tf_multi_touch_v2_get_touch_state(&mt, state), "get touch state");

    tf_hal_printf("Electrode 0: %s\n", state[0] ? "true" : "false");
    tf_hal_printf("Electrode 1: %s\n", state[1] ? "true" : "false");
    tf_hal_printf("Electrode 2: %s\n", state[2] ? "true" : "false");
    tf_hal_printf("Electrode 3: %s\n", state[3] ? "true" : "false");
    tf_hal_printf("Electrode 4: %s\n", state[4] ? "true" : "false");
    tf_hal_printf("Electrode 5: %s\n", state[5] ? "true" : "false");
    tf_hal_printf("Electrode 6: %s\n", state[6] ? "true" : "false");
    tf_hal_printf("Electrode 7: %s\n", state[7] ? "true" : "false");
    tf_hal_printf("Electrode 8: %s\n", state[8] ? "true" : "false");
    tf_hal_printf("Electrode 9: %s\n", state[9] ? "true" : "false");
    tf_hal_printf("Electrode 10: %s\n", state[10] ? "true" : "false");
    tf_hal_printf("Electrode 11: %s\n", state[11] ? "true" : "false");
    tf_hal_printf("Proximity: %s\n", state[12] ? "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_multi_touch_v2.h"

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

// Callback function for touch state callback
static void touch_state_handler(TF_MultiTouchV2 *device, bool state[13],
                                void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Electrode 0: %s\n", state[0] ? "true" : "false");
    tf_hal_printf("Electrode 1: %s\n", state[1] ? "true" : "false");
    tf_hal_printf("Electrode 2: %s\n", state[2] ? "true" : "false");
    tf_hal_printf("Electrode 3: %s\n", state[3] ? "true" : "false");
    tf_hal_printf("Electrode 4: %s\n", state[4] ? "true" : "false");
    tf_hal_printf("Electrode 5: %s\n", state[5] ? "true" : "false");
    tf_hal_printf("Electrode 6: %s\n", state[6] ? "true" : "false");
    tf_hal_printf("Electrode 7: %s\n", state[7] ? "true" : "false");
    tf_hal_printf("Electrode 8: %s\n", state[8] ? "true" : "false");
    tf_hal_printf("Electrode 9: %s\n", state[9] ? "true" : "false");
    tf_hal_printf("Electrode 10: %s\n", state[10] ? "true" : "false");
    tf_hal_printf("Electrode 11: %s\n", state[11] ? "true" : "false");
    tf_hal_printf("Proximity: %s\n", state[12] ? "true" : "false");
    tf_hal_printf("\n");
}

static TF_MultiTouchV2 mt;

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

    // Register touch state callback to function touch_state_handler
    tf_multi_touch_v2_register_touch_state_callback(&mt,
                                                    touch_state_handler,
                                                    NULL);

    // Set period for touch state callback to 0.01s (10ms)
    tf_multi_touch_v2_set_touch_state_callback_configuration(&mt, 10, 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_multi_touch_v2_create(TF_MultiTouchV2 *multi_touch_v2, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_MultiTouchV2 multi_touch_v2;
tf_multi_touch_v2_create(&multi_touch_v2, NULL, &hal);

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

int tf_multi_touch_v2_destroy(TF_MultiTouchV2 *multi_touch_v2)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
Returns:	e_code – Type: int

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

int tf_multi_touch_v2_get_touch_state(TF_MultiTouchV2 *multi_touch_v2, bool ret_state[13])¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
Output Parameters:	ret_state – Type: bool[13]
Returns:	e_code – Type: int

Returns the current touch state. The state is given as a array of bools.

Element 0 to 11 represent the 12 electrodes and element 12 represents the proximity.

If an electrode is touched, the corresponding element is true. If a hand or similar is in proximity to the electrodes, element 12 is true.

The proximity is activated with a distance of 1-2cm. An electrode is already counted as touched if a finger is nearly touching the electrode. This means that you can put a piece of paper or foil or similar on top of a electrode to build a touch panel with a professional look.

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

int tf_multi_touch_v2_recalibrate(TF_MultiTouchV2 *multi_touch_v2)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
Returns:	e_code – Type: int

Recalibrates the electrodes. Call this function whenever you changed or moved you electrodes.

int tf_multi_touch_v2_set_electrode_config(TF_MultiTouchV2 *multi_touch_v2, const bool enabled_electrodes[13])¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * enabled_electrodes – Type: const bool[13], Default: {true, true, true, true, true, true, true, true, true, true, true, true, true}
Returns:	e_code – Type: int

Enables/disables electrodes with a bool array (see tf_multi_touch_v2_get_touch_state()).

True enables the electrode, false disables the electrode. A disabled electrode will always return false as its state. If you don't need all electrodes you can disable the electrodes that are not needed.

It is recommended that you disable the proximity electrode (element 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by the Touch State callback.

Disabling electrodes will also reduce power consumption.

int tf_multi_touch_v2_get_electrode_config(TF_MultiTouchV2 *multi_touch_v2, bool ret_enabled_electrodes[13])¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
Output Parameters:	ret_enabled_electrodes – Type: bool[13], Default: {true, true, true, true, true, true, true, true, true, true, true, true, true}
Returns:	e_code – Type: int

Returns the electrode configuration, as set by tf_multi_touch_v2_set_electrode_config().

int tf_multi_touch_v2_set_electrode_sensitivity(TF_MultiTouchV2 *multi_touch_v2, uint8_t sensitivity)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * sensitivity – Type: uint8_t, Range: [5 to 201], Default: 181
Returns:	e_code – Type: int

Sets the sensitivity of the electrodes. An electrode with a high sensitivity will register a touch earlier then an electrode with a low sensitivity.

If you build a big electrode you might need to decrease the sensitivity, since the area that can be charged will get bigger. If you want to be able to activate an electrode from further away you need to increase the sensitivity.

After a new sensitivity is set, you likely want to call tf_multi_touch_v2_recalibrate() to calibrate the electrodes with the newly defined sensitivity.

int tf_multi_touch_v2_get_electrode_sensitivity(TF_MultiTouchV2 *multi_touch_v2, uint8_t *ret_sensitivity)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
Output Parameters:	ret_sensitivity – Type: uint8_t, Range: [5 to 201], Default: 181
Returns:	e_code – Type: int

Returns the current sensitivity, as set by tf_multi_touch_v2_set_electrode_sensitivity().

int tf_multi_touch_v2_set_touch_led_config(TF_MultiTouchV2 *multi_touch_v2, uint8_t config)¶

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

Configures the touch LED to be either turned off, turned on, blink in heartbeat mode or show the touch state (electrode touched = LED on).

The following constants are available for this function:

For config:

TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_OFF = 0
TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_ON = 1
TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

int tf_multi_touch_v2_get_touch_led_config(TF_MultiTouchV2 *multi_touch_v2, uint8_t *ret_config)¶

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

Returns the LED configuration as set by tf_multi_touch_v2_set_touch_led_config()

The following constants are available for this function:

For ret_config:

TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_OFF = 0
TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_ON = 1
TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_MULTI_TOUCH_V2_TOUCH_LED_CONFIG_SHOW_TOUCH = 3

Advanced Functions¶

int tf_multi_touch_v2_get_spitfp_error_count(TF_MultiTouchV2 *multi_touch_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:	multi_touch_v2 – Type: TF_MultiTouchV2 *
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_multi_touch_v2_set_status_led_config(TF_MultiTouchV2 *multi_touch_v2, uint8_t config)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_MULTI_TOUCH_V2_STATUS_LED_CONFIG_OFF = 0
TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_ON = 1
TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_multi_touch_v2_get_status_led_config(TF_MultiTouchV2 *multi_touch_v2, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_multi_touch_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_OFF = 0
TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_ON = 1
TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_MULTI_TOUCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_multi_touch_v2_get_chip_temperature(TF_MultiTouchV2 *multi_touch_v2, int16_t *ret_temperature)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
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_multi_touch_v2_reset(TF_MultiTouchV2 *multi_touch_v2)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
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_multi_touch_v2_get_identity(TF_MultiTouchV2 *multi_touch_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:	multi_touch_v2 – Type: TF_MultiTouchV2 *
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_multi_touch_v2_set_touch_state_callback_configuration(TF_MultiTouchV2 *multi_touch_v2, uint32_t period, bool value_has_to_change)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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 Touch State 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_multi_touch_v2_get_touch_state_callback_configuration(TF_MultiTouchV2 *multi_touch_v2, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
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_multi_touch_v2_set_touch_state_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_multi_touch_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_multi_touch_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_multi_touch_v2_register_touch_state_callback(TF_MultiTouchV2 *multi_touch_v2, TF_MultiTouchV2_TouchStateHandler handler, void *user_data)¶

void handler(TF_MultiTouchV2 *multi_touch_v2, bool state[13], void *user_data)

Callback Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * state – Type: bool[13] user_data – Type: void *

Returns the current touch state, see tf_multi_touch_v2_get_touch_state() for information about the state.

This callback is triggered every time the touch state changes with a given period (see tf_multi_touch_v2_set_touch_state_callback_configuration())

Virtual Functions¶

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

int tf_multi_touch_v2_get_response_expected(TF_MultiTouchV2 *multi_touch_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_multi_touch_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_MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION = 2
TF_MULTI_TOUCH_V2_FUNCTION_RECALIBRATE = 5
TF_MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_CONFIG = 6
TF_MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_SENSITIVITY = 8
TF_MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_LED_CONFIG = 10
TF_MULTI_TOUCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_MULTI_TOUCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_MULTI_TOUCH_V2_FUNCTION_RESET = 243
TF_MULTI_TOUCH_V2_FUNCTION_WRITE_UID = 248

int tf_multi_touch_v2_set_response_expected(TF_MultiTouchV2 *multi_touch_v2, uint8_t function_id, bool response_expected)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION = 2
TF_MULTI_TOUCH_V2_FUNCTION_RECALIBRATE = 5
TF_MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_CONFIG = 6
TF_MULTI_TOUCH_V2_FUNCTION_SET_ELECTRODE_SENSITIVITY = 8
TF_MULTI_TOUCH_V2_FUNCTION_SET_TOUCH_LED_CONFIG = 10
TF_MULTI_TOUCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_MULTI_TOUCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_MULTI_TOUCH_V2_FUNCTION_RESET = 243
TF_MULTI_TOUCH_V2_FUNCTION_WRITE_UID = 248

int tf_multi_touch_v2_set_response_expected_all(TF_MultiTouchV2 *multi_touch_v2, bool response_expected)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_multi_touch_v2_set_bootloader_mode(TF_MultiTouchV2 *multi_touch_v2, uint8_t mode, uint8_t *ret_status)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_MULTI_TOUCH_V2_BOOTLOADER_STATUS_OK = 0
TF_MULTI_TOUCH_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_MULTI_TOUCH_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_MULTI_TOUCH_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_MULTI_TOUCH_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_MULTI_TOUCH_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_multi_touch_v2_get_bootloader_mode(TF_MultiTouchV2 *multi_touch_v2, uint8_t *ret_mode)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_multi_touch_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_MULTI_TOUCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_multi_touch_v2_set_write_firmware_pointer(TF_MultiTouchV2 *multi_touch_v2, uint32_t pointer)¶

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

Sets the firmware pointer for tf_multi_touch_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_multi_touch_v2_write_firmware(TF_MultiTouchV2 *multi_touch_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_multi_touch_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_multi_touch_v2_write_uid(TF_MultiTouchV2 *multi_touch_v2, uint32_t uid)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 * 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_multi_touch_v2_read_uid(TF_MultiTouchV2 *multi_touch_v2, uint32_t *ret_uid)¶

Parameters:	multi_touch_v2 – Type: TF_MultiTouchV2 *
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_MULTI_TOUCH_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a Multi Touch Bricklet 2.0.

The functions tf_multi_touch_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_MULTI_TOUCH_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Multi Touch Bricklet 2.0.