Visual Basic .NET - Dual Button Bricklet¶

Callback¶

Download (ExampleCallback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleCallback
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Dual Button Bricklet
 8
 9    ' Callback subroutine for state changed callback
10    Sub StateChangedCB(ByVal sender As BrickletDualButton, ByVal buttonL As Byte, _
11                       ByVal buttonR As Byte, ByVal ledL As Byte, ByVal ledR As Byte)
12        If buttonL = BrickletDualButton.BUTTON_STATE_PRESSED Then
13            Console.WriteLine("Left Button: Pressed")
14        Else If buttonL = BrickletDualButton.BUTTON_STATE_RELEASED Then
15            Console.WriteLine("Left Button: Released")
16        End If
17
18        If buttonR = BrickletDualButton.BUTTON_STATE_PRESSED Then
19            Console.WriteLine("Right Button: Pressed")
20        Else If buttonR = BrickletDualButton.BUTTON_STATE_RELEASED Then
21            Console.WriteLine("Right Button: Released")
22        End If
23
24        Console.WriteLine("")
25    End Sub
26
27    Sub Main()
28        Dim ipcon As New IPConnection() ' Create IP connection
29        Dim db As New BrickletDualButton(UID, ipcon) ' Create device object
30
31        ipcon.Connect(HOST, PORT) ' Connect to brickd
32        ' Don't use device before ipcon is connected
33
34        ' Register state changed callback to subroutine StateChangedCB
35        AddHandler db.StateChangedCallback, AddressOf StateChangedCB
36
37        Console.WriteLine("Press key to exit")
38        Console.ReadLine()
39        ipcon.Disconnect()
40    End Sub
41End Module

Basic Functions¶

Class BrickletDualButton(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim dualButton As New BrickletDualButton("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected.

Sub BrickletDualButton.SetLEDState(ByVal ledL As Byte, ByVal ledR As Byte)¶

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

Sub BrickletDualButton.GetLEDState(ByRef ledL As Byte, ByRef ledR As Byte)¶

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

Sub BrickletDualButton.GetButtonState(ByRef buttonL As Byte, ByRef buttonR As Byte)¶

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

Sub BrickletDualButton.SetSelectedLEDState(ByVal led As Byte, ByVal state As Byte)¶

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

Sub BrickletDualButton.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Output Parameters:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 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 Array, Length: 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: Integer, 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. 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 procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletDualButton, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler dualButton.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Event BrickletDualButton.StateChangedCallback(ByVal sender As BrickletDualButton, ByVal buttonL As Byte, ByVal buttonR As Byte, ByVal ledL As Byte, ByVal ledR As Byte)¶

Callback Parameters:	sender – Type: 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.

Function BrickletDualButton.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 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.

Function BrickletDualButton.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	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

Sub BrickletDualButton.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

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

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

Sub BrickletDualButton.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

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

Constants¶

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

Const BrickletDualButton.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Dual Button Bricklet.