..
 #############################################################
 # 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-javascript">Software</a> / JavaScript - Industrial Digital In 4 Bricklet

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

.. _industrial_digital_in_4_bricklet_javascript:

JavaScript - Industrial Digital In 4 Bricklet
=============================================

This is the description of the :ref:`JavaScript API bindings <api_bindings_javascript>` for the :ref:`Industrial Digital In 4 Bricklet <industrial_digital_in_4_bricklet>`. General information and technical
specifications for the Industrial Digital In 4 Bricklet are summarized in its :ref:`hardware description
<industrial_digital_in_4_bricklet_description>`.

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

.. _industrial_digital_in_4_bricklet_javascript_examples:


Examples
--------

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

Simple (Node.js)
^^^^^^^^^^^^^^^^

`Download (ExampleSimple.js) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/javascript/ExampleSimple.js>`__

.. literalinclude:: IndustrialDigitalIn4_Bricklet_JavaScript_ExampleSimple.js
 :language: javascript
 :linenos:
 :tab-width: 4

Interrupt (Node.js)
^^^^^^^^^^^^^^^^^^^

`Download (ExampleInterrupt.js) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/javascript/ExampleInterrupt.js>`__

.. literalinclude:: IndustrialDigitalIn4_Bricklet_JavaScript_ExampleInterrupt.js
 :language: javascript
 :linenos:
 :tab-width: 4

Simple (HTML)
^^^^^^^^^^^^^

`Download (ExampleSimple.html) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/javascript/ExampleSimple.html>`__, `Test (ExampleSimple.html) <http://www.tinkerforge.com/en/doc/Software/Examples/JavaScript/IndustrialDigitalIn4_Bricklet_JavaScript_ExampleSimple.html>`__

.. literalinclude:: IndustrialDigitalIn4_Bricklet_JavaScript_ExampleSimple.html
 :language: html
 :linenos:
 :tab-width: 4

Interrupt (HTML)
^^^^^^^^^^^^^^^^

`Download (ExampleInterrupt.html) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/javascript/ExampleInterrupt.html>`__, `Test (ExampleInterrupt.html) <http://www.tinkerforge.com/en/doc/Software/Examples/JavaScript/IndustrialDigitalIn4_Bricklet_JavaScript_ExampleInterrupt.html>`__

.. literalinclude:: IndustrialDigitalIn4_Bricklet_JavaScript_ExampleInterrupt.html
 :language: html
 :linenos:
 :tab-width: 4

.. _industrial_digital_in_4_bricklet_javascript_api:

API
---

Generally, every method of the JavaScript bindings can take two optional
parameters, ``returnCallback`` and ``errorCallback``. These are two user
defined callback functions. The ``returnCallback`` is called with the return
values as parameters, if the method returns something. The ``errorCallback``
is called with an error code in case of an error. The error code can be one
of the following values:

* IPConnection.ERROR_ALREADY_CONNECTED = 11
* IPConnection.ERROR_NOT_CONNECTED = 12
* IPConnection.ERROR_CONNECT_FAILED = 13
* IPConnection.ERROR_INVALID_FUNCTION_ID = 21
* IPConnection.ERROR_TIMEOUT = 31
* IPConnection.ERROR_INVALID_PARAMETER = 41
* IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
* IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is ``Tinkerforge.*``.




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


.. javascript:function:: new BrickletIndustrialDigitalIn4(uid, ipcon)

 :param uid: string
 :param ipcon: IPConnection

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

 .. code-block:: javascript

    var industrialDigitalIn4 = new BrickletIndustrialDigitalIn4("YOUR_DEVICE_UID", ipcon);

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


.. javascript:function:: BrickletIndustrialDigitalIn4.getValue([returnCallback], [errorCallback])


 :return valueMask: int

 Returns the input value with a bitmask. The bitmask is 16bit long, *true*
 refers to high and *false* refers to low.
 
 For example: The value 3 or 0b0011 means that pins 0-1 are high and the other
 pins are low.
 
 If no groups are used (see :javascript:func:`setGroup() <BrickletIndustrialDigitalIn4.setGroup>`), the pins correspond to the
 markings on the Digital In 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.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getEdgeCount(pin, resetCounter, [returnCallback], [errorCallback])

 :param pin: int
 :param resetCounter: boolean

 :return count: int

 Returns the current value of the edge counter for the selected pin. You can
 configure the edges that are counted with :javascript:func:`setEdgeCountConfig() <BrickletIndustrialDigitalIn4.setEdgeCountConfig>`.
 
 If you set the reset counter to *true*, the count is set back to 0
 directly after it is read.
 
 .. versionadded:: 2.0.1~(Plugin)
 


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

