..
 #############################################################
 # 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 - Industrial Digital In 4 Bricklet

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

.. _industrial_digital_in_4_bricklet_vbnet:

Visual Basic .NET - Industrial Digital In 4 Bricklet
====================================================

This is the description of the :ref:`Visual Basic .NET API bindings <api_bindings_vbnet>` for the :ref:`Industrial Digital In 4 Bricklet <industrial_digital_in_4_bricklet>`. General information and technical
specifications for the Industrial Digital In 4 Bricklet are summarized in its :ref:`hardware description
<industrial_digital_in_4_bricklet_description>`.

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

.. _industrial_digital_in_4_bricklet_vbnet_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.vb) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/vbnet/ExampleSimple.vb>`__

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

Interrupt
^^^^^^^^^

`Download (ExampleInterrupt.vb) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/vbnet/ExampleInterrupt.vb>`__

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

.. _industrial_digital_in_4_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 BrickletIndustrialDigitalIn4(ByVal uid As String, ByVal ipcon As IPConnection)

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

 .. code-block:: vbnet

    Dim industrialDigitalIn4 As New BrickletIndustrialDigitalIn4("YOUR_DEVICE_UID", ipcon)

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


.. vbnet:function:: Function BrickletIndustrialDigitalIn4.GetValue() As Integer

 Returns the input value with a bitmask. The bitmask is 16bit long, *true*
 refers to high and *false* refers to low.
 
 For example: The value 3 or 0b0011 means that pins 0-1 are high and the other
 pins are low.
 
 If no groups are used (see :vbnet:func:`SetGroup() <BrickletIndustrialDigitalIn4.SetGroup>`), the pins correspond to the
 markings on the Digital In 4 Bricklet.
 
 If groups are used, the pins correspond to the element in the group.
 Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
 pins 8-11 and element 4 pins 12-15.
 
.. vbnet:function:: Function BrickletIndustrialDigitalIn4.GetEdgeCount(ByVal pin As Byte, ByVal resetCounter As Boolean) As Long

 Returns the current value of the edge counter for the selected pin. You can
 configure the edges that are counted with :vbnet:func:`SetEdgeCountConfig() <BrickletIndustrialDigitalIn4.SetEdgeCountConfig>`.
 
 If you set the reset counter to *true*, the count is set back to 0
 directly after it is read.
 
 .. versionadded:: 2.0.1~(Plugin)
 


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

.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.SetGroup(ByVal group[] As Char)

 Sets a group of Digital In 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :vbnet:func:`GetAvailableForGroup() <BrickletIndustrialDigitalIn4.GetAvailableForGroup>`.
 
 The group consists of 4 elements. Element 1 in the group will get pins 0-3,
 element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.
 
 Each element can either be one of the ports ('a' to 'd') or 'n' if it should
 not be used.
 
 For example: If you have two Digital In 4 Bricklets connected to port A and
 port B respectively, you could call with ``['a', 'b', 'n', 'n']``.
 
 Now the pins on the Digital In 4 on port A are assigned to 0-3 and the
 pins on the Digital In 4 on port B are assigned to 4-7. It is now possible
 to call :vbnet:func:`GetValue() <BrickletIndustrialDigitalIn4.GetValue>` and read out two Bricklets at the same time.
 
 Changing the group configuration resets all edge counter configurations
 and values.
 
.. vbnet:function:: Function BrickletIndustrialDigitalIn4.GetGroup() As Char[]

 Returns the group as set by :vbnet:func:`SetGroup() <BrickletIndustrialDigitalIn4.SetGroup>`
 
.. vbnet:function:: Function BrickletIndustrialDigitalIn4.GetAvailableForGroup() As Byte

 Returns a bitmask of ports that are available for grouping. For example the
 value 5 or 0b0101 means: Port A and port C are connected to Bricklets that
 can be grouped together.
 
.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.SetEdgeCountConfig(ByVal selectionMask As Integer, ByVal edgeType As Byte, ByVal debounce As Byte)

 Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will
 enable the edge counter for pins 0 and 3.
 
 The edge type parameter configures if rising edges, falling edges or
 both are counted if the pin is configured for input. Possible edge types are:
 
 * 0 = rising (default)
 * 1 = falling
 * 2 = both
 
 The debounce time is given in ms.
 
 Configuring an edge counter resets its value to 0.
 
 If you don't know what any of this means, just leave it at default. The
 default configuration is very likely OK for you.
 
 Default values: 0 (edge type) and 100ms (debounce time)
 
 The following constants are available for this function:
 
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.GetEdgeCountConfig(ByVal pin As Byte, ByRef edgeType As Byte, ByRef debounce As Byte)

 Returns the edge type and debounce time for the selected pin as set by
 :vbnet:func:`SetEdgeCountConfig() <BrickletIndustrialDigitalIn4.SetEdgeCountConfig>`.
 
 The following constants are available for this function:
 
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. vbnet:function:: Function BrickletIndustrialDigitalIn4.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 BrickletIndustrialDigitalIn4.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() <BrickletIndustrialDigitalIn4.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() <BrickletIndustrialDigitalIn4.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.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:
 
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_GROUP = 2
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_INTERRUPT = 7
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_EDGE_COUNT_CONFIG = 11
 
.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.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 BrickletIndustrialDigitalIn4.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|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.SetDebouncePeriod(ByVal debounce As Long)

 Sets the debounce period of the :vbnet:func:`Interrupt <BrickletIndustrialDigitalIn4.Interrupt>` callback in ms.
 
 For example: If you set this value to 100, you will get the interrupt
 maximal every 100ms. This is necessary if something that bounces is
 connected to the Digital In 4 Bricklet, such as a button.
 
 The default value is 100.
 
.. vbnet:function:: Function BrickletIndustrialDigitalIn4.GetDebouncePeriod() As Long

 Returns the debounce period as set by :vbnet:func:`SetDebouncePeriod() <BrickletIndustrialDigitalIn4.SetDebouncePeriod>`.
 
.. vbnet:function:: Sub BrickletIndustrialDigitalIn4.SetInterrupt(ByVal interruptMask As Integer)

 Sets the pins on which an interrupt is activated with a bitmask.
 Interrupts are triggered on changes of the voltage level of the pin,
 i.e. changes from high to low and low to high.
 
 For example: An interrupt bitmask of 9 or 0b1001 will enable the interrupt for
 pins 0 and 3.
 
 The interrupts use the grouping as set by :vbnet:func:`SetGroup() <BrickletIndustrialDigitalIn4.SetGroup>`.
 
 The interrupt is delivered with the callback :vbnet:func:`Interrupt <BrickletIndustrialDigitalIn4.Interrupt>`.
 
.. vbnet:function:: Function BrickletIndustrialDigitalIn4.GetInterrupt() As Integer

 Returns the interrupt bitmask as set by :vbnet:func:`SetInterrupt() <BrickletIndustrialDigitalIn4.SetInterrupt>`.
 


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

    AddHandler industrialDigitalIn4.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 BrickletIndustrialDigitalIn4.Interrupt(ByVal sender As BrickletIndustrialDigitalIn4, ByVal interruptMask As Integer, ByVal valueMask As Integer)


 This callback is triggered whenever a change of the voltage level is detected
 on pins where the interrupt was activated with :vbnet:func:`SetInterrupt() <BrickletIndustrialDigitalIn4.SetInterrupt>`.
 
 The values are a bitmask that specifies which interrupts occurred
 and the current value bitmask.
 
 For example:
 
 * (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and
   currently pin 0 is high and pins 1-3 are low.
 * (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3
   occurred and currently pin 0 is low and pins 1-3 are high.
 


.. _industrial_digital_in_4_bricklet_vbnet_constants:

Constants
^^^^^^^^^

.. vbnet:attribute:: Const BrickletIndustrialDigitalIn4.DEVICE_IDENTIFIER

 This constant is used to identify a Industrial Digital In 4 Bricklet.

 The :vbnet:func:`GetIdentity() <BrickletIndustrialDigitalIn4.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.

