This is the description of the Shell API bindings for the Dual Button Bricklet. General information and technical specifications for the Dual Button Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 | #!/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
# Handle incoming state changed callbacks
tinkerforge dispatch dual-button-bricklet $uid state-changed &
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Dual Button Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Dual Button Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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 send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Parameters: |
|
---|---|
Output: | no output |
Sets the state of the LEDs. Possible states are:
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 symbols are available for this function:
Output: |
|
---|
Returns the current state of the LEDs, as set by set-led-state.
The following symbols are available for this function:
Output: |
|
---|
Returns the current state for both buttons. Possible states are:
The following symbols are available for this function:
Parameters: |
|
---|---|
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:
Output: |
|
---|
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.
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.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
Output: |
|
---|
This callback is called whenever a button is pressed.
Possible states for buttons are:
Possible states for LEDs are:
The following symbols are available for this function: