..
 #############################################################
 # 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-vbnet">Software</a> / Visual Basic .NET - Color Bricklet

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

.. _color_bricklet_vbnet:

Visual Basic .NET - Color Bricklet
==================================

This is the description of the :ref:`Visual Basic .NET API bindings <api_bindings_vbnet>` 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_vbnet_install>` for the Visual Basic .NET API
bindings is part of their general description.

.. _color_bricklet_vbnet_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.vb) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/vbnet/ExampleSimple.vb>`__

.. literalinclude:: Color_Bricklet_VBNET_ExampleSimple.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.vb) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/vbnet/ExampleCallback.vb>`__

.. literalinclude:: Color_Bricklet_VBNET_ExampleCallback.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (ExampleThreshold.vb) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/vbnet/ExampleThreshold.vb>`__

.. literalinclude:: Color_Bricklet_VBNET_ExampleThreshold.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

.. _color_bricklet_vbnet_api:

API
---

Since Visual Basic .NET does not support multiple return values directly, we
use the ``ByRef`` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.




Basic Functions
^^^^^^^^^^^^^^^


.. vbnet:function:: Class BrickletColor(ByVal uid As String, ByVal ipcon As IPConnection)

 Creates an object with the unique device ID ``uid``:

 .. code-block:: vbnet

    Dim color As New BrickletColor("YOUR_DEVICE_UID", ipcon)

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <color_bricklet_vbnet_examples>`).


.. vbnet:function:: Sub BrickletColor.GetColor(ByRef r As Integer, ByRef g As Integer, ByRef b As Integer, ByRef c As Integer)

 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 :vbnet:func:`Color <BrickletColor.Color>` and set the period with 
 :vbnet:func:`SetColorCallbackPeriod() <BrickletColor.SetColorCallbackPeriod>`.
 
.. vbnet:function:: Sub BrickletColor.LightOn()

 Turns the LED on.
 
.. vbnet:function:: Sub BrickletColor.LightOff()

 Turns the LED off.
 
.. vbnet:function:: Function BrickletColor.IsLightOn() As 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
 
.. vbnet:function:: Sub BrickletColor.SetConfig(ByVal gain As Byte, ByVal integrationTime As 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
 
.. vbnet:function:: Sub BrickletColor.GetConfig(ByRef gain As Byte, ByRef integrationTime As Byte)

 Returns the configuration as set by :vbnet: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
 
.. vbnet:function:: Function BrickletColor.GetIlluminance() As Long

 Returns the illuminance affected by the gain and integration time as
 set by :vbnet: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 :vbnet:func:`SetConfig() <BrickletColor.SetConfig>`.
 
.. vbnet:function:: Function BrickletColor.GetColorTemperature() As Integer

 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 :vbnet:func:`SetConfig() <BrickletColor.SetConfig>`.
 


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

.. vbnet:function:: Function BrickletColor.GetAPIVersion() As Byte[]

 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.
 
.. vbnet:function:: Function BrickletColor.GetResponseExpected(ByVal functionId As Byte) As 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
 :vbnet: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 :vbnet:func:`SetResponseExpected() <BrickletColor.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. vbnet:function:: Sub BrickletColor.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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
 
.. vbnet:function:: Sub BrickletColor.SetResponseExpectedAll(ByVal responseExpected As Boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. vbnet:function:: Sub BrickletColor.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion[] As Byte, ByRef firmwareVersion[] As Byte, ByRef deviceIdentifier As Integer)

 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. vbnet:function:: Sub BrickletColor.SetColorCallbackPeriod(ByVal period As Long)

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

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

 Sets the thresholds for the :vbnet: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"C
 * BrickletColor.THRESHOLD_OPTION_OUTSIDE = "o"C
 * BrickletColor.THRESHOLD_OPTION_INSIDE = "i"C
 * BrickletColor.THRESHOLD_OPTION_SMALLER = "<"C
 * BrickletColor.THRESHOLD_OPTION_GREATER = ">"C
 
.. vbnet:function:: Sub BrickletColor.GetColorCallbackThreshold(ByRef option As Char, ByRef minR As Integer, ByRef maxR As Integer, ByRef minG As Integer, ByRef maxG As Integer, ByRef minB As Integer, ByRef maxB As Integer, ByRef minC As Integer, ByRef maxC As Integer)

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

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

 Returns the debounce period as set by :vbnet:func:`SetDebouncePeriod() <BrickletColor.SetDebouncePeriod>`.
 
.. vbnet:function:: Sub BrickletColor.SetIlluminanceCallbackPeriod(ByVal period As Long)

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

 Returns the period as set by :vbnet:func:`SetIlluminanceCallbackPeriod() <BrickletColor.SetIlluminanceCallbackPeriod>`.
 
.. vbnet:function:: Sub BrickletColor.SetColorTemperatureCallbackPeriod(ByVal period As Long)

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

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


.. _color_bricklet_vbnet_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by assigning a procedure to an callback
property of the device object:

 .. code-block:: vbnet

    Sub Callback(ByVal sender As BrickletColor, ByVal value As Short)
        Console.WriteLine("Value: {0}", value)
    End Sub

    AddHandler color.Example, AddressOf Callback

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.


.. vbnet:function:: Event BrickletColor.Color(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)


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

.. vbnet:function:: Event BrickletColor.ColorReached(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)


 This callback is triggered when the threshold as set by
 :vbnet: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 :vbnet:func:`SetDebouncePeriod() <BrickletColor.SetDebouncePeriod>`.
 

.. vbnet:function:: Event BrickletColor.Illuminance(ByVal sender As BrickletColor, ByVal illuminance As Long)


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

.. vbnet:function:: Event BrickletColor.ColorTemperature(ByVal sender As BrickletColor, ByVal colorTemperature As Integer)


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


.. _color_bricklet_vbnet_constants:

Constants
^^^^^^^^^

.. vbnet:attribute:: Const BrickletColor.DEVICE_IDENTIFIER

 This constant is used to identify a Color Bricklet.

 The :vbnet:func:`GetIdentity() <BrickletColor.GetIdentity>` function and the
 :vbnet:func:`EnumerateCallback <IPConnection.EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

