..
 #############################################################
 # 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 - Current25 Bricklet

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

.. _current25_bricklet_labview:

LabVIEW - Current25 Bricklet
============================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Current25 Bricklet <current25_bricklet>`. General information and technical
specifications for the Current25 Bricklet are summarized in its :ref:`hardware description
<current25_bricklet_description>`.

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

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

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

Callback
^^^^^^^^

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

.. raw:: html

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

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

.. raw:: html

   </div>

Threshold
^^^^^^^^^

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

.. raw:: html

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

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

.. raw:: html

   </div>

Graph
^^^^^

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

.. raw:: html

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

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

.. raw:: html

   </div>

.. _current25_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:: BrickletCurrent25(uid, ipcon) -> current25

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output current25: .NET Refnum (BrickletCurrent25)

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


.. labview:function:: BrickletCurrent25.GetCurrent() -> current


 :output current: Int16

 Returns the current of the sensor. The value is in mA
 and between -25000mA and 25000mA.
 
 If you want to get the current periodically, it is recommended to use the
 callback :labview:func:`Current <BrickletCurrent25.Current>` and set the period with 
 :labview:func:`SetCurrentCallbackPeriod() <BrickletCurrent25.SetCurrentCallbackPeriod>`.
 


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

.. labview:function:: BrickletCurrent25.Calibrate()


 Calibrates the 0 value of the sensor. You have to call this function
 when there is no current present. 
 
 The zero point of the current sensor
 is depending on the exact properties of the analog-to-digital converter,
 the length of the Bricklet cable and the temperature. Thus, if you change
 the Brick or the environment in which the Bricklet is used, you might
 have to recalibrate.
 
 The resulting calibration will be saved on the EEPROM of the Current
 Bricklet.
 
.. labview:function:: BrickletCurrent25.IsOverCurrent() -> over


 :output over: Boolean

 Returns *true* if more than 25A were measured.
 
 .. note::
  To reset this value you have to power cycle the Bricklet.
 
.. labview:function:: BrickletCurrent25.GetAnalogValue() -> value


 :output value: Int32

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 .. note::
  The value returned by :labview:func:`GetCurrent() <BrickletCurrent25.GetCurrent>` is averaged over several samples
  to yield less noise, while :labview:func:`GetAnalogValue() <BrickletCurrent25.GetAnalogValue>` gives back raw
  unfiltered analog values. The only reason to use :labview:func:`GetAnalogValue() <BrickletCurrent25.GetAnalogValue>` is,
  if you need the full resolution of the analog-to-digital converter.
 
 If you want the analog value periodically, it is recommended to use the 
 callback :labview:func:`AnalogValue <BrickletCurrent25.AnalogValue>` and set the period with 
 :labview:func:`SetAnalogValueCallbackPeriod() <BrickletCurrent25.SetAnalogValueCallbackPeriod>`.
 
.. labview:function:: BrickletCurrent25.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:: BrickletCurrent25.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() <BrickletCurrent25.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() <BrickletCurrent25.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletCurrent25.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:
 
 * BrickletCurrent25.FUNCTION_CALIBRATE = 2
 * BrickletCurrent25.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
 * BrickletCurrent25.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
 * BrickletCurrent25.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
 * BrickletCurrent25.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
 * BrickletCurrent25.FUNCTION_SET_DEBOUNCE_PERIOD = 13
 
.. labview:function:: BrickletCurrent25.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetCurrentCallbackPeriod() <BrickletCurrent25.SetCurrentCallbackPeriod>`.
 
