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

C/C++ for Microcontrollers - RS232 Bricklet 2.0

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

Loopback

Download (example_loopback.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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
// 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_rs232_v2.h"

// For this example connect the RX1 and TX pin to receive the send message

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

static char buffer[5] = {0}; // +1 for the null terminator

// Callback function for read callback
static void read_handler(TF_RS232V2 *device, char *message, uint16_t message_length,
                         void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    message[message_length] = '\0';

    tf_hal_printf("Message: \"%s\"\n", message);
}

static TF_RS232V2 rs232;

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

    // Register read callback to function read_handler
    tf_rs232_v2_register_read_callback(&rs232,
                                       read_handler,
                                       buffer,
                                       NULL);

    // Enable read callback
    check(tf_rs232_v2_enable_read_callback(&rs232), "call enable_read_callback");

    // Write "test" string
    char message[4] = {'t', 'e', 's', 't'};
    uint16_t written;
    check(tf_rs232_v2_write(&rs232, message, 4, &written), "call write");
}

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

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

TF_RS232V2 rs232_v2;
tf_rs232_v2_create(&rs232_v2, NULL, &hal);

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

int tf_rs232_v2_destroy(TF_RS232V2 *rs232_v2)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Returns:
  • e_code – Type: int

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

int tf_rs232_v2_write(TF_RS232V2 *rs232_v2, const char *message, uint16_t message_length, uint16_t *ret_message_written)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • message – Type: const char *
  • message_length – Type: uint16_t
Output Parameters:
  • ret_message_written – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • e_code – Type: int

Writes characters to the RS232 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See tf_rs232_v2_set_configuration() for configuration possibilities regarding baud rate, parity and so on.

int tf_rs232_v2_read(TF_RS232V2 *rs232_v2, uint16_t length, char *ret_message, uint16_t *ret_message_length)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • length – Type: uint16_t, Range: [0 to 216 - 1]
Output Parameters:
  • ret_message – Type: char *
  • ret_message_length – Type: uint16_t
Returns:
  • e_code – Type: int

Returns up to length characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See tf_rs232_v2_enable_read_callback() and Read Low Level callback.

int tf_rs232_v2_set_configuration(TF_RS232V2 *rs232_v2, uint32_t baudrate, uint8_t parity, uint8_t stopbits, uint8_t wordlength, uint8_t flowcontrol)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • baudrate – Type: uint32_t, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200
  • parity – Type: uint8_t, Range: See constants, Default: 0
  • stopbits – Type: uint8_t, Range: See constants, Default: 1
  • wordlength – Type: uint8_t, Range: See constants, Default: 8
  • flowcontrol – Type: uint8_t, Range: See constants, Default: 0
Returns:
  • e_code – Type: int

Sets the configuration for the RS232 communication.

The following constants are available for this function:

For parity:

  • TF_RS232_V2_PARITY_NONE = 0
  • TF_RS232_V2_PARITY_ODD = 1
  • TF_RS232_V2_PARITY_EVEN = 2

For stopbits:

  • TF_RS232_V2_STOPBITS_1 = 1
  • TF_RS232_V2_STOPBITS_2 = 2

For wordlength:

  • TF_RS232_V2_WORDLENGTH_5 = 5
  • TF_RS232_V2_WORDLENGTH_6 = 6
  • TF_RS232_V2_WORDLENGTH_7 = 7
  • TF_RS232_V2_WORDLENGTH_8 = 8

For flowcontrol:

  • TF_RS232_V2_FLOWCONTROL_OFF = 0
  • TF_RS232_V2_FLOWCONTROL_SOFTWARE = 1
  • TF_RS232_V2_FLOWCONTROL_HARDWARE = 2
int tf_rs232_v2_get_configuration(TF_RS232V2 *rs232_v2, uint32_t *ret_baudrate, uint8_t *ret_parity, uint8_t *ret_stopbits, uint8_t *ret_wordlength, uint8_t *ret_flowcontrol)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_baudrate – Type: uint32_t, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200
  • ret_parity – Type: uint8_t, Range: See constants, Default: 0
  • ret_stopbits – Type: uint8_t, Range: See constants, Default: 1
  • ret_wordlength – Type: uint8_t, Range: See constants, Default: 8
  • ret_flowcontrol – Type: uint8_t, Range: See constants, Default: 0
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_rs232_v2_set_configuration().

The following constants are available for this function:

For ret_parity:

  • TF_RS232_V2_PARITY_NONE = 0
  • TF_RS232_V2_PARITY_ODD = 1
  • TF_RS232_V2_PARITY_EVEN = 2

For ret_stopbits:

  • TF_RS232_V2_STOPBITS_1 = 1
  • TF_RS232_V2_STOPBITS_2 = 2

For ret_wordlength:

  • TF_RS232_V2_WORDLENGTH_5 = 5
  • TF_RS232_V2_WORDLENGTH_6 = 6
  • TF_RS232_V2_WORDLENGTH_7 = 7
  • TF_RS232_V2_WORDLENGTH_8 = 8

