..
 #############################################################
 # 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-labview">Software</a> / LabVIEW - Industrial Digital In 4 Bricklet

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

.. _industrial_digital_in_4_bricklet_labview:

LabVIEW - Industrial Digital In 4 Bricklet
==========================================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` 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_labview_install>` for the LabVIEW API
bindings is part of their general description.

.. _industrial_digital_in_4_bricklet_labview_examples:


Examples
--------

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

Simple
^^^^^^

`Download (Example Simple.vi) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/labview/Example%20Simple.vi>`__

.. image:: /Images/Screenshots/LabVIEW/IndustrialDigitalIn4_Bricklet_LabVIEW_Example_Simple.vi.png
 :scale: 100 %
 :alt: LabVIEW Simple Example
 :align: center

Interrupt
^^^^^^^^^

`Download (Example Interrupt.vi) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/labview/Example%20Interrupt.vi>`__, `Download (Example Interrupt - Interrupt Callback.vi) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/labview/Example%20Interrupt%20-%20Interrupt%20Callback.vi>`__

.. raw:: html

   <div class="horizontal-image-scroll">

.. image:: /Images/Screenshots/LabVIEW/IndustrialDigitalIn4_Bricklet_LabVIEW_Example_Interrupt.vi.png
 :scale: 100 %
 :alt: LabVIEW Interrupt Example
 :align: center

.. raw:: html

   </div>

.. _industrial_digital_in_4_bricklet_labview_api:

API
---

Generally, every method 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
^^^^^^^^^^^^^^^


.. labview:function:: BrickletIndustrialDigitalIn4(uid, ipcon) -> industrialDigitalIn4

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output industrialDigitalIn4: .NET Refnum (BrickletIndustrialDigitalIn4)

 Creates an object with the unique device ID ``uid``.
 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <industrial_digital_in_4_bricklet_labview_examples>`).


.. labview:function:: BrickletIndustrialDigitalIn4.GetValue() -> valueMask


 :output valueMask: Int32

 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 :labview: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.
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetEdgeCount(pin, resetCounter) -> count

 :input pin: Byte
 :input resetCounter: Boolean

 :output count: Int64

 Returns the current value of the edge counter for the selected pin. You can
 configure the edges that are counted with :labview: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
^^^^^^^^^^^^^^^^^^

.. labview:function:: BrickletIndustrialDigitalIn4.SetGroup(group)

 :input group: Char[4]

 Sets a group of Digital In 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :labview: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 :labview:func:`GetValue() <BrickletIndustrialDigitalIn4.GetValue>` and read out two Bricklets at the same time.
 
 Changing the group configuration resets all edge counter configurations
 and values.
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetGroup() -> group


 :output group: Char[4]

 Returns the group as set by :labview:func:`SetGroup() <BrickletIndustrialDigitalIn4.SetGroup>`
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetAvailableForGroup() -> available


 :output available: 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.
 
.. labview:function:: BrickletIndustrialDigitalIn4.SetEdgeCountConfig(selectionMask, edgeType, debounce)

 :input selectionMask: Int32
 :input edgeType: Byte
 :input debounce: 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)
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetEdgeCountConfig(pin) -> edgeType, debounce

 :input pin: Byte

 :output edgeType: Byte
 :output debounce: Byte

 Returns the edge type and debounce time for the selected pin as set by
 :labview: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)
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetAPIVersion() -> apiVersion


 :output apiVersion: Byte[3]

 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.
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetResponseExpected(functionId) -> responseExpected

 :input functionId: Byte

 :output responseExpected: 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
 :labview: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 :labview:func:`SetResponseExpected() <BrickletIndustrialDigitalIn4.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletIndustrialDigitalIn4.SetResponseExpected(functionId, responseExpected)

 :input functionId: Byte
 :input responseExpected: 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
 
.. labview:function:: BrickletIndustrialDigitalIn4.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetIdentity() -> uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier


 :output uid: String
 :output connectedUid: String
 :output position: Char
 :output hardwareVersion: Byte[3]
 :output firmwareVersion: Byte[3]
 :output deviceIdentifier: Int32

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



.. labview:function:: BrickletIndustrialDigitalIn4.SetDebouncePeriod(debounce)

 :input debounce: Int64

 Sets the debounce period of the :labview: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.
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetDebouncePeriod() -> debounce


 :output debounce: Int64

 Returns the debounce period as set by :labview:func:`SetDebouncePeriod() <BrickletIndustrialDigitalIn4.SetDebouncePeriod>`.
 
.. labview:function:: BrickletIndustrialDigitalIn4.SetInterrupt(interruptMask)

 :input interruptMask: Int32

 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 :labview:func:`SetGroup() <BrickletIndustrialDigitalIn4.SetGroup>`.
 
 The interrupt is delivered with the callback :labview:func:`Interrupt <BrickletIndustrialDigitalIn4.Interrupt>`.
 
.. labview:function:: BrickletIndustrialDigitalIn4.GetInterrupt() -> interruptMask


 :output interruptMask: Int32

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


.. _industrial_digital_in_4_bricklet_labview_callbacks:

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.


.. labview:function:: event BrickletIndustrialDigitalIn4.Interrupt(sender, interruptMask, valueMask)

 :input sender: .NET Refnum (BrickletIndustrialDigitalIn4)
 :input interruptMask: Int32
 :input valueMask: Int32

 This callback is triggered whenever a change of the voltage level is detected
 on pins where the interrupt was activated with :labview: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_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletIndustrialDigitalIn4.DEVICE_IDENTIFIER

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

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

