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


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-java">Software</a> / Java - Industrial Dual 0-20mA Bricklet

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

.. _industrial_dual_0_20ma_bricklet_java:

Java - Industrial Dual 0-20mA Bricklet
======================================

This is the description of the :ref:`Java API bindings <api_bindings_java>` for the :ref:`Industrial Dual 0-20mA Bricklet <industrial_dual_0_20ma_bricklet>`. General information and technical
specifications for the Industrial Dual 0-20mA Bricklet are summarized in its :ref:`hardware description
<industrial_dual_0_20ma_bricklet_description>`.

An :ref:`installation guide <api_bindings_java_install>` for the Java API
bindings is part of their general description.

.. _industrial_dual_0_20ma_bricklet_java_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.java) <https://github.com/Tinkerforge/industrial-dual-0-20ma-bricklet/raw/master/software/examples/java/ExampleSimple.java>`__

.. literalinclude:: IndustrialDual020mA_Bricklet_Java_ExampleSimple.java
 :language: java
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.java) <https://github.com/Tinkerforge/industrial-dual-0-20ma-bricklet/raw/master/software/examples/java/ExampleCallback.java>`__

.. literalinclude:: IndustrialDual020mA_Bricklet_Java_ExampleCallback.java
 :language: java
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (ExampleThreshold.java) <https://github.com/Tinkerforge/industrial-dual-0-20ma-bricklet/raw/master/software/examples/java/ExampleThreshold.java>`__

.. literalinclude:: IndustrialDual020mA_Bricklet_Java_ExampleThreshold.java
 :language: java
 :linenos:
 :tab-width: 4

.. _industrial_dual_0_20ma_bricklet_java_api:

API
---

Generally, every method of the Java bindings that returns a value can
throw a ``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 unplugs the
device). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Beside the ``TimeoutException`` there is also a ``NotConnectedException`` that
is thrown if a method needs to communicate with the device while the
IP Connection is not connected.

Since Java does not support multiple return values and return by reference
is not possible for primitive types, we use small classes that
only consist of member variables. The member variables of the returned objects
are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is
``com.tinkerforge.*``

All methods listed below are thread-safe.


Two sensors can be connected to the Bricklet. Functions that are related
directly to a sensor have a ``sensor`` parameter to specify one of the two
sensors. Valid values for the ``sensor`` parameter are 0 and 1.



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


.. java:function:: class BrickletIndustrialDual020mA(String uid, IPConnection ipcon)

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

 .. code-block:: java

  BrickletIndustrialDual020mA industrialDual020mA = new BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon);

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


.. java:function:: public int BrickletIndustrialDual020mA::getCurrent(short sensor)

 Returns the current of the specified sensor (0 or 1). The value is in nA
 and between 0nA and 22505322nA (22.5mA).
 
 It is possible to detect if an IEC 60381-1 compatible sensor is connected
 and if it works probably.
 
 If the returned current is below 4mA, there is likely no sensor connected
 or the sensor may be defect. If the returned current is over 20mA, there might
 be a short circuit or the sensor may be defect.
 
 If you want to get the current periodically, it is recommended to use the
 listener :java:func:`CurrentListener <BrickletIndustrialDual020mA.CurrentListener>` and set the period with 
 :java:func:`setCurrentCallbackPeriod() <BrickletIndustrialDual020mA::setCurrentCallbackPeriod>`.
 


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

.. java:function:: public void BrickletIndustrialDual020mA::setSampleRate(short rate)

 Sets the sample rate to either 240, 60, 15 or 4 samples per second.
 The resolution for the rates is 12, 14, 16 and 18 bit respectively.
 
 .. csv-table::
  :header: "Value", "Description"
  :widths: 10, 100
 
  "0",    "240 samples per second, 12 bit resolution"
  "1",    "60 samples per second, 14 bit resolution"
  "2",    "15 samples per second, 16 bit resolution"
  "3",    "4 samples per second, 18 bit resolution"
 
 The default value is 3: 4 samples per second with 18 bit resolution.
 
 The following constants are available for this function:
 
 * BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
 * BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
 * BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
 * BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3
 
.. java:function:: public short BrickletIndustrialDual020mA::getSampleRate()

 Returns the sample rate as set by :java:func:`setSampleRate() <BrickletIndustrialDual020mA::setSampleRate>`.
 
 The following constants are available for this function:
 
 * BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
 * BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
 * BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
 * BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3
 
.. java:function:: public short[] BrickletIndustrialDual020mA::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.
 
