..
 #############################################################
 # 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-mathematica">Software</a> / Mathematica - Color Bricklet

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

.. _color_bricklet_mathematica:

Mathematica - Color Bricklet
============================

This is the description of the :ref:`Mathematica API bindings <api_bindings_mathematica>` 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_mathematica_install>` for the Mathematica API
bindings is part of their general description.

.. _color_bricklet_mathematica_examples:


Examples
--------

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

Simple
^^^^^^

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

.. literalinclude:: Color_Bricklet_Mathematica_ExampleSimple.nb.txt
 :language: mathematica
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

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

.. literalinclude:: Color_Bricklet_Mathematica_ExampleCallback.nb.txt
 :language: mathematica
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

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

.. literalinclude:: Color_Bricklet_Mathematica_ExampleThreshold.nb.txt
 :language: mathematica
 :linenos:
 :tab-width: 4

.. _color_bricklet_mathematica_api:

API
---

Generally, every method of the Mathematica bindings that returns a value can
throw a ``Tinkerforge.TimeoutException``. This exception gets thrown 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.

Since .NET/Link does not support multiple return values directly, we use the
``out`` keyword to return multiple values from a method. For further
information about the ``out`` keyword in .NET/Link see the corresponding
Mathematica `.NET/Link documentation
<http://reference.wolfram.com/language/NETLink/tutorial/CallingNETFromTheWolframLanguage.html#15993>`__.

The namespace for all Brick/Bricklet bindings and the IPConnection is
``Tinkerforge.*``.




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


.. mathematica:function:: BrickletColor[uid, ipcon] -> color

 :param uid: String
 :param ipcon: NETObject[IPConnection]
 :ret color: NETObject[BrickletColor]

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

 .. code-block:: mathematica

    color=NETNew["Tinkerforge.BrickletColor","YOUR_DEVICE_UID",ipcon]

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

 The .NET runtime has built-in garbage collection that frees objects that are
 no longer in use by a program. But because Mathematica can not automatically
 tell when a Mathematica "program" doesn't use a .NET object anymore, this has
 to be done by the program. For this the `ReleaseNETObject[]
 <http://reference.wolfram.com/language/NETLink/ref/ReleaseNETObject.html>`__
 function is used in the examples.

 For further information about object management in .NET/Link see the
 corresponding Mathematica `.NET/Link documentation
 <http://reference.wolfram.com/language/NETLink/tutorial/CallingNETFromTheWolframLanguage.html#14400>`__.


.. mathematica:function:: BrickletColor@GetColor[out r, out g, out b, out c] -> Null

 :param r: Integer
 :param g: Integer
 :param b: Integer
 :param c: 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 :mathematica:func:`Color <BrickletColor@Color>` and set the period with 
 :mathematica:func:`SetColorCallbackPeriod[] <BrickletColor@SetColorCallbackPeriod>`.
 
.. mathematica:function:: BrickletColor@LightOn[] -> Null


 Turns the LED on.
 
.. mathematica:function:: BrickletColor@LightOff[] -> Null


 Turns the LED off.
 
.. mathematica:function:: BrickletColor@IsLightOn[] -> light

 :ret light: Integer

 Returns the state of the LED. Possible values are:
 
 * 0: On
 * 1: Off
 
 The following constants are available for this function:
 
 * BrickletColor`LIGHTUON = 0
 * BrickletColor`LIGHTUOFF = 1
 
