..
 #############################################################
 # 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 - Piezo Buzzer Bricklet

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

.. _piezo_buzzer_bricklet_java:

Java - Piezo Buzzer Bricklet
============================

This is the description of the :ref:`Java API bindings <api_bindings_java>` for the :ref:`Piezo Buzzer Bricklet <piezo_buzzer_bricklet>`. General information and technical
specifications for the Piezo Buzzer Bricklet are summarized in its :ref:`hardware description
<piezo_buzzer_bricklet_description>`.

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

.. _piezo_buzzer_bricklet_java_examples:


Examples
--------

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

Beep
^^^^

`Download (ExampleBeep.java) <https://github.com/Tinkerforge/piezo-buzzer-bricklet/raw/master/software/examples/java/ExampleBeep.java>`__

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

Morse Code
^^^^^^^^^^

`Download (ExampleMorseCode.java) <https://github.com/Tinkerforge/piezo-buzzer-bricklet/raw/master/software/examples/java/ExampleMorseCode.java>`__

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

.. _piezo_buzzer_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 BrickletPiezoBuzzer(String uid, IPConnection ipcon)

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

 .. code-block:: java

  BrickletPiezoBuzzer piezoBuzzer = new BrickletPiezoBuzzer("YOUR_DEVICE_UID", ipcon);

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


.. java:function:: public void BrickletPiezoBuzzer::beep(long duration)

 Beeps with the duration in ms. For example: If you set a value of 1000,
 the piezo buzzer will beep for one second.
 
.. java:function:: public void BrickletPiezoBuzzer::morseCode(String morse)

 Sets morse code that will be played by the piezo buzzer. The morse code
 is given as a string consisting of "." (dot), "-" (minus) and " " (space)
 for *dits*, *dahs* and *pauses*. Every other character is ignored.
 
 For example: If you set the string "...---...", the piezo buzzer will beep
 nine times with the durations "short short short long long long short 
 short short".
 
 The maximum string size is 60.
 


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

.. java:function:: public short[] BrickletPiezoBuzzer::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 BrickletPiezoBuzzer::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() <BrickletPiezoBuzzer::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() <BrickletPiezoBuzzer::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletPiezoBuzzer::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:
 
 * BrickletPiezoBuzzer.FUNCTION_BEEP = 1
 * BrickletPiezoBuzzer.FUNCTION_MORSE_CODE = 2
 
.. java:function:: public void BrickletPiezoBuzzer::setResponseExpectedAll(boolean responseExpected)

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



.. _piezo_buzzer_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 BrickletPiezoBuzzer.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 BrickletPiezoBuzzer.BeepFinishedListener()

 This listener can be added with the ``addBeepFinishedListener()`` function.
 An added listener can be removed with the ``removeBeepFinishedListener()`` function.

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


  This listener is triggered if a beep set by :java:func:`beep() <BrickletPiezoBuzzer::beep>` is finished
  

.. java:function:: public class BrickletPiezoBuzzer.MorseCodeFinishedListener()

 This listener can be added with the ``addMorseCodeFinishedListener()`` function.
 An added listener can be removed with the ``removeMorseCodeFinishedListener()`` function.

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


  This listener is triggered if the playback of the morse code set by
  :java:func:`morseCode() <BrickletPiezoBuzzer::morseCode>` is finished.
  


.. _piezo_buzzer_bricklet_java_constants:

Constants
^^^^^^^^^

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

 This constant is used to identify a Piezo Buzzer Bricklet.

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

