JavaScript - Barometer Bricklet 2.0

This is the description of the JavaScript 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 JavaScript API bindings is part of their general description.

Examples

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

Callback (Node.js)

Download (ExampleCallback.js)

 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
38
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var b = new Tinkerforge.BrickletBarometerV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Set period for air pressure callback to 1s (1000ms) without a threshold
        b.setAirPressureCallbackConfiguration(1000, false, 'x', 0, 0);
    }
);

// Register air pressure callback
b.on(Tinkerforge.BrickletBarometerV2.CALLBACK_AIR_PRESSURE,
    // Callback function for air pressure callback
    function (airPressure) {
        console.log('Air Pressure: ' + airPressure/1000.0 + ' mbar');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Threshold (Node.js)

Download (ExampleThreshold.js)

 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
38
39
40
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var b = new Tinkerforge.BrickletBarometerV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Configure threshold for air pressure "greater than 1025 mbar"
        // with a debounce period of 1s (1000ms)
        b.setAirPressureCallbackConfiguration(1000, false, '>', 1025*1000, 0);
    }
);

// Register air pressure callback
b.on(Tinkerforge.BrickletBarometerV2.CALLBACK_AIR_PRESSURE,
    // Callback function for air pressure callback
    function (airPressure) {
        console.log('Air Pressure: ' + airPressure/1000.0 + ' mbar');
        console.log('Enjoy the potentially good weather!');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (Node.js)

Download (ExampleSimple.js)

 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
38
39
40
41
42
43
44
45
46
47
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var b = new Tinkerforge.BrickletBarometerV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current air pressure
        b.getAirPressure(
            function (airPressure) {
                console.log('Air Pressure: ' + airPressure/1000.0 + ' mbar');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );

        // Get current altitude
        b.getAltitude(
            function (altitude) {
                console.log('Altitude: ' + altitude/1000.0 + ' m');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Barometer Bricklet 2.0 Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var b = new Tinkerforge.BrickletBarometerV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Set period for air pressure callback to 1s (1000ms) without a threshold
                        b.setAirPressureCallbackConfiguration(1000, false, 'x', 0, 0);
                    }
                );

                // Register air pressure callback
                b.on(Tinkerforge.BrickletBarometerV2.CALLBACK_AIR_PRESSURE,
                    // Callback function for air pressure callback
                    function (airPressure) {
                        textArea.value += 'Air Pressure: ' + airPressure/1000.0 + ' mbar\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Threshold (HTML)

Download (ExampleThreshold.html), Test (ExampleThreshold.html)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Barometer Bricklet 2.0 Threshold Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var b = new Tinkerforge.BrickletBarometerV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Configure threshold for air pressure "greater than 1025 mbar"
                        // with a debounce period of 1s (1000ms)
                        b.setAirPressureCallbackConfiguration(1000, false, '>', 1025*1000, 0);
                    }
                );

                // Register air pressure callback
                b.on(Tinkerforge.BrickletBarometerV2.CALLBACK_AIR_PRESSURE,
                    // Callback function for air pressure callback
                    function (airPressure) {
                        textArea.value += 'Air Pressure: ' + airPressure/1000.0 + ' mbar\n';
                        textArea.value += 'Enjoy the potentially good weather!\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.html)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Barometer Bricklet 2.0 Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var b = new Tinkerforge.BrickletBarometerV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current air pressure
                        b.getAirPressure(
                            function (airPressure) {
                                textArea.value += 'Air Pressure: ' + airPressure/1000.0 + ' mbar\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );

                        // Get current altitude
                        b.getAltitude(
                            function (altitude) {
                                textArea.value += 'Altitude: ' + altitude/1000.0 + ' m\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

API

Generally, every method of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback is called with the return values as parameters, if the method returns something. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletBarometerV2(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

var barometerV2 = new BrickletBarometerV2("YOUR_DEVICE_UID", ipcon);

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

BrickletBarometerV2.getAirPressure([returnCallback][, errorCallback])
Callback:
  • airPressure -- int

Returns the measured air pressure. The value has a range of 260000 to 1260000 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 value periodically, it is recommended to use the CALLBACK_AIR_PRESSURE callback. You can set the callback configuration with setAirPressureCallbackConfiguration().

BrickletBarometerV2.getAltitude([returnCallback][, errorCallback])
Callback:
  • altitude -- int

Returns the relative altitude of the air pressure sensor. The value is given in mm 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 value periodically, it is recommended to use the CALLBACK_ALTITUDE callback. You can set the callback configuration with setAltitudeCallbackConfiguration().

BrickletBarometerV2.getTemperature([returnCallback][, errorCallback])
Callback:
  • temperature -- int

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

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

BrickletBarometerV2.setMovingAverageConfiguration(movingAverageLengthAirPressure, movingAverageLengthTemperature[, returnCallback][, errorCallback])
Parameters:
  • movingAverageLengthAirPressure -- int
  • movingAverageLengthTemperature -- int
Callback:

undefined

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.

The range for the averaging is 1-1000.

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

The default value is 100.

BrickletBarometerV2.getMovingAverageConfiguration([returnCallback][, errorCallback])
Callback:
  • movingAverageLengthAirPressure -- int
  • movingAverageLengthTemperature -- int

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

BrickletBarometerV2.setReferenceAirPressure(airPressure[, returnCallback][, errorCallback])
Parameters:
  • airPressure -- int
Callback:

undefined

Sets the reference air pressure in mbar/1000 for the altitude calculation. Valid values are between 260000 and 1260000. 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.

The default value is 1013.25mbar.

BrickletBarometerV2.getReferenceAirPressure([returnCallback][, errorCallback])
Callback:
  • airPressure -- int

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

Advanced Functions

BrickletBarometerV2.setCalibration(measuredAirPressure, actualAirPressure[, returnCallback][, errorCallback])
Parameters:
  • measuredAirPressure -- int
  • actualAirPressure -- int
Callback:

undefined

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 and accurate reference barometer (actual air pressure) at the same time and passed to this function in mbar/1000.

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

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

BrickletBarometerV2.getCalibration([returnCallback][, errorCallback])
Callback:
  • measuredAirPressure -- int
  • actualAirPressure -- int

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

BrickletBarometerV2.setSensorConfiguration(dataRate, airPressureLowPassFilter[, returnCallback][, errorCallback])
Parameters:
  • dataRate -- int
  • airPressureLowPassFilter -- int
Callback:

undefined

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 default values are 50Hz data rate and 1/9th low pass filter.

The following constants are available for this function:

  • 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
  • BrickletBarometerV2.LOW_PASS_FILTER_OFF = 0
  • BrickletBarometerV2.LOW_PASS_FILTER_1_9TH = 1
  • BrickletBarometerV2.LOW_PASS_FILTER_1_20TH = 2
BrickletBarometerV2.getSensorConfiguration([returnCallback][, errorCallback])
Callback:
  • dataRate -- int
  • airPressureLowPassFilter -- int

Returns the sensor configuration as set by setSensorConfiguration().

The following constants are available for this function:

  • 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
  • BrickletBarometerV2.LOW_PASS_FILTER_OFF = 0
  • BrickletBarometerV2.LOW_PASS_FILTER_1_9TH = 1
  • BrickletBarometerV2.LOW_PASS_FILTER_1_20TH = 2
BrickletBarometerV2.getAPIVersion()
Return type:[int, int, int]

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.

BrickletBarometerV2.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId -- int
Return 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 send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

BrickletBarometerV2.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId -- int
  • responseExpected -- 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.

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:

  • 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
BrickletBarometerV2.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected -- boolean

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

BrickletBarometerV2.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback:
  • errorCountAckChecksum -- int
  • errorCountMessageChecksum -- int
  • errorCountFrame -- int
  • errorCountOverflow -- int

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.

BrickletBarometerV2.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameters:
  • mode -- int
Callback:
  • status -- int

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:

  • 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
  • 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
BrickletBarometerV2.getBootloaderMode([returnCallback][, errorCallback])
Callback:
  • mode -- int

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • 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
BrickletBarometerV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameters:
  • pointer -- int
Callback:

undefined

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.

BrickletBarometerV2.writeFirmware(data[, returnCallback][, errorCallback])
Parameters:
  • data -- [int, int, ..61x.., int]
Callback:
  • status -- int

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.

BrickletBarometerV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameters:
  • config -- int
Callback:

undefined

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:

  • 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
BrickletBarometerV2.getStatusLEDConfig([returnCallback][, errorCallback])
Callback:
  • config -- int

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • 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
BrickletBarometerV2.getChipTemperature([returnCallback][, errorCallback])
Callback:
  • temperature -- int

Returns the temperature in °C 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.

BrickletBarometerV2.reset([returnCallback][, errorCallback])
Callback:undefined

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.writeUID(uid[, returnCallback][, errorCallback])
Parameters:
  • uid -- int
Callback:

undefined

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.

BrickletBarometerV2.readUID([returnCallback][, errorCallback])
Callback:
  • uid -- int

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

BrickletBarometerV2.getIdentity([returnCallback][, errorCallback])
Callback:
  • uid -- string
  • connectedUid -- string
  • position -- char
  • hardwareVersion -- [int, int, int]
  • firmwareVersion -- [int, int, int]
  • deviceIdentifier -- int

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.

Callback Configuration Functions

BrickletBarometerV2.on(callback_id, function)
Parameters:
  • callback_id -- int
  • function -- function

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletBarometerV2.setAirPressureCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameters:
  • period -- int
  • valueHasToChange -- boolean
  • option -- char
  • min -- int
  • max -- int
Callback:

undefined

The period in ms is the period with which the CALLBACK_AIR_PRESSURE 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 CALLBACK_AIR_PRESSURE 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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometerV2.getAirPressureCallbackConfiguration([returnCallback][, errorCallback])
Callback:
  • period -- int
  • valueHasToChange -- boolean
  • option -- char
  • min -- int
  • max -- int

Returns the callback configuration as set by setAirPressureCallbackConfiguration().

The following constants are available for this function:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometerV2.setAltitudeCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameters:
  • period -- int
  • valueHasToChange -- boolean
  • option -- char
  • min -- int
  • max -- int
Callback:

undefined

The period in ms is the period with which the CALLBACK_ALTITUDE 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 CALLBACK_ALTITUDE 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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometerV2.getAltitudeCallbackConfiguration([returnCallback][, errorCallback])
Callback:
  • period -- int
  • valueHasToChange -- boolean
  • option -- char
  • min -- int
  • max -- int

Returns the callback configuration as set by setAltitudeCallbackConfiguration().

The following constants are available for this function:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometerV2.setTemperatureCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameters:
  • period -- int
  • valueHasToChange -- boolean
  • option -- char
  • min -- int
  • max -- int
Callback:

undefined

The period in ms is the period with which the CALLBACK_TEMPERATURE 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 CALLBACK_TEMPERATURE 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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletBarometerV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometerV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometerV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometerV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometerV2.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometerV2.getTemperatureCallbackConfiguration([returnCallback][, errorCallback])
Callback:
  • period -- int
  • valueHasToChange -- boolean
  • option -- char
  • min -- int
  • max -- int

Returns the callback configuration as set by setTemperatureCallbackConfiguration().

The following constants are available for this function:

  • 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 the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

barometerV2.on(BrickletBarometerV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters 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.

BrickletBarometerV2.CALLBACK_AIR_PRESSURE
Parameters:
  • airPressure -- int

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

The parameter is the same as getAirPressure().

BrickletBarometerV2.CALLBACK_ALTITUDE
Parameters:
  • altitude -- int

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

The parameter is the same as getAltitude().

BrickletBarometerV2.CALLBACK_TEMPERATURE
Parameters:
  • temperature -- int

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

The parameter is the same as getTemperature().

Constants

BrickletBarometerV2.DEVICE_IDENTIFIER

This constant is used to identify a Barometer Bricklet 2.0.

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

BrickletBarometerV2.DEVICE_DISPLAY_NAME

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