Java - Barometer Bricklet¶

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 + " hPa");

        // 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 + " hPa");
            }
        });

        // 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 + " hPa");
                System.out.println("Enjoy the potentially good weather!");
            }
        });

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

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

Basic Functions¶

class BrickletBarometer(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	barometer – Type: BrickletBarometer

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.

int BrickletBarometer.getAirPressure()¶

Returns:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [10000 to 1200000]

Returns the air pressure of the air pressure sensor.

If you want to get the air pressure periodically, it is recommended to use the AirPressureListener listener and set the period with setAirPressureCallbackPeriod().

int BrickletBarometer.getAltitude()¶

Returns:	altitude – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]

Returns the relative altitude of the air pressure sensor. The value 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().

void BrickletBarometer.setReferenceAirPressure(int airPressure)¶

Parameters:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [0, 10000 to 1200000], Default: 1013250

Sets the reference air pressure 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 and QFE used in aviation.

int BrickletBarometer.getReferenceAirPressure()¶

Returns:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [10000 to 1200000], Default: 1013250

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

Advanced Functions¶

short BrickletBarometer.getChipTemperature()¶

Returns:	temperature – Type: short, Unit: 1/100 °C, Range: [-4000 to 8500]

Returns the temperature of the air pressure sensor.

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.

void BrickletBarometer.setAveraging(short movingAveragePressure, short averagePressure, short averageTemperature)¶

Parameters:	movingAveragePressure – Type: short, Range: [0 to 25], Default: 25 averagePressure – Type: short, Range: [0 to 10], Default: 10 averageTemperature – Type: short, Range: [0 to 255], Default: 10

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.

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.

New in version 2.0.1 (Plugin).

BrickletBarometer.Averaging BrickletBarometer.getAveraging()¶

Return Object:	movingAveragePressure – Type: short, Range: [0 to 25], Default: 25 averagePressure – Type: short, Range: [0 to 10], Default: 10 averageTemperature – Type: short, Range: [0 to 255], Default: 10

Returns the averaging configuration as set by setAveraging().

New in version 2.0.1 (Plugin).

void BrickletBarometer.setI2CMode(short mode)¶

Parameters:	mode – Type: short, Range: See constants, Default: 0

Sets the I2C mode. Possible modes are:

• 0: Fast (400kHz)
• 1: Slow (100kHz)

If you have problems with obvious outliers in the Barometer Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

The following constants are available for this function:

For mode:

• BrickletBarometer.I2C_MODE_FAST = 0
• BrickletBarometer.I2C_MODE_SLOW = 1

New in version 2.0.3 (Plugin).

short BrickletBarometer.getI2CMode()¶

Returns:	mode – Type: short, Range: See constants, Default: 0

Returns the I2C mode as set by setI2CMode().

The following constants are available for this function:

For mode:

• BrickletBarometer.I2C_MODE_FAST = 0
• BrickletBarometer.I2C_MODE_SLOW = 1

New in version 2.0.3 (Plugin).

BrickletBarometer.Identity BrickletBarometer.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Listener Configuration Functions¶

void BrickletBarometer.setAirPressureCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

long BrickletBarometer.getAirPressureCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setAirPressureCallbackPeriod().

void BrickletBarometer.setAltitudeCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

long BrickletBarometer.getAltitudeCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setAltitudeCallbackPeriod().

void BrickletBarometer.setAirPressureCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0

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 following constants are available for this function:

For option:

• BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
• BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
• BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'

BrickletBarometer.AirPressureCallbackThreshold BrickletBarometer.getAirPressureCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1/1000 hPa, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by setAirPressureCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
• BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
• BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'

void BrickletBarometer.setAltitudeCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1], Default: 0

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 following constants are available for this function:

For option:

• BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
• BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
• BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'

BrickletBarometer.AltitudeCallbackThreshold BrickletBarometer.getAltitudeCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by setAltitudeCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
• BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
• BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'

void BrickletBarometer.setDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold listeners

• AirPressureReachedListener,
• AltitudeReachedListener

are triggered, if the thresholds

• setAirPressureCallbackThreshold(),
• setAltitudeCallbackThreshold()

keep being reached.

long BrickletBarometer.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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.

class BrickletBarometer.AirPressureListener()¶

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

void airPressure(int airPressure)

Parameters:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [10000 to 1200000]

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.

class BrickletBarometer.AltitudeListener()¶

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

void altitude(int altitude)

Parameters:	altitude – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]

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.

class BrickletBarometer.AirPressureReachedListener()¶

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

void airPressureReached(int airPressure)

Parameters:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [10000 to 1200000]

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().

class BrickletBarometer.AltitudeReachedListener()¶

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

void altitudeReached(int altitude)

Parameters:	altitude – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]

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().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletBarometer.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition 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.

boolean BrickletBarometer.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• 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
• BrickletBarometer.FUNCTION_SET_I2C_MODE = 22

void BrickletBarometer.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• 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
• BrickletBarometer.FUNCTION_SET_I2C_MODE = 22

void BrickletBarometer.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletBarometer.DEVICE_IDENTIFIER¶

This constant is used to identify a Barometer Bricklet.

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

String BrickletBarometer.DEVICE_DISPLAY_NAME¶

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