TCP/IP - Remote Switch Bricklet 2.0

This is the description of the TCP/IP protocol 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.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletRemoteSwitchV2.get_switching_state
Function ID:

1

Request:

empty payload

Response:
  • state -- uint8

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 set_repeats.

The following meanings are defined for the parameters of this function:

  • 0: ready, for state
  • 1: busy, for state
BrickletRemoteSwitchV2.switch_socket_a
Function ID:

5

Request:
  • house_code -- uint8
  • receiver_code -- uint8
  • switch_to -- uint8
Response:

no response

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.

The house code and receiver code have a range of 0 to 31 (5bit).

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

The following meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.switch_socket_b
Function ID:

6

Request:
  • address -- uint32
  • unit -- uint8
  • switch_to -- uint8
Response:

no response

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

The address has a range of 0 to 67108863 (26bit) and the unit has a range of 0 to 15 (4bit). 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 meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.dim_socket_b
Function ID:

7

Request:
  • address -- uint32
  • unit -- uint8
  • dim_value -- uint8
Response:

no response

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

The address has a range of 0 to 67108863 (26bit), the unit and the dim value has a range of 0 to 15 (4bit).

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

BrickletRemoteSwitchV2.switch_socket_c
Function ID:

8

Request:
  • system_code -- char
  • device_code -- uint8
  • switch_to -- uint8
Response:

no response

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.

The system code has a range of 'A' to 'P' (4bit) and the device code has a range of 1 to 16 (4bit).

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

The following meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.set_remote_configuration
Function ID:

9

Request:
  • remote_type -- uint8
  • minimum_repeats -- uint16
  • callback_enabled -- bool
Response:

no response

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

Default is ('A', 2, false).

The following meanings are defined for the parameters of this function:

  • 0: a, for remote_type
  • 1: b, for remote_type
  • 2: c, for remote_type
BrickletRemoteSwitchV2.get_remote_configuration
Function ID:

10

Request:

empty payload

Response:
  • remote_type -- uint8
  • minimum_repeats -- uint16
  • callback_enabled -- bool

Returns the remote configuration as set by set_remote_configuration

The following meanings are defined for the parameters of this function:

  • 0: a, for remote_type
  • 1: b, for remote_type
  • 2: c, for remote_type
BrickletRemoteSwitchV2.get_remote_status_a
Function ID:

11

Request:

empty payload

Response:
  • house_code -- uint8
  • receiver_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 set_remote_configuration and CALLBACK_REMOTE_STATUS_A callback.

The following meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.get_remote_status_b
Function ID:

12

Request:

empty payload

Response:
  • address -- uint32
  • unit -- uint8
  • switch_to -- uint8
  • dim_value -- uint8
  • repeats -- uint16

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 set_remote_configuration and CALLBACK_REMOTE_STATUS_B callback.

The following meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.get_remote_status_c
Function ID:

13

Request:

empty payload

Response:
  • system_code -- char
  • device_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 set_remote_configuration and CALLBACK_REMOTE_STATUS_C callback.

The following meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to

Advanced Functions

BrickletRemoteSwitchV2.set_repeats
Function ID:

3

Request:
  • repeats -- uint8
Response:

no response

Sets the number of times the code is send 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.

The default value is 5.

BrickletRemoteSwitchV2.get_repeats
Function ID:

4

Request:

empty payload

Response:
  • repeats -- uint8

Returns the number of repeats as set by set_repeats.

BrickletRemoteSwitchV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletRemoteSwitchV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletRemoteSwitchV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletRemoteSwitchV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

Sets the firmware pointer for 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.

BrickletRemoteSwitchV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

Writes 64 Bytes of firmware at the position as written by 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.

BrickletRemoteSwitchV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletRemoteSwitchV2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletRemoteSwitchV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

Returns the temperature in °C 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.

BrickletRemoteSwitchV2.reset
Function ID:243
Request:empty payload
Response:no response

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!

BrickletRemoteSwitchV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

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.

BrickletRemoteSwitchV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletRemoteSwitchV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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' or 'd'.

The device identifier numbers can be found here

Callbacks

BrickletRemoteSwitchV2.CALLBACK_SWITCHING_DONE
Function ID:2
Response:empty payload

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

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A
Function ID:

14

Response:
  • house_code -- uint8
  • receiver_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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 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 meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_B
Function ID:

15

Response:
  • address -- uint32
  • unit -- uint8
  • switch_to -- uint8
  • dim_value -- uint8
  • repeats -- uint16

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.

You have to enable the callback with 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 meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to
BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_C
Function ID:

16

Response:
  • system_code -- char
  • device_code -- uint8
  • switch_to -- uint8
  • repeats -- uint16

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.

You have to enable the callback with 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 meanings are defined for the parameters of this function:

  • 0: off, for switch_to
  • 1: on, for switch_to