Software / API Bindings / MATLAB/Octave / API Reference and Examples / Bricklets / Barometer Bricklet 2.0

MATLAB/Octave - Barometer Bricklet 2.0¶

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

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples¶

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

Simple (MATLAB)¶

Download (matlab_example_simple.m)

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletBarometerV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Barometer Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    b = handle(BrickletBarometerV2(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Get current air pressure
    airPressure = b.getAirPressure();
    fprintf('Air Pressure: %g hPa\n', airPressure/1000.0);

    % Get current altitude
    altitude = b.getAltitude();
    fprintf('Altitude: %g m\n', altitude/1000.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletBarometerV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Barometer Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    b = handle(BrickletBarometerV2(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register air pressure callback to function cb_air_pressure
    set(b, 'AirPressureCallback', @(h, e) cb_air_pressure(e));

    % Set period for air pressure callback to 1s (1000ms) without a threshold
    b.setAirPressureCallbackConfiguration(1000, false, 'x', 0, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for air pressure callback
function cb_air_pressure(e)
    fprintf('Air Pressure: %g hPa\n', e.airPressure/1000.0);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletBarometerV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Barometer Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    b = handle(BrickletBarometerV2(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register air pressure callback to function cb_air_pressure
    set(b, 'AirPressureCallback', @(h, e) cb_air_pressure(e));

    % Configure threshold for air pressure "greater than 1025 hPa"
    % with a debounce period of 1s (1000ms)
    b.setAirPressureCallbackConfiguration(1000, false, '>', 1025*1000, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for air pressure callback
function cb_air_pressure(e)
    fprintf('Air Pressure: %g hPa\n', e.airPressure/1000.0);
    fprintf('Enjoy the potentially good weather!\n');
end

Simple (Octave)¶

Download (octave_example_simple.m)

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Barometer Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    b = javaObject("com.tinkerforge.BrickletBarometerV2", UID, ipcon); % Create device object

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

    % Get current air pressure
    airPressure = b.getAirPressure();
    fprintf("Air Pressure: %g hPa\n", airPressure/1000.0);

    % Get current altitude
    altitude = b.getAltitude();
    fprintf("Altitude: %g m\n", altitude/1000.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Barometer Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    b = javaObject("com.tinkerforge.BrickletBarometerV2", UID, ipcon); % Create device object

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

    % Register air pressure callback to function cb_air_pressure
    b.addAirPressureCallback(@cb_air_pressure);

    % Set period for air pressure callback to 1s (1000ms) without a threshold
    b.setAirPressureCallbackConfiguration(1000, false, "x", 0, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for air pressure callback
function cb_air_pressure(e)
    fprintf("Air Pressure: %g hPa\n", e.airPressure/1000.0);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Barometer Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    b = javaObject("com.tinkerforge.BrickletBarometerV2", UID, ipcon); % Create device object

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

    % Register air pressure callback to function cb_air_pressure
    b.addAirPressureCallback(@cb_air_pressure);

    % Configure threshold for air pressure "greater than 1025 hPa"
    % with a debounce period of 1s (1000ms)
    b.setAirPressureCallbackConfiguration(1000, false, ">", 1025*1000, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for air pressure callback
function cb_air_pressure(e)
    fprintf("Air Pressure: %g hPa\n", e.airPressure/1000.0);
    fprintf("Enjoy the potentially good weather!\n");
end

API¶

Generally, every method of the MATLAB 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 the MATLAB bindings are based on Java and 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¶

class BrickletBarometerV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	barometerV2 – Type: BrickletBarometerV2

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletBarometerV2;

barometerV2 = BrickletBarometerV2('YOUR_DEVICE_UID', ipcon);

In Octave:

barometerV2 = java_new("com.tinkerforge.BrickletBarometerV2", "YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

int BrickletBarometerV2.getAirPressure()¶

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

Returns the measured air pressure.

If you want to get the value periodically, it is recommended to use the AirPressureCallback callback. You can set the callback configuration with setAirPressureCallbackConfiguration().

int BrickletBarometerV2.getAltitude()¶

Returns:	altitude – Type: int, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 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 value periodically, it is recommended to use the AltitudeCallback callback. You can set the callback configuration with setAltitudeCallbackConfiguration().

int BrickletBarometerV2.getTemperature()¶

Returns:	temperature – Type: int, 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 2.0 or the Temperature IR Bricklet 2.0.

If you want to get the value periodically, it is recommended to use the TemperatureCallback callback. You can set the callback configuration with setTemperatureCallbackConfiguration().

void BrickletBarometerV2.setMovingAverageConfiguration(int movingAverageLengthAirPressure, int movingAverageLengthTemperature)¶

Parameters:	movingAverageLengthAirPressure – Type: int, Range: [1 to 1000], Default: 100 movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 100

Sets the length of a moving averaging for the air pressure and temperature measurements.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

If you want to do long term measurements the longest moving average will give the cleanest results.

BrickletBarometerV2.MovingAverageConfiguration BrickletBarometerV2.getMovingAverageConfiguration()¶

Return Object:	movingAverageLengthAirPressure – Type: int, Range: [1 to 1000], Default: 100 movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 100

Returns the moving average configuration as set by setMovingAverageConfiguration().

void BrickletBarometerV2.setReferenceAirPressure(int airPressure)¶

Parameters:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000], 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 0mm. 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 BrickletBarometerV2.getReferenceAirPressure()¶

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

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

Advanced Functions¶

void BrickletBarometerV2.setCalibration(int measuredAirPressure, int actualAirPressure)¶

Parameters:	measuredAirPressure – Type: int, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000] actualAirPressure – Type: int, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]

Sets the one point calibration (OPC) values for the air pressure measurement.

Before the Bricklet can be calibrated any previous calibration has to be removed by setting measured air pressure and actual air pressure to 0.

Then the current air pressure has to be measured using the Bricklet (measured air pressure) and with an accurate reference barometer (actual air pressure) at the same time and passed to this function.

After proper calibration the air pressure measurement can achieve an accuracy up to 0.2 hPa.

The calibration is saved in the EEPROM of the Bricklet and only needs to be configured once.

BrickletBarometerV2.Calibration BrickletBarometerV2.getCalibration()¶

Return Object:	measuredAirPressure – Type: int, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000] actualAirPressure – Type: int, Unit: 1/1000 hPa, Range: [0, 260000 to 1260000]

Returns the air pressure one point calibration values as set by setCalibration().

void BrickletBarometerV2.setSensorConfiguration(int dataRate, int airPressureLowPassFilter)¶

Parameters:	dataRate – Type: int, Range: See constants, Default: 4 airPressureLowPassFilter – Type: int, Range: See constants, Default: 1

Configures the data rate and air pressure low pass filter. The low pass filter cut-off frequency (if enabled) can be set to 1/9th or 1/20th of the configure data rate to decrease the noise on the air pressure data.

The low pass filter configuration only applies to the air pressure measurement. There is no low pass filter for the temperature measurement.

A higher data rate will result in a less precise temperature because of self-heating of the sensor. If the accuracy of the temperature reading is important to you, we would recommend the 1Hz data rate.

The following constants are available for this function:

For dataRate:

BrickletBarometerV2.DATA_RATE_OFF = 0
BrickletBarometerV2.DATA_RATE_1HZ = 1
BrickletBarometerV2.DATA_RATE_10HZ = 2
BrickletBarometerV2.DATA_RATE_25HZ = 3
BrickletBarometerV2.DATA_RATE_50HZ = 4
BrickletBarometerV2.DATA_RATE_75HZ = 5

For airPressureLowPassFilter:

BrickletBarometerV2.LOW_PASS_FILTER_OFF = 0
BrickletBarometerV2.LOW_PASS_FILTER_1_9TH = 1
BrickletBarometerV2.LOW_PASS_FILTER_1_20TH = 2

BrickletBarometerV2.SensorConfiguration BrickletBarometerV2.getSensorConfiguration()¶

Return Object:	dataRate – Type: int, Range: See constants, Default: 4 airPressureLowPassFilter – Type: int, Range: See constants, Default: 1

Returns the sensor configuration as set by setSensorConfiguration().

The following constants are available for this function:

For dataRate:

BrickletBarometerV2.DATA_RATE_OFF = 0
BrickletBarometerV2.DATA_RATE_1HZ = 1
BrickletBarometerV2.DATA_RATE_10HZ = 2
BrickletBarometerV2.DATA_RATE_25HZ = 3
BrickletBarometerV2.DATA_RATE_50HZ = 4
BrickletBarometerV2.DATA_RATE_75HZ = 5

For airPressureLowPassFilter:

BrickletBarometerV2.LOW_PASS_FILTER_OFF = 0
BrickletBarometerV2.LOW_PASS_FILTER_1_9TH = 1
BrickletBarometerV2.LOW_PASS_FILTER_1_20TH = 2

BrickletBarometerV2.SPITFPErrorCount BrickletBarometerV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: long, Range: [0 to 2³² - 1] errorCountFrame – Type: long, Range: [0 to 2³² - 1] errorCountOverflow – Type: long, Range: [0 to 2³² - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

void BrickletBarometerV2.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

BrickletBarometerV2.STATUS_LED_CONFIG_OFF = 0
BrickletBarometerV2.STATUS_LED_CONFIG_ON = 1
BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletBarometerV2.getStatusLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

BrickletBarometerV2.STATUS_LED_CONFIG_OFF = 0
BrickletBarometerV2.STATUS_LED_CONFIG_ON = 1
BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletBarometerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletBarometerV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletBarometerV2.reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletBarometerV2.Identity BrickletBarometerV2.getIdentity()¶

Return Object:

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 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

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

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

firmwareVersion – Type: short[], Length: 3

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

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 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.

Callback Configuration Functions¶

void BrickletBarometerV2.setAirPressureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the AirPressureCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the AirPressureCallback callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletBarometerV2.AirPressureCallbackConfiguration BrickletBarometerV2.getAirPressureCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/1000 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by setAirPressureCallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletBarometerV2.setAltitudeCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the AltitudeCallback callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the AltitudeCallback callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletBarometerV2.AltitudeCallbackConfiguration BrickletBarometerV2.getAltitudeCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by setAltitudeCallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletBarometerV2.setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the TemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the TemperatureCallback callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletBarometerV2.TemperatureCallbackConfiguration BrickletBarometerV2.getTemperatureCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by setTemperatureCallbackConfiguration().

The following constants are available for this function:

For option:

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

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

Note

Using callbacks 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.

callback BrickletBarometerV2.AirPressureCallback¶

Event Object:	airPressure – Type: int, Unit: 1/1000 hPa, Range: [260000 to 1260000]

This callback is triggered periodically according to the configuration set by setAirPressureCallbackConfiguration().

The parameter is the same as getAirPressure().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAirPressureCallback() function. An added callback function can be removed with the removeAirPressureCallback() function.

callback BrickletBarometerV2.AltitudeCallback¶

Event Object:	altitude – Type: int, Unit: 1 mm, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by setAltitudeCallbackConfiguration().

The parameter is the same as getAltitude().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAltitudeCallback() function. An added callback function can be removed with the removeAltitudeCallback() function.

callback BrickletBarometerV2.TemperatureCallback¶

Event Object:	temperature – Type: int, Unit: 1/100 °C, Range: [-4000 to 8500]

This callback is triggered periodically according to the configuration set by setTemperatureCallbackConfiguration().

The parameter is the same as getTemperature().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addTemperatureCallback() function. An added callback function can be removed with the removeTemperatureCallback() function.

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[] BrickletBarometerV2.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: 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 BrickletBarometerV2.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 callback 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:

BrickletBarometerV2.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
BrickletBarometerV2.FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
BrickletBarometerV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
BrickletBarometerV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
BrickletBarometerV2.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
BrickletBarometerV2.FUNCTION_SET_CALIBRATION = 17
BrickletBarometerV2.FUNCTION_SET_SENSOR_CONFIGURATION = 19
BrickletBarometerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletBarometerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletBarometerV2.FUNCTION_RESET = 243
BrickletBarometerV2.FUNCTION_WRITE_UID = 248

void BrickletBarometerV2.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 callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For functionId:

BrickletBarometerV2.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
BrickletBarometerV2.FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
BrickletBarometerV2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
BrickletBarometerV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
BrickletBarometerV2.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
BrickletBarometerV2.FUNCTION_SET_CALIBRATION = 17
BrickletBarometerV2.FUNCTION_SET_SENSOR_CONFIGURATION = 19
BrickletBarometerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletBarometerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletBarometerV2.FUNCTION_RESET = 243
BrickletBarometerV2.FUNCTION_WRITE_UID = 248

void BrickletBarometerV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletBarometerV2.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

BrickletBarometerV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletBarometerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BrickletBarometerV2.BOOTLOADER_STATUS_OK = 0
BrickletBarometerV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletBarometerV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletBarometerV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletBarometerV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletBarometerV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletBarometerV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

BrickletBarometerV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletBarometerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletBarometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletBarometerV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletBarometerV2.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletBarometerV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 2³² - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletBarometerV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 2³² - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletBarometerV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Barometer Bricklet 2.0.

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

String BrickletBarometerV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Barometer Bricklet 2.0.