Shell - Dual Button Bricklet¶

Callback¶

Download (example-callback.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Dual Button Bricklet
 5
 6# Handle incoming state changed callbacks
 7tinkerforge dispatch dual-button-bricklet $uid state-changed &
 8
 9echo "Press key to exit"; read dummy
10
11kill -- -$$ # 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-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. 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 and exits

tinkerforge dispatch dual-button-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. 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 and exits

tinkerforge call dual-button-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-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-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-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-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-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 (0 or 1).

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

Callbacks¶

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

tinkerforge dispatch dual-button-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch dual-button-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).

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