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

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

.. _ac_current_bricklet_ruby:

Ruby - 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:`Ruby API bindings <api_bindings_ruby>` 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_ruby_install>` for the Ruby API
bindings is part of their general description.

.. _ac_current_bricklet_ruby_examples:


Examples
--------

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

.. _ac_current_bricklet_ruby_api:

API
---

All methods listed below are thread-safe.




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


.. rb:function:: BrickletACCurrent::new(uid, ipcon) -> ac_current

 :param uid: str
 :param ipcon: IPConnection

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

 .. code-block:: ruby

    ac_current = BrickletACCurrent.new 'YOUR_DEVICE_UID', ipcon

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


.. rb:function:: BrickletACCurrent#get_current -> int


 TODO
 
 If you want to get the current periodically, it is recommended to use the
 callback :rb:attr:`::CALLBACK_CURRENT <BrickletACCurrent::CALLBACK_CURRENT>` and set the period with
 :rb:func:`#set_current_callback_period <BrickletACCurrent#set_current_callback_period>`.
 
.. rb:function:: BrickletACCurrent#set_configuration(current_range) -> nil

 :param current_range: int

 
.. rb:function:: BrickletACCurrent#get_configuration -> int


 


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

.. rb:function:: BrickletACCurrent#get_analog_value -> int


 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 :rb:attr:`::CALLBACK_ANALOG_VALUE <BrickletACCurrent::CALLBACK_ANALOG_VALUE>` and set the period with
 :rb:func:`#set_analog_value_callback_period <BrickletACCurrent#set_analog_value_callback_period>`.
 
.. rb:function:: BrickletACCurrent#set_moving_average(average) -> nil

 :param average: int

 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.
 
.. rb:function:: BrickletACCurrent#get_moving_average -> int


 Returns the length of the moving average as set by :rb:func:`#set_moving_average <BrickletACCurrent#set_moving_average>`.
 
.. rb:function:: BrickletACCurrent#get_api_version -> [int, int, int]


 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.
 
.. rb:function:: BrickletACCurrent#get_response_expected(function_id) -> bool

 :param function_id: int

 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
 :rb:func:`#set_response_expected <BrickletACCurrent#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 :rb:func:`#set_response_expected <BrickletACCurrent#set_response_expected>`
 for the list of function ID constants available for this function.
 
.. rb:function:: BrickletACCurrent#set_response_expected(function_id, response_expected) -> nil

 :param function_id: int
 :param response_expected: bool

 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
 
.. rb:function:: BrickletACCurrent#set_response_expected_all(response_expected) -> nil

 :param response_expected: bool

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. rb:function:: BrickletACCurrent#get_identity -> [str, str, str, [int, int, int], [int, int, int], int]


 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|
 
 The returned array has the values ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. rb:function:: BrickletACCurrent#register_callback(id) { |param [, ...]| block } -> nil

 :param id: int

 Registers a callback with ID *id* to the given block. The available
 IDs with corresponding function signatures are listed
 :ref:`below <ac_current_bricklet_ruby_callbacks>`.


.. rb:function:: BrickletACCurrent#set_current_callback_period(period) -> nil

 :param period: int

 Sets the period in ms with which the :rb:attr:`::CALLBACK_CURRENT <BrickletACCurrent::CALLBACK_CURRENT>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :rb:attr:`::CALLBACK_CURRENT <BrickletACCurrent::CALLBACK_CURRENT>` is only triggered if the current has changed since the
 last triggering.
 
 The default value is 0.
 
.. rb:function:: BrickletACCurrent#get_current_callback_period -> int


 Returns the period as set by :rb:func:`#set_current_callback_period <BrickletACCurrent#set_current_callback_period>`.
 
.. rb:function:: BrickletACCurrent#set_analog_value_callback_period(period) -> nil

 :param period: int

 Sets the period in ms with which the :rb:attr:`::CALLBACK_ANALOG_VALUE <BrickletACCurrent::CALLBACK_ANALOG_VALUE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :rb:attr:`::CALLBACK_ANALOG_VALUE <BrickletACCurrent::CALLBACK_ANALOG_VALUE>` is only triggered if the analog value has changed since the
 last triggering.
 
 The default value is 0.
 
.. rb:function:: BrickletACCurrent#get_analog_value_callback_period -> int


 Returns the period as set by :rb:func:`#set_analog_value_callback_period <BrickletACCurrent#set_analog_value_callback_period>`.
 
