..
 #############################################################
 # 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 - Hall Effect Bricklet

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

.. _hall_effect_bricklet_labview:

LabVIEW - Hall Effect Bricklet
==============================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Hall Effect Bricklet <hall_effect_bricklet>`. General information and technical
specifications for the Hall Effect Bricklet are summarized in its :ref:`hardware description
<hall_effect_bricklet_description>`.

An :ref:`installation guide <api_bindings_labview_install>` for the LabVIEW API
bindings is part of their general description.

.. _hall_effect_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/hall-effect-bricklet/raw/master/software/examples/labview/Example%20Simple.vi>`__

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

Callback
^^^^^^^^

`Download (Example Callback.vi) <https://github.com/Tinkerforge/hall-effect-bricklet/raw/master/software/examples/labview/Example%20Callback.vi>`__, `Download (Example Callback - EdgeCount Callback.vi) <https://github.com/Tinkerforge/hall-effect-bricklet/raw/master/software/examples/labview/Example%20Callback%20-%20EdgeCount%20Callback.vi>`__

.. raw:: html

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

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

.. raw:: html

   </div>

.. _hall_effect_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:: BrickletHallEffect(uid, ipcon) -> hallEffect

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output hallEffect: .NET Refnum (BrickletHallEffect)

 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 <hall_effect_bricklet_labview_examples>`).


.. labview:function:: BrickletHallEffect.GetValue() -> value


 :output value: Boolean

 Returns *true* if a magnetic field of 35 Gauss (3.5mT) or greater is detected.
 
.. labview:function:: BrickletHallEffect.GetEdgeCount(resetCounter) -> count

 :input resetCounter: Boolean

 :output count: Int64

 Returns the current value of the edge counter. You can configure
 edge type (rising, falling, both) that is counted with
 :labview:func:`SetEdgeCountConfig() <BrickletHallEffect.SetEdgeCountConfig>`.
 
 If you set the reset counter to *true*, the count is set back to 0
 directly after it is read.
 


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

.. labview:function:: BrickletHallEffect.SetEdgeCountConfig(edgeType, debounce)

 :input edgeType: Byte
 :input debounce: Byte

 The edge type parameter configures if rising edges, falling edges or 
 both are counted. Possible edge types are:
 
 * 0 = rising (default)
 * 1 = falling
 * 2 = both
 
 A magnetic field of 35 Gauss (3.5mT) or greater causes a falling edge and a
 magnetic field of 25 Gauss (2.5mT) or smaller causes a rising edge.
 
 If a magnet comes near the Bricklet the signal goes low (falling edge), if
 a magnet is removed from the vicinity the signal goes high (rising edge).
 
 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:
 
 * BrickletHallEffect.EDGE_TYPE_RISING = 0
 * BrickletHallEffect.EDGE_TYPE_FALLING = 1
 * BrickletHallEffect.EDGE_TYPE_BOTH = 2
 
.. labview:function:: BrickletHallEffect.GetEdgeCountConfig() -> edgeType, debounce


 :output edgeType: Byte
 :output debounce: Byte

 Returns the edge type and debounce time as set by :labview:func:`SetEdgeCountConfig() <BrickletHallEffect.SetEdgeCountConfig>`.
 
 The following constants are available for this function:
 
 * BrickletHallEffect.EDGE_TYPE_RISING = 0
 * BrickletHallEffect.EDGE_TYPE_FALLING = 1
 * BrickletHallEffect.EDGE_TYPE_BOTH = 2
 
.. labview:function:: BrickletHallEffect.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:: BrickletHallEffect.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() <BrickletHallEffect.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() <BrickletHallEffect.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletHallEffect.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:
 
 * BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
 * BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
 * BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
 
.. labview:function:: BrickletHallEffect.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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

 :input edges: Int64

 Sets the number of edges until an interrupt is invoked.
 
 If *edges* is set to n, an interrupt is invoked for every n-th detected edge.
 
 If *edges* is set to 0, the interrupt is disabled.
 
 Default value is 0.
 
.. labview:function:: BrickletHallEffect.GetEdgeInterrupt() -> edges


 :output edges: Int64

 Returns the edges as set by :labview:func:`SetEdgeInterrupt() <BrickletHallEffect.SetEdgeInterrupt>`.
 
.. labview:function:: BrickletHallEffect.SetEdgeCountCallbackPeriod(period)

 :input period: Int64

 Sets the period in ms with which the :labview:func:`EdgeCount <BrickletHallEffect.EdgeCount>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :labview:func:`EdgeCount <BrickletHallEffect.EdgeCount>` is only triggered if the edge count has changed since the
 last triggering.
 
 The default value is 0.
 
.. labview:function:: BrickletHallEffect.GetEdgeCountCallbackPeriod() -> period


 :output period: Int64

 Returns the period as set by :labview:func:`SetEdgeCountCallbackPeriod() <BrickletHallEffect.SetEdgeCountCallbackPeriod>`.
 


.. _hall_effect_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 BrickletHallEffect.EdgeCount(sender, count, value)

 :input sender: .NET Refnum (BrickletHallEffect)
 :input count: Int64
 :input value: Boolean

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetEdgeCountCallbackPeriod() <BrickletHallEffect.SetEdgeCountCallbackPeriod>`. The parameters are the
 current count and the current value (see :labview:func:`GetValue() <BrickletHallEffect.GetValue>` and :labview:func:`GetEdgeCount() <BrickletHallEffect.GetEdgeCount>`).
 
 :labview:func:`EdgeCount <BrickletHallEffect.EdgeCount>` is only triggered if the count or value changed since the
 last triggering.
 


.. _hall_effect_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletHallEffect.DEVICE_IDENTIFIER

 This constant is used to identify a Hall Effect Bricklet.

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

