..
 #############################################################
 # 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++ - AC Current Bricklet

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

.. _ac_current_bricklet_c:

C/C++ - AC Current 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:`AC Current Bricklet <ac_current_bricklet>`. General information and technical
specifications for the AC Current Bricklet are summarized in its :ref:`hardware description
<ac_current_bricklet_description>`.

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

.. _ac_current_bricklet_c_examples:


Examples
--------

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

.. _ac_current_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 ac_current_create(ACCurrent *ac_current, const char *uid, IPConnection *ipcon)

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

 .. code-block:: c

    ACCurrent ac_current;
    ac_current_create(&ac_current, "YOUR_DEVICE_UID", &ipcon);

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

.. c:function:: void ac_current_destroy(ACCurrent *ac_current)

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


.. c:function:: int ac_current_get_current(ACCurrent *ac_current, uint16_t *ret_current)

 TODO
 
 If you want to get the current periodically, it is recommended to use the
 callback :c:data:`AC_CURRENT_CALLBACK_CURRENT` and set the period with
 :c:func:`ac_current_set_current_callback_period`.
 
.. c:function:: int ac_current_set_configuration(ACCurrent *ac_current, uint8_t current_range)

 
.. c:function:: int ac_current_get_configuration(ACCurrent *ac_current, uint8_t *ret_current_range)

 


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

.. c:function:: int ac_current_get_analog_value(ACCurrent *ac_current, uint16_t *ret_value)

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 If you want the analog value periodically, it is recommended to use the
 callback :c:data:`AC_CURRENT_CALLBACK_ANALOG_VALUE` and set the period with
 :c:func:`ac_current_set_analog_value_callback_period`.
 
.. c:function:: int ac_current_set_moving_average(ACCurrent *ac_current, uint8_t average)

 Sets the length of a `moving averaging <http://en.wikipedia.org/wiki/Moving_average>`__
 for the moisture value.
 
 Setting the length to 1 will turn the averaging off. With less
 averaging, there is more noise on the data.
 
 The range for the averaging is 1-50.
 
 The default value is 50.
 
.. c:function:: int ac_current_get_moving_average(ACCurrent *ac_current, uint8_t *ret_average)

 Returns the length of the moving average as set by :c:func:`ac_current_set_moving_average`.
 
