..
 #############################################################
 # 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-c">Software</a> / C/C++ - Industrial Dual Analog In Bricklet

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

.. _industrial_dual_analog_in_bricklet_c:

C/C++ - 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:`C/C++ API bindings <api_bindings_c>` 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_c_install>` for the C/C++ API
bindings is part of their general description.

.. _industrial_dual_analog_in_bricklet_c_examples:


Examples
--------

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

.. _industrial_dual_analog_in_bricklet_c_api:

API
---

Every function of the C/C++ bindings returns an integer which describes an
error code. Data returned from the device, when a getter is called,
is handled via call by reference. These parameters are labeled with the
``ret_`` prefix.

Possible error codes are:

* E_OK = 0
* E_TIMEOUT = -1
* E_NO_STREAM_SOCKET = -2
* E_HOSTNAME_INVALID = -3
* E_NO_CONNECT = -4
* E_NO_THREAD = -5
* E_NOT_ADDED = -6 (unused since bindings version 2.0.0)
* E_ALREADY_CONNECTED = -7
* E_NOT_CONNECTED = -8
* E_INVALID_PARAMETER = -9
* E_NOT_SUPPORTED = -10
* E_UNKNOWN_ERROR_CODE = -11

as defined in :file:`ip_connection.h`.

All functions listed below are thread-safe.


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.



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


.. c:function:: void industrial_dual_analog_in_create(IndustrialDualAnalogIn *industrial_dual_analog_in, const char *uid, IPConnection *ipcon)

 Creates the device object ``industrial_dual_analog_in`` with the unique device ID ``uid`` and adds
 it to the IPConnection ``ipcon``:

 .. code-block:: c

    IndustrialDualAnalogIn industrial_dual_analog_in;
    industrial_dual_analog_in_create(&industrial_dual_analog_in, "YOUR_DEVICE_UID", &ipcon);

 This device object can be used after the IP connection has been connected
 (see examples :ref:`above <industrial_dual_analog_in_bricklet_c_examples>`).

.. c:function:: void industrial_dual_analog_in_destroy(IndustrialDualAnalogIn *industrial_dual_analog_in)

 Removes the device object ``industrial_dual_analog_in`` from its IPConnection and destroys it.
 The device object cannot be used anymore afterwards.


.. c:function:: int industrial_dual_analog_in_get_voltage(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, int32_t *ret_voltage)

 Returns the voltage for the given channel in mV.
 
 If you want to get the voltage periodically, it is recommended to use the
 callback :c:data:`INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE` and set the period with 
 :c:func:`industrial_dual_analog_in_set_voltage_callback_period`.
 


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

.. c:function:: int industrial_dual_analog_in_set_sample_rate(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t rate)

 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 defines are available for this function:
 
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
 
.. c:function:: int industrial_dual_analog_in_get_sample_rate(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t *ret_rate)

 Returns the sample rate as set by :c:func:`industrial_dual_analog_in_set_sample_rate`.
 
 The following defines are available for this function:
 
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_976_SPS = 0
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_488_SPS = 1
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_244_SPS = 2
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_122_SPS = 3
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_61_SPS = 4
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_4_SPS = 5
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_2_SPS = 6
 * INDUSTRIAL_DUAL_ANALOG_IN_SAMPLE_RATE_1_SPS = 7
 
.. c:function:: int industrial_dual_analog_in_set_calibration(IndustrialDualAnalogIn *industrial_dual_analog_in, int32_t offset[2], int32_t gain[2])

 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
 
.. c:function:: int industrial_dual_analog_in_get_calibration(IndustrialDualAnalogIn *industrial_dual_analog_in, int32_t ret_offset[2], int32_t ret_gain[2])

 Returns the calibration as set by :c:func:`industrial_dual_analog_in_set_calibration`.
 
.. c:function:: int industrial_dual_analog_in_get_adc_values(IndustrialDualAnalogIn *industrial_dual_analog_in, int32_t ret_value[2])

 Returns the ADC values as given by the MCP3911 IC. This function
 is needed for proper calibration, see :c:func:`industrial_dual_analog_in_set_calibration`.
 
.. c:function:: int industrial_dual_analog_in_get_api_version(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t ret_api_version[3])

 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.
 
.. c:function:: int industrial_dual_analog_in_get_response_expected(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t function_id, bool *ret_response_expected)

 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
 :c:func:`industrial_dual_analog_in_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 :c:func:`industrial_dual_analog_in_set_response_expected`
 for the list of function ID defines available for this function.
 
.. c:function:: int industrial_dual_analog_in_set_response_expected(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t function_id, bool response_expected)

 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 defines are available for this function:
 
 * INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
 * INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
 * INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_DEBOUNCE_PERIOD = 6
 * INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_SAMPLE_RATE = 8
 * INDUSTRIAL_DUAL_ANALOG_IN_FUNCTION_SET_CALIBRATION = 10
 
