JavaScript - Accelerometer Bricklet

This is the description of the JavaScript API bindings for the Accelerometer Bricklet. General information and technical specifications for the Accelerometer 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).

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

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var a = new Tinkerforge.BrickletAccelerometer(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 acceleration
        a.getAcceleration(
            function (x, y, z) {
                console.log('Acceleration [X]: ' + x/1000.0 + ' g');
                console.log('Acceleration [Y]: ' + y/1000.0 + ' g');
                console.log('Acceleration [Z]: ' + z/1000.0 + ' g');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(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
41
42
43
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var a = new Tinkerforge.BrickletAccelerometer(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 acceleration callback to 1s (1000ms)
        // Note: The acceleration callback is only called every second
        //       if the acceleration has changed since the last call!
        a.setAccelerationCallbackPeriod(1000);
    }
);

// Register acceleration callback
a.on(Tinkerforge.BrickletAccelerometer.CALLBACK_ACCELERATION,
    // Callback function for acceleration callback
    function (x, y, z) {
        console.log('Acceleration [X]: ' + x/1000.0 + ' g');
        console.log('Acceleration [Y]: ' + y/1000.0 + ' g');
        console.log('Acceleration [Z]: ' + z/1000.0 + ' g');
        console.log();
    }
);

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

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var a = new Tinkerforge.BrickletAccelerometer(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)
        a.setDebouncePeriod(10000);

        // Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
        a.setAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
    }
);

// Register acceleration reached callback
a.on(Tinkerforge.BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED,
    // Callback function for acceleration reached callback
    function (x, y, z) {
        console.log('Acceleration [X]: ' + x/1000.0 + ' g');
        console.log('Acceleration [Y]: ' + y/1000.0 + ' g');
        console.log('Acceleration [Z]: ' + z/1000.0 + ' g');
        console.log();
    }
);

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

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
<!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>Accelerometer 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 a = new Tinkerforge.BrickletAccelerometer(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 acceleration
                        a.getAcceleration(
                            function (x, y, z) {
                                textArea.value += 'Acceleration [X]: ' + x/1000.0 + ' g\n';
                                textArea.value += 'Acceleration [Y]: ' + y/1000.0 + ' g\n';
                                textArea.value += 'Acceleration [Z]: ' + z/1000.0 + ' g\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

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
63
64
65
<!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>Accelerometer 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 a = new Tinkerforge.BrickletAccelerometer(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 acceleration callback to 1s (1000ms)
                        // Note: The acceleration callback is only called every second
                        //       if the acceleration has changed since the last call!
                        a.setAccelerationCallbackPeriod(1000);
                    }
                );

                // Register acceleration callback
                a.on(Tinkerforge.BrickletAccelerometer.CALLBACK_ACCELERATION,
                    // Callback function for acceleration callback
                    function (x, y, z) {
                        textArea.value += 'Acceleration [X]: ' + x/1000.0 + ' g\n';
                        textArea.value += 'Acceleration [Y]: ' + y/1000.0 + ' g\n';
                        textArea.value += 'Acceleration [Z]: ' + z/1000.0 + ' g\n';
                        textArea.value += '\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
65
66
<!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>Accelerometer 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 a = new Tinkerforge.BrickletAccelerometer(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)
                        a.setDebouncePeriod(10000);

                        // Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
                        a.setAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
                    }
                );

                // Register acceleration reached callback
                a.on(Tinkerforge.BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED,
                    // Callback function for acceleration reached callback
                    function (x, y, z) {
                        textArea.value += 'Acceleration [X]: ' + x/1000.0 + ' g\n';
                        textArea.value += 'Acceleration [Y]: ' + y/1000.0 + ' g\n';
                        textArea.value += 'Acceleration [Z]: ' + z/1000.0 + ' g\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. 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
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
  • IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletAccelerometer(uid, ipcon)
Parameters:
  • uid – Type: string
  • ipcon – Type: IPConnection
Returns:
  • accelerometer – Type: BrickletAccelerometer

Creates an object with the unique device ID uid:

var accelerometer = new BrickletAccelerometer("YOUR_DEVICE_UID", ipcon);

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

BrickletAccelerometer.getAcceleration([returnCallback][, errorCallback])
Callback Parameters:
  • x – Type: int, Unit: 1/1000 gₙ, Range: ?
  • y – Type: int, Unit: 1/1000 gₙ, Range: ?
  • z – Type: int, Unit: 1/1000 gₙ, Range: ?
Returns:
  • undefined

Returns the acceleration in x, y and z direction. The values are given in gₙ/1000 (1gₙ = 9.80665m/s²). The range is configured with setConfiguration().

If you want to get the acceleration periodically, it is recommended to use the CALLBACK_ACCELERATION callback and set the period with setAccelerationCallbackPeriod().

BrickletAccelerometer.getTemperature([returnCallback][, errorCallback])
Callback Parameters:
  • temperature – Type: int, Unit: 1 °C, Range: [-103 to 152]
Returns:
  • undefined

Returns the temperature of the accelerometer.

BrickletAccelerometer.ledOn([returnCallback][, errorCallback])
Callback Parameters:
  • undefined
Returns:
  • undefined

Enables the LED on the Bricklet.

BrickletAccelerometer.ledOff([returnCallback][, errorCallback])
Callback Parameters:
  • undefined
Returns:
  • undefined

Disables the LED on the Bricklet.

BrickletAccelerometer.isLEDOn([returnCallback][, errorCallback])
Callback Parameters:
  • on – Type: boolean, Default: false
Returns:
  • undefined

Returns true if the LED is enabled, false otherwise.

Advanced Functions

BrickletAccelerometer.setConfiguration(dataRate, fullScale, filterBandwidth[, returnCallback][, errorCallback])
Parameters:
  • dataRate – Type: int, Range: See constants, Default: 6
  • fullScale – Type: int, Range: See constants, Default: 1
  • filterBandwidth – Type: int, Range: See constants, Default: 2
Callback Parameters:
  • undefined
Returns:
  • undefined

Configures the data rate, full scale range and filter bandwidth. Possible values are:

  • Data rate of 0Hz to 1600Hz.
  • Full scale range of ±2gₙ up to ±16gₙ.
  • Filter bandwidth between 50Hz and 800Hz.

Decreasing data rate or full scale range will also decrease the noise on the data.

The following constants are available for this function:

For data_rate:

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9

For full_scale:

  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4

For filter_bandwidth:

  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
BrickletAccelerometer.getConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • dataRate – Type: int, Range: See constants, Default: 6
  • fullScale – Type: int, Range: See constants, Default: 1
  • filterBandwidth – Type: int, Range: See constants, Default: 2
Returns:
  • undefined

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For data_rate:

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9

For full_scale:

  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4

For filter_bandwidth:

  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
BrickletAccelerometer.getIdentity([returnCallback][, errorCallback])
Callback Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • firmwareVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]
Returns:
  • undefined

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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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

BrickletAccelerometer.on(callback_id, function)
Parameters:
  • callback_id – Type: int
  • function – Type: function
Returns:
  • undefined

Registers the given function with the given callback_id.

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

BrickletAccelerometer.setAccelerationCallbackPeriod(period[, returnCallback][, errorCallback])
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Callback Parameters:
  • undefined
Returns:
  • undefined

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

The CALLBACK_ACCELERATION callback is only triggered if the acceleration has changed since the last triggering.

BrickletAccelerometer.getAccelerationCallbackPeriod([returnCallback][, errorCallback])
Callback Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • undefined

Returns the period as set by setAccelerationCallbackPeriod().

BrickletAccelerometer.setAccelerationCallbackThreshold(option, minX, maxX, minY, maxY, minZ, maxZ[, returnCallback][, errorCallback])
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • minX – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxX – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minY – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxY – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minZ – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxZ – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
Callback Parameters:
  • undefined
Returns:
  • undefined

Sets the thresholds for the CALLBACK_ACCELERATION_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = '>'
BrickletAccelerometer.getAccelerationCallbackThreshold([returnCallback][, errorCallback])
Callback Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • minX – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxX – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minY – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxY – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minZ – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxZ – Type: int, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
Returns:
  • undefined

Returns the threshold as set by setAccelerationCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = '>'
BrickletAccelerometer.setDebouncePeriod(debounce[, returnCallback][, errorCallback])
Parameters:
  • debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Callback Parameters:
  • undefined
Returns:
  • undefined

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

BrickletAccelerometer.getDebouncePeriod([returnCallback][, errorCallback])
Callback Parameters:
  • debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Returns:
  • undefined

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:

accelerometer.on(BrickletAccelerometer.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.

BrickletAccelerometer.CALLBACK_ACCELERATION
Callback Parameters:
  • x – Type: int, Unit: 1/1000 gₙ, Range: ?
  • y – Type: int, Unit: 1/1000 gₙ, Range: ?
  • z – Type: int, Unit: 1/1000 gₙ, Range: ?

This callback is triggered periodically with the period that is set by setAccelerationCallbackPeriod(). The parameters are the X, Y and Z acceleration. The range is configured with setConfiguration().

The CALLBACK_ACCELERATION callback is only triggered if the acceleration has changed since the last triggering.

BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED
Callback Parameters:
  • x – Type: int, Unit: 1/1000 gₙ, Range: ?
  • y – Type: int, Unit: 1/1000 gₙ, Range: ?
  • z – Type: int, Unit: 1/1000 gₙ, Range: ?

This callback is triggered when the threshold as set by setAccelerationCallbackThreshold() is reached. The parameters are the X, Y and Z acceleration. The range is configured with setConfiguration().

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

Virtual Functions

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

BrickletAccelerometer.getAPIVersion()
Returns:
  • apiVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, 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.

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

The following constants are available for this function:

For function_id:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
BrickletAccelerometer.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
  • responseExpected – Type: boolean
Returns:
  • undefined

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

For function_id:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
BrickletAccelerometer.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected – Type: boolean
Returns:
  • undefined

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

Constants

BrickletAccelerometer.DEVICE_IDENTIFIER

This constant is used to identify a Accelerometer Bricklet.

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

BrickletAccelerometer.DEVICE_DISPLAY_NAME

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