Software / API Bindings / LabVIEW / API Reference and Examples / Bricklets (Discontinued) / Dual Button Bricklet

LabVIEW - Dual Button Bricklet¶

This is the description of the LabVIEW 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 LabVIEW API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Callback¶

Download (Example Callback.vi), Download (Example Callback - StateChanged Callback.vi)

API¶

Generally, every function of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions¶

BrickletDualButton(uid, ipcon) → dualButton¶

Input:	uid – Type: String ipcon – Type: .NET Refnum (IPConnection)
Output:	dualButton – Type: .NET Refnum (BrickletDualButton)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected.

BrickletDualButton.SetLEDState(ledL, ledR)¶

Input:	ledL – Type: Byte, Range: See constants, Default: 1 ledR – Type: Byte, Range: See constants, Default: 1

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 GetLEDState() or you can use SetSelectedLEDState().

The following constants are available for this function:

For ledL:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

For ledR:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.GetLEDState() → ledL, ledR¶

Output:	ledL – Type: Byte, Range: See constants, Default: 1 ledR – Type: Byte, Range: See constants, Default: 1

Returns the current state of the LEDs, as set by SetLEDState().

The following constants are available for this function:

For ledL:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

For ledR:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.GetButtonState() → buttonL, buttonR¶

Output:	buttonL – Type: Byte, Range: See constants buttonR – Type: Byte, Range: See constants

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

0 = pressed
1 = released

The following constants are available for this function:

For buttonL:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

For buttonR:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Advanced Functions¶

BrickletDualButton.SetSelectedLEDState(led, state)¶

Input:	led – Type: Byte, Range: See constants state – Type: Byte, Range: See constants

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

The other LED remains untouched.

The following constants are available for this function:

For led:

BrickletDualButton.LED_LEFT = 0
BrickletDualButton.LED_RIGHT = 1

For state:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶

Output:

Output:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a" to "h", "z"] hardwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Int32, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Char, Range: ["a" to "h", "z"]
hardwareVersion – Type: Byte[3]

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

firmwareVersion – Type: Byte[3]

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

deviceIdentifier – Type: Int32, Range: [0 to 2¹⁶ - 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. There is also a constant for the device identifier of this Bricklet.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters 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.

event BrickletDualButton.StateChangedCallback → sender, buttonL, buttonR, ledL, ledR¶

Callback Output:	sender – Type: .NET Refnum (BrickletDualButton) buttonL – Type: Byte, Range: See constants buttonR – Type: Byte, Range: See constants ledL – Type: Byte, Range: See constants ledR – Type: Byte, Range: See constants

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

For buttonL:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

For buttonR:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

For ledL:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

For ledR:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletDualButton.GetAPIVersion() → apiVersion¶

Output:	apiVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletDualButton.GetResponseExpected(functionId) → responseExpected¶

Input:	functionId – Type: Byte, Range: See constants
Output:	responseExpected – Type: Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

BrickletDualButton.FUNCTION_SET_LED_STATE = 1
BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

BrickletDualButton.SetResponseExpected(functionId, responseExpected)¶

Input:	functionId – Type: Byte, Range: See constants responseExpected – Type: Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For functionId:

BrickletDualButton.FUNCTION_SET_LED_STATE = 1
BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

BrickletDualButton.SetResponseExpectedAll(responseExpected)¶

Input:	responseExpected – Type: Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

BrickletDualButton.DEVICE_IDENTIFIER¶

This constant is used to identify a Dual Button Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletDualButton.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Dual Button Bricklet.