For ret_flowcontrol:

  • TF_RS232_V2_FLOWCONTROL_OFF = 0
  • TF_RS232_V2_FLOWCONTROL_SOFTWARE = 1
  • TF_RS232_V2_FLOWCONTROL_HARDWARE = 2

Advanced Functions

int tf_rs232_v2_set_buffer_config(TF_RS232V2 *rs232_v2, uint16_t send_buffer_size, uint16_t receive_buffer_size)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • send_buffer_size – Type: uint16_t, Unit: 1 B, Range: [210 to 9216], Default: 5120
  • receive_buffer_size – Type: uint16_t, Unit: 1 B, Range: [210 to 9216], Default: 5120
Returns:
  • e_code – Type: int

Sets the send and receive buffer size in byte. In total the buffers have to be 10240 byte (10KiB) in size, the minimum buffer size is 1024 byte (1KiB) for each.

The current buffer content is lost if this function is called.

The send buffer holds data that is given by tf_rs232_v2_write() and can not be written yet. The receive buffer holds data that is received through RS232 but could not yet be send to the user, either by tf_rs232_v2_read() or through Read Low Level callback.

int tf_rs232_v2_get_buffer_config(TF_RS232V2 *rs232_v2, uint16_t *ret_send_buffer_size, uint16_t *ret_receive_buffer_size)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_send_buffer_size – Type: uint16_t, Unit: 1 B, Range: [210 to 9216], Default: 5120
  • ret_receive_buffer_size – Type: uint16_t, Unit: 1 B, Range: [210 to 9216], Default: 5120
Returns:
  • e_code – Type: int

Returns the buffer configuration as set by tf_rs232_v2_set_buffer_config().

int tf_rs232_v2_get_buffer_status(TF_RS232V2 *rs232_v2, uint16_t *ret_send_buffer_used, uint16_t *ret_receive_buffer_used)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_send_buffer_used – Type: uint16_t, Unit: 1 B, Range: [0 to 9216]
  • ret_receive_buffer_used – Type: uint16_t, Unit: 1 B, Range: [0 to 9216]
Returns:
  • e_code – Type: int

Returns the currently used bytes for the send and received buffer.

See tf_rs232_v2_set_buffer_config() for buffer size configuration.

int tf_rs232_v2_get_error_count(TF_RS232V2 *rs232_v2, uint32_t *ret_error_count_overrun, uint32_t *ret_error_count_parity)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_error_count_overrun – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_parity – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Returns the current number of overrun and parity errors.