.. c:function:: int industrial_dual_analog_in_set_response_expected_all(IndustrialDualAnalogIn *industrial_dual_analog_in, bool response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. c:function:: int industrial_dual_analog_in_get_identity(IndustrialDualAnalogIn *industrial_dual_analog_in, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)

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


.. c:function:: void industrial_dual_analog_in_register_callback(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t id, void *callback, void *user_data)

 Registers a callback with ID ``id`` to the function ``callback``. The
 ``user_data`` will be given as a parameter of the callback.

 The available IDs with corresponding function signatures are listed
 :ref:`below <industrial_dual_analog_in_bricklet_c_callbacks>`.


.. c:function:: int industrial_dual_analog_in_set_voltage_callback_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, uint32_t period)

 Sets the period in ms with which the :c:data:`INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE` callback is triggered
 periodically for the given channel. A value of 0 turns the callback off.
 
 :c:data:`INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE` is only triggered if the voltage has changed since the
 last triggering.
 
 The default value is 0.
 
.. c:function:: int industrial_dual_analog_in_get_voltage_callback_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, uint32_t *ret_period)

 Returns the period as set by :c:func:`industrial_dual_analog_in_set_voltage_callback_period`.
 
.. c:function:: int industrial_dual_analog_in_set_voltage_callback_threshold(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, char option, int32_t min, int32_t max)

 Sets the thresholds for the :c:data:`INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_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 defines are available for this function:
 
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
 
.. c:function:: int industrial_dual_analog_in_get_voltage_callback_threshold(IndustrialDualAnalogIn *industrial_dual_analog_in, uint8_t channel, char *ret_option, int32_t *ret_min, int32_t *ret_max)

 Returns the threshold as set by :c:func:`industrial_dual_analog_in_set_voltage_callback_threshold`.
 
 The following defines are available for this function:
 
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OFF = 'x'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_OUTSIDE = 'o'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_INSIDE = 'i'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_SMALLER = '<'
 * INDUSTRIAL_DUAL_ANALOG_IN_THRESHOLD_OPTION_GREATER = '>'
 
.. c:function:: int industrial_dual_analog_in_set_debounce_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint32_t debounce)

 Sets the period in ms with which the threshold callback
 
 * :c:data:`INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED`
 
 is triggered, if the threshold
 
 * :c:func:`industrial_dual_analog_in_set_voltage_callback_threshold`
 
 keeps being reached.
 
 The default value is 100.
 
.. c:function:: int industrial_dual_analog_in_get_debounce_period(IndustrialDualAnalogIn *industrial_dual_analog_in, uint32_t *ret_debounce)

 Returns the debounce period as set by :c:func:`industrial_dual_analog_in_set_debounce_period`.
 


.. _industrial_dual_analog_in_bricklet_c_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive
time critical or recurring data from the device. The registration is done
with the :c:func:`industrial_dual_analog_in_register_callback` function. The parameters consist of
the device object, the callback ID, the callback function and optional
user data:

 .. code-block:: c

    void my_callback(int p, void *user_data) {
        printf("parameter: %d\n", p);
    }

    industrial_dual_analog_in_register_callback(&industrial_dual_analog_in, INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_EXAMPLE, (void *)my_callback, NULL);

The available constants with corresponding callback function signatures
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.

.. c:var:: INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE

 .. code-block:: c

  void callback(uint8_t channel, int32_t voltage, void *user_data)


 This callback is triggered periodically with the period that is set by
 :c:func:`industrial_dual_analog_in_set_voltage_callback_period`. The parameter is the voltage of the
 channel.
 
 :c:data:`INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE` is only triggered if the voltage has changed since the
 last triggering.
 
.. c:var:: INDUSTRIAL_DUAL_ANALOG_IN_CALLBACK_VOLTAGE_REACHED

 .. code-block:: c

  void callback(uint8_t channel, int32_t voltage, void *user_data)


 This callback is triggered when the threshold as set by
 :c:func:`industrial_dual_analog_in_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 :c:func:`industrial_dual_analog_in_set_debounce_period`.
 


.. _industrial_dual_analog_in_bricklet_c_constants:

Constants
^^^^^^^^^

.. c:var:: INDUSTRIAL_DUAL_ANALOG_IN_DEVICE_IDENTIFIER

 This constant is used to identify a Industrial Dual Analog In Bricklet.

 The :c:func:`industrial_dual_analog_in_get_identity` function and the :c:data:`IPCON_CALLBACK_ENUMERATE`
 callback of the IP Connection have a ``device_identifier`` parameter to specify
 the Brick's or Bricklet's type.

