JavaScript - Barometer Bricklet

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

An installation guide for the 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
39
40
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var b = new Tinkerforge.BrickletBarometer(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)
        // Note: The air pressure callback is only called every second
        //       if the air pressure has changed since the last call!
        b.setAirPressureCallbackPeriod(1000);
    }
);

// Register air pressure callback
b.on(Tinkerforge.BrickletBarometer.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
41
42
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var b = new Tinkerforge.BrickletBarometer(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 threshold callbacks with a debounce time of 10 seconds (10000ms)
        b.setDebouncePeriod(10000);

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

// Register air pressure reached callback
b.on(Tinkerforge.BrickletBarometer.CALLBACK_AIR_PRESSURE_REACHED,
    // Callback function for air pressure reached 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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var b = new Tinkerforge.BrickletBarometer(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/100.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
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 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.BrickletBarometer(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)
                        // Note: The air pressure callback is only called every second
                        //       if the air pressure has changed since the last call!
                        b.setAirPressureCallbackPeriod(1000);
                    }
                );

                // Register air pressure callback
                b.on(Tinkerforge.BrickletBarometer.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
63
64
<!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 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.BrickletBarometer(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 threshold callbacks with a debounce time of 10 seconds (10000ms)
                        b.setDebouncePeriod(10000);

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

                // Register air pressure reached callback
                b.on(Tinkerforge.BrickletBarometer.CALLBACK_AIR_PRESSURE_REACHED,
                    // Callback function for air pressure reached 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 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.BrickletBarometer(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/100.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 BrickletBarometer(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

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

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

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

Returns the air pressure of the air pressure sensor. The value has a range of 10000 to 1200000 and is given in mbar/1000, i.e. a value of 1001092 means that an air pressure of 1001.092 mbar is measured.

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

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

Returns the relative altitude of the air pressure sensor. The value is given in cm and is calculated based on the difference between the current air pressure and the reference air pressure that can be set with setReferenceAirPressure().

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

BrickletBarometer.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 10000 and 1200000. Setting the reference to the current air pressure results in a calculated altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as reference.

Well known reference values are the Q codes QNH and QFE used in aviation.

The default value is 1013.25mbar.

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

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

Advanced Functions

BrickletBarometer.getChipTemperature([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 or the Temperature IR Bricklet.

BrickletBarometer.setAveraging(movingAveragePressure, averagePressure, averageTemperature[, returnCallback][, errorCallback])
Parameters:
  • movingAveragePressure -- int
  • averagePressure -- int
  • averageTemperature -- int
Callback:

undefined

Sets the different averaging parameters. It is possible to set the length of a normal averaging for the temperature and pressure, as well as an additional length of a moving average for the pressure. The moving average is calculated from the normal averages. There is no moving average for the temperature.

The maximum length for the pressure average is 10, for the temperature average is 255 and for the moving average is 25.

Setting the all three parameters to 0 will turn the averaging completely off. If the averaging is off, there is lots of noise on the data, but the data is without delay. Thus we recommend to turn the averaging off if the Barometer Bricklet data is to be used for sensor fusion with other sensors.

The default values are 10 for the normal averages and 25 for the moving average.

New in version 2.0.1 (Plugin).

BrickletBarometer.getAveraging([returnCallback][, errorCallback])
Callback:
  • movingAveragePressure -- int
  • averagePressure -- int
  • averageTemperature -- int

Returns the averaging configuration as set by setAveraging().

New in version 2.0.1 (Plugin).

BrickletBarometer.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.

BrickletBarometer.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.

BrickletBarometer.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:

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

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

BrickletBarometer.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

BrickletBarometer.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.

BrickletBarometer.setAirPressureCallbackPeriod(period[, returnCallback][, errorCallback])
Parameters:
  • period -- int
Callback:

undefined

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

The CALLBACK_AIR_PRESSURE callback is only triggered if the air pressure has changed since the last triggering.

The default value is 0.

BrickletBarometer.getAirPressureCallbackPeriod([returnCallback][, errorCallback])
Callback:
  • period -- int

Returns the period as set by setAirPressureCallbackPeriod().

BrickletBarometer.setAltitudeCallbackPeriod(period[, returnCallback][, errorCallback])
Parameters:
  • period -- int
Callback:

undefined

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

The CALLBACK_ALTITUDE callback is only triggered if the altitude has changed since the last triggering.

The default value is 0.

BrickletBarometer.getAltitudeCallbackPeriod([returnCallback][, errorCallback])
Callback:
  • period -- int

Returns the period as set by setAltitudeCallbackPeriod().

BrickletBarometer.setAirPressureCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
Parameters:
  • option -- char
  • min -- int
  • max -- int
Callback:

undefined

Sets the thresholds for the CALLBACK_AIR_PRESSURE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the air pressure is outside the min and max values
'i' Callback is triggered when the air pressure is inside the min and max values
'<' Callback is triggered when the air pressure is smaller than the min value (max is ignored)
'>' Callback is triggered when the air pressure is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

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

Returns the threshold as set by setAirPressureCallbackThreshold().

The following constants are available for this function:

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

undefined

Sets the thresholds for the CALLBACK_ALTITUDE_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

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

Returns the threshold as set by setAltitudeCallbackThreshold().

The following constants are available for this function:

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometer.setDebouncePeriod(debounce[, returnCallback][, errorCallback])
Parameters:
  • debounce -- int
Callback:

undefined

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletBarometer.getDebouncePeriod([returnCallback][, errorCallback])
Callback:
  • debounce -- int

Returns the debounce period as set by setDebouncePeriod().

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:

barometer.on(BrickletBarometer.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.

BrickletBarometer.CALLBACK_AIR_PRESSURE
Parameters:
  • airPressure -- int

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

The CALLBACK_AIR_PRESSURE callback is only triggered if the air pressure has changed since the last triggering.

BrickletBarometer.CALLBACK_ALTITUDE
Parameters:
  • altitude -- int

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

The CALLBACK_ALTITUDE callback is only triggered if the altitude has changed since the last triggering.

BrickletBarometer.CALLBACK_AIR_PRESSURE_REACHED
Parameters:
  • airPressure -- int

This callback 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 callback is triggered periodically with the period as set by setDebouncePeriod().

BrickletBarometer.CALLBACK_ALTITUDE_REACHED
Parameters:
  • altitude -- int

This callback 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 callback is triggered periodically with the period as set by setDebouncePeriod().

Constants

BrickletBarometer.DEVICE_IDENTIFIER

This constant is used to identify a Barometer Bricklet.

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.

BrickletBarometer.DEVICE_DISPLAY_NAME

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