MQTT - Dual Button Bricklet 2.0¶

Callback¶

Download (example-callback.txt)

1# Change XYZ to the UID of your Dual Button Bricklet 2.0
2
3setup:
4    # Handle incoming state changed callbacks
5    subscribe to tinkerforge/callback/dual_button_v2_bricklet/XYZ/state_changed
6    publish '{"register": true}' to tinkerforge/register/dual_button_v2_bricklet/XYZ/state_changed # Register state_changed callback
7
8    # Enable state changed callback
9    publish '{"enabled": true}' to tinkerforge/request/dual_button_v2_bricklet/XYZ/set_state_changed_callback_configuration

Basic Functions¶

request/dual_button_v2_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_v2_bricklet/<UID>/get_led_state() or you can use request/dual_button_v2_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_v2_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_v2_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_v2_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_v2_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.

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_v2_bricklet/<UID>/get_spitfp_error_count¶

Request:	empty payload
Response:	error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] error_count_message_checksum – Type: int, Range: [0 to 232 - 1] error_count_frame – Type: int, Range: [0 to 232 - 1] error_count_overflow – Type: int, 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.

request/dual_button_v2_bricklet/<UID>/set_status_led_config¶

Request:	config – Type: int, Range: See symbols, 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 symbols are available for this function:

For config:

• "off" = 0

• "on" = 1

• "show_heartbeat" = 2

• "show_status" = 3

request/dual_button_v2_bricklet/<UID>/get_status_led_config¶

Request:	empty payload
Response:	config – Type: int, Range: See symbols, Default: 3

Returns the configuration as set by request/dual_button_v2_bricklet/<UID>/set_status_led_config()

The following symbols are available for this function:

For config:

• "off" = 0

• "on" = 1

• "show_heartbeat" = 2

• "show_status" = 3

request/dual_button_v2_bricklet/<UID>/get_chip_temperature¶

Request:	empty payload
Response:	temperature – Type: int, 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.

request/dual_button_v2_bricklet/<UID>/reset¶

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!

request/dual_button_v2_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 2.0's name in a human readable form.

Callback Configuration Functions¶

request/dual_button_v2_bricklet/<UID>/set_state_changed_callback_configuration¶

Request:	enabled – Type: bool, Default: false
Response:	no response

If you enable this callback, the register/dual_button_v2_bricklet/<UID>/state_changed() callback is triggered every time a button is pressed/released

request/dual_button_v2_bricklet/<UID>/get_state_changed_callback_configuration¶

Request:	empty payload
Response:	enabled – Type: bool, Default: false

Returns the configuration as set by request/dual_button_v2_bricklet/<UID>/set_state_changed_callback_configuration().

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_v2_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_v2_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_v2_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).

This callback can be enabled with request/dual_button_v2_bricklet/<UID>/set_state_changed_callback_configuration().

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

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.

request/dual_button_v2_bricklet/<UID>/set_bootloader_mode¶

Request:	mode – Type: int, Range: See symbols
Response:	status – Type: int, Range: See 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

• "bootloader_wait_for_reboot" = 2

• "firmware_wait_for_reboot" = 3

• "firmware_wait_for_erase_and_reboot" = 4

For status:

• "ok" = 0

• "invalid_mode" = 1

• "no_change" = 2

• "entry_function_not_present" = 3

• "device_identifier_incorrect" = 4

• "crc_mismatch" = 5

request/dual_button_v2_bricklet/<UID>/get_bootloader_mode¶

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

Returns the current bootloader mode, see request/dual_button_v2_bricklet/<UID>/set_bootloader_mode().

The following symbols are available for this function:

For mode:

• "bootloader" = 0

• "firmware" = 1

• "bootloader_wait_for_reboot" = 2

• "firmware_wait_for_reboot" = 3

• "firmware_wait_for_erase_and_reboot" = 4

request/dual_button_v2_bricklet/<UID>/set_write_firmware_pointer¶

Request:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Response:	no response

Sets the firmware pointer for request/dual_button_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/dual_button_v2_bricklet/<UID>/write_firmware¶

Request:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Response:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by request/dual_button_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/dual_button_v2_bricklet/<UID>/write_uid¶

Request:	uid – Type: int, 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.

request/dual_button_v2_bricklet/<UID>/read_uid¶

Request:	empty payload
Response:	uid – Type: int, Range: [0 to 232 - 1]

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