MQTT - Remote Switch Bricklet¶

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

Basic Functions¶

request/remote_switch_bricklet/<UID>/switch_socket¶

Request:	house_code – Type: int, Range: [0 to 31] receiver_code – Type: int, Range: [0 to 31] switch_to – Type: int, Range: See symbols
Response:	no response

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¶

Request:	empty payload
Response:	state – Type: int, Range: See 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 requests to switch sockets 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:	house_code – Type: int, Range: [0 to 31] receiver_code – Type: int, Range: [0 to 31] switch_to – Type: int, Range: See symbols
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 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:	address – Type: int, Range: [0 to 226 - 1] unit – Type: int, Range: [0 to 15, 255] switch_to – Type: int, Range: See symbols
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 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:	address – Type: int, Range: [0 to 226 - 1] unit – Type: int, Range: [0 to 15, 255] dim_value – Type: int, 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.

New in version 2.0.1 (Plugin).

request/remote_switch_bricklet/<UID>/switch_socket_c¶

Request:	system_code – Type: char, Range: ["A" to "P"] device_code – Type: int, Range: [1 to 16] switch_to – Type: int, Range: See symbols
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 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:	repeats – Type: int, 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.

request/remote_switch_bricklet/<UID>/get_repeats¶

Request:	empty payload
Response:	repeats – Type: int, Range: [0 to 255], Default: 5

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

request/remote_switch_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: 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', '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. 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.

register/remote_switch_bricklet/<UID>/switching_done¶

Register Request:	register – Type: bool
Callback Response:	empty payload

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.