TCP/IP - Dual Button Bricklet 2.0

This is the description of the TCP/IP protocol for the Dual Button Bricklet 2.0. General information and technical specifications for the Dual Button Bricklet 2.0 are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletDualButtonV2.set_led_state
Function ID:

1

Request:
  • led_l -- uint8
  • led_r -- uint8
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 get_led_state or you can use set_selected_led_state.

The default value is (1, 1).

The following meanings are defined for the parameters of this function:

  • 0: auto toggle on, for led_l and led_r
  • 1: auto toggle off, for led_l and led_r
  • 2: on, for led_l and led_r
  • 3: off, for led_l and led_r
BrickletDualButtonV2.get_led_state
Function ID:

2

Request:

empty payload

Response:
  • led_l -- uint8
  • led_r -- uint8

Returns the current state of the LEDs, as set by set_led_state.

The following meanings are defined for the parameters of this function:

  • 0: auto toggle on, for led_l and led_r
  • 1: auto toggle off, for led_l and led_r
  • 2: on, for led_l and led_r
  • 3: off, for led_l and led_r
BrickletDualButtonV2.get_button_state
Function ID:

3

Request:

empty payload

Response:
  • button_l -- uint8
  • button_r -- uint8

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

  • 0 = pressed
  • 1 = released

The following meanings are defined for the parameters of this function:

  • 0: pressed, for button_l and button_r
  • 1: released, for button_l and button_r

Advanced Functions

BrickletDualButtonV2.set_selected_led_state
Function ID:

5

Request:
  • led -- uint8
  • state -- uint8
Response:

no response

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

The other LED remains untouched.

The following meanings are defined for the parameters of this function:

  • 0: left, for led
  • 1: right, for led
  • 0: auto toggle on, for state
  • 1: auto toggle off, for state
  • 2: on, for state
  • 3: off, for state
BrickletDualButtonV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletDualButtonV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletDualButtonV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletDualButtonV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

Sets the firmware pointer for 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.

BrickletDualButtonV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

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

BrickletDualButtonV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
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 meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletDualButtonV2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletDualButtonV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

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.

BrickletDualButtonV2.reset
Function ID:243
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!

BrickletDualButtonV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
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.

BrickletDualButtonV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletDualButtonV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callback Configuration Functions

BrickletDualButtonV2.set_state_changed_callback_configuration
Function ID:

6

Request:
  • enabled -- bool
Response:

no response

If you enable this callback, the CALLBACK_STATE_CHANGED callback is triggered every time a button is pressed/released

By default this callback is disabled.

BrickletDualButtonV2.get_state_changed_callback_configuration
Function ID:

7

Request:

empty payload

Response:
  • enabled -- bool

Returns the configuration as set by set_state_changed_callback_configuration.

Callbacks

BrickletDualButtonV2.CALLBACK_STATE_CHANGED
Function ID:

4

Response:
  • button_l -- uint8
  • button_r -- uint8
  • led_l -- uint8
  • led_r -- uint8

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 set_state_changed_callback_configuration.

The following meanings are defined for the parameters of this function:

  • 0: pressed, for button_l and button_r
  • 1: released, for button_l and button_r
  • 0: auto toggle on, for led_l and led_r
  • 1: auto toggle off, for led_l and led_r
  • 2: on, for led_l and led_r
  • 3: off, for led_l and led_r