..
 #############################################################
 # 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 - Industrial Digital Out 4 Bricklet

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

.. _industrial_digital_out_4_bricklet_mathematica:

Mathematica - Industrial Digital Out 4 Bricklet
===============================================

This is the description of the :ref:`Mathematica API bindings <api_bindings_mathematica>` for the :ref:`Industrial Digital Out 4 Bricklet <industrial_digital_out_4_bricklet>`. General information and technical
specifications for the Industrial Digital Out 4 Bricklet are summarized in its :ref:`hardware description
<industrial_digital_out_4_bricklet_description>`.

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

.. _industrial_digital_out_4_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/industrial-digital-out-4-bricklet/raw/master/software/examples/mathematica/ExampleSimple.nb>`__

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

.. _industrial_digital_out_4_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:: BrickletIndustrialDigitalOut4[uid, ipcon] -> industrialDigitalOut4

 :param uid: String
 :param ipcon: NETObject[IPConnection]
 :ret industrialDigitalOut4: NETObject[BrickletIndustrialDigitalOut4]

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

 .. code-block:: mathematica

    industrialDigitalOut4=NETNew["Tinkerforge.BrickletIndustrialDigitalOut4","YOUR_DEVICE_UID",ipcon]

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <industrial_digital_out_4_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:: BrickletIndustrialDigitalOut4@SetValue[valueMask] -> Null

 :param valueMask: Integer

 Sets the output value with a bitmask (16bit). A 1 in the bitmask means high
 and a 0 in the bitmask means low.
 
 For example: The value 3 or 0b0011 will turn pins 0-1 high and the other pins
 low.
 
 If no groups are used (see :mathematica:func:`SetGroup[] <BrickletIndustrialDigitalOut4@SetGroup>`), the pins correspond to the
 markings on the Digital Out 4 Bricklet.
 
 If groups are used, the pins correspond to the element in the group.
 Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
 pins 8-11 and element 4 pins 12-15.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@GetValue[] -> valueMask

 :ret valueMask: Integer

 Returns the bitmask as set by :mathematica:func:`SetValue[] <BrickletIndustrialDigitalOut4@SetValue>`.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@SetSelectedValues[selectionMask, valueMask] -> Null

 :param selectionMask: Integer
 :param valueMask: Integer

 Sets the output value with a bitmask, according to the selection mask.
 The bitmask is 16 bit long, *true* refers to high and *false* refers to 
 low.
 
 For example: The values (3, 1) or (0b0011, 0b0001) will turn pin 0 high, pin 1
 low the other pins remain untouched.
 
 If no groups are used (see :mathematica:func:`SetGroup[] <BrickletIndustrialDigitalOut4@SetGroup>`), the pins correspond to the
 markings on the Digital Out 4 Bricklet.
 
 If groups are used, the pins correspond to the element in the group.
 Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
 pins 8-11 and element 4 pins 12-15.
 


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

.. mathematica:function:: BrickletIndustrialDigitalOut4@SetMonoflop[selectionMask, valueMask, time] -> Null

 :param selectionMask: Integer
 :param valueMask: Integer
 :param time: Integer

 Configures a monoflop of the pins specified by the first parameter
 bitmask.
 
 The second parameter is a bitmask with the desired value of the specified
 pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
 
 The third parameter indicates the time (in ms) that the pins should hold
 the value.
 
 If this function is called with the parameters (9, 1, 1500) or
 (0b1001, 0b0001, 1500): Pin 0 will get high and pin 3 will get low. In 1.5s
 pin 0 will get low and pin 3 will get high again.
 
 A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
 have a RS485 bus and a Digital Out 4 Bricklet connected to one of the slave
 stacks. You can now call this function every second, with a time parameter
 of two seconds and pin 0 high. Pin 0 will be high all the time. If now
 the RS485 connection is lost, then pin 0 will turn low in at most two seconds.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@GetMonoflop[pin, out value, out time, out timeRemaining] -> Null

 :param pin: Integer
 :param value: Integer
 :param time: Integer
 :param timeRemaining: Integer

 Returns (for the given pin) the current value and the time as set by
 :mathematica:func:`SetMonoflop[] <BrickletIndustrialDigitalOut4@SetMonoflop>` as well as the remaining time until the value flips.
 
 If the timer is not running currently, the remaining time will be returned
 as 0.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@SetGroup[{group1, group2, ..., group4}] -> Null

 :param groupi: Integer

 Sets a group of Digital Out 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :mathematica:func:`GetAvailableForGroup[] <BrickletIndustrialDigitalOut4@GetAvailableForGroup>`.
 
 The group consists of 4 elements. Element 1 in the group will get pins 0-3,
 element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.
 
 Each element can either be one of the ports ('a' to 'd') or 'n' if it should
 not be used.
 
 For example: If you have two Digital Out 4 Bricklets connected to port A and
 port B respectively, you could call with ``['a', 'b', 'n', 'n']``.
 
 Now the pins on the Digital Out 4 on port A are assigned to 0-3 and the
 pins on the Digital Out 4 on port B are assigned to 4-7. It is now possible
 to call :mathematica:func:`SetValue[] <BrickletIndustrialDigitalOut4@SetValue>` and control two Bricklets at the same time.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@GetGroup[] -> {group1, group2, ..., group4}

 :ret groupi: Integer

 Returns the group as set by :mathematica:func:`SetGroup[] <BrickletIndustrialDigitalOut4@SetGroup>`
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@GetAvailableForGroup[] -> available

 :ret available: Integer

 Returns a bitmask of ports that are available for grouping. For example the
 value 5 or 0b0101 means: Port A and port C are connected to Bricklets that
 can be grouped together.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@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:: BrickletIndustrialDigitalOut4@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[] <BrickletIndustrialDigitalOut4@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[] <BrickletIndustrialDigitalOut4@SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@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:
 
 * BrickletIndustrialDigitalOut4`FUNCTIONUSETUVALUE = 1
 * BrickletIndustrialDigitalOut4`FUNCTIONUSETUMONOFLOP = 3
 * BrickletIndustrialDigitalOut4`FUNCTIONUSETUGROUP = 5
 * BrickletIndustrialDigitalOut4`FUNCTIONUSETUSELECTEDUVALUES = 9
 
.. mathematica:function:: BrickletIndustrialDigitalOut4@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:: BrickletIndustrialDigitalOut4@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|
 


.. _industrial_digital_out_4_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[industrialDigitalOut4@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 BrickletIndustrialDigitalOut4@MonoflopDone[sender, selectionMask, valueMask]

 :param sender: NETObject[BrickletIndustrialDigitalOut4]
 :param selectionMask: Integer
 :param valueMask: Integer

 This callback is triggered whenever a monoflop timer reaches 0. The
 parameters contain the involved pins and the current value of the pins
 (the value after the monoflop).
 


.. _industrial_digital_out_4_bricklet_mathematica_constants:

Constants
^^^^^^^^^

.. mathematica:symbol:: BrickletIndustrialDigitalOut4`DEVICEUIDENTIFIER

 This constant is used to identify a Industrial Digital Out 4 Bricklet.

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

