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

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-labview">Software</a> / LabVIEW - Industrial Analog Out Bricklet

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

.. _industrial_analog_out_bricklet_labview:

LabVIEW - Industrial Analog Out Bricklet
========================================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Industrial Analog Out Bricklet <industrial_analog_out_bricklet>`. General information and technical
specifications for the Industrial Analog Out Bricklet are summarized in its :ref:`hardware description
<industrial_analog_out_bricklet_description>`.

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

.. _industrial_analog_out_bricklet_labview_examples:


Examples
--------

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

.. _industrial_analog_out_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:: BrickletIndustrialAnalogOut(uid, ipcon) -> industrialAnalogOut

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output industrialAnalogOut: .NET Refnum (BrickletIndustrialAnalogOut)

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


.. labview:function:: BrickletIndustrialAnalogOut.Enable()


 Enables the output of voltage and current.
 
 The default is disabled.
 
.. labview:function:: BrickletIndustrialAnalogOut.Disable()


 Disables the output of voltage and current.
 
 The default is disabled.
 
.. labview:function:: BrickletIndustrialAnalogOut.IsEnabled() -> enabled


 :output enabled: Boolean

 Returns *true* if output of voltage and current is enabled, *false* otherwise.
 
.. labview:function:: BrickletIndustrialAnalogOut.SetVoltage(voltage)

 :input voltage: Int32

 Sets the output voltage in mV.
 
.. labview:function:: BrickletIndustrialAnalogOut.GetVoltage() -> voltage


 :output voltage: Int32

 Returns the voltage as set by :labview:func:`SetVoltage() <BrickletIndustrialAnalogOut.SetVoltage>`.
 
.. labview:function:: BrickletIndustrialAnalogOut.SetCurrent(current)

 :input current: Int32

 Sets the output current in µA.
 
.. labview:function:: BrickletIndustrialAnalogOut.GetCurrent() -> current


 :output current: Int32

 Returns the current as set by :labview:func:`SetCurrent() <BrickletIndustrialAnalogOut.SetCurrent>`.
 


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

.. labview:function:: BrickletIndustrialAnalogOut.SetConfiguration(voltageRange, currentRange)

 :input voltageRange: Byte
 :input currentRange: Byte

 Configures the voltage and current range.
 
 Possible voltage ranges are:
 
 * 0V to 5V
 * 0V to 10V
 
 Possible current ranges are:
 
 * 4mA to 20mA
 * 0mA to 20mA
 * 0mA to 24mA
 
 The resolution will always be 12 bit. This means, that the
 precision is higher with a smaller range.
 
 The following constants are available for this function:
 
 * BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
 * BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
 * BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
 * BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
 * BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
 
.. labview:function:: BrickletIndustrialAnalogOut.GetConfiguration() -> voltageRange, currentRange


 :output voltageRange: Byte
 :output currentRange: Byte

 Returns the configuration as set by :labview:func:`SetConfiguration() <BrickletIndustrialAnalogOut.SetConfiguration>`.
 
 The following constants are available for this function:
 
 * BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
 * BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
 * BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
 * BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
 * BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
 
.. labview:function:: BrickletIndustrialAnalogOut.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:: BrickletIndustrialAnalogOut.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() <BrickletIndustrialAnalogOut.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() <BrickletIndustrialAnalogOut.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletIndustrialAnalogOut.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:
 
 * BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
 * BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
 * BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
 * BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
 * BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8
 
.. labview:function:: BrickletIndustrialAnalogOut.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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


.. _industrial_analog_out_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER

 This constant is used to identify a Industrial Analog Out Bricklet.

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

