JavaScript - Accelerometer Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# JavaScript - Accelerometer Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

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
    40

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'sad'; // Change to your UID

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var acc = 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
            acc.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');
                    console.log();
                },
                function(error) {
                    console.log('Error: '+error);
                }
            );
        }
    );

    console.log("Press any 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 = 'sad'; // Change to your UID

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

    // Register temperature callback
    acc.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 any 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

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'sad'; // Change to your UID

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var acc = 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 threshold callbacks with a debounce time of 10 seconds (10000ms)
            acc.setDebouncePeriod(10000);
            // Configure threshold for acceleration values X, Y or Z greater than 2G
            acc.setAccelerationCallbackThreshold('>', 2000, 0, 2000, 0, 2000, 0);
        }
    );

    // Register threshold reached callback
    acc.on(Tinkerforge.BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED,
        // Callback for acceleration threshold reached
        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 any 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
    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>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 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 acc = 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 ccceleration
                            acc.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';
                                    textArea.value += '\n';
                                    textArea.scrollTop = textArea.scrollHeight;
                                },
                                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

    <!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 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 acc = 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 callback is only called every second if the
                            // acceleration has changed since the last call!
                            acc.setAccelerationCallbackPeriod(1000);
                        }
                    );
                    // Register acceleration callback
                    acc.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

    <!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 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 acc = 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 threshold callbacks with a debounce time of 10 seconds (10000ms)
                            acc.setDebouncePeriod(10000);
                            // Configure threshold for acceleration values X, Y or Z greather than 2G
                            acc.setAccelerationCallbackThreshold('>', 2000, 0, 2000, 0, 2000, 0);
                        }
                    );
                    // Register threshold reached callback
                    acc.on(Tinkerforge.BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED,
                        // Callback for acceleration threshold reached
                        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 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 `BrickletAccelerometer`(uid, ipcon)

  Parameters:

  - uid -- string
  - ipcon -- IPConnection

  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:

  - x -- int
  - y -- int
  - z -- int

  Returns the acceleration in x, y and z direction. The values are given in mG (1/1000 G).

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

`BrickletAccelerometer.``getTemperature`([returnCallback][, errorCallback])

  Callback:

  - temperature -- int

  Returns the temperature of the accelerometer in °C.

`BrickletAccelerometer.``ledOn`([returnCallback][, errorCallback])

  Callback: | undefined

  Enables the LED on the Bricklet.

`BrickletAccelerometer.``ledOff`([returnCallback][, errorCallback])

  Callback: | undefined

  Disables the LED on the Bricklet.

`BrickletAccelerometer.``isLEDOn`([returnCallback][, errorCallback])

  Callback:

  - value -- int

  Returns true if the LED is enabled, false otherwise.

### Advanced Functions

`BrickletAccelerometer.``setConfiguration`(dataRate, fullScale, filterBandwidth[, returnCallback][, errorCallback])

  Parameters:

  - dataRate -- int
  - fullScale -- int
  - filterBandwidth -- int

  Callback: | 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 to +2G up to -16G to +16G.
  - Filter bandwidth between 50Hz and 800Hz.

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

  The default values are 100Hz data rate, -4G to +4G range and 200Hz filter bandwidth.

  The following constants are available for this function:

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

  - dataRate -- int
  - fullScale -- int
  - filterBandwidth -- int

  Returns the configuration as set by `setConfiguration()`.

  The following constants are available for this function:

  - 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
  - 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
  - BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  - BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  - BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  - BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3

`BrickletAccelerometer.``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.

`BrickletAccelerometer.``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.

`BrickletAccelerometer.``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 and callbacks it is always disabled.

  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:

  - 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 -- boolean

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

`BrickletAccelerometer.``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

`BrickletAccelerometer.``on`(id, callback)

  Parameters:

  - id -- int
  - callback -- function

  Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

`BrickletAccelerometer.``setAccelerationCallbackPeriod`(period[, returnCallback][, errorCallback])

  Parameters:

  - period -- int

  Callback: | undefined

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

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

  The default value is 0.

`BrickletAccelerometer.``getAccelerationCallbackPeriod`([returnCallback][, errorCallback])

  Callback:

  - period -- int

  Returns the period as set by `setAccelerationCallbackPeriod()`.

`BrickletAccelerometer.``setAccelerationCallbackThreshold`(option, minX, maxX, minY, maxY, minZ, maxZ[, returnCallback][, errorCallback])

  Parameters:

  - option -- char
  - minX -- int
  - maxX -- int
  - minY -- int
  - maxY -- int
  - minZ -- int
  - maxZ -- int

  Callback: | 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 temperature is outside the min and max values
  'i' | Callback is triggered when the temperature is inside the min and max values
  '<' | Callback is triggered when the temperature is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the temperature is greater than the min value (max is ignored)

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

  The following constants are available for this function:

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

  - option -- char
  - minX -- int
  - maxX -- int
  - minY -- int
  - maxY -- int
  - minZ -- int
  - maxZ -- int

  Returns the threshold as set by `setAccelerationCallbackThreshold()`.

  The following constants are available for this function:

  - 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 -- int

  Callback: | undefined

  Sets the period in ms with which the threshold callback

  - `CALLBACK_ACCELERATION_REACHED`

  is triggered, if the threshold

  - `setAccelerationCallbackThreshold()`

  keeps being reached.

  The default value is 100.

`BrickletAccelerometer.``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:

    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`

  Parameters:

  - x -- int
  - y -- int
  - z -- int

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

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

`BrickletAccelerometer.``CALLBACK_ACCELERATION_REACHED`

  Parameters:

  - x -- int
  - y -- int
  - z -- int

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

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

### Constants

`BrickletAccelerometer.``DEVICE_IDENTIFIER`

  This constant is used to identify a Accelerometer 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.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.