MQTT - Dual Button Bricklet¶

Callback¶

Download (example-callback.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Dual Button Bricklet

setup:
    # Handle incoming state changed callbacks
    subscribe to tinkerforge/callback/dual_button_bricklet/XYZ/state_changed
    publish '{"register": true}' to tinkerforge/register/dual_button_bricklet/XYZ/state_changed # Register state_changed callback

Basic Functions¶

request/dual_button_bricklet/<UID>/set_led_state¶

Request:	led_l – Type: int, Range: See symbols, Default: 1 led_r – Type: int, Range: See symbols, Default: 1
Response:	no response

Sets the state of the LEDs. Possible states are:

• 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.
• 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.
• 2 = On: Enables LED (auto toggle is disabled).
• 3 = Off: Disables LED (auto toggle is disabled).

In auto toggle mode the LED is toggled automatically at each press of a button.

If you just want to set one of the LEDs and don't know the current state of the other LED, you can get the state with request/dual_button_bricklet/<UID>/get_led_state or you can use request/dual_button_bricklet/<UID>/set_selected_led_state.

The following symbols are available for this function:

For led_l:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3

For led_r:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3

request/dual_button_bricklet/<UID>/get_led_state¶

Request:	empty payload
Response:	led_l – Type: int, Range: See symbols, Default: 1 led_r – Type: int, Range: See symbols, Default: 1

Returns the current state of the LEDs, as set by request/dual_button_bricklet/<UID>/set_led_state.

The following symbols are available for this function:

For led_l:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3

For led_r:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3

request/dual_button_bricklet/<UID>/get_button_state¶

Request:	empty payload
Response:	button_l – Type: int, Range: See symbols button_r – Type: int, Range: See symbols

Returns the current state for both buttons. Possible states are:

• 0 = pressed
• 1 = released

The following symbols are available for this function:

For button_l:

• "pressed" = 0
• "released" = 1

For button_r:

• "pressed" = 0
• "released" = 1

Advanced Functions¶

request/dual_button_bricklet/<UID>/set_selected_led_state¶

Request:	led – Type: int, Range: See symbols state – Type: int, Range: See symbols
Response:	no response

Sets the state of the selected LED (0 or 1).

The other LED remains untouched.

The following symbols are available for this function:

For led:

• "left" = 0
• "right" = 1

For state:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3

request/dual_button_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 Dual Button'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/dual_button_bricklet/<UID>/state_changed¶

Register Request:	register – Type: bool
Callback Response:	button_l – Type: int, Range: See symbols button_r – Type: int, Range: See symbols led_l – Type: int, Range: See symbols led_r – Type: int, Range: See symbols

A callback can be registered for this event by publishing to the .../register/dual_button_bricklet/<UID>/state_changed[/<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/dual_button_bricklet/<UID>/state_changed[/<SUFFIX>] topic for each registered suffix.

This callback is called whenever a button is pressed.

Possible states for buttons are:

• 0 = pressed
• 1 = released

Possible states for LEDs are:

• 0 = AutoToggleOn: Auto toggle enabled and LED on.
• 1 = AutoToggleOff: Auto toggle enabled and LED off.
• 2 = On: LED on (auto toggle is disabled).
• 3 = Off: LED off (auto toggle is disabled).

The following symbols are available for this function:

For button_l:

• "pressed" = 0
• "released" = 1

For button_r:

• "pressed" = 0
• "released" = 1

For led_l:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3

For led_r:

• "auto_toggle_on" = 0
• "auto_toggle_off" = 1
• "on" = 2
• "off" = 3