..
 #############################################################
 # 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 - Temperature IR Bricklet

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

.. _temperature_ir_bricklet_labview:

LabVIEW - Temperature IR Bricklet
=================================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Temperature IR Bricklet <temperature_ir_bricklet>`. General information and technical
specifications for the Temperature IR Bricklet are summarized in its :ref:`hardware description
<temperature_ir_bricklet_description>`.

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

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

.. raw:: html

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

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

.. raw:: html

   </div>

Water Boiling
^^^^^^^^^^^^^

`Download (Example Water Boiling.vi) <https://github.com/Tinkerforge/temperature-ir-bricklet/raw/master/software/examples/labview/Example%20Water%20Boiling.vi>`__

.. raw:: html

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

.. image:: /Images/Screenshots/LabVIEW/TemperatureIR_Bricklet_LabVIEW_Example_Water_Boiling.vi.png
 :scale: 100 %
 :alt: LabVIEW Water Boiling Example
 :align: center

.. raw:: html

   </div>

Callback
^^^^^^^^

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

.. raw:: html

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

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

.. raw:: html

   </div>

Graph
^^^^^

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

.. raw:: html

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

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

.. raw:: html

   </div>

.. _temperature_ir_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:: BrickletTemperatureIR(uid, ipcon) -> temperatureIR

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output temperatureIR: .NET Refnum (BrickletTemperatureIR)

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


.. labview:function:: BrickletTemperatureIR.GetAmbientTemperature() -> temperature


 :output temperature: Int16

 Returns the ambient temperature of the sensor. The value
 has a range of -400 to 1250 and is given in °C/10,
 e.g. a value of 423 means that an ambient temperature of 42.3 °C is 
 measured.
 
 If you want to get the ambient temperature periodically, it is recommended 
 to use the callback :labview:func:`AmbientTemperature <BrickletTemperatureIR.AmbientTemperature>` and set the period with 
 :labview:func:`SetAmbientTemperatureCallbackPeriod() <BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod>`.
 
.. labview:function:: BrickletTemperatureIR.GetObjectTemperature() -> temperature


 :output temperature: Int16

 Returns the object temperature of the sensor, i.e. the temperature
 of the surface of the object the sensor is aimed at. The value
 has a range of -700 to 3800 and is given in °C/10,
 e.g. a value of 3001 means that a temperature of 300.1 °C is measured
 on the surface of the object.
 
 The temperature of different materials is dependent on their `emissivity 
 <http://en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material
 can be set with :labview:func:`SetEmissivity() <BrickletTemperatureIR.SetEmissivity>`.
 
 If you want to get the object temperature periodically, it is recommended 
 to use the callback :labview:func:`ObjectTemperature <BrickletTemperatureIR.ObjectTemperature>` and set the period with 
 :labview:func:`SetObjectTemperatureCallbackPeriod() <BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod>`.
 


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

.. labview:function:: BrickletTemperatureIR.SetEmissivity(emissivity)

 :input emissivity: Int32

 Sets the `emissivity <http://en.wikipedia.org/wiki/Emissivity>`__ that is
 used to calculate the surface temperature as returned by 
 :labview:func:`GetObjectTemperature() <BrickletTemperatureIR.GetObjectTemperature>`. 
 
 The emissivity is usually given as a value between 0.0 and 1.0. A list of
 emissivities of different materials can be found 
 `here <http://www.infrared-thermography.com/material.htm>`__.
 
 The parameter of :labview:func:`SetEmissivity() <BrickletTemperatureIR.SetEmissivity>` has to be given with a factor of
 65535 (16-bit). For example: An emissivity of 0.1 can be set with the
 value 6553, an emissivity of 0.5 with the value 32767 and so on.
 
 .. note::
  If you need a precise measurement for the object temperature, it is
  absolutely crucial that you also provide a precise emissivity.
 
 The default emissivity is 1.0 (value of 65535) and the minimum emissivity the
 sensor can handle is 0.1 (value of 6553).
 
.. labview:function:: BrickletTemperatureIR.GetEmissivity() -> emissivity


 :output emissivity: Int32

 Returns the emissivity as set by :labview:func:`SetEmissivity() <BrickletTemperatureIR.SetEmissivity>`.
 
