..
 #############################################################
 # 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-csharp">Software</a> / C# - AC Current Bricklet

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

.. _ac_current_bricklet_csharp:

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# API bindings <api_bindings_csharp>` 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_csharp_install>` for the C# API
bindings is part of their general description.

.. _ac_current_bricklet_csharp_examples:


Examples
--------

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

.. _ac_current_bricklet_csharp_api:

API
---

Generally, every method of the C# bindings that returns a value can
throw a ``Tinkerforge.TimeoutException``. This exception gets thrown if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody plugs the
device out). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the ``out``
keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is
``Tinkerforge.*``.

All methods listed below are thread-safe.




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


.. csharp:function:: class BrickletACCurrent(String uid, IPConnection ipcon)

 Creates an object with the unique device ID ``uid``:

 .. code-block:: csharp

  BrickletACCurrent acCurrent = new BrickletACCurrent("YOUR_DEVICE_UID", ipcon);

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <ac_current_bricklet_csharp_examples>`).


.. csharp:function:: public int BrickletACCurrent::GetCurrent()

 TODO
 
 If you want to get the current periodically, it is recommended to use the
 callback :csharp:func:`Current <BrickletACCurrent::Current>` and set the period with
 :csharp:func:`SetCurrentCallbackPeriod() <BrickletACCurrent::SetCurrentCallbackPeriod>`.
 
.. csharp:function:: public void BrickletACCurrent::SetConfiguration(byte currentRange)

 
.. csharp:function:: public byte BrickletACCurrent::GetConfiguration()

 


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

.. csharp:function:: public int BrickletACCurrent::GetAnalogValue()

 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 :csharp:func:`AnalogValue <BrickletACCurrent::AnalogValue>` and set the period with
 :csharp:func:`SetAnalogValueCallbackPeriod() <BrickletACCurrent::SetAnalogValueCallbackPeriod>`.
 
.. csharp:function:: public void BrickletACCurrent::SetMovingAverage(byte 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.
 
.. csharp:function:: public byte BrickletACCurrent::GetMovingAverage()

 Returns the length of the moving average as set by :csharp:func:`SetMovingAverage() <BrickletACCurrent::SetMovingAverage>`.
 
.. csharp:function:: public byte[] BrickletACCurrent::GetAPIVersion()

 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.
 
.. csharp:function:: public bool BrickletACCurrent::GetResponseExpected(byte functionId)

 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
 :csharp:func:`SetResponseExpected() <BrickletACCurrent::SetResponseExpected>`. 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 :csharp:func:`SetResponseExpected() <BrickletACCurrent::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletACCurrent::SetResponseExpected(byte functionId, bool responseExpected)

 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 constants are available for this function:
 
 * BrickletACCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 3
 * BrickletACCurrent.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
 * BrickletACCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 7
 * BrickletACCurrent.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
 * BrickletACCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 11
 * BrickletACCurrent.FUNCTION_SET_MOVING_AVERAGE = 13
 * BrickletACCurrent.FUNCTION_SET_CONFIGURATION = 15
 
