..
 #############################################################
 # 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 Analog Out Bricklet

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

.. _industrial_analog_out_bricklet_c:

C/C++ - Industrial Analog Out 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 Analog Out Bricklet <industrial_analog_out_bricklet>`. General information and technical
specifications for the Industrial Analog Out Bricklet are summarized in its :ref:`hardware description
<industrial_analog_out_bricklet_description>`.

An :ref:`installation guide <api_bindings_c_install>` for the C/C++ API
bindings is part of their general description.

.. _industrial_analog_out_bricklet_c_examples:


Examples
--------

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

Simple Current
^^^^^^^^^^^^^^

`Download (example_simple_current.c) <https://github.com/Tinkerforge/industrial-analog-out-bricklet/raw/master/software/examples/c/example_simple_current.c>`__

.. literalinclude:: IndustrialAnalogOut_Bricklet_C_example_simple_current.c
 :language: c
 :linenos:
 :tab-width: 4

Simple Voltage
^^^^^^^^^^^^^^

`Download (example_simple_voltage.c) <https://github.com/Tinkerforge/industrial-analog-out-bricklet/raw/master/software/examples/c/example_simple_voltage.c>`__

.. literalinclude:: IndustrialAnalogOut_Bricklet_C_example_simple_voltage.c
 :language: c
 :linenos:
 :tab-width: 4

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




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


.. c:function:: void industrial_analog_out_create(IndustrialAnalogOut *industrial_analog_out, const char *uid, IPConnection *ipcon)

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

 .. code-block:: c

    IndustrialAnalogOut industrial_analog_out;
    industrial_analog_out_create(&industrial_analog_out, "YOUR_DEVICE_UID", &ipcon);

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

.. c:function:: void industrial_analog_out_destroy(IndustrialAnalogOut *industrial_analog_out)

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


.. c:function:: int industrial_analog_out_enable(IndustrialAnalogOut *industrial_analog_out)

 Enables the output of voltage and current.
 
 The default is disabled.
 
.. c:function:: int industrial_analog_out_disable(IndustrialAnalogOut *industrial_analog_out)

 Disables the output of voltage and current.
 
 The default is disabled.
 
.. c:function:: int industrial_analog_out_is_enabled(IndustrialAnalogOut *industrial_analog_out, bool *ret_enabled)

 Returns *true* if output of voltage and current is enabled, *false* otherwise.
 
.. c:function:: int industrial_analog_out_set_voltage(IndustrialAnalogOut *industrial_analog_out, uint16_t voltage)

 Sets the output voltage in mV.
 
.. c:function:: int industrial_analog_out_get_voltage(IndustrialAnalogOut *industrial_analog_out, uint16_t *ret_voltage)

 Returns the voltage as set by :c:func:`industrial_analog_out_set_voltage`.
 
.. c:function:: int industrial_analog_out_set_current(IndustrialAnalogOut *industrial_analog_out, uint16_t current)

 Sets the output current in µA.
 
.. c:function:: int industrial_analog_out_get_current(IndustrialAnalogOut *industrial_analog_out, uint16_t *ret_current)

 Returns the current as set by :c:func:`industrial_analog_out_set_current`.
 


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

.. c:function:: int industrial_analog_out_set_configuration(IndustrialAnalogOut *industrial_analog_out, uint8_t voltage_range, uint8_t current_range)

 Configures the voltage and current range.
 
 Possible voltage ranges are:
 
 * 0V to 5V
 * 0V to 10V
 
 Possible current ranges are:
 
 * 4mA to 20mA
 * 0mA to 20mA
 * 0mA to 24mA
 
 The resolution will always be 12 bit. This means, that the
 precision is higher with a smaller range.
 
 The following defines are available for this function:
 
 * INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
 * INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1
 * INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_4_TO_20MA = 0
 * INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_20MA = 1
 * INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_24MA = 2
 
.. c:function:: int industrial_analog_out_get_configuration(IndustrialAnalogOut *industrial_analog_out, uint8_t *ret_voltage_range, uint8_t *ret_current_range)

 Returns the configuration as set by :c:func:`industrial_analog_out_set_configuration`.
 
 The following defines are available for this function:
 
 * INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
 * INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1
 * INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_4_TO_20MA = 0
 * INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_20MA = 1
 * INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_24MA = 2
 
.. c:function:: int industrial_analog_out_get_api_version(IndustrialAnalogOut *industrial_analog_out, 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_analog_out_get_response_expected(IndustrialAnalogOut *industrial_analog_out, 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_analog_out_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_analog_out_set_response_expected`
 for the list of function ID defines available for this function.
 
.. c:function:: int industrial_analog_out_set_response_expected(IndustrialAnalogOut *industrial_analog_out, 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_ANALOG_OUT_FUNCTION_ENABLE = 1
 * INDUSTRIAL_ANALOG_OUT_FUNCTION_DISABLE = 2
 * INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_VOLTAGE = 4
 * INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CURRENT = 6
 * INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CONFIGURATION = 8
 
.. c:function:: int industrial_analog_out_set_response_expected_all(IndustrialAnalogOut *industrial_analog_out, bool response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. c:function:: int industrial_analog_out_get_identity(IndustrialAnalogOut *industrial_analog_out, 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|
 


.. _industrial_analog_out_bricklet_c_constants:

Constants
^^^^^^^^^

.. c:var:: INDUSTRIAL_ANALOG_OUT_DEVICE_IDENTIFIER

 This constant is used to identify a Industrial Analog Out Bricklet.

 The :c:func:`industrial_analog_out_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.

