..
 #############################################################
 # 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 - Segment Display 4x7 Bricklet

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

.. _segment_display_4x7_bricklet_java:

Java - Segment Display 4x7 Bricklet
===================================

This is the description of the :ref:`Java API bindings <api_bindings_java>` for the :ref:`Segment Display 4x7 Bricklet <segment_display_4x7_bricklet>`. General information and technical
specifications for the Segment Display 4x7 Bricklet are summarized in its :ref:`hardware description
<segment_display_4x7_bricklet_description>`.

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

.. _segment_display_4x7_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/segment-display-4x7-bricklet/raw/master/software/examples/java/ExampleSimple.java>`__

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

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




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


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

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

 .. code-block:: java

  BrickletSegmentDisplay4x7 segmentDisplay4x7 = new BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon);

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


.. java:function:: public void BrickletSegmentDisplay4x7::setSegments(short[] segments, short brightness, boolean colon)

 The 7-segment display can be set with bitmaps. Every bit controls one
 segment:
 
 .. image:: /Images/Bricklets/bricklet_segment_display_4x7_bit_order.png
    :scale: 100 %
    :alt: Bit order of one segment
    :align: center
 
 For example to set a "5" you would want to activate segments 0, 2, 3, 5 and 6.
 This is represented by the number 0b01101101 = 0x6d = 109.
 
 The brightness can be set between 0 (dark) and 7 (bright). The colon
 parameter turns the colon of the display on or off.
 
.. java:function:: public BrickletSegmentDisplay4x7.Segments BrickletSegmentDisplay4x7::getSegments()

 Returns the segment, brightness and color data as set by 
 :java:func:`setSegments() <BrickletSegmentDisplay4x7::setSegments>`.
 
 The returned object has the public member variables ``short[] segments``, ``short brightness`` and ``boolean colon``.



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

.. java:function:: public void BrickletSegmentDisplay4x7::startCounter(short valueFrom, short valueTo, short increment, long length)

 Starts a counter with the *from* value that counts to the *to*
 value with the each step incremented by *increment*.
 The *length* of the increment is given in ms.
 
 Example: If you set *from* to 0, *to* to 100, *increment* to 1 and
 *length* to 1000, a counter that goes from 0 to 100 with one second
 pause between each increment will be started.
 
 The maximum values for *from*, *to* and *increment* is 9999, 
 the minimum value is -999.
 
 Using a negative increment allows to count backwards.
 
 You can stop the counter at every time by calling :java:func:`setSegments() <BrickletSegmentDisplay4x7::setSegments>`.
 
.. java:function:: public int BrickletSegmentDisplay4x7::getCounterValue()

 Returns the counter value that is currently shown on the display.
 
 If there is no counter running a 0 will be returned.
 
.. java:function:: public short[] BrickletSegmentDisplay4x7::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 BrickletSegmentDisplay4x7::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() <BrickletSegmentDisplay4x7::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() <BrickletSegmentDisplay4x7::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletSegmentDisplay4x7::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:
 
 * BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
 * BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
 
.. java:function:: public void BrickletSegmentDisplay4x7::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and listener configuration
 functions of this device at once.
 
.. java:function:: public BrickletSegmentDisplay4x7.Identity BrickletSegmentDisplay4x7::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``.



.. _segment_display_4x7_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 BrickletSegmentDisplay4x7.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 BrickletSegmentDisplay4x7.CounterFinishedListener()

 This listener can be added with the ``addCounterFinishedListener()`` function.
 An added listener can be removed with the ``removeCounterFinishedListener()`` function.

 .. java:function:: public void counterFinished()
  :noindex:


  This listener is triggered when the counter (see :java:func:`startCounter() <BrickletSegmentDisplay4x7::startCounter>`) is
  finished.
  


.. _segment_display_4x7_bricklet_java_constants:

Constants
^^^^^^^^^

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

 This constant is used to identify a Segment Display 4x7 Bricklet.

 The :java:func:`getIdentity() <BrickletSegmentDisplay4x7::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.

