MQTT - Remote Switch Bricklet

This is the description of the MQTT 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 MQTT 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.txt)

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

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_bricklet/XYZ/switch_socket_a 

API

All published payloads to and from the MQTT bindings are in 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_bricklet/<UID>/switch_socket
Request payload:
  • house_code -- int
  • receiver_code -- int
  • switch_to -- int (has symbols)

This function is deprecated, use request/remote_switch_bricklet/<UID>/switch_socket_a instead.

The following symbols are available for this function:

for switch_to:

  • "Off" = 0
  • "On" = 1
request/remote_switch_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 request/remote_switch_bricklet/<UID>/switch_socket until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see request/remote_switch_bricklet/<UID>/set_repeats.

The following symbols are available for this function:

for state:

  • "Ready" = 0
  • "Busy" = 1
request/remote_switch_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

New in version 2.0.1 (Plugin).

request/remote_switch_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

New in version 2.0.1 (Plugin).

request/remote_switch_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.

New in version 2.0.1 (Plugin).

request/remote_switch_bricklet/<UID>/switch_socket_c
Request payload:
  • system_code -- char
  • 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

New in version 2.0.1 (Plugin).

Advanced Functions

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

Sets the number of times the code is send when of the request/remote_switch_bricklet/<UID>/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_bricklet/<UID>/get_repeats
Response payload:
  • repeats -- int

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

request/remote_switch_bricklet/<UID>/get_identity
Response payload:
  • uid -- string
  • connected_uid -- string
  • position -- char
  • 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's name in a human readable form.

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_bricklet/<UID>/switching_done
Request payload:
  • register -- bool

A callback can be registered for this event by publishing to the .../register/remote_switch_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_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_bricklet/<UID>/get_switching_state.