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

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

.. _current12_bricklet_mathematica:

Mathematica - Current12 Bricklet
================================

This is the description of the :ref:`Mathematica API bindings <api_bindings_mathematica>` for the :ref:`Current12 Bricklet <current12_bricklet>`. General information and technical
specifications for the Current12 Bricklet are summarized in its :ref:`hardware description
<current12_bricklet_description>`.

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

.. _current12_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/current12-bricklet/raw/master/software/examples/mathematica/ExampleSimple.nb>`__

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

Callback
^^^^^^^^

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

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

Threshold
^^^^^^^^^

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

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

.. _current12_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:: BrickletCurrent12[uid, ipcon] -> current12

 :param uid: String
 :param ipcon: NETObject[IPConnection]
 :ret current12: NETObject[BrickletCurrent12]

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

 .. code-block:: mathematica

    current12=NETNew["Tinkerforge.BrickletCurrent12","YOUR_DEVICE_UID",ipcon]

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <current12_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:: BrickletCurrent12@GetCurrent[] -> current

 :ret current: Integer

 Returns the current of the sensor. The value is in mA
 and between -12500mA and 12500mA.
 
 If you want to get the current periodically, it is recommended to use the
 callback :mathematica:func:`Current <BrickletCurrent12@Current>` and set the period with 
 :mathematica:func:`SetCurrentCallbackPeriod[] <BrickletCurrent12@SetCurrentCallbackPeriod>`.
 


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

.. mathematica:function:: BrickletCurrent12@Calibrate[] -> Null


 Calibrates the 0 value of the sensor. You have to call this function
 when there is no current present. 
 
 The zero point of the current sensor
 is depending on the exact properties of the analog-to-digital converter,
 the length of the Bricklet cable and the temperature. Thus, if you change
 the Brick or the environment in which the Bricklet is used, you might
 have to recalibrate.
 
 The resulting calibration will be saved on the EEPROM of the Current
 Bricklet.
 
.. mathematica:function:: BrickletCurrent12@IsOverCurrent[] -> over

 :ret over: True/False

 Returns *true* if more than 12.5A were measured.
 
 .. note::
  To reset this value you have to power cycle the Bricklet.
 
.. mathematica:function:: BrickletCurrent12@GetAnalogValue[] -> value

 :ret value: Integer

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 .. note::
  The value returned by :mathematica:func:`GetCurrent[] <BrickletCurrent12@GetCurrent>` is averaged over several samples
  to yield less noise, while :mathematica:func:`GetAnalogValue[] <BrickletCurrent12@GetAnalogValue>` gives back raw
  unfiltered analog values. The only reason to use :mathematica:func:`GetAnalogValue[] <BrickletCurrent12@GetAnalogValue>` is,
  if you need the full resolution of the analog-to-digital converter.
 
 If you want the analog value periodically, it is recommended to use the 
 callback :mathematica:func:`AnalogValue <BrickletCurrent12@AnalogValue>` and set the period with 
 :mathematica:func:`SetAnalogValueCallbackPeriod[] <BrickletCurrent12@SetAnalogValueCallbackPeriod>`.
 
.. mathematica:function:: BrickletCurrent12@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:: BrickletCurrent12@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[] <BrickletCurrent12@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[] <BrickletCurrent12@SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. mathematica:function:: BrickletCurrent12@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:
 
 * BrickletCurrent12`FUNCTIONUCALIBRATE = 2
 * BrickletCurrent12`FUNCTIONUSETUCURRENTUCALLBACKUPERIOD = 5
 * BrickletCurrent12`FUNCTIONUSETUANALOGUVALUEUCALLBACKUPERIOD = 7
 * BrickletCurrent12`FUNCTIONUSETUCURRENTUCALLBACKUTHRESHOLD = 9
 * BrickletCurrent12`FUNCTIONUSETUANALOGUVALUEUCALLBACKUTHRESHOLD = 11
 * BrickletCurrent12`FUNCTIONUSETUDEBOUNCEUPERIOD = 13
 
.. mathematica:function:: BrickletCurrent12@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:: BrickletCurrent12@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:: BrickletCurrent12@SetCurrentCallbackPeriod[period] -> Null

 :param period: Integer

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

 :ret period: Integer

 Returns the period as set by :mathematica:func:`SetCurrentCallbackPeriod[] <BrickletCurrent12@SetCurrentCallbackPeriod>`.
 
.. mathematica:function:: BrickletCurrent12@SetAnalogValueCallbackPeriod[period] -> Null

 :param period: Integer

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

 :ret period: Integer

 Returns the period as set by :mathematica:func:`SetAnalogValueCallbackPeriod[] <BrickletCurrent12@SetAnalogValueCallbackPeriod>`.
 
.. mathematica:function:: BrickletCurrent12@SetCurrentCallbackThreshold[option, min, max] -> Null

 :param option: Integer
 :param min: Integer
 :param max: Integer

 Sets the thresholds for the :mathematica:func:`CurrentReached <BrickletCurrent12@CurrentReached>` 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 current is *outside* the min and max values"
  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletCurrent12`THRESHOLDUOPTIONUOFF = ``ToCharacterCode["x"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUOUTSIDE = ``ToCharacterCode["o"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUINSIDE = ``ToCharacterCode["i"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUSMALLER = ``ToCharacterCode["<"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUGREATER = ``ToCharacterCode[">"][[0]]``
 
.. mathematica:function:: BrickletCurrent12@GetCurrentCallbackThreshold[out option, out min, out max] -> Null

 :param option: Integer
 :param min: Integer
 :param max: Integer

 Returns the threshold as set by :mathematica:func:`SetCurrentCallbackThreshold[] <BrickletCurrent12@SetCurrentCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletCurrent12`THRESHOLDUOPTIONUOFF = ``ToCharacterCode["x"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUOUTSIDE = ``ToCharacterCode["o"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUINSIDE = ``ToCharacterCode["i"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUSMALLER = ``ToCharacterCode["<"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUGREATER = ``ToCharacterCode[">"][[0]]``
 
.. mathematica:function:: BrickletCurrent12@SetAnalogValueCallbackThreshold[option, min, max] -> Null

 :param option: Integer
 :param min: Integer
 :param max: Integer

 Sets the thresholds for the :mathematica:func:`AnalogValueReached <BrickletCurrent12@AnalogValueReached>` 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 analog value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletCurrent12`THRESHOLDUOPTIONUOFF = ``ToCharacterCode["x"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUOUTSIDE = ``ToCharacterCode["o"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUINSIDE = ``ToCharacterCode["i"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUSMALLER = ``ToCharacterCode["<"][[0]]``
 * BrickletCurrent12`THRESHOLDUOPTIONUGREATER = ``ToCharacterCode[">"][[0]]``
 
.. mathematica:function:: BrickletCurrent12@GetAnalogValueCallbackThreshold[out option, out min, out max] -> Null

 :param option: Integer
 :param min: Integer
 :param max: Integer

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

 :param debounce: Integer

 Sets the period in ms with which the threshold callbacks
 
 * :mathematica:func:`CurrentReached <BrickletCurrent12@CurrentReached>`,
 * :mathematica:func:`AnalogValueReached <BrickletCurrent12@AnalogValueReached>`
 
 are triggered, if the thresholds
 
 * :mathematica:func:`SetCurrentCallbackThreshold[] <BrickletCurrent12@SetCurrentCallbackThreshold>`,
 * :mathematica:func:`SetAnalogValueCallbackThreshold[] <BrickletCurrent12@SetAnalogValueCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. mathematica:function:: BrickletCurrent12@GetDebouncePeriod[] -> debounce

 :ret debounce: Integer

 Returns the debounce period as set by :mathematica:func:`SetDebouncePeriod[] <BrickletCurrent12@SetDebouncePeriod>`.
 


.. _current12_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[current12@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 BrickletCurrent12@Current[sender, current]

 :param sender: NETObject[BrickletCurrent12]
 :param current: Integer

 This callback is triggered periodically with the period that is set by
 :mathematica:func:`SetCurrentCallbackPeriod[] <BrickletCurrent12@SetCurrentCallbackPeriod>`. The parameter is the current of the
 sensor.
 
 :mathematica:func:`Current <BrickletCurrent12@Current>` is only triggered if the current has changed since the
 last triggering.
 

.. mathematica:function:: event BrickletCurrent12@AnalogValue[sender, value]

 :param sender: NETObject[BrickletCurrent12]
 :param value: Integer

 This callback is triggered periodically with the period that is set by
 :mathematica:func:`SetAnalogValueCallbackPeriod[] <BrickletCurrent12@SetAnalogValueCallbackPeriod>`. The parameter is the analog value
 of the sensor.
 
 :mathematica:func:`AnalogValue <BrickletCurrent12@AnalogValue>` is only triggered if the current has changed since the
 last triggering.
 

.. mathematica:function:: event BrickletCurrent12@CurrentReached[sender, current]

 :param sender: NETObject[BrickletCurrent12]
 :param current: Integer

 This callback is triggered when the threshold as set by
 :mathematica:func:`SetCurrentCallbackThreshold[] <BrickletCurrent12@SetCurrentCallbackThreshold>` is reached.
 The parameter is the current of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :mathematica:func:`SetDebouncePeriod[] <BrickletCurrent12@SetDebouncePeriod>`.
 

.. mathematica:function:: event BrickletCurrent12@AnalogValueReached[sender, value]

 :param sender: NETObject[BrickletCurrent12]
 :param value: Integer

 This callback is triggered when the threshold as set by
 :mathematica:func:`SetAnalogValueCallbackThreshold[] <BrickletCurrent12@SetAnalogValueCallbackThreshold>` is reached.
 The parameter is the analog value of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :mathematica:func:`SetDebouncePeriod[] <BrickletCurrent12@SetDebouncePeriod>`.
 

.. mathematica:function:: event BrickletCurrent12@OverCurrent[sender]

 :param sender: NETObject[BrickletCurrent12]

 This callback is triggered when an over current is measured
 (see :mathematica:func:`IsOverCurrent[] <BrickletCurrent12@IsOverCurrent>`).
 


.. _current12_bricklet_mathematica_constants:

Constants
^^^^^^^^^

.. mathematica:symbol:: BrickletCurrent12`DEVICEUIDENTIFIER

 This constant is used to identify a Current12 Bricklet.

 The :mathematica:func:`GetIdentity[] <BrickletCurrent12@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.

