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

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

.. _barometer_bricklet_java:

Java - Barometer Bricklet
=========================

This is the description of the :ref:`Java API bindings <api_bindings_java>` for the :ref:`Barometer Bricklet <barometer_bricklet>`. General information and technical
specifications for the Barometer Bricklet are summarized in its :ref:`hardware description
<barometer_bricklet_description>`.

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

.. _barometer_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/barometer-bricklet/raw/master/software/examples/java/ExampleSimple.java>`__

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

Threshold
^^^^^^^^^

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

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

Callback
^^^^^^^^

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

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

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

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

 .. code-block:: java

  BrickletBarometer barometer = new BrickletBarometer("YOUR_DEVICE_UID", ipcon);

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


.. java:function:: public int BrickletBarometer::getAirPressure()

 Returns the air pressure of the air pressure sensor. The value
 has a range of 10000 to 1200000 and is given in mbar/1000, i.e. a value
 of 1001092 means that an air pressure of 1001.092 mbar is measured.
 
 If you want to get the air pressure periodically, it is recommended to use the
 listener :java:func:`AirPressureListener <BrickletBarometer.AirPressureListener>` and set the period with
 :java:func:`setAirPressureCallbackPeriod() <BrickletBarometer::setAirPressureCallbackPeriod>`.
 
.. java:function:: public int BrickletBarometer::getAltitude()

 Returns the relative altitude of the air pressure sensor. The value is given in
 cm and is calculated based on the difference between the current air pressure
 and the reference air pressure that can be set with :java:func:`setReferenceAirPressure() <BrickletBarometer::setReferenceAirPressure>`.
 
 If you want to get the altitude periodically, it is recommended to use the
 listener :java:func:`AltitudeListener <BrickletBarometer.AltitudeListener>` and set the period with
 :java:func:`setAltitudeCallbackPeriod() <BrickletBarometer::setAltitudeCallbackPeriod>`.
 
.. java:function:: public void BrickletBarometer::setReferenceAirPressure(int airPressure)

 Sets the reference air pressure in mbar/1000 for the altitude calculation.
 Setting the reference to the current air pressure results in a calculated
 altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as
 reference.
 
 Well known reference values are the Q codes
 `QNH <http://en.wikipedia.org/wiki/QNH>`__ and
 `QFE <http://en.wikipedia.org/wiki/Mean_sea_level_pressure#Mean_sea_level_pressure>`__
 used in aviation.
 
 The default value is 1013.25mbar.
 
.. java:function:: public int BrickletBarometer::getReferenceAirPressure()

 Returns the reference air pressure as set by :java:func:`setReferenceAirPressure() <BrickletBarometer::setReferenceAirPressure>`.
 


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

.. java:function:: public short BrickletBarometer::getChipTemperature()

 Returns the temperature of the air pressure sensor. The value
 has a range of -4000 to 8500 and is given in °C/100, i.e. a value
 of 2007 means that a temperature of 20.07 °C is measured.
 
 This temperature is used internally for temperature compensation of the air
 pressure measurement. It is not as accurate as the temperature measured by the
 :ref:`temperature_bricklet` or the :ref:`temperature_ir_bricklet`.
 