.. csharp:function:: public void BrickletACCurrent::SetResponseExpectedAll(bool responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. csharp:function:: public void BrickletACCurrent::GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

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



.. csharp:function:: public void BrickletACCurrent::SetCurrentCallbackPeriod(long period)

 Sets the period in ms with which the :csharp:func:`Current <BrickletACCurrent::Current>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :csharp:func:`Current <BrickletACCurrent::Current>` is only triggered if the current has changed since the
 last triggering.
 
 The default value is 0.
 
.. csharp:function:: public long BrickletACCurrent::GetCurrentCallbackPeriod()

 Returns the period as set by :csharp:func:`SetCurrentCallbackPeriod() <BrickletACCurrent::SetCurrentCallbackPeriod>`.
 
.. csharp:function:: public void BrickletACCurrent::SetAnalogValueCallbackPeriod(long period)

 Sets the period in ms with which the :csharp:func:`AnalogValue <BrickletACCurrent::AnalogValue>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :csharp:func:`AnalogValue <BrickletACCurrent::AnalogValue>` is only triggered if the analog value has changed since the
 last triggering.
 
 The default value is 0.
 
.. csharp:function:: public long BrickletACCurrent::GetAnalogValueCallbackPeriod()

 Returns the period as set by :csharp:func:`SetAnalogValueCallbackPeriod() <BrickletACCurrent::SetAnalogValueCallbackPeriod>`.
 
.. csharp:function:: public void BrickletACCurrent::SetCurrentCallbackThreshold(char option, short min, short max)

 Sets the thresholds for the :csharp:func:`CurrentReached <BrickletACCurrent::CurrentReached>` 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 constants are available for this function:
 
 * BrickletACCurrent.THRESHOLD_OPTION_OFF = 'x'
 * BrickletACCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletACCurrent.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletACCurrent.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletACCurrent.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletACCurrent::GetCurrentCallbackThreshold(out char option, out short min, out short max)

 Returns the threshold as set by :csharp:func:`SetCurrentCallbackThreshold() <BrickletACCurrent::SetCurrentCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletACCurrent.THRESHOLD_OPTION_OFF = 'x'
 * BrickletACCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletACCurrent.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletACCurrent.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletACCurrent.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletACCurrent::SetAnalogValueCallbackThreshold(char option, int min, int max)

 Sets the thresholds for the :csharp:func:`AnalogValueReached <BrickletACCurrent::AnalogValueReached>` 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 constants are available for this function:
 
 * BrickletACCurrent.THRESHOLD_OPTION_OFF = 'x'
 * BrickletACCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletACCurrent.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletACCurrent.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletACCurrent.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletACCurrent::GetAnalogValueCallbackThreshold(out char option, out int min, out int max)

 Returns the threshold as set by :csharp:func:`SetAnalogValueCallbackThreshold() <BrickletACCurrent::SetAnalogValueCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletACCurrent.THRESHOLD_OPTION_OFF = 'x'
 * BrickletACCurrent.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletACCurrent.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletACCurrent.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletACCurrent.THRESHOLD_OPTION_GREATER = '>'
 
.. csharp:function:: public void BrickletACCurrent::SetDebouncePeriod(long debounce)

 Sets the period in ms with which the threshold callbacks
 
 * :csharp:func:`CurrentReached <BrickletACCurrent::CurrentReached>`,
 * :csharp:func:`AnalogValueReached <BrickletACCurrent::AnalogValueReached>`
 
 are triggered, if the thresholds
 
 * :csharp:func:`SetCurrentCallbackThreshold() <BrickletACCurrent::SetCurrentCallbackThreshold>`,
 * :csharp:func:`SetAnalogValueCallbackThreshold() <BrickletACCurrent::SetAnalogValueCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. csharp:function:: public long BrickletACCurrent::GetDebouncePeriod()

 Returns the debounce period as set by :csharp:func:`SetDebouncePeriod() <BrickletACCurrent::SetDebouncePeriod>`.
 


.. _ac_current_bricklet_csharp_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by appending your callback handler to
the corresponding event:

.. code-block:: csharp

    void Callback(BrickletACCurrent sender, int value)
    {
        System.Console.WriteLine("Value: " + value);
    }

    acCurrent.ExampleCallback += Callback;

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


.. csharp:function:: public event BrickletACCurrent::Current(BrickletACCurrent sender, int current)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetCurrentCallbackPeriod() <BrickletACCurrent::SetCurrentCallbackPeriod>`. The parameter is the current of the
  sensor.
  
  :csharp:func:`Current <BrickletACCurrent::Current>` is only triggered if the current has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletACCurrent::AnalogValue(BrickletACCurrent sender, int value)


  This callback is triggered periodically with the period that is set by
  :csharp:func:`SetAnalogValueCallbackPeriod() <BrickletACCurrent::SetAnalogValueCallbackPeriod>`. The parameter is the analog value of the
  sensor.
  
  :csharp:func:`AnalogValue <BrickletACCurrent::AnalogValue>` is only triggered if the current has changed since the
  last triggering.
  

.. csharp:function:: public event BrickletACCurrent::CurrentReached(BrickletACCurrent sender, int current)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetCurrentCallbackThreshold() <BrickletACCurrent::SetCurrentCallbackThreshold>` 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 :csharp:func:`SetDebouncePeriod() <BrickletACCurrent::SetDebouncePeriod>`.
  

.. csharp:function:: public event BrickletACCurrent::AnalogValueReached(BrickletACCurrent sender, int value)


  This callback is triggered when the threshold as set by
  :csharp:func:`SetAnalogValueCallbackThreshold() <BrickletACCurrent::SetAnalogValueCallbackThreshold>` 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 :csharp:func:`SetDebouncePeriod() <BrickletACCurrent::SetDebouncePeriod>`.
  


.. _ac_current_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletACCurrent::DEVICE_IDENTIFIER

 This constant is used to identify a AC Current Bricklet.

 The :csharp:func:`GetIdentity() <BrickletACCurrent::GetIdentity>` function and the
 :csharp:func:`EnumerateCallback <IPConnection::EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

