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

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

.. _color_bricklet_labview:

LabVIEW - Color Bricklet
========================

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

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

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

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

Callback
^^^^^^^^

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

.. raw:: html

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

.. image:: /Images/Screenshots/LabVIEW/Color_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/color-bricklet/raw/master/software/examples/labview/Example%20Threshold.vi>`__, `Download (Example Threshold - ColorReached Callback.vi) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/labview/Example%20Threshold%20-%20ColorReached%20Callback.vi>`__

.. raw:: html

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

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

.. raw:: html

   </div>

.. _color_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:: BrickletColor(uid, ipcon) -> color

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output color: .NET Refnum (BrickletColor)

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


.. labview:function:: BrickletColor.GetColor() -> r, g, b, c


 :output r: Int32
 :output g: Int32
 :output b: Int32
 :output c: Int32

 Returns the measured color of the sensor. The values
 have a range of 0 to 65535.
 
 The red (r), green (g), blue (b) and clear (c) colors are measured
 with four different photodiodes that are responsive at different
 wavelengths:
 
 .. image:: /Images/Bricklets/bricklet_color_wavelength_chart_600.jpg
    :scale: 100 %
    :alt: Chart Responsivity / Wavelength
    :align: center
    :target: ../../_images/Bricklets/bricklet_color_wavelength_chart_600.jpg
 
 If you want to get the color periodically, it is recommended 
 to use the callback :labview:func:`Color <BrickletColor.Color>` and set the period with 
 :labview:func:`SetColorCallbackPeriod() <BrickletColor.SetColorCallbackPeriod>`.
 
.. labview:function:: BrickletColor.LightOn()


 Turns the LED on.
 
.. labview:function:: BrickletColor.LightOff()


 Turns the LED off.
 
.. labview:function:: BrickletColor.IsLightOn() -> light


 :output light: Byte

 Returns the state of the LED. Possible values are:
 
 * 0: On
 * 1: Off
 
 The following constants are available for this function:
 
 * BrickletColor.LIGHT_ON = 0
 * BrickletColor.LIGHT_OFF = 1
 
.. labview:function:: BrickletColor.SetConfig(gain, integrationTime)

 :input gain: Byte
 :input integrationTime: Byte

 Sets the configuration of the sensor. Gain and integration time
 can be configured in this way.
 
 For configuring the gain:
 
 * 0: 1x Gain
 * 1: 4x Gain
 * 2: 16x Gain
 * 3: 60x Gain
 
 For configuring the integration time:
 
 * 0: 2.4ms
 * 1: 24ms
 * 2: 101ms
 * 3: 154ms
 * 4: 700ms
 
 Increasing the gain enables the sensor to detect a
 color from a higher distance.
 
 The integration time provides a trade-off between conversion time
 and accuracy. With a longer integration time the values read will
 be more accurate but it will take longer time to get the conversion
 results.
 
 The default values are 60x gain and 154ms integration time.
 
 The following constants are available for this function:
 
 * BrickletColor.GAIN_1X = 0
 * BrickletColor.GAIN_4X = 1
 * BrickletColor.GAIN_16X = 2
 * BrickletColor.GAIN_60X = 3
 * BrickletColor.INTEGRATION_TIME_2MS = 0
 * BrickletColor.INTEGRATION_TIME_24MS = 1
 * BrickletColor.INTEGRATION_TIME_101MS = 2
 * BrickletColor.INTEGRATION_TIME_154MS = 3
 * BrickletColor.INTEGRATION_TIME_700MS = 4
 
.. labview:function:: BrickletColor.GetConfig() -> gain, integrationTime


 :output gain: Byte
 :output integrationTime: Byte

 Returns the configuration as set by :labview:func:`SetConfig() <BrickletColor.SetConfig>`.
 
 The following constants are available for this function:
 
 * BrickletColor.GAIN_1X = 0
 * BrickletColor.GAIN_4X = 1
 * BrickletColor.GAIN_16X = 2
 * BrickletColor.GAIN_60X = 3
 * BrickletColor.INTEGRATION_TIME_2MS = 0
 * BrickletColor.INTEGRATION_TIME_24MS = 1
 * BrickletColor.INTEGRATION_TIME_101MS = 2
 * BrickletColor.INTEGRATION_TIME_154MS = 3
 * BrickletColor.INTEGRATION_TIME_700MS = 4
 
.. labview:function:: BrickletColor.GetIlluminance() -> illuminance


 :output illuminance: Int64

 Returns the illuminance affected by the gain and integration time as
 set by :labview:func:`SetConfig() <BrickletColor.SetConfig>`. To get the illuminance in Lux apply this formula::
 
  lux = illuminance * 700 / gain / integration_time
 
 To get a correct illuminance measurement make sure that the color
 values themself are not saturated. The color value (R, G or B)
 is saturated if it is equal to the maximum value of 65535.
 In that case you have to reduce the gain, see :labview:func:`SetConfig() <BrickletColor.SetConfig>`.
 
.. labview:function:: BrickletColor.GetColorTemperature() -> colorTemperature


 :output colorTemperature: Int32

 Returns the color temperature in Kelvin.
 
 To get a correct color temperature measurement make sure that the color
 values themself are not saturated. The color value (R, G or B)
 is saturated if it is equal to the maximum value of 65535.
 In that case you have to reduce the gain, see :labview:func:`SetConfig() <BrickletColor.SetConfig>`.
 


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

.. labview:function:: BrickletColor.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:: BrickletColor.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() <BrickletColor.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() <BrickletColor.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletColor.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:
 
 * BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
 * BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
 * BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
 * BrickletColor.FUNCTION_LIGHT_ON = 10
 * BrickletColor.FUNCTION_LIGHT_OFF = 11
 * BrickletColor.FUNCTION_SET_CONFIG = 13
 * BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
 * BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
 
.. labview:function:: BrickletColor.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetColorCallbackPeriod() <BrickletColor.SetColorCallbackPeriod>`.
 
