MQTT - Remote Switch Bricklet 2.0

This is the description of the MQTT 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 MQTT API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Remote Callback

Download (example-remote-callback.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Remote Switch Bricklet 2.0

setup:
    # Configure to receive from remote type A with minimum repeats set to 1 and enable callback
    publish '{"remote_type": "a", "minimum_repeats": 1, "callback_enabled": true}' to tinkerforge/request/remote_switch_v2_bricklet/XYZ/set_remote_configuration 
    
    # Handle incoming remote status a callbacks
    subscribe to tinkerforge/callback/remote_switch_v2_bricklet/XYZ/remote_status_a
    publish '{"register": true}' to tinkerforge/register/remote_switch_v2_bricklet/XYZ/remote_status_a # Register remote_status_a callback

Switch Socket

Download (example-switch-socket.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Remote Switch Bricklet 2.0

setup:
    # 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.
    publish '{"house_code": 17, "receiver_code": 1, "switch_to": "on"}' to tinkerforge/request/remote_switch_v2_bricklet/XYZ/switch_socket_a 

API

All published payload to an from the MQTT bindings is in the JSON format.

If an error occures, the bindings publish a JSON object containing the error message as attribute "_ERROR". It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Basic Functions

request/remote_switch_v2_bricklet/<UID>/get_switching_state
Response payload:
 
  • state -- int (has symbols)

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 request/remote_switch_v2_bricklet/<UID>/set_repeats.

The following symbols are available for this function:

for state:

  • "Ready" = 0
  • "Busy" = 1
request/remote_switch_v2_bricklet/<UID>/switch_socket_a
Request payload:
 
  • house_code -- int
  • receiver_code -- int
  • switch_to -- int (has symbols)

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 symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
request/remote_switch_v2_bricklet/<UID>/switch_socket_b
Request payload:
 
  • address -- int
  • unit -- int
  • switch_to -- int (has symbols)

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 symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
request/remote_switch_v2_bricklet/<UID>/dim_socket_b
Request payload:
 
  • address -- int
  • unit -- int
  • dim_value -- 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.

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.

request/remote_switch_v2_bricklet/<UID>/switch_socket_c
Request payload:
 
  • system_code -- string
  • device_code -- int
  • switch_to -- int (has symbols)

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 symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
request/remote_switch_v2_bricklet/<UID>/set_remote_configuration
Request payload:
 
  • remote_type -- int (has symbols)
  • minimum_repeats -- int
  • callback_enabled -- bool

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

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

The following symbols are available for this function:

for remote_type:

  • "A" = 0
  • "B" = 1
  • "C" = 2
request/remote_switch_v2_bricklet/<UID>/get_remote_configuration
Response payload:
 
  • remote_type -- int (has symbols)
  • minimum_repeats -- int
  • callback_enabled -- bool

Returns the remote configuration as set by request/remote_switch_v2_bricklet/<UID>/set_remote_configuration

The following symbols are available for this function:

for remote_type:

  • "A" = 0
  • "B" = 1
  • "C" = 2
request/remote_switch_v2_bricklet/<UID>/get_remote_status_a
Response payload:
 
  • house_code -- int
  • receiver_code -- int
  • switch_to -- int (has symbols)
  • repeats -- 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 request/remote_switch_v2_bricklet/<UID>/set_remote_configuration and register/remote_switch_v2_bricklet/<UID>/remote_status_a callback.

The following symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
request/remote_switch_v2_bricklet/<UID>/get_remote_status_b
Response payload:
 
  • address -- int
  • unit -- int
  • switch_to -- int (has symbols)
  • dim_value -- int
  • repeats -- 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 request/remote_switch_v2_bricklet/<UID>/set_remote_configuration and register/remote_switch_v2_bricklet/<UID>/remote_status_b callback.

The following symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
request/remote_switch_v2_bricklet/<UID>/get_remote_status_c
Response payload:
 
  • system_code -- string
  • device_code -- int
  • switch_to -- int (has symbols)
  • repeats -- 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 request/remote_switch_v2_bricklet/<UID>/set_remote_configuration and register/remote_switch_v2_bricklet/<UID>/remote_status_c callback.

The following symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1

Advanced Functions

request/remote_switch_v2_bricklet/<UID>/set_repeats
Request payload:
 
  • repeats -- int

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.

request/remote_switch_v2_bricklet/<UID>/get_repeats
Response payload:
 
  • repeats -- int

Returns the number of repeats as set by request/remote_switch_v2_bricklet/<UID>/set_repeats.

request/remote_switch_v2_bricklet/<UID>/get_spitfp_error_count
Response payload:
 
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- 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.

request/remote_switch_v2_bricklet/<UID>/set_bootloader_mode
Request payload:
 
  • mode -- int (has symbols)
Response payload:
 
  • status -- int (has symbols)

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 symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

for status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/remote_switch_v2_bricklet/<UID>/get_bootloader_mode
Response payload:
 
  • mode -- int (has symbols)

Returns the current bootloader mode, see request/remote_switch_v2_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/remote_switch_v2_bricklet/<UID>/set_write_firmware_pointer
Request payload:
 
  • pointer -- int

Sets the firmware pointer for request/remote_switch_v2_bricklet/<UID>/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.

request/remote_switch_v2_bricklet/<UID>/write_firmware
Request payload:
 
  • data -- [int,... (x64)]
Response payload:
 
  • status -- int

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

request/remote_switch_v2_bricklet/<UID>/set_status_led_config
Request payload:
 
  • config -- int (has symbols)

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 symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/remote_switch_v2_bricklet/<UID>/get_status_led_config
Response payload:
 
  • config -- int (has symbols)

Returns the configuration as set by request/remote_switch_v2_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/remote_switch_v2_bricklet/<UID>/get_chip_temperature
Response payload:
 
  • temperature -- int

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.

request/remote_switch_v2_bricklet/<UID>/reset

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!

request/remote_switch_v2_bricklet/<UID>/write_uid
Request payload:
 
  • uid -- 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.

request/remote_switch_v2_bricklet/<UID>/read_uid
Response payload:
 
  • uid -- int

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

request/remote_switch_v2_bricklet/<UID>/get_identity
Response payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (has symbols)
  • _display_name -- string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Remote Switch 2.0's name in a human readable form.

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 .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

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.

register/remote_switch_v2_bricklet/<UID>/switching_done
Request payload:
 
  • register -- bool

A callback can be registered for this event by publishing to the .../register/remote_switch_v2_bricklet/<UID>/switching_done[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/remote_switch_v2_bricklet/<UID>/switching_done[/<SUFFIX>] topic for each registered suffix.

This callback is triggered whenever the switching state changes from busy to ready, see request/remote_switch_v2_bricklet/<UID>/get_switching_state.

register/remote_switch_v2_bricklet/<UID>/remote_status_a
Request payload:
 
  • register -- bool
Response payload:
 
  • house_code -- int
  • receiver_code -- int
  • switch_to -- int (has symbols)
  • repeats -- int

A callback can be registered for this event by publishing to the .../register/remote_switch_v2_bricklet/<UID>/remote_status_a[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/remote_switch_v2_bricklet/<UID>/remote_status_a[/<SUFFIX>] topic for each registered suffix.

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 request/remote_switch_v2_bricklet/<UID>/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 symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
register/remote_switch_v2_bricklet/<UID>/remote_status_b
Request payload:
 
  • register -- bool
Response payload:
 
  • address -- int
  • unit -- int
  • switch_to -- int (has symbols)
  • dim_value -- int
  • repeats -- int

A callback can be registered for this event by publishing to the .../register/remote_switch_v2_bricklet/<UID>/remote_status_b[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/remote_switch_v2_bricklet/<UID>/remote_status_b[/<SUFFIX>] topic for each registered suffix.

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 request/remote_switch_v2_bricklet/<UID>/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 symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
register/remote_switch_v2_bricklet/<UID>/remote_status_c
Request payload:
 
  • register -- bool
Response payload:
 
  • system_code -- string
  • device_code -- int
  • switch_to -- int (has symbols)
  • repeats -- int

A callback can be registered for this event by publishing to the .../register/remote_switch_v2_bricklet/<UID>/remote_status_c[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/remote_switch_v2_bricklet/<UID>/remote_status_c[/<SUFFIX>] topic for each registered suffix.

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 request/remote_switch_v2_bricklet/<UID>/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 symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1