Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / Remote Switch Bricklet 2.0

C/C++ for Microcontrollers - Remote Switch Bricklet 2.0¶

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

Switch Socket¶

Download (example_switch_socket.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_remote_switch_v2.h"

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

static TF_RemoteSwitchV2 rs;

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

    // Switch on a type A socket with house code 17 and receiver code 1.
    // House code 17 is 10001 in binary (least-significant bit first)
    // and means that the DIP switches 1 and 5 are on and 2-4 are off.
    // Receiver code 1 is 10000 in binary (least-significant bit first)
    // and means that the DIP switch A is on and B-E are off.
    check(tf_remote_switch_v2_switch_socket_a(&rs, 17, 1,
                                              TF_REMOTE_SWITCH_V2_SWITCH_TO_ON), "call switch_socket_a");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Remote Callback¶

Download (example_remote_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_remote_switch_v2.h"

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

// Callback function for remote status a callback
static void remote_status_a_handler(TF_RemoteSwitchV2 *device, uint8_t house_code,
                                    uint8_t receiver_code, uint8_t switch_to,
                                    uint16_t repeats, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("House Code: %I8u\n", house_code);
    tf_hal_printf("Receiver Code: %I8u\n", receiver_code);

    if (switch_to == TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF) {
        tf_hal_printf("Switch To: Off\n");
    } else if (switch_to == TF_REMOTE_SWITCH_V2_SWITCH_TO_ON) {
        tf_hal_printf("Switch To: On\n");
    }

    tf_hal_printf("Repeats: %I16u\n", repeats);
    tf_hal_printf("\n");
}

static TF_RemoteSwitchV2 rs;

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

    // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
    check(tf_remote_switch_v2_set_remote_configuration(&rs,
                                                       TF_REMOTE_SWITCH_V2_REMOTE_TYPE_A,
                                                       1,
                                                       true), "call set_remote_configuration");

    // Register remote status a callback to function remote_status_a_handler
    tf_remote_switch_v2_register_remote_status_a_callback(&rs,
                                                          remote_status_a_handler,
                                                          NULL);
}

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_remote_switch_v2_create(TF_RemoteSwitchV2 *remote_switch_v2, const char *uid_or_port_name, TF_HAL *hal)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * uid – Type: const char * hal – Type: TF_HAL *
Returns:	e_code – Type: int

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

TF_RemoteSwitchV2 remote_switch_v2;
tf_remote_switch_v2_create(&remote_switch_v2, NULL, &hal);

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

int tf_remote_switch_v2_destroy(TF_RemoteSwitchV2 *remote_switch_v2)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Returns:	e_code – Type: int

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

int tf_remote_switch_v2_get_switching_state(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_state)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_state – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switch socket functions until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see tf_remote_switch_v2_set_repeats().

The following constants are available for this function:

For ret_state:

TF_REMOTE_SWITCH_V2_SWITCHING_STATE_READY = 0
TF_REMOTE_SWITCH_V2_SWITCHING_STATE_BUSY = 1

int tf_remote_switch_v2_switch_socket_a(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * house_code – Type: uint8_t, Range: [0 to 31] receiver_code – Type: uint8_t, Range: [0 to 31] switch_to – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

For switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_switch_socket_b(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t address, uint8_t unit, uint8_t switch_to)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * address – Type: uint32_t, Range: [0 to 2²⁶ - 1] unit – Type: uint8_t, Range: [0 to 15, 255] switch_to – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

The following constants are available for this function:

For switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_dim_socket_b(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t address, uint8_t unit, uint8_t dim_value)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * address – Type: uint32_t, Range: [0 to 2²⁶ - 1] unit – Type: uint8_t, Range: [0 to 15, 255] dim_value – Type: uint8_t, Range: [0 to 255]
Returns:	e_code – Type: int

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

int tf_remote_switch_v2_switch_socket_c(TF_RemoteSwitchV2 *remote_switch_v2, char system_code, uint8_t device_code, uint8_t switch_to)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * system_code – Type: char, Range: ['A' to 'P'] device_code – Type: uint8_t, Range: [1 to 16] switch_to – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

For switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_set_remote_configuration(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t remote_type, uint16_t minimum_repeats, bool callback_enabled)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * remote_type – Type: uint8_t, Range: See constants, Default: 0 minimum_repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1], Default: 2 callback_enabled – Type: bool, Default: false
Returns:	e_code – Type: int

Sets the configuration for receiving data from a remote of type A, B or C.

Remote Type: A, B or C depending on the type of remote you want to receive.
Minimum Repeats: The minimum number of repeated data packets until the callback is triggered (if enabled).
Callback Enabled: Enable or disable callback (see Remote Status A callback, Remote Status B callback and Remote Status C callback).

The following constants are available for this function:

For remote_type:

TF_REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
TF_REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
TF_REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2

int tf_remote_switch_v2_get_remote_configuration(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_remote_type, uint16_t *ret_minimum_repeats, bool *ret_callback_enabled)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_remote_type – Type: uint8_t, Range: See constants, Default: 0 ret_minimum_repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1], Default: 2 ret_callback_enabled – Type: bool, Default: false
Returns:	e_code – Type: int

