Shell - Dual Button Bricklet 2.0¶

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Dual Button Bricklet 2.0

# Handle incoming state changed callbacks
tinkerforge dispatch dual-button-v2-bricklet $uid state-changed &

# Enable state changed callback
tinkerforge call dual-button-v2-bricklet $uid set-state-changed-callback-configuration true

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call dual-button-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Dual Button Bricklet 2.0. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the Dual Button Bricklet 2.0 and exits

tinkerforge dispatch dual-button-v2-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Dual Button Bricklet 2.0. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the Dual Button Bricklet 2.0 and exits

tinkerforge call dual-button-v2-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch dual-button-v2-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call dual-button-v2-bricklet <uid> set-led-state <led-l> <led-r>¶

Parameters:	<led-l> – Type: Int, Range: See symbols, Default: 1 <led-r> – Type: Int, Range: See symbols, Default: 1
Output:	no output

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 following symbols are available for this function:

For <led-l>:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-off = 3

For <led-r>:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-off = 3

tinkerforge call dual-button-v2-bricklet <uid> get-led-state¶

Output:	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 set-led-state.

The following symbols are available for this function:

For led-l:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-off = 3

For led-r:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-off = 3

tinkerforge call dual-button-v2-bricklet <uid> get-button-state¶

Output:	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:

• button-state-pressed = 0
• button-state-released = 1

For button-r:

• button-state-pressed = 0
• button-state-released = 1

Advanced Functions¶

tinkerforge call dual-button-v2-bricklet <uid> set-selected-led-state <led> <state>¶

Parameters:	<led> – Type: Int, Range: See symbols <state> – Type: Int, Range: See symbols
Output:	no output

Sets the state of the selected LED.

The other LED remains untouched.

The following symbols are available for this function:

For <led>:

• led-left = 0
• led-right = 1

For <state>:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-off = 3

tinkerforge call dual-button-v2-bricklet <uid> get-spitfp-error-count¶

Output:	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.

tinkerforge call dual-button-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call dual-button-v2-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call dual-button-v2-bricklet <uid> get-chip-temperature¶

Output:	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.

tinkerforge call dual-button-v2-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call dual-button-v2-bricklet <uid> get-identity¶

Output:

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 Array, 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 Array, 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]

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. 

Callback Configuration Functions¶

tinkerforge call dual-button-v2-bricklet <uid> set-state-changed-callback-configuration <enabled>¶

Parameters:	<enabled> – Type: Bool, Default: false
Output:	no output

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

tinkerforge call dual-button-v2-bricklet <uid> get-state-changed-callback-configuration¶

Output:	enabled – Type: Bool, Default: false

Returns the configuration as set by set-state-changed-callback-configuration.

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch dual-button-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch dual-button-v2-bricklet <uid> state-changed¶

Output:	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

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 symbols are available for this function:

For button-l:

• button-state-pressed = 0
• button-state-released = 1

For button-r:

• button-state-pressed = 0
• button-state-released = 1

For led-l:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-off = 3

For led-r:

• led-state-auto-toggle-on = 0
• led-state-auto-toggle-off = 1
• led-state-on = 2
• led-state-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.

tinkerforge call dual-button-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	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-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call dual-button-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call dual-button-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call dual-button-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

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.

tinkerforge call dual-button-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call dual-button-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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