..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-vbnet">Software</a> / Visual Basic .NET - Dual Button Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <dual_button_bricklet_vbnet_constants>` for the device identifier of this Bricklet.

.. _dual_button_bricklet_vbnet:

Visual Basic .NET - Dual Button Bricklet
========================================

This is the description of the :ref:`Visual Basic .NET API bindings <api_bindings_vbnet>` for the :ref:`Dual Button Bricklet <dual_button_bricklet>`. General information and technical
specifications for the Dual Button Bricklet are summarized in its :ref:`hardware description
<dual_button_bricklet_description>`.

An :ref:`installation guide <api_bindings_vbnet_install>` for the Visual Basic .NET API
bindings is part of their general description.

.. _dual_button_bricklet_vbnet_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Callback
^^^^^^^^

`Download (ExampleCallback.vb) <https://github.com/Tinkerforge/dual-button-bricklet/raw/master/software/examples/vbnet/ExampleCallback.vb>`__

.. literalinclude:: DualButton_Bricklet_VBNET_ExampleCallback.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

.. _dual_button_bricklet_vbnet_api:

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


.. vbnet:function:: Class BrickletDualButton(ByVal uid As String, ByVal ipcon As IPConnection)

 Creates an object with the unique device ID ``uid``:

 .. code-block:: vbnet

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

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <dual_button_bricklet_vbnet_examples>`).


.. vbnet:function:: Sub BrickletDualButton.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 :vbnet:func:`GetLEDState() <BrickletDualButton.GetLEDState>` or you
 can use :vbnet:func:`SetSelectedLEDState() <BrickletDualButton.SetSelectedLEDState>`.
 
 The default value is (1, 1).
 
 The following constants are available for this function:
 
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
 * BrickletDualButton.LED_STATE_ON = 2
 * BrickletDualButton.LED_STATE_OFF = 3
 
.. vbnet:function:: Sub BrickletDualButton.GetLEDState(ByRef ledL As Byte, ByRef ledR As Byte)

 Returns the current state of the LEDs, as set by :vbnet:func:`SetLEDState() <BrickletDualButton.SetLEDState>`.
 
 The following constants are available for this function:
 
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
 * BrickletDualButton.LED_STATE_ON = 2
 * BrickletDualButton.LED_STATE_OFF = 3
 
.. vbnet:function:: Sub BrickletDualButton.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:
 
 * BrickletDualButton.BUTTON_STATE_PRESSED = 0
 * BrickletDualButton.BUTTON_STATE_RELEASED = 1
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. vbnet:function:: Sub BrickletDualButton.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:
 
 * BrickletDualButton.LED_LEFT = 0
 * BrickletDualButton.LED_RIGHT = 1
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
 * BrickletDualButton.LED_STATE_ON = 2
 * BrickletDualButton.LED_STATE_OFF = 3
 
.. vbnet:function:: Function BrickletDualButton.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.
 
.. vbnet:function:: Function BrickletDualButton.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
 :vbnet:func:`SetResponseExpected() <BrickletDualButton.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 :vbnet:func:`SetResponseExpected() <BrickletDualButton.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. vbnet:function:: Sub BrickletDualButton.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 and callbacks it is always disabled.
 
 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:
 
 * BrickletDualButton.FUNCTION_SET_LED_STATE = 1
 * BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5
 
.. vbnet:function:: Sub BrickletDualButton.SetResponseExpectedAll(ByVal responseExpected As Boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. vbnet:function:: 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)

 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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 


.. _dual_button_bricklet_vbnet_callbacks:

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:

 .. code-block:: vbnet

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

    AddHandler dualButton.Example, AddressOf Callback

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.


.. vbnet:function:: Event BrickletDualButton.StateChanged(ByVal sender As BrickletDualButton, 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).
 
 The following constants are available for this function:
 
 * BrickletDualButton.BUTTON_STATE_PRESSED = 0
 * BrickletDualButton.BUTTON_STATE_RELEASED = 1
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
 * BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
 * BrickletDualButton.LED_STATE_ON = 2
 * BrickletDualButton.LED_STATE_OFF = 3
 


.. _dual_button_bricklet_vbnet_constants:

Constants
^^^^^^^^^

.. vbnet:attribute:: Const BrickletDualButton.DEVICE_IDENTIFIER

 This constant is used to identify a Dual Button Bricklet.

 The :vbnet:func:`GetIdentity() <BrickletDualButton.GetIdentity>` function and the
 :vbnet:func:`EnumerateCallback <IPConnection.EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