Returns the remote configuration as set by tf_remote_switch_v2_set_remote_configuration()

The following constants are available for this function:

For ret_remote_type:

TF_REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
TF_REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
TF_REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2

int tf_remote_switch_v2_get_remote_status_a(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_house_code, uint8_t *ret_receiver_code, uint8_t *ret_switch_to, uint16_t *ret_repeats)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_house_code – Type: uint8_t, Range: [0 to 31] ret_receiver_code – Type: uint8_t, Range: [0 to 31] ret_switch_to – Type: uint8_t, Range: See constants ret_repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see tf_remote_switch_v2_set_remote_configuration() and Remote Status A callback.

The following constants are available for this function:

For ret_switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_get_remote_status_b(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t *ret_address, uint8_t *ret_unit, uint8_t *ret_switch_to, uint8_t *ret_dim_value, uint16_t *ret_repeats)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_address – Type: uint32_t, Range: [0 to 2²⁶ - 1] ret_unit – Type: uint8_t, Range: [0 to 15] ret_switch_to – Type: uint8_t, Range: See constants ret_dim_value – Type: uint8_t, Range: [0 to 255] ret_repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see tf_remote_switch_v2_set_remote_configuration() and Remote Status B callback.

The following constants are available for this function:

For ret_switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_get_remote_status_c(TF_RemoteSwitchV2 *remote_switch_v2, char *ret_system_code, uint8_t *ret_device_code, uint8_t *ret_switch_to, uint16_t *ret_repeats)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_system_code – Type: char, Range: ['A' to 'P'] ret_device_code – Type: uint8_t, Range: [1 to 16] ret_switch_to – Type: uint8_t, Range: See constants ret_repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1]
Returns:	e_code – Type: int

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see tf_remote_switch_v2_set_remote_configuration() and Remote Status C callback.

The following constants are available for this function:

For ret_switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

Advanced Functions¶

int tf_remote_switch_v2_set_repeats(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t repeats)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * repeats – Type: uint8_t, Range: [0 to 255], Default: 5
Returns:	e_code – Type: int

Sets the number of times the code is sent when one of the Switch Socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

int tf_remote_switch_v2_get_repeats(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_repeats)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_repeats – Type: uint8_t, Range: [0 to 255], Default: 5
Returns:	e_code – Type: int

Returns the number of repeats as set by tf_remote_switch_v2_set_repeats().