.. labview:function:: BrickletCurrent25.SetAnalogValueCallbackPeriod(period)

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetAnalogValueCallbackPeriod() <BrickletCurrent25.SetAnalogValueCallbackPeriod>`.
 
.. labview:function:: BrickletCurrent25.SetCurrentCallbackThreshold(option, min, max)

 :input option: Char
 :input min: Int16
 :input max: Int16

 Sets the thresholds for the :labview:func:`CurrentReached <BrickletCurrent25.CurrentReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the current is *outside* the min and max values"
  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletCurrent25.THRESHOLD_OPTION_OFF = 'x'
 * BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletCurrent25.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletCurrent25.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletCurrent25.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletCurrent25.GetCurrentCallbackThreshold() -> option, min, max


 :output option: Char
 :output min: Int16
 :output max: Int16

 Returns the threshold as set by :labview:func:`SetCurrentCallbackThreshold() <BrickletCurrent25.SetCurrentCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletCurrent25.THRESHOLD_OPTION_OFF = 'x'
 * BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletCurrent25.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletCurrent25.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletCurrent25.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletCurrent25.SetAnalogValueCallbackThreshold(option, min, max)

 :input option: Char
 :input min: Int32
 :input max: Int32

 Sets the thresholds for the :labview:func:`AnalogValueReached <BrickletCurrent25.AnalogValueReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the analog value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletCurrent25.THRESHOLD_OPTION_OFF = 'x'
 * BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletCurrent25.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletCurrent25.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletCurrent25.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletCurrent25.GetAnalogValueCallbackThreshold() -> option, min, max


 :output option: Char
 :output min: Int32
 :output max: Int32

 Returns the threshold as set by :labview:func:`SetAnalogValueCallbackThreshold() <BrickletCurrent25.SetAnalogValueCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletCurrent25.THRESHOLD_OPTION_OFF = 'x'
 * BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletCurrent25.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletCurrent25.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletCurrent25.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletCurrent25.SetDebouncePeriod(debounce)

 :input debounce: Int64

 Sets the period in ms with which the threshold callbacks
 
 * :labview:func:`CurrentReached <BrickletCurrent25.CurrentReached>`,
 * :labview:func:`AnalogValueReached <BrickletCurrent25.AnalogValueReached>`
 
 are triggered, if the thresholds
 
 * :labview:func:`SetCurrentCallbackThreshold() <BrickletCurrent25.SetCurrentCallbackThreshold>`,
 * :labview:func:`SetAnalogValueCallbackThreshold() <BrickletCurrent25.SetAnalogValueCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. labview:function:: BrickletCurrent25.GetDebouncePeriod() -> debounce


 :output debounce: Int64

 Returns the debounce period as set by :labview:func:`SetDebouncePeriod() <BrickletCurrent25.SetDebouncePeriod>`.
 


.. _current25_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 BrickletCurrent25.Current(sender, current)

 :input sender: .NET Refnum (BrickletCurrent25)
 :input current: Int16

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetCurrentCallbackPeriod() <BrickletCurrent25.SetCurrentCallbackPeriod>`. The parameter is the current of the
 sensor.
 
 :labview:func:`Current <BrickletCurrent25.Current>` is only triggered if the current has changed since the
 last triggering.
 

.. labview:function:: event BrickletCurrent25.AnalogValue(sender, value)

 :input sender: .NET Refnum (BrickletCurrent25)
 :input value: Int32

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetAnalogValueCallbackPeriod() <BrickletCurrent25.SetAnalogValueCallbackPeriod>`. The parameter is the analog value of the
 sensor.
 
 :labview:func:`AnalogValue <BrickletCurrent25.AnalogValue>` is only triggered if the current has changed since the
 last triggering.
 

.. labview:function:: event BrickletCurrent25.CurrentReached(sender, current)

 :input sender: .NET Refnum (BrickletCurrent25)
 :input current: Int16

 This callback is triggered when the threshold as set by
 :labview:func:`SetCurrentCallbackThreshold() <BrickletCurrent25.SetCurrentCallbackThreshold>` is reached.
 The parameter is the current of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :labview:func:`SetDebouncePeriod() <BrickletCurrent25.SetDebouncePeriod>`.
 

.. labview:function:: event BrickletCurrent25.AnalogValueReached(sender, value)

 :input sender: .NET Refnum (BrickletCurrent25)
 :input value: Int32

 This callback is triggered when the threshold as set by
 :labview:func:`SetAnalogValueCallbackThreshold() <BrickletCurrent25.SetAnalogValueCallbackThreshold>` is reached.
 The parameter is the analog value of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :labview:func:`SetDebouncePeriod() <BrickletCurrent25.SetDebouncePeriod>`.
 

.. labview:function:: event BrickletCurrent25.OverCurrent(sender)

 :input sender: .NET Refnum (BrickletCurrent25)

 This callback is triggered when an over current is measured
 (see :labview:func:`IsOverCurrent() <BrickletCurrent25.IsOverCurrent>`).
 


.. _current25_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletCurrent25.DEVICE_IDENTIFIER

 This constant is used to identify a Current25 Bricklet.

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

