Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / DMX Bricklet

C/C++ for Microcontrollers - DMX Bricklet¶

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

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

static TF_DMX dmx;

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

    // Configure Bricklet as DMX master
    check(tf_dmx_set_dmx_mode(&dmx, TF_DMX_DMX_MODE_MASTER), "call set_dmx_mode");

    // Write DMX frame with 3 channels
    uint8_t frame[3] = {255, 128, 0};
    check(tf_dmx_write_frame(&dmx, frame, 3), "call write_frame");
}

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_dmx_create(TF_DMX *dmx, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	dmx – Type: TF_DMX * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_DMX dmx;
tf_dmx_create(&dmx, NULL, &hal);

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

int tf_dmx_destroy(TF_DMX *dmx)¶

Parameters:	dmx – Type: TF_DMX *
Returns:	e_code – Type: int

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

int tf_dmx_set_dmx_mode(TF_DMX *dmx, uint8_t dmx_mode)¶

Parameters:	dmx – Type: TF_DMX * dmx_mode – Type: uint8_t, Range: See constants, Default: 0
Returns:	e_code – Type: int

Sets the DMX mode to either master or slave.

Calling this function sets frame number to 0.

The following constants are available for this function:

For dmx_mode:

TF_DMX_DMX_MODE_MASTER = 0
TF_DMX_DMX_MODE_SLAVE = 1

int tf_dmx_get_dmx_mode(TF_DMX *dmx, uint8_t *ret_dmx_mode)¶

Parameters:	dmx – Type: TF_DMX *
Output Parameters:	ret_dmx_mode – Type: uint8_t, Range: See constants, Default: 0
Returns:	e_code – Type: int

Returns the DMX mode, as set by tf_dmx_set_dmx_mode().

The following constants are available for this function:

For ret_dmx_mode:

TF_DMX_DMX_MODE_MASTER = 0
TF_DMX_DMX_MODE_SLAVE = 1

int tf_dmx_write_frame(TF_DMX *dmx, const uint8_t *frame, uint16_t frame_length)¶

Parameters:	dmx – Type: TF_DMX * frame – Type: const uint8_t , Range: [0 to 255] frame_length* – Type: uint16_t
Returns:	e_code – Type: int

Writes a DMX frame. The maximum frame size is 512 byte. Each byte represents one channel.

The next frame can be written after the Frame Started callback was called. The frame is double buffered, so a new frame can be written as soon as the writing of the prior frame starts.

The data will be transfered when the next frame duration ends, see tf_dmx_set_frame_duration().

Generic approach:

Set the frame duration to a value that represents the number of frames per second you want to achieve.
Set channels for first frame.
Wait for the Frame Started callback.
Set channels for next frame.
Wait for the Frame Started callback.
and so on.

This approach ensures that you can set new DMX data with a fixed frame rate.

This function can only be called in master mode.

int tf_dmx_read_frame(TF_DMX *dmx, uint8_t *ret_frame, uint16_t *ret_frame_length, uint32_t *ret_frame_number)¶

Parameters:	dmx – Type: TF_DMX *
Output Parameters:	ret_frame – Type: uint8_t , Range: [0 to 255] ret_frame_length* – Type: uint16_t ret_frame_number – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the last frame that was written by the DMX master. The size of the array is equivalent to the number of channels in the frame. Each byte represents one channel.

The next frame is available after the Frame Available callback was called.

Generic approach:

Call tf_dmx_read_frame() to get first frame.
Wait for the Frame Available callback.
Call tf_dmx_read_frame() to get second frame.
Wait for the Frame Available callback.
and so on.

Instead of polling this function you can also use the Frame Low Level callback. You can enable it with tf_dmx_set_frame_callback_config().

The frame number starts at 0 and it is increased by one with each received frame.

This function can only be called in slave mode.

int tf_dmx_set_frame_duration(TF_DMX *dmx, uint16_t frame_duration)¶

Parameters:	dmx – Type: TF_DMX * frame_duration – Type: uint16_t, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 100
Returns:	e_code – Type: int

Sets the duration of a frame.

Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).

If you always want to send a frame as fast as possible you can set this value to 0.

This setting is only used in master mode.

int tf_dmx_get_frame_duration(TF_DMX *dmx, uint16_t *ret_frame_duration)¶

Parameters:	dmx – Type: TF_DMX *
Output Parameters:	ret_frame_duration – Type: uint16_t, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 100
Returns:	e_code – Type: int

Returns the frame duration as set by tf_dmx_set_frame_duration().

Advanced Functions¶

int tf_dmx_get_frame_error_count(TF_DMX *dmx, uint32_t *ret_overrun_error_count, uint32_t *ret_framing_error_count)¶