.. rb:function:: BrickletACCurrent#set_current_callback_threshold(option, min, max) -> nil

 :param option: str
 :param min: int
 :param max: int

 Sets the thresholds for the :rb:attr:`::CALLBACK_CURRENT_REACHED <BrickletACCurrent::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 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 = '>'
 
.. rb:function:: BrickletACCurrent#get_current_callback_threshold -> [str, int, int]


 Returns the threshold as set by :rb:func:`#set_current_callback_threshold <BrickletACCurrent#set_current_callback_threshold>`.
 
 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 = '>'
 
 The returned array has the values ``option``, ``min`` and ``max``.

.. rb:function:: BrickletACCurrent#set_analog_value_callback_threshold(option, min, max) -> nil

 :param option: str
 :param min: int
 :param max: int

 Sets the thresholds for the :rb:attr:`::CALLBACK_ANALOG_VALUE_REACHED <BrickletACCurrent::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 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 = '>'
 
.. rb:function:: BrickletACCurrent#get_analog_value_callback_threshold -> [str, int, int]


 Returns the threshold as set by :rb:func:`#set_analog_value_callback_threshold <BrickletACCurrent#set_analog_value_callback_threshold>`.
 
 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 = '>'
 
 The returned array has the values ``option``, ``min`` and ``max``.

.. rb:function:: BrickletACCurrent#set_debounce_period(debounce) -> nil

 :param debounce: int

 Sets the period in ms with which the threshold callbacks
 
 * :rb:attr:`::CALLBACK_CURRENT_REACHED <BrickletACCurrent::CALLBACK_CURRENT_REACHED>`,
 * :rb:attr:`::CALLBACK_ANALOG_VALUE_REACHED <BrickletACCurrent::CALLBACK_ANALOG_VALUE_REACHED>`
 
 are triggered, if the thresholds
 
 * :rb:func:`#set_current_callback_threshold <BrickletACCurrent#set_current_callback_threshold>`,
 * :rb:func:`#set_analog_value_callback_threshold <BrickletACCurrent#set_analog_value_callback_threshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. rb:function:: BrickletACCurrent#get_debounce_period -> int


 Returns the debounce period as set by :rb:func:`#set_debounce_period <BrickletACCurrent#set_debounce_period>`.
 


.. _ac_current_bricklet_ruby_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done with the
:rb:func:`#register_callback <BrickletACCurrent#register_callback>` function of
the device object. The first parameter is the callback ID and the second
parameter is a block:

.. code-block:: ruby

    ac_current.register_callback BrickletACCurrent::CALLBACK_EXAMPLE, do |param|
      puts "#{param}"
    end

The available constants with inherent number and type of parameters 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.

.. rb:attribute:: BrickletACCurrent::CALLBACK_CURRENT

 :param current: int


 This callback is triggered periodically with the period that is set by
 :rb:func:`#set_current_callback_period <BrickletACCurrent#set_current_callback_period>`. The parameter is the current of the
 sensor.
 
 :rb:attr:`::CALLBACK_CURRENT <BrickletACCurrent::CALLBACK_CURRENT>` is only triggered if the current has changed since the
 last triggering.
 
.. rb:attribute:: BrickletACCurrent::CALLBACK_ANALOG_VALUE

 :param value: int


 This callback is triggered periodically with the period that is set by
 :rb:func:`#set_analog_value_callback_period <BrickletACCurrent#set_analog_value_callback_period>`. The parameter is the analog value of the
 sensor.
 
 :rb:attr:`::CALLBACK_ANALOG_VALUE <BrickletACCurrent::CALLBACK_ANALOG_VALUE>` is only triggered if the current has changed since the
 last triggering.
 
.. rb:attribute:: BrickletACCurrent::CALLBACK_CURRENT_REACHED

 :param current: int


 This callback is triggered when the threshold as set by
 :rb:func:`#set_current_callback_threshold <BrickletACCurrent#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 :rb:func:`#set_debounce_period <BrickletACCurrent#set_debounce_period>`.
 
.. rb:attribute:: BrickletACCurrent::CALLBACK_ANALOG_VALUE_REACHED

 :param value: int


 This callback is triggered when the threshold as set by
 :rb:func:`#set_analog_value_callback_threshold <BrickletACCurrent#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 :rb:func:`#set_debounce_period <BrickletACCurrent#set_debounce_period>`.
 


.. _ac_current_bricklet_ruby_constants:

Constants
^^^^^^^^^

.. rb:attribute:: BrickletACCurrent::DEVICE_IDENTIFIER

 This constant is used to identify a AC Current Bricklet.

 The :rb:func:`#get_identity() <BrickletACCurrent#get_identity>` function and the
 :rb:attr:`::CALLBACK_ENUMERATE <IPConnection::CALLBACK_ENUMERATE>`
 callback of the IP Connection have a ``device_identifier`` parameter to specify
 the Brick's or Bricklet's type.