.. java:function:: public boolean BrickletIndustrialDual020mA::getResponseExpected(short 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 listener configuration
 functions it is enabled by default too, but can be disabled by
 :java:func:`setResponseExpected() <BrickletIndustrialDual020mA::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 :java:func:`setResponseExpected() <BrickletIndustrialDual020mA::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletIndustrialDual020mA::setResponseExpected(short functionId, boolean 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 listener configuration functions (default value: *true*). For
 getter functions it is always enabled and listeners 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:
 
 * BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
 * BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
 * BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
 * BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8
 
.. java:function:: public void BrickletIndustrialDual020mA::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and listener configuration
 functions of this device at once.
 
.. java:function:: public BrickletIndustrialDual020mA.Identity BrickletIndustrialDual020mA::getIdentity()

 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 object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



Listener Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:function:: public void BrickletIndustrialDual020mA::setCurrentCallbackPeriod(short sensor, long period)

 Sets the period in ms with which the :java:func:`CurrentListener <BrickletIndustrialDual020mA.CurrentListener>` listener is triggered
 periodically for the given sensor. A value of 0 turns the listener off.
 
 :java:func:`CurrentListener <BrickletIndustrialDual020mA.CurrentListener>` is only triggered if the current has changed since the
 last triggering.
 
 The default value is 0.
 
.. java:function:: public long BrickletIndustrialDual020mA::getCurrentCallbackPeriod(short sensor)

 Returns the period as set by :java:func:`setCurrentCallbackPeriod() <BrickletIndustrialDual020mA::setCurrentCallbackPeriod>`.
 
.. java:function:: public void BrickletIndustrialDual020mA::setCurrentCallbackThreshold(short sensor, char option, int min, int max)

 Sets the thresholds for the :java:func:`CurrentReachedListener <BrickletIndustrialDual020mA.CurrentReachedListener>` listener for the given
 sensor.
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Listener is turned off"
  "'o'",    "Listener is triggered when the current is *outside* the min and max values"
  "'i'",    "Listener is triggered when the current is *inside* the min and max values"
  "'<'",    "Listener is triggered when the current is smaller than the min value (max is ignored)"
  "'>'",    "Listener 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:
 
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_OFF = 'x'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_GREATER = '>'
 
.. java:function:: public BrickletIndustrialDual020mA.CurrentCallbackThreshold BrickletIndustrialDual020mA::getCurrentCallbackThreshold(short sensor)

 Returns the threshold as set by :java:func:`setCurrentCallbackThreshold() <BrickletIndustrialDual020mA::setCurrentCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_OFF = 'x'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletIndustrialDual020mA.THRESHOLD_OPTION_GREATER = '>'
 
 The returned object has the public member variables ``char option``, ``int min`` and ``int max``.

.. java:function:: public void BrickletIndustrialDual020mA::setDebouncePeriod(long debounce)

 Sets the period in ms with which the threshold listener
 
 * :java:func:`CurrentReachedListener <BrickletIndustrialDual020mA.CurrentReachedListener>`
 
 is triggered, if the threshold
 
 * :java:func:`setCurrentCallbackThreshold() <BrickletIndustrialDual020mA::setCurrentCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. java:function:: public long BrickletIndustrialDual020mA::getDebouncePeriod()

 Returns the debounce period as set by :java:func:`setDebouncePeriod() <BrickletIndustrialDual020mA::setDebouncePeriod>`.
 


.. _industrial_dual_0_20ma_bricklet_java_callbacks:

Listeners
^^^^^^^^^

Listeners can be registered to receive
time critical or recurring data from the device. The registration is done
with "add*Listener" functions of the device object.

The parameter is a listener class object, for example:

.. code-block:: java

    device.addExampleListener(new BrickletIndustrialDual020mA.ExampleListener() {
        public void property(int value) {
            System.out.println("Value: " + value);
        }
    });

The available listener classes with inherent methods to be overwritten
are described below. It is possible to add several listeners and
to remove them with the corresponding "remove*Listener" function.

.. note::
 Using listeners 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.


.. java:function:: public class BrickletIndustrialDual020mA.CurrentListener()

 This listener can be added with the ``addCurrentListener()`` function.
 An added listener can be removed with the ``removeCurrentListener()`` function.

 .. java:function:: public void current(short sensor, int current)
  :noindex:


  This listener is triggered periodically with the period that is set by
  :java:func:`setCurrentCallbackPeriod() <BrickletIndustrialDual020mA::setCurrentCallbackPeriod>`. The parameter is the current of the
  sensor.
  
  :java:func:`CurrentListener <BrickletIndustrialDual020mA.CurrentListener>` is only triggered if the current has changed since the
  last triggering.
  

.. java:function:: public class BrickletIndustrialDual020mA.CurrentReachedListener()

 This listener can be added with the ``addCurrentReachedListener()`` function.
 An added listener can be removed with the ``removeCurrentReachedListener()`` function.

 .. java:function:: public void currentReached(short sensor, int current)
  :noindex:


  This listener is triggered when the threshold as set by
  :java:func:`setCurrentCallbackThreshold() <BrickletIndustrialDual020mA::setCurrentCallbackThreshold>` is reached.
  The parameter is the current of the sensor.
  
  If the threshold keeps being reached, the listener is triggered periodically
  with the period as set by :java:func:`setDebouncePeriod() <BrickletIndustrialDual020mA::setDebouncePeriod>`.
  


.. _industrial_dual_0_20ma_bricklet_java_constants:

Constants
^^^^^^^^^

.. java:member:: public static final int BrickletIndustrialDual020mA.DEVICE_IDENTIFIER

 This constant is used to identify a Industrial Dual 0-20mA Bricklet.

 The :java:func:`getIdentity() <BrickletIndustrialDual020mA::getIdentity>` function and the
 :java:func:`EnumerateListener <IPConnection.EnumerateListener>`
 listener of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