Parameters:	dmx – Type: TF_DMX *
Output Parameters:	ret_overrun_error_count – Type: uint32_t, Range: [0 to 2³² - 1] ret_framing_error_count – Type: uint32_t, Range: [0 to 2³² - 1]
Returns:	e_code – Type: int

Returns the current number of overrun and framing errors.

int tf_dmx_set_communication_led_config(TF_DMX *dmx, uint8_t config)¶

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

Sets the communication LED configuration. By default the LED shows communication traffic, 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 off.

The following constants are available for this function:

For config:

TF_DMX_COMMUNICATION_LED_CONFIG_OFF = 0
TF_DMX_COMMUNICATION_LED_CONFIG_ON = 1
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_dmx_get_communication_led_config(TF_DMX *dmx, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_dmx_set_communication_led_config()

The following constants are available for this function:

For ret_config:

TF_DMX_COMMUNICATION_LED_CONFIG_OFF = 0
TF_DMX_COMMUNICATION_LED_CONFIG_ON = 1
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_dmx_set_error_led_config(TF_DMX *dmx, uint8_t config)¶

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

Sets the error LED configuration.

By default the error LED turns on if there is any error (see Frame Error Count callback). If you call this function with the Show-Error option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For config:

TF_DMX_ERROR_LED_CONFIG_OFF = 0
TF_DMX_ERROR_LED_CONFIG_ON = 1
TF_DMX_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_dmx_get_error_led_config(TF_DMX *dmx, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_dmx_set_error_led_config().

The following constants are available for this function:

For ret_config:

TF_DMX_ERROR_LED_CONFIG_OFF = 0
TF_DMX_ERROR_LED_CONFIG_ON = 1
TF_DMX_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_dmx_get_spitfp_error_count(TF_DMX *dmx, 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:	dmx – Type: TF_DMX *
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_dmx_set_status_led_config(TF_DMX *dmx, uint8_t config)¶

Parameters:	dmx – Type: TF_DMX * 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_DMX_STATUS_LED_CONFIG_OFF = 0
TF_DMX_STATUS_LED_CONFIG_ON = 1
TF_DMX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_dmx_get_status_led_config(TF_DMX *dmx, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_dmx_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_DMX_STATUS_LED_CONFIG_OFF = 0
TF_DMX_STATUS_LED_CONFIG_ON = 1
TF_DMX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_DMX_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_dmx_get_chip_temperature(TF_DMX *dmx, int16_t *ret_temperature)¶

Parameters:	dmx – Type: TF_DMX *
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_dmx_reset(TF_DMX *dmx)¶

Parameters:	dmx – Type: TF_DMX *
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_dmx_get_identity(TF_DMX *dmx, 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:	dmx – Type: TF_DMX *
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_dmx_set_frame_callback_config(TF_DMX *dmx, bool frame_started_callback_enabled, bool frame_available_callback_enabled, bool frame_callback_enabled, bool frame_error_count_callback_enabled)¶

Parameters:	dmx – Type: TF_DMX * frame_started_callback_enabled – Type: bool, Default: true frame_available_callback_enabled – Type: bool, Default: true frame_callback_enabled – Type: bool, Default: false frame_error_count_callback_enabled – Type: bool, Default: false
Returns:	e_code – Type: int

Enables/Disables the different callbacks. By default the Frame Started callback and Frame Available callback are enabled while the Frame Low Level callback and Frame Error Count callback are disabled.

If you want to use the Frame Low Level callback you can enable it and disable the Frame Available callback at the same time. It becomes redundant in this case.

int tf_dmx_get_frame_callback_config(TF_DMX *dmx, bool *ret_frame_started_callback_enabled, bool *ret_frame_available_callback_enabled, bool *ret_frame_callback_enabled, bool *ret_frame_error_count_callback_enabled)¶

Parameters:	dmx – Type: TF_DMX *
Output Parameters:	ret_frame_started_callback_enabled – Type: bool, Default: true ret_frame_available_callback_enabled – Type: bool, Default: true ret_frame_callback_enabled – Type: bool, Default: false ret_frame_error_count_callback_enabled – Type: bool, Default: false
Returns:	e_code – Type: int

Returns the frame callback config as set by tf_dmx_set_frame_callback_config().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_dmx_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_dmx_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_dmx_register_frame_started_callback(TF_DMX *dmx, TF_DMX_FrameStartedHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, void *user_data)

Callback Parameters:	dmx – Type: TF_DMX * user_data – Type: void *

This callback is triggered as soon as a new frame write is started. You should send the data for the next frame directly after this callback was triggered.

For an explanation of the general approach see tf_dmx_write_frame().

This callback can be enabled via tf_dmx_set_frame_callback_config().

This callback can only be triggered in master mode.

int tf_dmx_register_frame_available_callback(TF_DMX *dmx, TF_DMX_FrameAvailableHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, uint32_t frame_number, void *user_data)

Callback Parameters:	dmx – Type: TF_DMX * frame_number – Type: uint32_t, Range: [0 to 2³² - 1] user_data – Type: void *

This callback is triggered in slave mode when a new frame was received from the DMX master and it can be read out. You have to read the frame before the master has written the next frame, see tf_dmx_read_frame() for more details.

The parameter is the frame number, it is increased by one with each received frame.

This callback can be enabled via tf_dmx_set_frame_callback_config().

This callback can only be triggered in slave mode.

int tf_dmx_register_frame_low_level_callback(TF_DMX *dmx, TF_DMX_FrameLowLevelHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, uint16_t frame_length, uint16_t frame_chunk_offset, uint8_t frame_chunk_data[56], uint32_t frame_number, void *user_data)

Callback Parameters:	dmx – Type: TF_DMX * frame_length – Type: uint16_t, Range: [0 to 2⁹] frame_chunk_offset – Type: uint16_t, Range: [0 to 2¹⁶ - 1] frame_chunk_data – Type: uint8_t[56], Range: [0 to 255] frame_number – Type: uint32_t, Range: [0 to 2³² - 1] user_data – Type: void *

This callback is called as soon as a new frame is available (written by the DMX master).

The size of the array is equivalent to the number of channels in the frame. Each byte represents one channel.

This callback can be enabled via tf_dmx_set_frame_callback_config().

This callback can only be triggered in slave mode.

int tf_dmx_register_frame_error_count_callback(TF_DMX *dmx, TF_DMX_FrameErrorCountHandler handler, void *user_data)¶

void handler(TF_DMX *dmx, uint32_t overrun_error_count, uint32_t framing_error_count, void *user_data)

Callback Parameters:	dmx – Type: TF_DMX * overrun_error_count – Type: uint32_t, Range: [0 to 2³² - 1] framing_error_count – Type: uint32_t, Range: [0 to 2³² - 1] user_data – Type: void *

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

Virtual Functions¶

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

int tf_dmx_get_response_expected(TF_DMX *dmx, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	dmx – Type: TF_DMX * 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_dmx_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_DMX_FUNCTION_SET_DMX_MODE = 1
TF_DMX_FUNCTION_WRITE_FRAME = 3
TF_DMX_FUNCTION_SET_FRAME_DURATION = 5
TF_DMX_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
TF_DMX_FUNCTION_SET_ERROR_LED_CONFIG = 10
TF_DMX_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
TF_DMX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_DMX_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_DMX_FUNCTION_RESET = 243
TF_DMX_FUNCTION_WRITE_UID = 248

int tf_dmx_set_response_expected(TF_DMX *dmx, uint8_t function_id, bool response_expected)¶

Parameters:	dmx – Type: TF_DMX * 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_DMX_FUNCTION_SET_DMX_MODE = 1
TF_DMX_FUNCTION_WRITE_FRAME = 3
TF_DMX_FUNCTION_SET_FRAME_DURATION = 5
TF_DMX_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
TF_DMX_FUNCTION_SET_ERROR_LED_CONFIG = 10
TF_DMX_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
TF_DMX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_DMX_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_DMX_FUNCTION_RESET = 243
TF_DMX_FUNCTION_WRITE_UID = 248

int tf_dmx_set_response_expected_all(TF_DMX *dmx, bool response_expected)¶

Parameters:	dmx – Type: TF_DMX * 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_dmx_set_bootloader_mode(TF_DMX *dmx, uint8_t mode, uint8_t *ret_status)¶

Parameters:	dmx – Type: TF_DMX * 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_DMX_BOOTLOADER_MODE_BOOTLOADER = 0
TF_DMX_BOOTLOADER_MODE_FIRMWARE = 1
TF_DMX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_DMX_BOOTLOADER_STATUS_OK = 0
TF_DMX_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_DMX_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_DMX_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_DMX_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_DMX_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_dmx_get_bootloader_mode(TF_DMX *dmx, uint8_t *ret_mode)¶

Parameters:	dmx – Type: TF_DMX *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_dmx_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_DMX_BOOTLOADER_MODE_BOOTLOADER = 0
TF_DMX_BOOTLOADER_MODE_FIRMWARE = 1
TF_DMX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_dmx_set_write_firmware_pointer(TF_DMX *dmx, uint32_t pointer)¶

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

Sets the firmware pointer for tf_dmx_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_dmx_write_firmware(TF_DMX *dmx, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	dmx – Type: TF_DMX * 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_dmx_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_dmx_write_uid(TF_DMX *dmx, uint32_t uid)¶

Parameters:	dmx – Type: TF_DMX * 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_dmx_read_uid(TF_DMX *dmx, uint32_t *ret_uid)¶

Parameters:	dmx – Type: TF_DMX *
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_DMX_DEVICE_IDENTIFIER¶

This constant is used to identify a DMX Bricklet.

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

TF_DMX_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a DMX Bricklet.