.. labview:function:: BrickletColor.SetColorCallbackThreshold(option, minR, maxR, minG, maxG, minB, maxB, minC, maxC)

 :input option: Char
 :input minR: Int32
 :input maxR: Int32
 :input minG: Int32
 :input maxG: Int32
 :input minB: Int32
 :input maxB: Int32
 :input minC: Int32
 :input maxC: Int32

 Sets the thresholds for the :labview:func:`ColorReached <BrickletColor.ColorReached>` 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 temperature is *outside* the min and max values"
  "'i'",    "Callback is triggered when the temperature is *inside* the min and max values"
  "'<'",    "Callback is triggered when the temperature is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the temperature is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0, 0, 0, 0, 0, 0, 0).
 
 The following constants are available for this function:
 
 * BrickletColor.THRESHOLD_OPTION_OFF = 'x'
 * BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletColor.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletColor.GetColorCallbackThreshold() -> option, minR, maxR, minG, maxG, minB, maxB, minC, maxC


 :output option: Char
 :output minR: Int32
 :output maxR: Int32
 :output minG: Int32
 :output maxG: Int32
 :output minB: Int32
 :output maxB: Int32
 :output minC: Int32
 :output maxC: Int32

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

 :input debounce: Int64

 Sets the period in ms with which the threshold callback
 
 * :labview:func:`ColorReached <BrickletColor.ColorReached>`
 
 is triggered, if the threshold
 
 * :labview:func:`SetColorCallbackThreshold() <BrickletColor.SetColorCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. labview:function:: BrickletColor.GetDebouncePeriod() -> debounce


 :output debounce: Int64

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

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetIlluminanceCallbackPeriod() <BrickletColor.SetIlluminanceCallbackPeriod>`.
 
.. labview:function:: BrickletColor.SetColorTemperatureCallbackPeriod(period)

 :input period: Int64

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


 :output period: Int64

 Returns the period as set by :labview:func:`SetColorTemperatureCallbackPeriod() <BrickletColor.SetColorTemperatureCallbackPeriod>`.
 


.. _color_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 BrickletColor.Color(sender, r, g, b, c)

 :input sender: .NET Refnum (BrickletColor)
 :input r: Int32
 :input g: Int32
 :input b: Int32
 :input c: Int32

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetColorCallbackPeriod() <BrickletColor.SetColorCallbackPeriod>`. The parameter is the color
 of the sensor as RGBC.
 
 :labview:func:`Color <BrickletColor.Color>` is only triggered if the color has changed since the
 last triggering.
 

.. labview:function:: event BrickletColor.ColorReached(sender, r, g, b, c)

 :input sender: .NET Refnum (BrickletColor)
 :input r: Int32
 :input g: Int32
 :input b: Int32
 :input c: Int32

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

.. labview:function:: event BrickletColor.Illuminance(sender, illuminance)

 :input sender: .NET Refnum (BrickletColor)
 :input illuminance: Int64

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetIlluminanceCallbackPeriod() <BrickletColor.SetIlluminanceCallbackPeriod>`. The parameter is the illuminance.
 See :labview:func:`GetIlluminance() <BrickletColor.GetIlluminance>` for how to interpret this value.
 
 :labview:func:`Illuminance <BrickletColor.Illuminance>` is only triggered if the illuminance has changed since the
 last triggering.
 

.. labview:function:: event BrickletColor.ColorTemperature(sender, colorTemperature)

 :input sender: .NET Refnum (BrickletColor)
 :input colorTemperature: Int32

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetColorTemperatureCallbackPeriod() <BrickletColor.SetColorTemperatureCallbackPeriod>`. The parameter is the 
 color temperature in Kelvin.
 
 :labview:func:`ColorTemperature <BrickletColor.ColorTemperature>` is only triggered if the color temperature has 
 changed since the last triggering.
 


.. _color_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletColor.DEVICE_IDENTIFIER

 This constant is used to identify a Color Bricklet.

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

