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

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _industrial_digital_in_4_bricklet_shell:

Shell - Industrial Digital In 4 Bricklet
========================================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` 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_shell_install>` for the Shell API
bindings is part of their general description.

.. _industrial_digital_in_4_bricklet_shell_examples:


Examples
--------

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

Simple
^^^^^^

`Download (example-simple.sh) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

.. literalinclude:: IndustrialDigitalIn4_Bricklet_Shell_example-simple.sh
 :language: bash
 :linenos:
 :tab-width: 4

Interrupt
^^^^^^^^^

`Download (example-interrupt.sh) <https://github.com/Tinkerforge/industrial-digital-in-4-bricklet/raw/master/software/examples/shell/example-interrupt.sh>`__

.. literalinclude:: IndustrialDigitalIn4_Bricklet_Shell_example-interrupt.sh
 :language: bash
 :linenos:
 :tab-width: 4

.. _industrial_digital_in_4_bricklet_shell_api:

API
---

Possible exit codes for all ``tinkerforge`` commands are:

* 1: interrupted (ctrl+c)
* 2: syntax error
* 21: Python 2.5 or newer is required
* 22: Python ``argparse`` module is missing
* 23: socket error
* 24: other exception
* 25: invalid placeholder in format string
* 26: authentication error
* 201: timeout occurred
* 209: invalid argument value
* 210: function is not supported
* 211: unknown error



Command Structure
^^^^^^^^^^^^^^^^^

The common options of the ``call`` and ``dispatch`` commands are documented
:ref:`here <ipcon_shell_api>`. The specific command structure is shown below.

.. sh:function:: X Stinkerforge Pcall Nindustrial-digital-in-4-bricklet A[<option>..] L<uid> L<function> L[<argument>..]

 :param <uid>: string
 :param <function>: string

 The ``call`` command is used to call a function of the Industrial Digital In 4 Bricklet. It can take several
 options:

 * ``--help`` shows help for the specific ``call`` command and exits
 * ``--list-functions`` shows a list of known functions of the Industrial Digital In 4 Bricklet and exits


.. sh:function:: X Stinkerforge Pdispatch Nindustrial-digital-in-4-bricklet A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <callback>: string

 The ``dispatch`` command is used to dispatch a callback of the Industrial Digital In 4 Bricklet. It can
 take several options:

 * ``--help`` shows help for the specific ``dispatch`` command and exits
 * ``--list-callbacks`` shows a list of known callbacks of the Industrial Digital In 4 Bricklet and exits


.. sh:function:: X Stinkerforge Scall Pindustrial-digital-in-4-bricklet L<uid> N<function> A[<option>..] L[<argument>..]

 :param <uid>: string
 :param <function>: string

 The ``<function>`` to be called can take different options depending of its
 kind. All functions can take the following options:

 * ``--help`` shows help for the specific function and exits

 Getter functions can take the following options:

 * ``--execute <command>`` shell command line to execute for each incoming
   response (see section about :ref:`output formatting <ipcon_shell_output>`
   for details)

 Setter functions can take the following options:

 * ``--expect-response`` requests response and waits for it

 The ``--expect-response`` option for setter functions allows to detect
 timeouts and other error conditions calls of setters as well. The device will
 then send a response for this purpose. If this option is not given for a
 setter function then no response is send and errors are silently ignored,
 because they cannot be detected.


.. sh:function:: X Stinkerforge Sdispatch Pindustrial-digital-in-4-bricklet L<uid> N<callback> A[<option>..]

 :param <uid>: string
 :param <callback>: string

 The ``<callback>`` to be dispatched can take several options:

 * ``--help`` shows help for the specific callback and exits
 * ``--execute <command>`` shell command line to execute for each incoming
   response (see section about :ref:`output formatting <ipcon_shell_output>`
   for details)



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



.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-value  


 :returns value-mask: 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 :sh:func:`set-group <industrial-digital-in-4-bricklet set-group>`), 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.
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-edge-count <pin> <reset-counter> 

 :param <pin>: int
 :param <reset-counter>: bool

 :returns count: int

 Returns the current value of the edge counter for the selected pin. You can
 configure the edges that are counted with :sh:func:`set-edge-count-config <industrial-digital-in-4-bricklet set-edge-count-config>`.
 
 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
^^^^^^^^^^^^^^^^^^

.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> set-group <group> 

 :param <group>: char,char,char,char

 :noreturn: no output

 Sets a group of Digital In 4 Bricklets that should work together. You can
 find Bricklets that can be grouped together with :sh:func:`get-available-for-group <industrial-digital-in-4-bricklet 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 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 :sh:func:`get-value <industrial-digital-in-4-bricklet get-value>` and read out two Bricklets at the same time.
 
 Changing the group configuration resets all edge counter configurations
 and values.
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-group  


 :returns group: char,char,char,char

 Returns the group as set by :sh:func:`set-group <industrial-digital-in-4-bricklet set-group>`
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-available-for-group  


 :returns 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.
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> set-edge-count-config <selection-mask> <edge-type> <debounce> 

 :param <selection-mask>: int
 :param <edge-type>: int (has symbols)
 :param <debounce>: int

 :noreturn: no output

 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 symbols are available for this function:
 
 * ``rising`` = 0, for <edge-type>
 * ``falling`` = 1, for <edge-type>
 * ``both`` = 2, for <edge-type>
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-edge-count-config <pin> 

 :param <pin>: int

 :returns edge-type: int (has symbols)
 :returns debounce: int

 Returns the edge type and debounce time for the selected pin as set by
 :sh:func:`set-edge-count-config <industrial-digital-in-4-bricklet set-edge-count-config>`.
 
 The following symbols are available for this function:
 
 * ``rising`` = 0, for edge-type
 * ``falling`` = 1, for edge-type
 * ``both`` = 2, for edge-type
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-identity  


 :returns uid: string
 :returns connected-uid: string
 :returns position: char
 :returns hardware-version: int,int,int
 :returns firmware-version: int,int,int
 :returns device-identifier: int (has symbols)

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



.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> set-debounce-period <debounce> 

 :param <debounce>: int

 :noreturn: no output

 Sets the debounce period of the :sh:func:`interrupt <industrial-digital-in-4-bricklet 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.
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-debounce-period  


 :returns debounce: int

 Returns the debounce period as set by :sh:func:`set-debounce-period <industrial-digital-in-4-bricklet set-debounce-period>`.
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> set-interrupt <interrupt-mask> 

 :param <interrupt-mask>: int

 :noreturn: no output

 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 :sh:func:`set-group <industrial-digital-in-4-bricklet set-group>`.
 
 The interrupt is delivered with the callback :sh:func:`interrupt <industrial-digital-in-4-bricklet interrupt>`.
 
.. sh:function:: tinkerforge call industrial-digital-in-4-bricklet <uid> get-interrupt  


 :returns interrupt-mask: int

 Returns the interrupt bitmask as set by :sh:func:`set-interrupt <industrial-digital-in-4-bricklet set-interrupt>`.
 


.. _industrial_digital_in_4_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be used to receive time critical or recurring data from the
device:

.. code-block:: bash

    tinkerforge dispatch industrial-digital-in-4-bricklet <uid> example

The available callbacks 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.

.. sh:function::  tinkerforge dispatch industrial-digital-in-4-bricklet <uid> interrupt

 :returns interrupt-mask: int
 :returns value-mask: int


 This callback is triggered whenever a change of the voltage level is detected
 on pins where the interrupt was activated with :sh:func:`set-interrupt <industrial-digital-in-4-bricklet set-interrupt>`.
 
 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.
 


