Visual Basic .NET - Dual Button Bricklet 2.0

This is the description of the Visual Basic .NET API bindings for the Dual Button Bricklet 2.0. General information and technical specifications for the Dual Button Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

Examples

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

Callback

Download (ExampleCallback.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Dual Button Bricklet 2.0

    ' Callback subroutine for state changed callback
    Sub StateChangedCB(ByVal sender As BrickletDualButtonV2, ByVal buttonL As Byte, _
                       ByVal buttonR As Byte, ByVal ledL As Byte, ByVal ledR As Byte)
        If buttonL = BrickletDualButtonV2.BUTTON_STATE_PRESSED Then
            Console.WriteLine("Left Button: Pressed")
        Else If buttonL = BrickletDualButtonV2.BUTTON_STATE_RELEASED Then
            Console.WriteLine("Left Button: Released")
        End If

        If buttonR = BrickletDualButtonV2.BUTTON_STATE_PRESSED Then
            Console.WriteLine("Right Button: Pressed")
        Else If buttonR = BrickletDualButtonV2.BUTTON_STATE_RELEASED Then
            Console.WriteLine("Right Button: Released")
        End If

        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim db As New BrickletDualButtonV2(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register state changed callback to subroutine StateChangedCB
        AddHandler db.StateChangedCallback, AddressOf StateChangedCB

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickletDualButtonV2(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim dualButtonV2 As New BrickletDualButtonV2("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

Sub BrickletDualButtonV2.SetLEDState(ByVal ledL As Byte, ByVal ledR As Byte)

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 default value is (1, 1).

The following constants are available for this function:

  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2.LED_STATE_ON = 2
  • BrickletDualButtonV2.LED_STATE_OFF = 3
Sub BrickletDualButtonV2.GetLEDState(ByRef ledL As Byte, ByRef ledR As Byte)

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

The following constants are available for this function:

  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2.LED_STATE_ON = 2
  • BrickletDualButtonV2.LED_STATE_OFF = 3
Sub BrickletDualButtonV2.GetButtonState(ByRef buttonL As Byte, ByRef buttonR As Byte)

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

  • 0 = pressed
  • 1 = released

The following constants are available for this function:

  • BrickletDualButtonV2.BUTTON_STATE_PRESSED = 0
  • BrickletDualButtonV2.BUTTON_STATE_RELEASED = 1

Advanced Functions

Sub BrickletDualButtonV2.SetSelectedLEDState(ByVal led As Byte, ByVal state As Byte)

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

The other LED remains untouched.

The following constants are available for this function:

  • BrickletDualButtonV2.LED_LEFT = 0
  • BrickletDualButtonV2.LED_RIGHT = 1
  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2.LED_STATE_ON = 2
  • BrickletDualButtonV2.LED_STATE_OFF = 3
Function BrickletDualButtonV2.GetAPIVersion() As Byte()

Returns the version of the API definition (major, minor, revision) 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 BrickletDualButtonV2.GetResponseExpected(ByVal functionId As Byte) As 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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected() for the list of function ID constants available for this function.

Sub BrickletDualButtonV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletDualButtonV2.FUNCTION_SET_LED_STATE = 1
  • BrickletDualButtonV2.FUNCTION_SET_SELECTED_LED_STATE = 5
  • BrickletDualButtonV2.FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION = 6
  • BrickletDualButtonV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDualButtonV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDualButtonV2.FUNCTION_RESET = 243
  • BrickletDualButtonV2.FUNCTION_WRITE_UID = 248
Sub BrickletDualButtonV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletDualButtonV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

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.

Function BrickletDualButtonV2.SetBootloaderMode(ByVal mode As Byte) As Byte

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

  • BrickletDualButtonV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDualButtonV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDualButtonV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDualButtonV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDualButtonV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletDualButtonV2.BOOTLOADER_STATUS_OK = 0
  • BrickletDualButtonV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletDualButtonV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletDualButtonV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletDualButtonV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletDualButtonV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletDualButtonV2.GetBootloaderMode() As Byte

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • BrickletDualButtonV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDualButtonV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDualButtonV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDualButtonV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDualButtonV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletDualButtonV2.SetWriteFirmwarePointer(ByVal pointer As Long)

Sets the firmware pointer for WriteFirmware(). 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.

Function BrickletDualButtonV2.WriteFirmware(ByVal data() As Byte) As Byte

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() 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.

Sub BrickletDualButtonV2.SetStatusLEDConfig(ByVal config As Byte)

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

  • BrickletDualButtonV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDualButtonV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDualButtonV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDualButtonV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletDualButtonV2.GetStatusLEDConfig() As Byte

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • BrickletDualButtonV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDualButtonV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDualButtonV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDualButtonV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletDualButtonV2.GetChipTemperature() As Short

Returns the temperature in °C 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.

Sub BrickletDualButtonV2.Reset()

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!

Sub BrickletDualButtonV2.WriteUID(ByVal uid As Long)

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.

Function BrickletDualButtonV2.ReadUID() As Long

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

Sub BrickletDualButtonV2.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)

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

Sub BrickletDualButtonV2.SetStateChangedCallbackConfiguration(ByVal enabled As Boolean)

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

By default this callback is disabled.

Function BrickletDualButtonV2.GetStateChangedCallbackConfiguration() As Boolean

Returns the configuration as set by SetStateChangedCallbackConfiguration().

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 BrickletDualButtonV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler dualButtonV2.ExampleCallback, AddressOf MyCallback

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 BrickletDualButtonV2.StateChangedCallback(ByVal sender As BrickletDualButtonV2, ByVal buttonL As Byte, ByVal buttonR As Byte, ByVal ledL As Byte, ByVal ledR As Byte)

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 SetStateChangedCallbackConfiguration().

The following constants are available for this function:

  • BrickletDualButtonV2.BUTTON_STATE_PRESSED = 0
  • BrickletDualButtonV2.BUTTON_STATE_RELEASED = 1
  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_ON = 0
  • BrickletDualButtonV2.LED_STATE_AUTO_TOGGLE_OFF = 1
  • BrickletDualButtonV2.LED_STATE_ON = 2
  • BrickletDualButtonV2.LED_STATE_OFF = 3

Constants

Const BrickletDualButtonV2.DEVICE_IDENTIFIER

This constant is used to identify a Dual Button Bricklet 2.0.

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

Const BrickletDualButtonV2.DEVICE_DISPLAY_NAME

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