.. mathematica:function:: BrickletColor@SetConfig[gain, integrationTime] -> Null

 :param gain: Integer
 :param integrationTime: Integer

 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`GAINU1X = 0
 * BrickletColor`GAINU4X = 1
 * BrickletColor`GAINU16X = 2
 * BrickletColor`GAINU60X = 3
 * BrickletColor`INTEGRATIONUTIMEU2MS = 0
 * BrickletColor`INTEGRATIONUTIMEU24MS = 1
 * BrickletColor`INTEGRATIONUTIMEU101MS = 2
 * BrickletColor`INTEGRATIONUTIMEU154MS = 3
 * BrickletColor`INTEGRATIONUTIMEU700MS = 4
 
.. mathematica:function:: BrickletColor@GetConfig[out gain, out integrationTime] -> Null

 :param gain: Integer
 :param integrationTime: Integer

 Returns the configuration as set by :mathematica:func:`SetConfig[] <BrickletColor@SetConfig>`.
 
 The following constants are available for this function:
 
 * BrickletColor`GAINU1X = 0
 * BrickletColor`GAINU4X = 1
 * BrickletColor`GAINU16X = 2
 * BrickletColor`GAINU60X = 3
 * BrickletColor`INTEGRATIONUTIMEU2MS = 0
 * BrickletColor`INTEGRATIONUTIMEU24MS = 1
 * BrickletColor`INTEGRATIONUTIMEU101MS = 2
 * BrickletColor`INTEGRATIONUTIMEU154MS = 3
 * BrickletColor`INTEGRATIONUTIMEU700MS = 4
 
.. mathematica:function:: BrickletColor@GetIlluminance[] -> illuminance

 :ret illuminance: Integer

 Returns the illuminance affected by the gain and integration time as
 set by :mathematica: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 :mathematica:func:`SetConfig[] <BrickletColor@SetConfig>`.
 
.. mathematica:function:: BrickletColor@GetColorTemperature[] -> colorTemperature

 :ret colorTemperature: 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 :mathematica:func:`SetConfig[] <BrickletColor@SetConfig>`.
 


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

.. mathematica:function:: BrickletColor@GetAPIVersion[] -> {apiVersion1, apiVersion2, apiVersion3}

 :ret apiVersioni: Integer

 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.
 