.. c:function:: int ac_current_get_api_version(ACCurrent *ac_current, 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 ac_current_get_response_expected(ACCurrent *ac_current, 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:`ac_current_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:`ac_current_set_response_expected`
 for the list of function ID defines available for this function.
 
.. c:function:: int ac_current_set_response_expected(ACCurrent *ac_current, 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:
 
 * AC_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 3
 * AC_CURRENT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
 * AC_CURRENT_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 7
 * AC_CURRENT_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
 * AC_CURRENT_FUNCTION_SET_DEBOUNCE_PERIOD = 11
 * AC_CURRENT_FUNCTION_SET_MOVING_AVERAGE = 13
 * AC_CURRENT_FUNCTION_SET_CONFIGURATION = 15
 
.. c:function:: int ac_current_set_response_expected_all(ACCurrent *ac_current, bool response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. c:function:: int ac_current_get_identity(ACCurrent *ac_current, 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 ac_current_register_callback(ACCurrent *ac_current, 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 <ac_current_bricklet_c_callbacks>`.


.. c:function:: int ac_current_set_current_callback_period(ACCurrent *ac_current, uint32_t period)

 Sets the period in ms with which the :c:data:`AC_CURRENT_CALLBACK_CURRENT` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :c:data:`AC_CURRENT_CALLBACK_CURRENT` is only triggered if the current has changed since the
 last triggering.
 
 The default value is 0.
 
.. c:function:: int ac_current_get_current_callback_period(ACCurrent *ac_current, uint32_t *ret_period)

 Returns the period as set by :c:func:`ac_current_set_current_callback_period`.
 
.. c:function:: int ac_current_set_analog_value_callback_period(ACCurrent *ac_current, uint32_t period)

 Sets the period in ms with which the :c:data:`AC_CURRENT_CALLBACK_ANALOG_VALUE` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :c:data:`AC_CURRENT_CALLBACK_ANALOG_VALUE` is only triggered if the analog value has changed since the
 last triggering.
 
 The default value is 0.
 
.. c:function:: int ac_current_get_analog_value_callback_period(ACCurrent *ac_current, uint32_t *ret_period)

 Returns the period as set by :c:func:`ac_current_set_analog_value_callback_period`.
 
.. c:function:: int ac_current_set_current_callback_threshold(ACCurrent *ac_current, char option, int16_t min, int16_t max)

 Sets the thresholds for the :c:data:`AC_CURRENT_CALLBACK_CURRENT_REACHED` callback.
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the current is *outside* the min and max values"
  "'i'",    "Callback is triggered when the current is *inside* the min and max values"
  "'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following defines are available for this function:
 
 * AC_CURRENT_THRESHOLD_OPTION_OFF = 'x'
 * AC_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
 * AC_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
 * AC_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
 * AC_CURRENT_THRESHOLD_OPTION_GREATER = '>'
 
.. c:function:: int ac_current_get_current_callback_threshold(ACCurrent *ac_current, char *ret_option, int16_t *ret_min, int16_t *ret_max)

 Returns the threshold as set by :c:func:`ac_current_set_current_callback_threshold`.
 
 The following defines are available for this function:
 
 * AC_CURRENT_THRESHOLD_OPTION_OFF = 'x'
 * AC_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
 * AC_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
 * AC_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
 * AC_CURRENT_THRESHOLD_OPTION_GREATER = '>'
 
.. c:function:: int ac_current_set_analog_value_callback_threshold(ACCurrent *ac_current, char option, uint16_t min, uint16_t max)

 Sets the thresholds for the :c:data:`AC_CURRENT_CALLBACK_ANALOG_VALUE_REACHED` callback.
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the analog value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following defines are available for this function:
 
 * AC_CURRENT_THRESHOLD_OPTION_OFF = 'x'
 * AC_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
 * AC_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
 * AC_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
 * AC_CURRENT_THRESHOLD_OPTION_GREATER = '>'
 
.. c:function:: int ac_current_get_analog_value_callback_threshold(ACCurrent *ac_current, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

 Returns the threshold as set by :c:func:`ac_current_set_analog_value_callback_threshold`.
 
 The following defines are available for this function:
 
 * AC_CURRENT_THRESHOLD_OPTION_OFF = 'x'
 * AC_CURRENT_THRESHOLD_OPTION_OUTSIDE = 'o'
 * AC_CURRENT_THRESHOLD_OPTION_INSIDE = 'i'
 * AC_CURRENT_THRESHOLD_OPTION_SMALLER = '<'
 * AC_CURRENT_THRESHOLD_OPTION_GREATER = '>'
 
.. c:function:: int ac_current_set_debounce_period(ACCurrent *ac_current, uint32_t debounce)

 Sets the period in ms with which the threshold callbacks
 
 * :c:data:`AC_CURRENT_CALLBACK_CURRENT_REACHED`,
 * :c:data:`AC_CURRENT_CALLBACK_ANALOG_VALUE_REACHED`
 
 are triggered, if the thresholds
 
 * :c:func:`ac_current_set_current_callback_threshold`,
 * :c:func:`ac_current_set_analog_value_callback_threshold`
 
 keep being reached.
 
 The default value is 100.
 
.. c:function:: int ac_current_get_debounce_period(ACCurrent *ac_current, uint32_t *ret_debounce)

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


.. _ac_current_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:`ac_current_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);
    }

    ac_current_register_callback(&ac_current, AC_CURRENT_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:: AC_CURRENT_CALLBACK_CURRENT

 .. code-block:: c

  void callback(uint16_t current, void *user_data)


 This callback is triggered periodically with the period that is set by
 :c:func:`ac_current_set_current_callback_period`. The parameter is the current of the
 sensor.
 
 :c:data:`AC_CURRENT_CALLBACK_CURRENT` is only triggered if the current has changed since the
 last triggering.
 
.. c:var:: AC_CURRENT_CALLBACK_ANALOG_VALUE

 .. code-block:: c

  void callback(uint16_t value, void *user_data)


 This callback is triggered periodically with the period that is set by
 :c:func:`ac_current_set_analog_value_callback_period`. The parameter is the analog value of the
 sensor.
 
 :c:data:`AC_CURRENT_CALLBACK_ANALOG_VALUE` is only triggered if the current has changed since the
 last triggering.
 
.. c:var:: AC_CURRENT_CALLBACK_CURRENT_REACHED

 .. code-block:: c

  void callback(uint16_t current, void *user_data)


 This callback is triggered when the threshold as set by
 :c:func:`ac_current_set_current_callback_threshold` is reached.
 The parameter is the current of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :c:func:`ac_current_set_debounce_period`.
 
.. c:var:: AC_CURRENT_CALLBACK_ANALOG_VALUE_REACHED

 .. code-block:: c

  void callback(uint16_t value, void *user_data)


 This callback is triggered when the threshold as set by
 :c:func:`ac_current_set_analog_value_callback_threshold` is reached.
 The parameter is the analog value of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :c:func:`ac_current_set_debounce_period`.
 


.. _ac_current_bricklet_c_constants:

Constants
^^^^^^^^^

.. c:var:: AC_CURRENT_DEVICE_IDENTIFIER

 This constant is used to identify a AC Current Bricklet.

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