int tf_rs232_v2_get_spitfp_error_count(TF_RS232V2 *rs232_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:
  • rs232_v2 – Type: TF_RS232V2 *
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_rs232_v2_set_status_led_config(TF_RS232V2 *rs232_v2, uint8_t config)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_RS232_V2_STATUS_LED_CONFIG_OFF = 0
  • TF_RS232_V2_STATUS_LED_CONFIG_ON = 1
  • TF_RS232_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_RS232_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_rs232_v2_get_status_led_config(TF_RS232V2 *rs232_v2, uint8_t *ret_config)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_rs232_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • TF_RS232_V2_STATUS_LED_CONFIG_OFF = 0
  • TF_RS232_V2_STATUS_LED_CONFIG_ON = 1
  • TF_RS232_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_RS232_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_rs232_v2_get_chip_temperature(TF_RS232V2 *rs232_v2, int16_t *ret_temperature)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
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_rs232_v2_reset(TF_RS232V2 *rs232_v2)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
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_rs232_v2_get_identity(TF_RS232V2 *rs232_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:
  • rs232_v2 – Type: TF_RS232V2 *
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_rs232_v2_enable_read_callback(TF_RS232V2 *rs232_v2)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Returns:
  • e_code – Type: int

Enables the Read Low Level callback. This will disable the Frame Readable callback.

By default the callback is disabled.

int tf_rs232_v2_disable_read_callback(TF_RS232V2 *rs232_v2)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Returns:
  • e_code – Type: int

Disables the Read Low Level callback.

By default the callback is disabled.

int tf_rs232_v2_is_read_callback_enabled(TF_RS232V2 *rs232_v2, bool *ret_enabled)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_enabled – Type: bool, Default: false
Returns:
  • e_code – Type: int

Returns true if the Read Low Level callback is enabled, false otherwise.

int tf_rs232_v2_set_frame_readable_callback_configuration(TF_RS232V2 *rs232_v2, uint16_t frame_size)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • frame_size – Type: uint16_t, Unit: 1 B, Range: [0 to 9216], Default: 0
Returns:
  • e_code – Type: int

Configures the Frame Readable callback. The frame size is the number of bytes, that have to be readable to trigger the callback. A frame size of 0 disables the callback. A frame size greater than 0 enables the callback and disables the Read Low Level callback.

By default the callback is disabled.

New in version 2.0.3 (Plugin).

int tf_rs232_v2_get_frame_readable_callback_configuration(TF_RS232V2 *rs232_v2, uint16_t *ret_frame_size)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_frame_size – Type: uint16_t, Unit: 1 B, Range: [0 to 9216], Default: 0
Returns:
  • e_code – Type: int

Returns the callback configuration as set by tf_rs232_v2_set_frame_readable_callback_configuration().

New in version 2.0.3 (Plugin).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_rs232_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_rs232_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_rs232_v2_register_read_low_level_callback(TF_RS232V2 *rs232_v2, TF_RS232V2_ReadLowLevelHandler handler, void *user_data)
void handler(TF_RS232V2 *rs232_v2, uint16_t message_length, uint16_t message_chunk_offset, char message_chunk_data[60], void *user_data)
Callback Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • message_length – Type: uint16_t, Range: [0 to 216 - 1]
  • message_chunk_offset – Type: uint16_t, Range: [0 to 216 - 1]
  • message_chunk_data – Type: char[60]
  • user_data – Type: void *

This callback is called if new data is available.

To enable this callback, use tf_rs232_v2_enable_read_callback().

int tf_rs232_v2_register_error_count_callback(TF_RS232V2 *rs232_v2, TF_RS232V2_ErrorCountHandler handler, void *user_data)
void handler(TF_RS232V2 *rs232_v2, uint32_t error_count_overrun, uint32_t error_count_parity, void *user_data)
Callback Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • error_count_overrun – Type: uint32_t, Range: [0 to 232 - 1]
  • error_count_parity – Type: uint32_t, Range: [0 to 232 - 1]
  • user_data – Type: void *

This callback is called if a new error occurs. It returns the current overrun and parity error count.

int tf_rs232_v2_register_frame_readable_callback(TF_RS232V2 *rs232_v2, TF_RS232V2_FrameReadableHandler handler, void *user_data)
void handler(TF_RS232V2 *rs232_v2, uint16_t frame_count, void *user_data)
Callback Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • frame_count – Type: uint16_t, Range: [0 to 216 - 1]
  • user_data – Type: void *

This callback is called if at least one frame of data is readable. The frame size is configured with tf_rs232_v2_set_frame_readable_callback_configuration(). The frame count parameter is the number of frames that can be read. This callback is triggered only once until tf_rs232_v2_read() is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the tf_rs232_v2_read() function, every time the callback triggers without checking the frame count parameter.

New in version 2.0.3 (Plugin).

Virtual Functions

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

int tf_rs232_v2_get_response_expected(TF_RS232V2 *rs232_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_rs232_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_RS232_V2_FUNCTION_ENABLE_READ_CALLBACK = 3
  • TF_RS232_V2_FUNCTION_DISABLE_READ_CALLBACK = 4
  • TF_RS232_V2_FUNCTION_SET_CONFIGURATION = 6
  • TF_RS232_V2_FUNCTION_SET_BUFFER_CONFIG = 8
  • TF_RS232_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
  • TF_RS232_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_RS232_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_RS232_V2_FUNCTION_RESET = 243
  • TF_RS232_V2_FUNCTION_WRITE_UID = 248
int tf_rs232_v2_set_response_expected(TF_RS232V2 *rs232_v2, uint8_t function_id, bool response_expected)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_RS232_V2_FUNCTION_ENABLE_READ_CALLBACK = 3
  • TF_RS232_V2_FUNCTION_DISABLE_READ_CALLBACK = 4
  • TF_RS232_V2_FUNCTION_SET_CONFIGURATION = 6
  • TF_RS232_V2_FUNCTION_SET_BUFFER_CONFIG = 8
  • TF_RS232_V2_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
  • TF_RS232_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_RS232_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_RS232_V2_FUNCTION_RESET = 243
  • TF_RS232_V2_FUNCTION_WRITE_UID = 248
int tf_rs232_v2_set_response_expected_all(TF_RS232V2 *rs232_v2, bool response_expected)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_rs232_v2_set_bootloader_mode(TF_RS232V2 *rs232_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_RS232_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • TF_RS232_V2_BOOTLOADER_STATUS_OK = 0
  • TF_RS232_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • TF_RS232_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • TF_RS232_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • TF_RS232_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • TF_RS232_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int tf_rs232_v2_get_bootloader_mode(TF_RS232V2 *rs232_v2, uint8_t *ret_mode)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Returns the current bootloader mode, see tf_rs232_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_RS232_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_RS232_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int tf_rs232_v2_set_write_firmware_pointer(TF_RS232V2 *rs232_v2, uint32_t pointer)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Sets the firmware pointer for tf_rs232_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_rs232_v2_write_firmware(TF_RS232V2 *rs232_v2, const uint8_t data[64], uint8_t *ret_status)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_rs232_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_rs232_v2_write_uid(TF_RS232V2 *rs232_v2, uint32_t uid)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
  • 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_rs232_v2_read_uid(TF_RS232V2 *rs232_v2, uint32_t *ret_uid)
Parameters:
  • rs232_v2 – Type: TF_RS232V2 *
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_RS232_V2_DEVICE_IDENTIFIER

This constant is used to identify a RS232 Bricklet 2.0.

The functions tf_rs232_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_RS232_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a RS232 Bricklet 2.0.