int tf_remote_switch_v2_get_spitfp_error_count(TF_RemoteSwitchV2 *remote_switch_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:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
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_remote_switch_v2_set_status_led_config(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t config)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_remote_switch_v2_get_status_led_config(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_config)¶

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

Returns the configuration as set by tf_remote_switch_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_remote_switch_v2_get_chip_temperature(TF_RemoteSwitchV2 *remote_switch_v2, int16_t *ret_temperature)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
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_remote_switch_v2_reset(TF_RemoteSwitchV2 *remote_switch_v2)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
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_remote_switch_v2_get_identity(TF_RemoteSwitchV2 *remote_switch_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:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
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¶

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_remote_switch_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_remote_switch_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_remote_switch_v2_register_switching_done_callback(TF_RemoteSwitchV2 *remote_switch_v2, TF_RemoteSwitchV2_SwitchingDoneHandler handler, void *user_data)¶

void handler(TF_RemoteSwitchV2 *remote_switch_v2, void *user_data)

Callback Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * user_data – Type: void *

This callback is triggered whenever the switching state changes from busy to ready, see tf_remote_switch_v2_get_switching_state().

int tf_remote_switch_v2_register_remote_status_a_callback(TF_RemoteSwitchV2 *remote_switch_v2, TF_RemoteSwitchV2_RemoteStatusAHandler handler, void *user_data)¶

void handler(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to, uint16_t repeats, void *user_data)

Callback Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * house_code – Type: uint8_t, Range: [0 to 31] receiver_code – Type: uint8_t, Range: [0 to 31] switch_to – Type: uint8_t, Range: See constants repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1] user_data – Type: void *

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with tf_remote_switch_v2_set_remote_configuration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_register_remote_status_b_callback(TF_RemoteSwitchV2 *remote_switch_v2, TF_RemoteSwitchV2_RemoteStatusBHandler handler, void *user_data)¶

void handler(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t address, uint8_t unit, uint8_t switch_to, uint8_t dim_value, uint16_t repeats, void *user_data)

Callback Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * address – Type: uint32_t, Range: [0 to 2²⁶ - 1] unit – Type: uint8_t, Range: [0 to 15, 255] switch_to – Type: uint8_t, Range: See constants dim_value – Type: uint8_t, Range: [0 to 255] repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1] user_data – Type: void *

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

The following constants are available for this function:

For switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

int tf_remote_switch_v2_register_remote_status_c_callback(TF_RemoteSwitchV2 *remote_switch_v2, TF_RemoteSwitchV2_RemoteStatusCHandler handler, void *user_data)¶

void handler(TF_RemoteSwitchV2 *remote_switch_v2, char system_code, uint8_t device_code, uint8_t switch_to, uint16_t repeats, void *user_data)

Callback Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * system_code – Type: char, Range: ['A' to 'P'] device_code – Type: uint8_t, Range: [1 to 16] switch_to – Type: uint8_t, Range: See constants repeats – Type: uint16_t, Range: [0 to 2¹⁶ - 1] user_data – Type: void *

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

The following constants are available for this function:

For switch_to:

TF_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
TF_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

Virtual Functions¶

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

int tf_remote_switch_v2_get_response_expected(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_remote_switch_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_REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
TF_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
TF_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
TF_REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
TF_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
TF_REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
TF_REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_REMOTE_SWITCH_V2_FUNCTION_RESET = 243
TF_REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248

int tf_remote_switch_v2_set_response_expected(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t function_id, bool response_expected)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
TF_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
TF_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
TF_REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
TF_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
TF_REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
TF_REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_REMOTE_SWITCH_V2_FUNCTION_RESET = 243
TF_REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248

int tf_remote_switch_v2_set_response_expected_all(TF_RemoteSwitchV2 *remote_switch_v2, bool response_expected)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_remote_switch_v2_set_bootloader_mode(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t mode, uint8_t *ret_status)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

TF_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_OK = 0
TF_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_remote_switch_v2_get_bootloader_mode(TF_RemoteSwitchV2 *remote_switch_v2, uint8_t *ret_mode)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
Output Parameters:	ret_mode – Type: uint8_t, Range: See constants
Returns:	e_code – Type: int

Returns the current bootloader mode, see tf_remote_switch_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_remote_switch_v2_set_write_firmware_pointer(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t pointer)¶

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

Sets the firmware pointer for tf_remote_switch_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_remote_switch_v2_write_firmware(TF_RemoteSwitchV2 *remote_switch_v2, const uint8_t data[64], uint8_t *ret_status)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_remote_switch_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_remote_switch_v2_write_uid(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t uid)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 * 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_remote_switch_v2_read_uid(TF_RemoteSwitchV2 *remote_switch_v2, uint32_t *ret_uid)¶

Parameters:	remote_switch_v2 – Type: TF_RemoteSwitchV2 *
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_REMOTE_SWITCH_V2_DEVICE_IDENTIFIER¶

This constant is used to identify a Remote Switch Bricklet 2.0.

The functions tf_remote_switch_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_REMOTE_SWITCH_V2_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Remote Switch Bricklet 2.0.