C/C++ - Remote Switch Bricklet

This is the description of the C/C++ API bindings for the Remote Switch Bricklet. General information and technical specifications for the Remote Switch Bricklet are summarized in its hardware description.

An installation guide for the C/C++ 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)

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_remote_switch.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Remote Switch Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    RemoteSwitch rs;
    remote_switch_create(&rs, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // 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.
    remote_switch_switch_socket_a(&rs, 17, 1, REMOTE_SWITCH_SWITCH_TO_ON);

    printf("Press key to exit\n");
    getchar();
    remote_switch_destroy(&rs);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Most functions of the C/C++ bindings return an error code (e_code). Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix.

Possible error codes are:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (unused since C/C++ bindings version 2.0.0)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void remote_switch_create(RemoteSwitch *remote_switch, const char *uid, IPConnection *ipcon)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

Creates the device object remote_switch with the unique device ID uid and adds it to the IPConnection ipcon:

RemoteSwitch remote_switch;
remote_switch_create(&remote_switch, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected.

void remote_switch_destroy(RemoteSwitch *remote_switch)
Parameters:
  • remote_switch – Type: RemoteSwitch *

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

int remote_switch_switch_socket(RemoteSwitch *remote_switch, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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

This function is deprecated, use remote_switch_switch_socket_a() instead.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1
int remote_switch_get_switching_state(RemoteSwitch *remote_switch, uint8_t *ret_state)
Parameters:
  • remote_switch – Type: RemoteSwitch *
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 requests to switch sockets until the state changes to ready.

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

The following constants are available for this function:

For ret_state:

  • REMOTE_SWITCH_SWITCHING_STATE_READY = 0
  • REMOTE_SWITCH_SWITCHING_STATE_BUSY = 1
int remote_switch_switch_socket_a(RemoteSwitch *remote_switch, uint8_t house_code, uint8_t receiver_code, uint8_t switch_to)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

int remote_switch_switch_socket_b(RemoteSwitch *remote_switch, uint32_t address, uint8_t unit, uint8_t switch_to)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • address – Type: uint32_t, Range: [0 to 226 - 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:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

int remote_switch_dim_socket_b(RemoteSwitch *remote_switch, uint32_t address, uint8_t unit, uint8_t dim_value)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • address – Type: uint32_t, Range: [0 to 226 - 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.

New in version 2.0.1 (Plugin).

int remote_switch_switch_socket_c(RemoteSwitch *remote_switch, char system_code, uint8_t device_code, uint8_t switch_to)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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:

  • REMOTE_SWITCH_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

Advanced Functions

int remote_switch_set_repeats(RemoteSwitch *remote_switch, uint8_t repeats)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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 remote_switch_get_repeats(RemoteSwitch *remote_switch, uint8_t *ret_repeats)
Parameters:
  • remote_switch – Type: RemoteSwitch *
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 remote_switch_set_repeats().

int remote_switch_get_identity(RemoteSwitch *remote_switch, 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 – Type: RemoteSwitch *
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 as 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

void remote_switch_register_callback(RemoteSwitch *remote_switch, int16_t callback_id, void (*function)(void), void *user_data)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • callback_id – Type: int16_t
  • function – Type: void (*)(void)
  • user_data – Type: void *

Registers the given function with the given callback_id. The user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the remote_switch_register_callback() function:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

remote_switch_register_callback(&remote_switch,
                                REMOTE_SWITCH_CALLBACK_EXAMPLE,
                                (void (*)(void))my_callback,
                                NULL);

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

REMOTE_SWITCH_CALLBACK_SWITCHING_DONE
void callback(void *user_data)
Callback Parameters:
  • user_data – Type: void *

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

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

int remote_switch_get_api_version(RemoteSwitch *remote_switch, uint8_t ret_api_version[3])
Parameters:
  • remote_switch – Type: RemoteSwitch *
Output Parameters:
  • ret_api_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]
Returns:
  • e_code – Type: int

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

int remote_switch_get_response_expected(RemoteSwitch *remote_switch, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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 remote_switch_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:

  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET = 1
  • REMOTE_SWITCH_FUNCTION_SET_REPEATS = 4
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_A = 6
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_B = 7
  • REMOTE_SWITCH_FUNCTION_DIM_SOCKET_B = 8
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_C = 9
int remote_switch_set_response_expected(RemoteSwitch *remote_switch, uint8_t function_id, bool response_expected)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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:

  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET = 1
  • REMOTE_SWITCH_FUNCTION_SET_REPEATS = 4
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_A = 6
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_B = 7
  • REMOTE_SWITCH_FUNCTION_DIM_SOCKET_B = 8
  • REMOTE_SWITCH_FUNCTION_SWITCH_SOCKET_C = 9
int remote_switch_set_response_expected_all(RemoteSwitch *remote_switch, bool response_expected)
Parameters:
  • remote_switch – Type: RemoteSwitch *
  • 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.

Constants

REMOTE_SWITCH_DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch Bricklet.

The remote_switch_get_identity() function and the IPCON_CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

REMOTE_SWITCH_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Remote Switch Bricklet.