.. javascript:function:: BrickletIndustrialDigitalIn4.setGroup(group, [returnCallback], [errorCallback])

 :param group: [char, char, char, char]

 :noreturn: undefined

 Sets a group of Digital In 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :javascript:func:`getAvailableForGroup() <BrickletIndustrialDigitalIn4.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 In 4 Bricklets connected to port A and
 port B respectively, you could call with ``['a', 'b', 'n', 'n']``.
 
 Now the pins on the Digital In 4 on port A are assigned to 0-3 and the
 pins on the Digital In 4 on port B are assigned to 4-7. It is now possible
 to call :javascript:func:`getValue() <BrickletIndustrialDigitalIn4.getValue>` and read out two Bricklets at the same time.
 
 Changing the group configuration resets all edge counter configurations
 and values.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getGroup([returnCallback], [errorCallback])


 :return group: [char, char, char, char]

 Returns the group as set by :javascript:func:`setGroup() <BrickletIndustrialDigitalIn4.setGroup>`
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getAvailableForGroup([returnCallback], [errorCallback])


 :return available: 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.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.setEdgeCountConfig(selectionMask, edgeType, debounce, [returnCallback], [errorCallback])

 :param selectionMask: int
 :param edgeType: int
 :param debounce: int

 :noreturn: undefined

 Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will
 enable the edge counter for pins 0 and 3.
 
 The edge type parameter configures if rising edges, falling edges or
 both are counted if the pin is configured for input. Possible edge types are:
 
 * 0 = rising (default)
 * 1 = falling
 * 2 = both
 
 The debounce time is given in ms.
 
 Configuring an edge counter resets its value to 0.
 
 If you don't know what any of this means, just leave it at default. The
 default configuration is very likely OK for you.
 
 Default values: 0 (edge type) and 100ms (debounce time)
 
 The following constants are available for this function:
 
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getEdgeCountConfig(pin, [returnCallback], [errorCallback])

 :param pin: int

 :return edgeType: int
 :return debounce: int

 Returns the edge type and debounce time for the selected pin as set by
 :javascript:func:`setEdgeCountConfig() <BrickletIndustrialDigitalIn4.setEdgeCountConfig>`.
 
 The following constants are available for this function:
 
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
 * BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getAPIVersion()

 :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.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getResponseExpected(functionId, [errorCallback])

 :param functionId: int
 :rtype: boolean

 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
 :javascript:func:`setResponseExpected() <BrickletIndustrialDigitalIn4.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 :javascript:func:`setResponseExpected() <BrickletIndustrialDigitalIn4.setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.setResponseExpected(functionId, responseExpected, [errorCallback])

 :param functionId: int
 :param responseExpected: boolean

 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:
 
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_GROUP = 2
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_INTERRUPT = 7
 * BrickletIndustrialDigitalIn4.FUNCTION_SET_EDGE_COUNT_CONFIG = 11
 
.. javascript:function:: BrickletIndustrialDigitalIn4.setResponseExpectedAll(responseExpected)

 :param responseExpected: boolean

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getIdentity([returnCallback], [errorCallback])


 :return uid: string
 :return connectedUid: string
 :return position: char
 :return hardwareVersion: [int, int, int]
 :return firmwareVersion: [int, int, int]
 :return deviceIdentifier: 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|
 


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


.. javascript:function:: BrickletIndustrialDigitalIn4.on(id, callback)

 :param id: int
 :param callback: function

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


.. javascript:function:: BrickletIndustrialDigitalIn4.setDebouncePeriod(debounce, [returnCallback], [errorCallback])

 :param debounce: int

 :noreturn: undefined

 Sets the debounce period of the :javascript:attr:`CALLBACK_INTERRUPT <BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT>` callback in ms.
 
 For example: If you set this value to 100, you will get the interrupt
 maximal every 100ms. This is necessary if something that bounces is
 connected to the Digital In 4 Bricklet, such as a button.
 
 The default value is 100.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getDebouncePeriod([returnCallback], [errorCallback])


 :return debounce: int

 Returns the debounce period as set by :javascript:func:`setDebouncePeriod() <BrickletIndustrialDigitalIn4.setDebouncePeriod>`.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.setInterrupt(interruptMask, [returnCallback], [errorCallback])

 :param interruptMask: int

 :noreturn: undefined

 Sets the pins on which an interrupt is activated with a bitmask.
 Interrupts are triggered on changes of the voltage level of the pin,
 i.e. changes from high to low and low to high.
 
 For example: An interrupt bitmask of 9 or 0b1001 will enable the interrupt for
 pins 0 and 3.
 
 The interrupts use the grouping as set by :javascript:func:`setGroup() <BrickletIndustrialDigitalIn4.setGroup>`.
 
 The interrupt is delivered with the callback :javascript:attr:`CALLBACK_INTERRUPT <BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT>`.
 
.. javascript:function:: BrickletIndustrialDigitalIn4.getInterrupt([returnCallback], [errorCallback])


 :return interruptMask: int

 Returns the interrupt bitmask as set by :javascript:func:`setInterrupt() <BrickletIndustrialDigitalIn4.setInterrupt>`.
 


.. _industrial_digital_in_4_bricklet_javascript_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: javascript

    industrialDigitalIn4.on(BrickletIndustrialDigitalIn4.CALLBACK_EXAMPLE,
        function (param) {
            console.log(param);
        }
    );

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.

.. javascript:attribute:: BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT

 :param interruptMask: int
 :param valueMask: int


 This callback is triggered whenever a change of the voltage level is detected
 on pins where the interrupt was activated with :javascript:func:`setInterrupt() <BrickletIndustrialDigitalIn4.setInterrupt>`.
 
 The values are a bitmask that specifies which interrupts occurred
 and the current value bitmask.
 
 For example:
 
 * (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and
   currently pin 0 is high and pins 1-3 are low.
 * (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3
   occurred and currently pin 0 is low and pins 1-3 are high.
 


.. _industrial_digital_in_4_bricklet_javascript_constants:

Constants
^^^^^^^^^

.. javascript:attribute:: BrickletIndustrialDigitalIn4.DEVICE_IDENTIFIER

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

 The :javascript:func:`getIdentity() <BrickletIndustrialDigitalIn4.getIdentity>` function and the
 :javascript: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.

