..
 #############################################################
 # 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-perl">Software</a> / Perl - Industrial Digital Out 4 Bricklet

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

.. _industrial_digital_out_4_bricklet_perl:

Perl - Industrial Digital Out 4 Bricklet
========================================

This is the description of the :ref:`Perl API bindings <api_bindings_perl>` 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_perl_install>` for the Perl API
bindings is part of their general description.

.. _industrial_digital_out_4_bricklet_perl_examples:


Examples
--------

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

Simple
^^^^^^

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

.. literalinclude:: IndustrialDigitalOut4_Bricklet_Perl_example_simple.pl
 :language: perl
 :linenos:
 :tab-width: 4

.. _industrial_digital_out_4_bricklet_perl_api:

API
---

Generally, every subroutine of the Perl bindings can report an error as
``Tinkerforge::Error`` object via ``croak()``. The object has a
``get_code()`` and a ``get_message()`` subroutine. There are different
error code:

* Error->ALREADY_CONNECTED = 11
* Error->NOT_CONNECTED = 12
* Error->CONNECT_FAILED = 13
* Error->INVALID_FUNCTION_ID = 21
* Error->TIMEOUT = 31
* Error->INVALID_PARAMETER = 41
* Error->FUNCTION_NOT_SUPPORTED = 42
* Error->UNKNOWN_ERROR = 43

All methods listed below are thread-safe.




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


.. perl:function:: BrickletIndustrialDigitalOut4->new($uid, $ipcon)

 :param $uid: string
 :param $ipcon: IPConnection
 :rtype: BrickletIndustrialDigitalOut4

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

 .. code-block:: perl

    $industrial_digital_out_4 = BrickletIndustrialDigitalOut4->new("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_perl_examples>`).


.. perl:function:: BrickletIndustrialDigitalOut4->set_value($value_mask)

 :param $value_mask: int
 :rtype: undef

 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 :perl:func:`set_group() <BrickletIndustrialDigitalOut4->set_group>`), 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.
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_value()

 :rtype: int

 Returns the bitmask as set by :perl:func:`set_value() <BrickletIndustrialDigitalOut4->set_value>`.
 
.. perl:function:: BrickletIndustrialDigitalOut4->set_selected_values($selection_mask, $value_mask)

 :param $selection_mask: int
 :param $value_mask: int
 :rtype: undef

 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 :perl:func:`set_group() <BrickletIndustrialDigitalOut4->set_group>`), 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
^^^^^^^^^^^^^^^^^^

.. perl:function:: BrickletIndustrialDigitalOut4->set_monoflop($selection_mask, $value_mask, $time)

 :param $selection_mask: int
 :param $value_mask: int
 :param $time: int
 :rtype: undef

 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.
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_monoflop($pin)

 :param $pin: int
 :rtype: [int, int, int]

 Returns (for the given pin) the current value and the time as set by
 :perl:func:`set_monoflop() <BrickletIndustrialDigitalOut4->set_monoflop>` 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 array contains the elements ``value``, ``time`` and ``time_remaining``.

.. perl:function:: BrickletIndustrialDigitalOut4->set_group(@group)

 :param @group: [char, char, char, char]
 :rtype: undef

 Sets a group of Digital Out 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :perl:func:`get_available_for_group() <BrickletIndustrialDigitalOut4->get_available_for_group>`.
 
 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 :perl:func:`set_value() <BrickletIndustrialDigitalOut4->set_value>` and control two Bricklets at the same time.
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_group()

 :rtype: [char, char, char, char]

 Returns the group as set by :perl:func:`set_group() <BrickletIndustrialDigitalOut4->set_group>`
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_available_for_group()

 :rtype: int

 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.
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_api_version()

 :rtype: [int, int, int]

 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.
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_response_expected($function_id)

 :param $function_id: int
 :rtype: bool

 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
 :perl:func:`set_response_expected() <BrickletIndustrialDigitalOut4->set_response_expected>`. 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 :perl:func:`set_response_expected() <BrickletIndustrialDigitalOut4->set_response_expected>`
 for the list of function ID constants available for this function.
 
.. perl:function:: BrickletIndustrialDigitalOut4->set_response_expected($function_id, $response_expected)

 :param $function_id: int
 :param $response_expected: bool
 :rtype: undef

 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
 
.. perl:function:: BrickletIndustrialDigitalOut4->set_response_expected_all($response_expected)

 :param $response_expected: bool
 :rtype: undef

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. perl:function:: BrickletIndustrialDigitalOut4->get_identity()

 :rtype: [string, string, char, [int, int, int], [int, int, int], int]

 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 array contains the elements ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. perl:function:: BrickletIndustrialDigitalOut4->register_callback($id, $callback)

 :param $id: int
 :param $callback: string
 :rtype: undef

 Registers a callback with ID ``$id`` to the function named ``$callback``. The
 available IDs with corresponding function signatures are listed
 :ref:`below <industrial_digital_out_4_bricklet_perl_callbacks>`.




.. _industrial_digital_out_4_bricklet_perl_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive
time critical or recurring data from the device. The registration is done
with the :perl:func:`register_callback() <BrickletIndustrialDigitalOut4->register_callback>` function of
the device object. The first parameter is the callback ID and the second
parameter the callback function name:

.. code-block:: perl

    sub my_callback
    {
        print "@_[0]";
    }

    $industrial_digital_out_4->register_callback(BrickletIndustrialDigitalOut4->CALLBACK_EXAMPLE, 'my_callback')

The callback function will be called from an internal thread of the
IP Connection. In contrast to many other programming languages, variables are
not automatically shared between threads in Perl. If you want to share a global
variable between a callback function and the rest for your program it has to be
marked as ``:shared``. See the documentation of the `threads::shared
<http://perldoc.perl.org/threads/shared.html>`__ Perl module for more details.

The available constants with inherent number and 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.

.. perl:attribute:: BrickletIndustrialDigitalOut4->CALLBACK_MONOFLOP_DONE

 :param $selection_mask: int
 :param $value_mask: 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).
 


.. _industrial_digital_out_4_bricklet_perl_constants:

Constants
^^^^^^^^^

.. perl:attribute:: BrickletIndustrialDigitalOut4->DEVICE_IDENTIFIER

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

 The :perl:func:`get_identity() <BrickletIndustrialDigitalOut4->get_identity>` function and the
 :perl:attr:`CALLBACK_ENUMERATE <IPConnection.CALLBACK_ENUMERATE>`
 callback of the IP Connection have a ``device_identifier`` parameter to specify
 the Brick's or Bricklet's type.