.. mathematica:function:: BrickletColor@GetResponseExpected[functionId] -> responseExpected

 :param functionId: Integer
 :ret responseExpected: True/False

 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
 :mathematica: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 :mathematica:func:`SetResponseExpected[] <BrickletColor@SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. mathematica:function:: BrickletColor@SetResponseExpected[functionId, responseExpected] -> Null

 :param functionId: Integer
 :param responseExpected: True/False

 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`FUNCTIONUSETUCOLORUCALLBACKUPERIOD = 2
 * BrickletColor`FUNCTIONUSETUCOLORUCALLBACKUTHRESHOLD = 4
 * BrickletColor`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
 * BrickletColor`FUNCTIONULIGHTUON = 10
 * BrickletColor`FUNCTIONULIGHTUOFF = 11
 * BrickletColor`FUNCTIONUSETUCONFIG = 13
 * BrickletColor`FUNCTIONUSETUILLUMINANCEUCALLBACKUPERIOD = 17
 * BrickletColor`FUNCTIONUSETUCOLORUTEMPERATUREUCALLBACKUPERIOD = 19
 
.. mathematica:function:: BrickletColor@SetResponseExpectedAll[responseExpected] -> Null

 :param responseExpected: True/False

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. mathematica:function:: BrickletColor@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] -> Null

 :param uid: String
 :param connectedUid: String
 :param position: Integer
 :param hardwareVersioni: Integer
 :param firmwareVersioni: Integer
 :param deviceIdentifier: 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. mathematica:function:: BrickletColor@SetColorCallbackPeriod[period] -> Null

 :param period: Integer

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

 :ret period: Integer

 Returns the period as set by :mathematica:func:`SetColorCallbackPeriod[] <BrickletColor@SetColorCallbackPeriod>`.
 
.. mathematica:function:: BrickletColor@SetColorCallbackThreshold[option, minR, maxR, minG, maxG, minB, maxB, minC, maxC] -> Null

 :param option: Integer
 :param minR: Integer
 :param maxR: Integer
 :param minG: Integer
 :param maxG: Integer
 :param minB: Integer
 :param maxB: Integer
 :param minC: Integer
 :param maxC: Integer

 Sets the thresholds for the :mathematica: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`THRESHOLDUOPTIONUOFF = ``ToCharacterCode["x"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUOUTSIDE = ``ToCharacterCode["o"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUINSIDE = ``ToCharacterCode["i"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUSMALLER = ``ToCharacterCode["<"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUGREATER = ``ToCharacterCode[">"][[0]]``
 
.. mathematica:function:: BrickletColor@GetColorCallbackThreshold[out option, out minR, out maxR, out minG, out maxG, out minB, out maxB, out minC, out maxC] -> Null

 :param option: Integer
 :param minR: Integer
 :param maxR: Integer
 :param minG: Integer
 :param maxG: Integer
 :param minB: Integer
 :param maxB: Integer
 :param minC: Integer
 :param maxC: Integer

 Returns the threshold as set by :mathematica:func:`SetColorCallbackThreshold[] <BrickletColor@SetColorCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletColor`THRESHOLDUOPTIONUOFF = ``ToCharacterCode["x"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUOUTSIDE = ``ToCharacterCode["o"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUINSIDE = ``ToCharacterCode["i"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUSMALLER = ``ToCharacterCode["<"][[0]]``
 * BrickletColor`THRESHOLDUOPTIONUGREATER = ``ToCharacterCode[">"][[0]]``
 
.. mathematica:function:: BrickletColor@SetDebouncePeriod[debounce] -> Null

 :param debounce: Integer

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

 :ret debounce: Integer

 Returns the debounce period as set by :mathematica:func:`SetDebouncePeriod[] <BrickletColor@SetDebouncePeriod>`.
 
.. mathematica:function:: BrickletColor@SetIlluminanceCallbackPeriod[period] -> Null

 :param period: Integer

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

 :ret period: Integer

 Returns the period as set by :mathematica:func:`SetIlluminanceCallbackPeriod[] <BrickletColor@SetIlluminanceCallbackPeriod>`.
 
.. mathematica:function:: BrickletColor@SetColorTemperatureCallbackPeriod[period] -> Null

 :param period: Integer

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

 :ret period: Integer

 Returns the period as set by :mathematica:func:`SetColorTemperatureCallbackPeriod[] <BrickletColor@SetColorTemperatureCallbackPeriod>`.
 


.. _color_bricklet_mathematica_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:

 .. code-block:: mathematica

    Callback[sender_,value_]:=Print["Value: "<>ToString[value]]

    AddEventHandler[color@Example,Callback]

For further information about event handling using .NET/Link see the
corresponding Mathematica `.NET/Link documentation
<http://reference.wolfram.com/language/NETLink/tutorial/CallingNETFromTheWolframLanguage.html#17034>`__.

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.


.. mathematica:function:: event BrickletColor@Color[sender, r, g, b, c]

 :param sender: NETObject[BrickletColor]
 :param r: Integer
 :param g: Integer
 :param b: Integer
 :param c: Integer

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

.. mathematica:function:: event BrickletColor@ColorReached[sender, r, g, b, c]

 :param sender: NETObject[BrickletColor]
 :param r: Integer
 :param g: Integer
 :param b: Integer
 :param c: Integer

 This callback is triggered when the threshold as set by
 :mathematica: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 :mathematica:func:`SetDebouncePeriod[] <BrickletColor@SetDebouncePeriod>`.
 

.. mathematica:function:: event BrickletColor@Illuminance[sender, illuminance]

 :param sender: NETObject[BrickletColor]
 :param illuminance: Integer

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

.. mathematica:function:: event BrickletColor@ColorTemperature[sender, colorTemperature]

 :param sender: NETObject[BrickletColor]
 :param colorTemperature: Integer

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


.. _color_bricklet_mathematica_constants:

Constants
^^^^^^^^^

.. mathematica:symbol:: BrickletColor`DEVICEUIDENTIFIER

 This constant is used to identify a Color Bricklet.

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