.. labview:function:: BrickletTemperatureIR.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:: BrickletTemperatureIR.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() <BrickletTemperatureIR.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() <BrickletTemperatureIR.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletTemperatureIR.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:
 
 * BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
 * BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
 * BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
 * BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
 * BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
 * BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
 
.. labview:function:: BrickletTemperatureIR.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetAmbientTemperatureCallbackPeriod() <BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod>`.
 
.. labview:function:: BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod(period)

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetObjectTemperatureCallbackPeriod() <BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod>`.
 
.. labview:function:: BrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold(option, min, max)

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

 Sets the thresholds for the :labview:func:`AmbientTemperatureReached <BrickletTemperatureIR.AmbientTemperatureReached>` 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 ambient temperature is *outside* the min and max values"
  "'i'",    "Callback is triggered when the ambient temperature is *inside* the min and max values"
  "'<'",    "Callback is triggered when the ambient temperature is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the ambient temperature is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
 * BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletTemperatureIR.GetAmbientTemperatureCallbackThreshold() -> option, min, max


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

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

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

 Sets the thresholds for the :labview:func:`ObjectTemperatureReached <BrickletTemperatureIR.ObjectTemperatureReached>` 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 object temperature is *outside* the min and max values"
  "'i'",    "Callback is triggered when the object temperature is *inside* the min and max values"
  "'<'",    "Callback is triggered when the object temperature is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the object temperature is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
 * BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletTemperatureIR.GetObjectTemperatureCallbackThreshold() -> option, min, max


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

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

 :input debounce: Int64

 Sets the period in ms with which the threshold callbacks
 
 * :labview:func:`AmbientTemperatureReached <BrickletTemperatureIR.AmbientTemperatureReached>`,
 * :labview:func:`ObjectTemperatureReached <BrickletTemperatureIR.ObjectTemperatureReached>`
 
 are triggered, if the thresholds
 
 * :labview:func:`SetAmbientTemperatureCallbackThreshold() <BrickletTemperatureIR.SetAmbientTemperatureCallbackThreshold>`,
 * :labview:func:`SetObjectTemperatureCallbackThreshold() <BrickletTemperatureIR.SetObjectTemperatureCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. labview:function:: BrickletTemperatureIR.GetDebouncePeriod() -> debounce


 :output debounce: Int64

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


.. _temperature_ir_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 BrickletTemperatureIR.AmbientTemperature(sender, temperature)

 :input sender: .NET Refnum (BrickletTemperatureIR)
 :input temperature: Int16

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetAmbientTemperatureCallbackPeriod() <BrickletTemperatureIR.SetAmbientTemperatureCallbackPeriod>`. The parameter is the ambient
 temperature of the sensor.
 
 :labview:func:`AmbientTemperature <BrickletTemperatureIR.AmbientTemperature>` is only triggered if the ambient temperature
 has changed since the last triggering.
 

.. labview:function:: event BrickletTemperatureIR.ObjectTemperature(sender, temperature)

 :input sender: .NET Refnum (BrickletTemperatureIR)
 :input temperature: Int16

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetObjectTemperatureCallbackPeriod() <BrickletTemperatureIR.SetObjectTemperatureCallbackPeriod>`. The parameter is the object
 temperature of the sensor.
 
 :labview:func:`ObjectTemperature <BrickletTemperatureIR.ObjectTemperature>` is only triggered if the object temperature
 has changed since the last triggering.
 

.. labview:function:: event BrickletTemperatureIR.AmbientTemperatureReached(sender, temperature)

 :input sender: .NET Refnum (BrickletTemperatureIR)
 :input temperature: Int16

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

.. labview:function:: event BrickletTemperatureIR.ObjectTemperatureReached(sender, temperature)

 :input sender: .NET Refnum (BrickletTemperatureIR)
 :input temperature: Int16

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


.. _temperature_ir_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletTemperatureIR.DEVICE_IDENTIFIER

 This constant is used to identify a Temperature IR Bricklet.

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

