Modbus - Remote Switch Bricklet 2.0¶

Basic Functions¶

BrickletRemoteSwitchV2.get_switching_state¶

Function ID:	1
Request:	empty payload
Response:	state – Type: uint8, Range: See meanings

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 elements of this function:

For state:

• 0 = Ready
• 1 = Busy

BrickletRemoteSwitchV2.switch_socket_a¶

Function ID:	5
Request:	house_code – Type: uint8, Range: [0 to 31] receiver_code – Type: uint8, Range: [0 to 31] switch_to – Type: uint8, Range: See meanings
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.

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.switch_socket_b¶

Function ID:	6
Request:	address – Type: uint32, Range: [0 to 226 - 1] unit – Type: uint8, Range: [0 to 15, 255] switch_to – Type: uint8, Range: See meanings
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.

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.dim_socket_b¶

Function ID:	7
Request:	address – Type: uint32, Range: [0 to 226 - 1] unit – Type: uint8, Range: [0 to 15, 255] dim_value – Type: uint8, Range: [0 to 255]
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.

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 – Type: char, Range: ['A' to 'P'] device_code – Type: uint8, Range: [1 to 16] switch_to – Type: uint8, Range: See meanings
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.

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.set_remote_configuration¶

Function ID:	9
Request:	remote_type – Type: uint8, Range: See meanings, Default: 0 minimum_repeats – Type: uint16, Range: [0 to 216 - 1], Default: 2 callback_enabled – Type: bool, Default: false
Response:	no response

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 CALLBACK_REMOTE_STATUS_A callback, CALLBACK_REMOTE_STATUS_B callback and CALLBACK_REMOTE_STATUS_C callback).

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

For remote_type:

• 0 = A
• 1 = B
• 2 = C

BrickletRemoteSwitchV2.get_remote_configuration¶

Function ID:	10
Request:	empty payload
Response:	remote_type – Type: uint8, Range: See meanings, Default: 0 minimum_repeats – Type: uint16, Range: [0 to 216 - 1], Default: 2 callback_enabled – Type: bool, Default: false

Returns the remote configuration as set by set_remote_configuration

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

For remote_type:

• 0 = A
• 1 = B
• 2 = C

BrickletRemoteSwitchV2.get_remote_status_a¶

Function ID:	11
Request:	empty payload
Response:	house_code – Type: uint8, Range: [0 to 31] receiver_code – Type: uint8, Range: [0 to 31] switch_to – Type: uint8, Range: See meanings repeats – Type: uint16, Range: [0 to 216 - 1]

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.get_remote_status_b¶

Function ID:	12
Request:	empty payload
Response:	address – Type: uint32, Range: [0 to 226 - 1] unit – Type: uint8, Range: [0 to 15] switch_to – Type: uint8, Range: See meanings dim_value – Type: uint8, Range: [0 to 255] repeats – Type: uint16, Range: [0 to 216 - 1]

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.get_remote_status_c¶

Function ID:	13
Request:	empty payload
Response:	system_code – Type: char, Range: ['A' to 'P'] device_code – Type: uint8, Range: [1 to 16] switch_to – Type: uint8, Range: See meanings repeats – Type: uint16, Range: [0 to 216 - 1]

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

Advanced Functions¶

BrickletRemoteSwitchV2.set_repeats¶

Function ID:	3
Request:	repeats – Type: uint8, Range: [0 to 255], Default: 5
Response:	no response

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.

BrickletRemoteSwitchV2.get_repeats¶

Function ID:	4
Request:	empty payload
Response:	repeats – Type: uint8, Range: [0 to 255], Default: 5

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 – Type: uint32, Range: [0 to 232 - 1] error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1] error_count_frame – Type: uint32, Range: [0 to 232 - 1] error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

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_status_led_config¶

Function ID:	239
Request:	config – Type: uint8, Range: See meanings, Default: 3
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 elements of this function:

For config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletRemoteSwitchV2.get_status_led_config¶

Function ID:	240
Request:	empty payload
Response:	config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

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

For config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletRemoteSwitchV2.get_chip_temperature¶

Function ID:	242
Request:	empty payload
Response:	temperature – Type: int16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

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.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] device_identifier – Type: uint16, Range: [0 to 216 - 1]

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. 

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 – Type: uint8, Range: [0 to 31] receiver_code – Type: uint8, Range: [0 to 31] switch_to – Type: uint8, Range: See meanings repeats – Type: uint16, Range: [0 to 216 - 1]

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_B¶

Function ID:	15
Response:	address – Type: uint32, Range: [0 to 226 - 1] unit – Type: uint8, Range: [0 to 15, 255] switch_to – Type: uint8, Range: See meanings dim_value – Type: uint8, Range: [0 to 255] repeats – Type: uint16, Range: [0 to 216 - 1]

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_C¶

Function ID:	16
Response:	system_code – Type: char, Range: ['A' to 'P'] device_code – Type: uint8, Range: [1 to 16] switch_to – Type: uint8, Range: See meanings repeats – Type: uint16, Range: [0 to 216 - 1]

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 elements of this function:

For switch_to:

• 0 = Off
• 1 = On

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.

BrickletRemoteSwitchV2.set_bootloader_mode¶

Function ID:	235
Request:	mode – Type: uint8, Range: See meanings
Response:	status – Type: uint8, Range: See meanings

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 elements of this function:

For mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

For status:

• 0 = OK
• 1 = Invalid Mode
• 2 = No Change
• 3 = Entry Function Not Present
• 4 = Device Identifier Incorrect
• 5 = CRC Mismatch

BrickletRemoteSwitchV2.get_bootloader_mode¶

Function ID:	236
Request:	empty payload
Response:	mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

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

For mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

BrickletRemoteSwitchV2.set_write_firmware_pointer¶

Function ID:	237
Request:	pointer – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
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 – Type: uint8[64], Range: [0 to 255]
Response:	status – Type: uint8, Range: [0 to 255]

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.write_uid¶

Function ID:	248
Request:	uid – Type: uint32, Range: [0 to 232 - 1]
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 – Type: uint32, Range: [0 to 232 - 1]

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