..
 #############################################################
 # 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-matlab">Software</a> / MATLAB/Octave - Industrial Digital Out 4 Bricklet

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

.. _industrial_digital_out_4_bricklet_matlab:

MATLAB/Octave - Industrial Digital Out 4 Bricklet
=================================================

This is the description of the :ref:`MATLAB/Octave API bindings <api_bindings_matlab>` 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_matlab_install>` for the MATLAB/Octave API
bindings is part of their general description.

.. _industrial_digital_out_4_bricklet_matlab_examples:


Examples
--------

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

Simple (MATLAB)
^^^^^^^^^^^^^^^

`Download (matlab_example_simple.m) <https://github.com/Tinkerforge/industrial-digital-out-4-bricklet/raw/master/software/examples/matlab/matlab_example_simple.m>`__

.. literalinclude:: IndustrialDigitalOut4_Bricklet_MATLAB_matlab_example_simple.m
 :language: matlab
 :linenos:
 :tab-width: 4

Simple (Octave)
^^^^^^^^^^^^^^^

`Download (octave_example_simple.m) <https://github.com/Tinkerforge/industrial-digital-out-4-bricklet/raw/master/software/examples/matlab/octave_example_simple.m>`__

.. literalinclude:: IndustrialDigitalOut4_Bricklet_MATLAB_octave_example_simple.m
 :language: octave_fixed
 :linenos:
 :tab-width: 4

.. _industrial_digital_out_4_bricklet_matlab_api:

API
---

Generally, every method of the MATLAB bindings that returns a value can
throw a ``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 unplugs the
device). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Beside the ``TimeoutException`` there is also a ``NotConnectedException`` that
is thrown if a method needs to communicate with the device while the
IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple
return values and return by reference is not possible for primitive types, we
use small classes that only consist of member variables. The member variables
of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is
``com.tinkerforge.*``

All methods listed below are thread-safe.




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


.. matlab:function:: class BrickletIndustrialDigitalOut4(String uid, IPConnection ipcon)

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

 In MATLAB:

 .. code-block:: matlab

  import com.tinkerforge.BrickletIndustrialDigitalOut4;

  industrialDigitalOut4 = BrickletIndustrialDigitalOut4('YOUR_DEVICE_UID', ipcon);

 In Octave:

 .. code-block:: octave_fixed

  industrialDigitalOut4 = java_new("com.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_matlab_examples>`).


.. matlab:function:: public void BrickletIndustrialDigitalOut4::setValue(int valueMask)

 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 :matlab: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.
 
.. matlab:function:: public int BrickletIndustrialDigitalOut4::getValue()

 Returns the bitmask as set by :matlab:func:`setValue() <BrickletIndustrialDigitalOut4::setValue>`.
 
.. matlab:function:: public void BrickletIndustrialDigitalOut4::setSelectedValues(int selectionMask, int valueMask)

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

.. matlab:function:: public void BrickletIndustrialDigitalOut4::setMonoflop(int selectionMask, int valueMask, long time)

 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.
 
.. matlab:function:: public BrickletIndustrialDigitalOut4.Monoflop BrickletIndustrialDigitalOut4::getMonoflop(short pin)

 Returns (for the given pin) the current value and the time as set by
 :matlab: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.
 
 The returned object has the public member variables ``int value``, ``long time`` and ``long timeRemaining``.

.. matlab:function:: public void BrickletIndustrialDigitalOut4::setGroup(char[] group)

 Sets a group of Digital Out 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :matlab: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 :matlab:func:`setValue() <BrickletIndustrialDigitalOut4::setValue>` and control two Bricklets at the same time.
 
.. matlab:function:: public char[] BrickletIndustrialDigitalOut4::getGroup()

 Returns the group as set by :matlab:func:`setGroup() <BrickletIndustrialDigitalOut4::setGroup>`
 
.. matlab:function:: public short BrickletIndustrialDigitalOut4::getAvailableForGroup()

 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.
 
.. matlab:function:: public short[] BrickletIndustrialDigitalOut4::getAPIVersion()

 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.
 
.. matlab:function:: public boolean BrickletIndustrialDigitalOut4::getResponseExpected(short functionId)

 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
 :matlab: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 :matlab:func:`setResponseExpected() <BrickletIndustrialDigitalOut4::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. matlab:function:: public void BrickletIndustrialDigitalOut4::setResponseExpected(short functionId, boolean responseExpected)

 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.FUNCTION_SET_VALUE = 1
 * BrickletIndustrialDigitalOut4.FUNCTION_SET_MONOFLOP = 3
 * BrickletIndustrialDigitalOut4.FUNCTION_SET_GROUP = 5
 * BrickletIndustrialDigitalOut4.FUNCTION_SET_SELECTED_VALUES = 9
 
.. matlab:function:: public void BrickletIndustrialDigitalOut4::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. matlab:function:: public BrickletIndustrialDigitalOut4.Identity BrickletIndustrialDigitalOut4::getIdentity()

 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|
 
 The returned object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



.. _industrial_digital_out_4_bricklet_matlab_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done with "set" function of MATLAB. The
parameters consist of the IP Connection object, the callback name and the
callback function. For example, it looks like this in MATLAB:

.. code-block:: matlab

    function cb_example(e)
        fprintf('Parameter: %s\n', e.param);
    end

    set(device, 'ExampleCallback', @(h, e) cb_example(e));

Due to a difference in the Octave Java support the "set" function cannot be
used in Octave. The registration is done with "add*Callback" functions of the
device object. It looks like this in Octave:

.. code-block:: octave_fixed

    function cb_example(e)
        fprintf("Parameter: %s\n", e.param);
    end

    device.addExampleCallback(@cb_example);

It is possible to add several callbacks and to remove them with the
corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of
the structure ``e``, which is derived from the ``java.util.EventObject`` class.
The available callback names with corresponding structure fields 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.



.. matlab:member:: public callback BrickletIndustrialDigitalOut4.MonoflopDoneCallback

 :param selectionMask: int
 :param valueMask: int


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

 In MATLAB the ``set()`` function can be used to register a callback function
 to this callback.

 In Octave a callback function can be added to this callback using the
 ``addMonoflopDoneCallback()`` function. An added callback function can be removed with
 the ``removeMonoflopDoneCallback()`` function.



.. _industrial_digital_out_4_bricklet_matlab_constants:

Constants
^^^^^^^^^

.. matlab:member:: public static final int BrickletIndustrialDigitalOut4.DEVICE_IDENTIFIER

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

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

