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

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-shell">Software</a> / Shell - Industrial Dual Analog In Bricklet

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

.. _industrial_dual_analog_in_bricklet_shell:

Shell - Industrial Dual Analog In Bricklet
==========================================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`Industrial Dual Analog In Bricklet <industrial_dual_analog_in_bricklet>`. General information and technical
specifications for the Industrial Dual Analog In Bricklet are summarized in its :ref:`hardware description
<industrial_dual_analog_in_bricklet_description>`.

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

.. _industrial_dual_analog_in_bricklet_shell_examples:


Examples
--------

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

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


The Bricklet has two input channel. Functions that are related
directly to a channel have a ``channel`` parameter to specify one of the two
channels. Valid values for the ``channel`` parameter are 0 and 1.


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-dual-analog-in-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 Dual Analog In 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 Dual Analog In Bricklet and exits


.. sh:function:: X Stinkerforge Pdispatch Nindustrial-dual-analog-in-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 Dual Analog In 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 Dual Analog In Bricklet and exits


.. sh:function:: X Stinkerforge Scall Pindustrial-dual-analog-in-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-dual-analog-in-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-dual-analog-in-bricklet <uid> get-voltage <channel> 

 :param <channel>: int

 :returns voltage: int

 Returns the voltage for the given channel in mV.
 
 If you want to get the voltage periodically, it is recommended to use the
 callback :sh:func:`voltage <industrial-dual-analog-in-bricklet voltage>` and set the period with 
 :sh:func:`set-voltage-callback-period <industrial-dual-analog-in-bricklet set-voltage-callback-period>`.
 


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

.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> set-sample-rate <rate> 

 :param <rate>: int (has symbols)

 :noreturn: no output

 Sets the sample rate. The sample rate can be between 1 sample per second
 and 976 samples per second. Decreasing the sample rate will also decrease the
 noise on the data.
 
 The following symbols are available for this function:
 
 * ``976-sps`` = 0, for <rate>
 * ``488-sps`` = 1, for <rate>
 * ``244-sps`` = 2, for <rate>
 * ``122-sps`` = 3, for <rate>
 * ``61-sps`` = 4, for <rate>
 * ``4-sps`` = 5, for <rate>
 * ``2-sps`` = 6, for <rate>
 * ``1-sps`` = 7, for <rate>
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> get-sample-rate  


 :returns rate: int (has symbols)

 Returns the sample rate as set by :sh:func:`set-sample-rate <industrial-dual-analog-in-bricklet set-sample-rate>`.
 
 The following symbols are available for this function:
 
 * ``976-sps`` = 0, for rate
 * ``488-sps`` = 1, for rate
 * ``244-sps`` = 2, for rate
 * ``122-sps`` = 3, for rate
 * ``61-sps`` = 4, for rate
 * ``4-sps`` = 5, for rate
 * ``2-sps`` = 6, for rate
 * ``1-sps`` = 7, for rate
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> set-calibration <offset> <gain> 

 :param <offset>: int,int
 :param <gain>: int,int

 :noreturn: no output

 Sets offset and gain of MCP3911 internal calibration registers.
 
 See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet
 is already factory calibrated by Tinkerforge. It should not be necessary
 for you to use this function
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> get-calibration  


 :returns offset: int,int
 :returns gain: int,int

 Returns the calibration as set by :sh:func:`set-calibration <industrial-dual-analog-in-bricklet set-calibration>`.
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> get-adc-values  


 :returns value: int,int

 Returns the ADC values as given by the MCP3911 IC. This function
 is needed for proper calibration, see :sh:func:`set-calibration <industrial-dual-analog-in-bricklet set-calibration>`.
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-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-dual-analog-in-bricklet <uid> set-voltage-callback-period <channel> <period> 

 :param <channel>: int
 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`voltage <industrial-dual-analog-in-bricklet voltage>` callback is triggered
 periodically for the given channel. A value of 0 turns the callback off.
 
 :sh:func:`voltage <industrial-dual-analog-in-bricklet voltage>` is only triggered if the voltage has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> get-voltage-callback-period <channel> 

 :param <channel>: int

 :returns period: int

 Returns the period as set by :sh:func:`set-voltage-callback-period <industrial-dual-analog-in-bricklet set-voltage-callback-period>`.
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> set-voltage-callback-threshold <channel> <option> <min> <max> 

 :param <channel>: int
 :param <option>: char (has symbols)
 :param <min>: int
 :param <max>: int

 :noreturn: no output

 Sets the thresholds for the :sh:func:`voltage-reached <industrial-dual-analog-in-bricklet voltage-reached>` callback for the given
 channel.
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the voltage is *outside* the min and max values"
  "'i'",    "Callback is triggered when the voltage is *inside* the min and max values"
  "'<'",    "Callback is triggered when the voltage is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the voltage is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following symbols are available for this function:
 
 * ``off`` = x, for <option>
 * ``outside`` = o, for <option>
 * ``inside`` = i, for <option>
 * ``smaller`` = <, for <option>
 * ``greater`` = >, for <option>
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> get-voltage-callback-threshold <channel> 

 :param <channel>: int

 :returns option: char (has symbols)
 :returns min: int
 :returns max: int

 Returns the threshold as set by :sh:func:`set-voltage-callback-threshold <industrial-dual-analog-in-bricklet set-voltage-callback-threshold>`.
 
 The following symbols are available for this function:
 
 * ``off`` = x, for option
 * ``outside`` = o, for option
 * ``inside`` = i, for option
 * ``smaller`` = <, for option
 * ``greater`` = >, for option
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> set-debounce-period <debounce> 

 :param <debounce>: int

 :noreturn: no output

 Sets the period in ms with which the threshold callback
 
 * :sh:func:`voltage-reached <industrial-dual-analog-in-bricklet voltage-reached>`
 
 is triggered, if the threshold
 
 * :sh:func:`set-voltage-callback-threshold <industrial-dual-analog-in-bricklet set-voltage-callback-threshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. sh:function:: tinkerforge call industrial-dual-analog-in-bricklet <uid> get-debounce-period  


 :returns debounce: int

 Returns the debounce period as set by :sh:func:`set-debounce-period <industrial-dual-analog-in-bricklet set-debounce-period>`.
 


.. _industrial_dual_analog_in_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    tinkerforge dispatch industrial-dual-analog-in-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-dual-analog-in-bricklet <uid> voltage

 :returns channel: int
 :returns voltage: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-voltage-callback-period <industrial-dual-analog-in-bricklet set-voltage-callback-period>`. The parameter is the voltage of the
 channel.
 
 :sh:func:`voltage <industrial-dual-analog-in-bricklet voltage>` is only triggered if the voltage has changed since the
 last triggering.
 
.. sh:function::  tinkerforge dispatch industrial-dual-analog-in-bricklet <uid> voltage-reached

 :returns channel: int
 :returns voltage: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-voltage-callback-threshold <industrial-dual-analog-in-bricklet set-voltage-callback-threshold>` is reached.
 The parameter is the voltage of the channel.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :sh:func:`set-debounce-period <industrial-dual-analog-in-bricklet set-debounce-period>`.
 