.. java:function:: public void BrickletBarometer::setAveraging(short movingAveragePressure, short averagePressure, short averageTemperature)

 Sets the different averaging parameters. It is possible to set
 the length of a normal averaging for the temperature and pressure,
 as well as an additional length of a 
 `moving average <http://en.wikipedia.org/wiki/Moving_average>`__ 
 for the pressure. The moving average is calculated from the normal 
 averages.  There is no moving average for the temperature.
 
 The maximum length for the pressure average is 10, for the
 temperature average is 255 and for the moving average is 25.
 
 Setting the all three parameters to 0 will turn the averaging
 completely off. If the averaging is off, there is lots of noise
 on the data, but the data is without delay. Thus we recommend
 to turn the averaging off if the Barometer Bricklet data is
 to be used for sensor fusion with other sensors.
 
 The default values are 10 for the normal averages and 25 for the
 moving average.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. java:function:: public BrickletBarometer.Averaging BrickletBarometer::getAveraging()

 Returns the averaging configuration as set by :java:func:`setAveraging() <BrickletBarometer::setAveraging>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
 The returned object has the public member variables ``short movingAveragePressure``, ``short averagePressure`` and ``short averageTemperature``.

.. java:function:: public short[] BrickletBarometer::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 BrickletBarometer::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() <BrickletBarometer::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() <BrickletBarometer::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletBarometer::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:
 
 * BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
 * BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
 * BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
 * BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
 * BrickletBarometer.FUNCTION_SET_DEBOUNCE_PERIOD = 11
 * BrickletBarometer.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
 * BrickletBarometer.FUNCTION_SET_AVERAGING = 20
 
.. java:function:: public void BrickletBarometer::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and listener configuration
 functions of this device at once.
 
.. java:function:: public BrickletBarometer.Identity BrickletBarometer::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 BrickletBarometer::setAirPressureCallbackPeriod(long period)

 Sets the period in ms with which the :java:func:`AirPressureListener <BrickletBarometer.AirPressureListener>` listener is triggered
 periodically. A value of 0 turns the listener off.
 
 :java:func:`AirPressureListener <BrickletBarometer.AirPressureListener>` is only triggered if the air pressure has changed since the
 last triggering.
 
 The default value is 0.
 
.. java:function:: public long BrickletBarometer::getAirPressureCallbackPeriod()

 Returns the period as set by :java:func:`setAirPressureCallbackPeriod() <BrickletBarometer::setAirPressureCallbackPeriod>`.
 
.. java:function:: public void BrickletBarometer::setAltitudeCallbackPeriod(long period)

 Sets the period in ms with which the :java:func:`AltitudeListener <BrickletBarometer.AltitudeListener>` listener is triggered
 periodically. A value of 0 turns the listener off.
 
 :java:func:`AltitudeListener <BrickletBarometer.AltitudeListener>` is only triggered if the altitude has changed since the
 last triggering.
 
 The default value is 0.
 
.. java:function:: public long BrickletBarometer::getAltitudeCallbackPeriod()

 Returns the period as set by :java:func:`setAltitudeCallbackPeriod() <BrickletBarometer::setAltitudeCallbackPeriod>`.
 
.. java:function:: public void BrickletBarometer::setAirPressureCallbackThreshold(char option, int min, int max)

 Sets the thresholds for the :java:func:`AirPressureReachedListener <BrickletBarometer.AirPressureReachedListener>` listener.
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Listener is turned off"
  "'o'",    "Listener is triggered when the air pressure is *outside* the min and max values"
  "'i'",    "Listener is triggered when the air pressure is *inside* the min and max values"
  "'<'",    "Listener is triggered when the air pressure is smaller than the min value (max is ignored)"
  "'>'",    "Listener is triggered when the air pressure is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
 * BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
 
.. java:function:: public BrickletBarometer.AirPressureCallbackThreshold BrickletBarometer::getAirPressureCallbackThreshold()

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

.. java:function:: public void BrickletBarometer::setAltitudeCallbackThreshold(char option, int min, int max)

 Sets the thresholds for the :java:func:`AltitudeReachedListener <BrickletBarometer.AltitudeReachedListener>` listener.
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Listener is turned off"
  "'o'",    "Listener is triggered when the altitude is *outside* the min and max values"
  "'i'",    "Listener is triggered when the altitude is *inside* the min and max values"
  "'<'",    "Listener is triggered when the altitude is smaller than the min value (max is ignored)"
  "'>'",    "Listener is triggered when the altitude is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
 * BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
 
.. java:function:: public BrickletBarometer.AltitudeCallbackThreshold BrickletBarometer::getAltitudeCallbackThreshold()

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

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

 Sets the period in ms with which the threshold listeners
 
 * :java:func:`AirPressureReachedListener <BrickletBarometer.AirPressureReachedListener>`,
 * :java:func:`AltitudeReachedListener <BrickletBarometer.AltitudeReachedListener>`
 
 are triggered, if the thresholds
 
 * :java:func:`setAirPressureCallbackThreshold() <BrickletBarometer::setAirPressureCallbackThreshold>`,
 * :java:func:`setAltitudeCallbackThreshold() <BrickletBarometer::setAltitudeCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. java:function:: public long BrickletBarometer::getDebouncePeriod()

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


.. _barometer_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 BrickletBarometer.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 BrickletBarometer.AirPressureListener()

 This listener can be added with the ``addAirPressureListener()`` function.
 An added listener can be removed with the ``removeAirPressureListener()`` function.

 .. java:function:: public void airPressure(int airPressure)
  :noindex:


  This listener is triggered periodically with the period that is set by
  :java:func:`setAirPressureCallbackPeriod() <BrickletBarometer::setAirPressureCallbackPeriod>`. The parameter is the air pressure of the
  air pressure sensor.
  
  :java:func:`AirPressureListener <BrickletBarometer.AirPressureListener>` is only triggered if the air pressure has changed since the
  last triggering.
  

.. java:function:: public class BrickletBarometer.AltitudeListener()

 This listener can be added with the ``addAltitudeListener()`` function.
 An added listener can be removed with the ``removeAltitudeListener()`` function.

 .. java:function:: public void altitude(int altitude)
  :noindex:


  This listener is triggered periodically with the period that is set by
  :java:func:`setAltitudeCallbackPeriod() <BrickletBarometer::setAltitudeCallbackPeriod>`. The parameter is the altitude of the
  air pressure sensor.
  
  :java:func:`AltitudeListener <BrickletBarometer.AltitudeListener>` is only triggered if the altitude has changed since the
  last triggering.
  

.. java:function:: public class BrickletBarometer.AirPressureReachedListener()

 This listener can be added with the ``addAirPressureReachedListener()`` function.
 An added listener can be removed with the ``removeAirPressureReachedListener()`` function.

 .. java:function:: public void airPressureReached(int airPressure)
  :noindex:


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

.. java:function:: public class BrickletBarometer.AltitudeReachedListener()

 This listener can be added with the ``addAltitudeReachedListener()`` function.
 An added listener can be removed with the ``removeAltitudeReachedListener()`` function.

 .. java:function:: public void altitudeReached(int altitude)
  :noindex:


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


.. _barometer_bricklet_java_constants:

Constants
^^^^^^^^^

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

 This constant is used to identify a Barometer Bricklet.

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

