Java - Barometer Bricklet

This is the description of the Java API bindings for the Barometer Bricklet. General information and technical specifications for the Barometer Bricklet are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletBarometer;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Barometer Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletBarometer b = new BrickletBarometer(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current air pressure
        int airPressure = b.getAirPressure(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Air Pressure: " + airPressure/1000.0 + " mbar");

        // Get current altitude
        int altitude = b.getAltitude(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Altitude: " + altitude/100.0 + " m");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback

Download (ExampleCallback.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletBarometer;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Barometer Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletBarometer b = new BrickletBarometer(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Add air pressure listener
        b.addAirPressureListener(new BrickletBarometer.AirPressureListener() {
            public void airPressure(int airPressure) {
                System.out.println("Air Pressure: " + airPressure/1000.0 + " mbar");
            }
        });

        // Set period for air pressure callback to 1s (1000ms)
        // Note: The air pressure callback is only called every second
        //       if the air pressure has changed since the last call!
        b.setAirPressureCallbackPeriod(1000);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Threshold

Download (ExampleThreshold.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletBarometer;

public class ExampleThreshold {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Barometer Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletBarometer b = new BrickletBarometer(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        b.setDebouncePeriod(10000);

        // Add air pressure reached listener
        b.addAirPressureReachedListener(new BrickletBarometer.AirPressureReachedListener() {
            public void airPressureReached(int airPressure) {
                System.out.println("Air Pressure: " + airPressure/1000.0 + " mbar");
                System.out.println("Enjoy the potentially good weather!");
            }
        });

        // Configure threshold for air pressure "greater than 1025 mbar"
        b.setAirPressureCallbackThreshold('>', 1025*1000, 0);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

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

public class BrickletBarometer(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected (see examples above).

public int 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 AirPressureListener listener and set the period with setAirPressureCallbackPeriod().

public int 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 setReferenceAirPressure().

If you want to get the altitude periodically, it is recommended to use the AltitudeListener listener and set the period with setAltitudeCallbackPeriod().

public void setReferenceAirPressure(int airPressure)

Sets the reference air pressure in mbar/1000 for the altitude calculation. Valid values are between 10000 and 1200000. 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 and QFE used in aviation.

The default value is 1013.25mbar.

public int getReferenceAirPressure()

Returns the reference air pressure as set by setReferenceAirPressure().

Advanced Functions

public short 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 Temperature Bricklet or the Temperature IR Bricklet.

public void 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 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.

New in version 2.0.1 (Plugin).

public BrickletBarometer.Averaging getAveraging()

Returns the averaging configuration as set by setAveraging().

New in version 2.0.1 (Plugin).

The returned object has the public member variables short movingAveragePressure, short averagePressure and short averageTemperature.

public short[] 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.

public boolean 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 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 setResponseExpected() for the list of function ID constants available for this function.

public void 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.

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
public void setResponseExpectedAll(boolean responseExpected)

Changes the response expected flag for all setter and listener configuration functions of this device at once.

public BrickletBarometer.Identity 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 here. There is also a constant for the device identifier of this Bricklet.

The returned object has the public member variables String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion and int deviceIdentifier.

Listener Configuration Functions

public void setAirPressureCallbackPeriod(long period)

Sets the period in ms with which the AirPressureListener listener is triggered periodically. A value of 0 turns the listener off.

The AirPressureListener listener is only triggered if the air pressure has changed since the last triggering.

The default value is 0.

public long getAirPressureCallbackPeriod()

Returns the period as set by setAirPressureCallbackPeriod().

public void setAltitudeCallbackPeriod(long period)

Sets the period in ms with which the AltitudeListener listener is triggered periodically. A value of 0 turns the listener off.

The AltitudeListener listener is only triggered if the altitude has changed since the last triggering.

The default value is 0.

public long getAltitudeCallbackPeriod()

Returns the period as set by setAltitudeCallbackPeriod().

public void setAirPressureCallbackThreshold(char option, int min, int max)

Sets the thresholds for the AirPressureReachedListener listener.

The following options are possible:

Option Description
'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 = '>'
public BrickletBarometer.AirPressureCallbackThreshold getAirPressureCallbackThreshold()

Returns the threshold as set by 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.

public void setAltitudeCallbackThreshold(char option, int min, int max)

Sets the thresholds for the AltitudeReachedListener listener.

The following options are possible:

Option Description
'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 = '>'
public BrickletBarometer.AltitudeCallbackThreshold getAltitudeCallbackThreshold()

Returns the threshold as set by 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.

public void setDebouncePeriod(long debounce)

Sets the period in ms with which the threshold listeners

are triggered, if the thresholds

keep being reached.

The default value is 100.

public long getDebouncePeriod()

Returns the debounce period as set by setDebouncePeriod().

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:

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.

public class BrickletBarometer.AirPressureListener()

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

public void airPressure(int airPressure)

This listener is triggered periodically with the period that is set by setAirPressureCallbackPeriod(). The parameter is the air pressure of the air pressure sensor.

The AirPressureListener listener is only triggered if the air pressure has changed since the last triggering.

public class BrickletBarometer.AltitudeListener()

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

public void altitude(int altitude)

This listener is triggered periodically with the period that is set by setAltitudeCallbackPeriod(). The parameter is the altitude of the air pressure sensor.

The AltitudeListener listener is only triggered if the altitude has changed since the last triggering.

public class BrickletBarometer.AirPressureReachedListener()

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

public void airPressureReached(int airPressure)

This listener is triggered when the threshold as set by 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 setDebouncePeriod().

public class BrickletBarometer.AltitudeReachedListener()

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

public void altitudeReached(int altitude)

This listener is triggered when the threshold as set by 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 setDebouncePeriod().

Constants

public static final int BrickletBarometer.DEVICE_IDENTIFIER

This constant is used to identify a Barometer Bricklet.

The getIdentity() function and the EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

public static final String BrickletBarometer.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Barometer Bricklet.