JavaScript - IMU Brick 2.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 = 'XXYYZZ'; // Change XXYYZZ to the UID of your IMU Brick 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var imu = new Tinkerforge.BrickIMUV2(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 quaternion
        imu.getQuaternion(
            function (w, x, y, z) {
                console.log('Quaternion [W]: ' + w/16383.0);
                console.log('Quaternion [X]: ' + x/16383.0);
                console.log('Quaternion [Y]: ' + y/16383.0);
                console.log('Quaternion [Z]: ' + z/16383.0);
            },
            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

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your IMU Brick 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var imu = new Tinkerforge.BrickIMUV2(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 quaternion callback to 0.1s (100ms)
        imu.setQuaternionPeriod(100);
    }
);

// Register quaternion callback
imu.on(Tinkerforge.BrickIMUV2.CALLBACK_QUATERNION,
    // Callback function for quaternion callback
    function (w, x, y, z) {
        console.log('Quaternion [W]: ' + w/16383.0);
        console.log('Quaternion [X]: ' + x/16383.0);
        console.log('Quaternion [Y]: ' + y/16383.0);
        console.log('Quaternion [Z]: ' + z/16383.0);
        console.log();
    }
);

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

All Data (Node.js)¶

Download (ExampleAllData.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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your IMU Brick 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var imu = new Tinkerforge.BrickIMUV2(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 all data callback to 0.1s (100ms)
        imu.setAllDataPeriod(100);
    }
);

// Register all data callback
imu.on(Tinkerforge.BrickIMUV2.CALLBACK_ALL_DATA,
    // Callback function for all data callback
    function (acceleration, magneticField, angularVelocity, eulerAngle, quaternion,
              linearAcceleration, gravityVector, temperature, calibrationStatus) {
        console.log('Acceleration [X]: ' + acceleration[0]/100.0 + ' m/s²');
        console.log('Acceleration [Y]: ' + acceleration[1]/100.0 + ' m/s²');
        console.log('Acceleration [Z]: ' + acceleration[2]/100.0 + ' m/s²');
        console.log('Magnetic Field [X]: ' + magneticField[0]/16.0 + ' µT');
        console.log('Magnetic Field [Y]: ' + magneticField[1]/16.0 + ' µT');
        console.log('Magnetic Field [Z]: ' + magneticField[2]/16.0 + ' µT');
        console.log('Angular Velocity [X]: ' + angularVelocity[0]/16.0 + ' °/s');
        console.log('Angular Velocity [Y]: ' + angularVelocity[1]/16.0 + ' °/s');
        console.log('Angular Velocity [Z]: ' + angularVelocity[2]/16.0 + ' °/s');
        console.log('Euler Angle [Heading]: ' + eulerAngle[0]/16.0 + ' °');
        console.log('Euler Angle [Roll]: ' + eulerAngle[1]/16.0 + ' °');
        console.log('Euler Angle [Pitch]: ' + eulerAngle[2]/16.0 + ' °');
        console.log('Quaternion [W]: ' + quaternion[0]/16383.0);
        console.log('Quaternion [X]: ' + quaternion[1]/16383.0);
        console.log('Quaternion [Y]: ' + quaternion[2]/16383.0);
        console.log('Quaternion [Z]: ' + quaternion[3]/16383.0);
        console.log('Linear Acceleration [X]: ' + linearAcceleration[0]/100.0 + ' m/s²');
        console.log('Linear Acceleration [Y]: ' + linearAcceleration[1]/100.0 + ' m/s²');
        console.log('Linear Acceleration [Z]: ' + linearAcceleration[2]/100.0 + ' m/s²');
        console.log('Gravity Vector [X]: ' + gravityVector[0]/100.0 + ' m/s²');
        console.log('Gravity Vector [Y]: ' + gravityVector[1]/100.0 + ' m/s²');
        console.log('Gravity Vector [Z]: ' + gravityVector[2]/100.0 + ' m/s²');
        console.log('Temperature: ' + temperature + ' °C');
        console.log('Calibration Status: ' + calibrationStatus.toString(2));
        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
61

<!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>IMU Brick 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 imu = new Tinkerforge.BrickIMUV2(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 quaternion
                        imu.getQuaternion(
                            function (w, x, y, z) {
                                textArea.value += 'Quaternion [W]: ' + w/16383.0 + '\n';
                                textArea.value += 'Quaternion [X]: ' + x/16383.0 + '\n';
                                textArea.value += 'Quaternion [Y]: ' + y/16383.0 + '\n';
                                textArea.value += 'Quaternion [Z]: ' + z/16383.0 + '\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

<!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>IMU Brick 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 imu = new Tinkerforge.BrickIMUV2(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 quaternion callback to 0.1s (100ms)
                        imu.setQuaternionPeriod(100);
                    }
                );

                // Register quaternion callback
                imu.on(Tinkerforge.BrickIMUV2.CALLBACK_QUATERNION,
                    // Callback function for quaternion callback
                    function (w, x, y, z) {
                        textArea.value += 'Quaternion [W]: ' + w/16383.0 + '\n';
                        textArea.value += 'Quaternion [X]: ' + x/16383.0 + '\n';
                        textArea.value += 'Quaternion [Y]: ' + y/16383.0 + '\n';
                        textArea.value += 'Quaternion [Z]: ' + z/16383.0 + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

All Data (HTML)¶

Download (ExampleAllData.html), Test (ExampleAllData.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

<!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>IMU Brick 2.0 All Data 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 imu = new Tinkerforge.BrickIMUV2(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 all data callback to 0.1s (100ms)
                        imu.setAllDataPeriod(100);
                    }
                );

                // Register all data callback
                imu.on(Tinkerforge.BrickIMUV2.CALLBACK_ALL_DATA,
                    // Callback function for all data callback
                    function (acceleration, magneticField, angularVelocity, eulerAngle, quaternion,
                              linearAcceleration, gravityVector, temperature, calibrationStatus) {
                        textArea.value += 'Acceleration [X]: ' + acceleration[0]/100.0 + ' m/s²\n';
                        textArea.value += 'Acceleration [Y]: ' + acceleration[1]/100.0 + ' m/s²\n';
                        textArea.value += 'Acceleration [Z]: ' + acceleration[2]/100.0 + ' m/s²\n';
                        textArea.value += 'Magnetic Field [X]: ' + magneticField[0]/16.0 + ' µT\n';
                        textArea.value += 'Magnetic Field [Y]: ' + magneticField[1]/16.0 + ' µT\n';
                        textArea.value += 'Magnetic Field [Z]: ' + magneticField[2]/16.0 + ' µT\n';
                        textArea.value += 'Angular Velocity [X]: ' + angularVelocity[0]/16.0 + ' °/s\n';
                        textArea.value += 'Angular Velocity [Y]: ' + angularVelocity[1]/16.0 + ' °/s\n';
                        textArea.value += 'Angular Velocity [Z]: ' + angularVelocity[2]/16.0 + ' °/s\n';
                        textArea.value += 'Euler Angle [Heading]: ' + eulerAngle[0]/16.0 + ' °\n';
                        textArea.value += 'Euler Angle [Roll]: ' + eulerAngle[1]/16.0 + ' °\n';
                        textArea.value += 'Euler Angle [Pitch]: ' + eulerAngle[2]/16.0 + ' °\n';
                        textArea.value += 'Quaternion [W]: ' + quaternion[0]/16383.0 + '\n';
                        textArea.value += 'Quaternion [X]: ' + quaternion[1]/16383.0 + '\n';
                        textArea.value += 'Quaternion [Y]: ' + quaternion[2]/16383.0 + '\n';
                        textArea.value += 'Quaternion [Z]: ' + quaternion[3]/16383.0 + '\n';
                        textArea.value += 'Linear Acceleration [X]: ' + linearAcceleration[0]/100.0 + ' m/s²\n';
                        textArea.value += 'Linear Acceleration [Y]: ' + linearAcceleration[1]/100.0 + ' m/s²\n';
                        textArea.value += 'Linear Acceleration [Z]: ' + linearAcceleration[2]/100.0 + ' m/s²\n';
                        textArea.value += 'Gravity Vector [X]: ' + gravityVector[0]/100.0 + ' m/s²\n';
                        textArea.value += 'Gravity Vector [Y]: ' + gravityVector[1]/100.0 + ' m/s²\n';
                        textArea.value += 'Gravity Vector [Z]: ' + gravityVector[2]/100.0 + ' m/s²\n';
                        textArea.value += 'Temperature: ' + temperature + ' °C\n';
                        textArea.value += 'Calibration Status: ' + calibrationStatus.toString(2) + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Basic Functions¶

new BrickIMUV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	imuV2 – Type: BrickIMUV2

Creates an object with the unique device ID uid:

var imuV2 = new BrickIMUV2("YOUR_DEVICE_UID", ipcon);

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

BrickIMUV2.getOrientation([returnCallback][, errorCallback])¶

Callback Parameters:	heading – Type: int, Unit: 1/16 °, Range: [0 to 5760] roll – Type: int, Unit: 1/16 °, Range: [-1440 to 1440] pitch – Type: int, Unit: 1/16 °, Range: [-2880 to 2880]
Returns:	undefined

Returns the current orientation (heading, roll, pitch) of the IMU Brick as independent Euler angles. Note that Euler angles always experience a gimbal lock. We recommend that you use quaternions instead, if you need the absolute orientation.

If you want to get the orientation periodically, it is recommended to use the CALLBACK_ORIENTATION callback and set the period with setOrientationPeriod().

BrickIMUV2.getLinearAcceleration([returnCallback][, errorCallback])¶

Callback Parameters:	x – Type: int, Unit: 1 cm/s², Range: ? y – Type: int, Unit: 1 cm/s², Range: ? z – Type: int, Unit: 1 cm/s², Range: ?
Returns:	undefined

Returns the linear acceleration of the IMU Brick for the x, y and z axis. The acceleration is in the range configured with setSensorConfiguration().

The linear acceleration is the acceleration in each of the three axis of the IMU Brick with the influences of gravity removed.

It is also possible to get the gravity vector with the influence of linear acceleration removed, see getGravityVector().

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

BrickIMUV2.getGravityVector([returnCallback][, errorCallback])¶

Callback Parameters:	x – Type: int, Unit: 1 cm/s², Range: [-981 to 981] y – Type: int, Unit: 1 cm/s², Range: [-981 to 981] z – Type: int, Unit: 1 cm/s², Range: [-981 to 981]
Returns:	undefined

Returns the current gravity vector of the IMU Brick for the x, y and z axis.

The gravity vector is the acceleration that occurs due to gravity. Influences of additional linear acceleration are removed.

It is also possible to get the linear acceleration with the influence of gravity removed, see getLinearAcceleration().

If you want to get the gravity vector periodically, it is recommended to use the CALLBACK_GRAVITY_VECTOR callback and set the period with setGravityVectorPeriod().

BrickIMUV2.getQuaternion([returnCallback][, errorCallback])¶

Callback Parameters:	w – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] x – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] y – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] z – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
Returns:	undefined

Returns the current orientation (w, x, y, z) of the IMU Brick as quaternions.

You have to divide the return values by 16383 (14 bit) to get the usual range of -1.0 to +1.0 for quaternions.

If you want to get the quaternions periodically, it is recommended to use the CALLBACK_QUATERNION callback and set the period with setQuaternionPeriod().

BrickIMUV2.getAllData([returnCallback][, errorCallback])¶

Callback Parameters:

acceleration – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1 cm/s², Range: ? 1: y – Type: int, Unit: 1 cm/s², Range: ? 2: z – Type: int, Unit: 1 cm/s², Range: ? magneticField – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] 1: y – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] 2: z – Type: int, Unit: 1/16 µT, Range: [-40000 to 40000] angularVelocity – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1/16 °/s, Range: ? 1: y – Type: int, Unit: 1/16 °/s, Range: ? 2: z – Type: int, Unit: 1/16 °/s, Range: ? eulerAngle – Type: [int, ...], Length: 3 0: heading – Type: int, Unit: 1/16 °, Range: [0 to 5760] 1: roll – Type: int, Unit: 1/16 °, Range: [-1440 to 1440] 2: pitch – Type: int, Unit: 1/16 °, Range: [-2880 to 2880] quaternion – Type: [int, ...], Length: 4 0: w – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 1: x – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 2: y – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 3: z – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] linearAcceleration – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1 cm/s², Range: ? 1: y – Type: int, Unit: 1 cm/s², Range: ? 2: z – Type: int, Unit: 1 cm/s², Range: ? gravityVector – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1 cm/s², Range: [-981 to 981] 1: y – Type: int, Unit: 1 cm/s², Range: [-981 to 981] 2: z – Type: int, Unit: 1 cm/s², Range: [-981 to 981] temperature – Type: int, Unit: 1 °C, Range: [-128 to 127] calibrationStatus – Type: int, Range: [0 to 255]

Returns:

undefined

Return all of the available data of the IMU Brick.

• acceleration (see getAcceleration())
• magnetic field (see getMagneticField())
• angular velocity (see getAngularVelocity())
• Euler angles (see getOrientation())
• quaternion (see getQuaternion())
• linear acceleration (see getLinearAcceleration())
• gravity vector (see getGravityVector())
• temperature (see getTemperature())
• calibration status (see below)

The calibration status consists of four pairs of two bits. Each pair of bits represents the status of the current calibration.

• bit 0-1: Magnetometer
• bit 2-3: Accelerometer
• bit 4-5: Gyroscope
• bit 6-7: System

A value of 0 means for "not calibrated" and a value of 3 means "fully calibrated". In your program you should always be able to ignore the calibration status, it is used by the calibration window of the Brick Viewer and it can be ignored after the first calibration. See the documentation in the calibration window for more information regarding the calibration of the IMU Brick.

If you want to get the data periodically, it is recommended to use the CALLBACK_ALL_DATA callback and set the period with setAllDataPeriod().

BrickIMUV2.ledsOn([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Turns the orientation and direction LEDs of the IMU Brick on.

BrickIMUV2.ledsOff([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Turns the orientation and direction LEDs of the IMU Brick off.

BrickIMUV2.areLedsOn([returnCallback][, errorCallback])¶

Callback Parameters:	leds – Type: boolean, Default: true
Returns:	undefined

Returns true if the orientation and direction LEDs of the IMU Brick are on, false otherwise.

Advanced Functions¶

BrickIMUV2.getAcceleration([returnCallback][, errorCallback])¶

Callback Parameters:	x – Type: int, Unit: 1 cm/s², Range: ? y – Type: int, Unit: 1 cm/s², Range: ? z – Type: int, Unit: 1 cm/s², Range: ?
Returns:	undefined

Returns the calibrated acceleration from the accelerometer for the x, y and z axis. The acceleration is in the range configured with setSensorConfiguration().

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

BrickIMUV2.getMagneticField([returnCallback][, errorCallback])¶

Callback Parameters:	x – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] y – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] z – Type: int, Unit: 1/16 µT, Range: [-40000 to 40000]
Returns:	undefined

Returns the calibrated magnetic field from the magnetometer for the x, y and z axis.

If you want to get the magnetic field periodically, it is recommended to use the CALLBACK_MAGNETIC_FIELD callback and set the period with setMagneticFieldPeriod().

BrickIMUV2.getAngularVelocity([returnCallback][, errorCallback])¶

Callback Parameters:	x – Type: int, Unit: 1/16 °/s, Range: ? y – Type: int, Unit: 1/16 °/s, Range: ? z – Type: int, Unit: 1/16 °/s, Range: ?
Returns:	undefined

Returns the calibrated angular velocity from the gyroscope for the x, y and z axis. The angular velocity is in the range configured with setSensorConfiguration().

If you want to get the angular velocity periodically, it is recommended to use the CALLBACK_ANGULAR_VELOCITY acallback nd set the period with setAngularVelocityPeriod().

BrickIMUV2.getTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-128 to 127]
Returns:	undefined

Returns the temperature of the IMU Brick. The temperature is measured in the core of the BNO055 IC, it is not the ambient temperature

BrickIMUV2.saveCalibration([returnCallback][, errorCallback])¶

Callback Parameters:	calibrationDone – Type: boolean
Returns:	undefined

A call of this function saves the current calibration to be used as a starting point for the next restart of continuous calibration of the IMU Brick.

A return value of true means that the calibration could be used and false means that it could not be used (this happens if the calibration status is not "fully calibrated").

This function is used by the calibration window of the Brick Viewer, you should not need to call it in your program.

BrickIMUV2.setSensorConfiguration(magnetometerRate, gyroscopeRange, gyroscopeBandwidth, accelerometerRange, accelerometerBandwidth[, returnCallback][, errorCallback])¶

Parameters:	magnetometerRate – Type: int, Range: See constants, Default: 5 gyroscopeRange – Type: int, Range: See constants, Default: 0 gyroscopeBandwidth – Type: int, Range: See constants, Default: 7 accelerometerRange – Type: int, Range: See constants, Default: 1 accelerometerBandwidth – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Sets the available sensor configuration for the Magnetometer, Gyroscope and Accelerometer. The Accelerometer Range is user selectable in all fusion modes, all other configurations are auto-controlled in fusion mode.

The following constants are available for this function:

For magnetometer_rate:

• BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
• BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
• BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
• BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
• BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
• BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
• BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
• BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7

For gyroscope_range:

• BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
• BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
• BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
• BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
• BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4

For gyroscope_bandwidth:

• BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
• BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
• BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
• BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
• BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
• BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
• BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
• BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7

For accelerometer_range:

• BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
• BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
• BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
• BrickIMUV2.ACCELEROMETER_RANGE_16G = 3

For accelerometer_bandwidth:

• BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

New in version 2.0.5 (Firmware).

BrickIMUV2.getSensorConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	magnetometerRate – Type: int, Range: See constants, Default: 5 gyroscopeRange – Type: int, Range: See constants, Default: 0 gyroscopeBandwidth – Type: int, Range: See constants, Default: 7 accelerometerRange – Type: int, Range: See constants, Default: 1 accelerometerBandwidth – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returns the sensor configuration as set by setSensorConfiguration().

The following constants are available for this function:

For magnetometer_rate:

• BrickIMUV2.MAGNETOMETER_RATE_2HZ = 0
• BrickIMUV2.MAGNETOMETER_RATE_6HZ = 1
• BrickIMUV2.MAGNETOMETER_RATE_8HZ = 2
• BrickIMUV2.MAGNETOMETER_RATE_10HZ = 3
• BrickIMUV2.MAGNETOMETER_RATE_15HZ = 4
• BrickIMUV2.MAGNETOMETER_RATE_20HZ = 5
• BrickIMUV2.MAGNETOMETER_RATE_25HZ = 6
• BrickIMUV2.MAGNETOMETER_RATE_30HZ = 7

For gyroscope_range:

• BrickIMUV2.GYROSCOPE_RANGE_2000DPS = 0
• BrickIMUV2.GYROSCOPE_RANGE_1000DPS = 1
• BrickIMUV2.GYROSCOPE_RANGE_500DPS = 2
• BrickIMUV2.GYROSCOPE_RANGE_250DPS = 3
• BrickIMUV2.GYROSCOPE_RANGE_125DPS = 4

For gyroscope_bandwidth:

• BrickIMUV2.GYROSCOPE_BANDWIDTH_523HZ = 0
• BrickIMUV2.GYROSCOPE_BANDWIDTH_230HZ = 1
• BrickIMUV2.GYROSCOPE_BANDWIDTH_116HZ = 2
• BrickIMUV2.GYROSCOPE_BANDWIDTH_47HZ = 3
• BrickIMUV2.GYROSCOPE_BANDWIDTH_23HZ = 4
• BrickIMUV2.GYROSCOPE_BANDWIDTH_12HZ = 5
• BrickIMUV2.GYROSCOPE_BANDWIDTH_64HZ = 6
• BrickIMUV2.GYROSCOPE_BANDWIDTH_32HZ = 7

For accelerometer_range:

• BrickIMUV2.ACCELEROMETER_RANGE_2G = 0
• BrickIMUV2.ACCELEROMETER_RANGE_4G = 1
• BrickIMUV2.ACCELEROMETER_RANGE_8G = 2
• BrickIMUV2.ACCELEROMETER_RANGE_16G = 3

For accelerometer_bandwidth:

• BrickIMUV2.ACCELEROMETER_BANDWIDTH_7_81HZ = 0
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_15_63HZ = 1
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_31_25HZ = 2
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_62_5HZ = 3
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_125HZ = 4
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_250HZ = 5
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_500HZ = 6
• BrickIMUV2.ACCELEROMETER_BANDWIDTH_1000HZ = 7

New in version 2.0.5 (Firmware).

BrickIMUV2.setSensorFusionMode(mode[, returnCallback][, errorCallback])¶

Parameters:	mode – Type: int, Range: See constants, Default: 1
Callback Parameters:	undefined
Returns:	undefined

If the fusion mode is turned off, the functions getAcceleration(), getMagneticField() and getAngularVelocity() return uncalibrated and uncompensated sensor data. All other sensor data getters return no data.

Since firmware version 2.0.6 you can also use a fusion mode without magnetometer. In this mode the calculated orientation is relative (with magnetometer it is absolute with respect to the earth). However, the calculation can't be influenced by spurious magnetic fields.

Since firmware version 2.0.13 you can also use a fusion mode without fast magnetometer calibration. This mode is the same as the normal fusion mode, but the fast magnetometer calibration is turned off. So to find the orientation the first time will likely take longer, but small magnetic influences might not affect the automatic calibration as much.

The following constants are available for this function:

For mode:

• BrickIMUV2.SENSOR_FUSION_OFF = 0
• BrickIMUV2.SENSOR_FUSION_ON = 1
• BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
• BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

New in version 2.0.5 (Firmware).

BrickIMUV2.getSensorFusionMode([returnCallback][, errorCallback])¶

Callback Parameters:	mode – Type: int, Range: See constants, Default: 1
Returns:	undefined

Returns the sensor fusion mode as set by setSensorFusionMode().

The following constants are available for this function:

For mode:

• BrickIMUV2.SENSOR_FUSION_OFF = 0
• BrickIMUV2.SENSOR_FUSION_ON = 1
• BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
• BrickIMUV2.SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

New in version 2.0.5 (Firmware).

BrickIMUV2.setSPITFPBaudrateConfig(enableDynamicBaudrate, minimumDynamicBaudrate[, returnCallback][, errorCallback])¶

Parameters:	enableDynamicBaudrate – Type: boolean, Default: true minimumDynamicBaudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Callback Parameters:	undefined
Returns:	undefined

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Brick will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate will be increased exponentially if lots of data is sent/received and decreased linearly if little data is sent/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function setSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by setSPITFPBaudrate() will be used statically.

New in version 2.0.10 (Firmware).

BrickIMUV2.getSPITFPBaudrateConfig([returnCallback][, errorCallback])¶

Callback Parameters:	enableDynamicBaudrate – Type: boolean, Default: true minimumDynamicBaudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Returns:	undefined

Returns the baudrate config, see setSPITFPBaudrateConfig().

New in version 2.0.10 (Firmware).

BrickIMUV2.getSendTimeoutCount(communicationMethod[, returnCallback][, errorCallback])¶

Parameters:	communicationMethod – Type: int, Range: See constants
Callback Parameters:	timeoutCount – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

Returns the timeout count for the different communication methods.

The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.

This function is mostly used for debugging during development, in normal operation the counters should nearly always stay at 0.

The following constants are available for this function:

For communication_method:

• BrickIMUV2.COMMUNICATION_METHOD_NONE = 0
• BrickIMUV2.COMMUNICATION_METHOD_USB = 1
• BrickIMUV2.COMMUNICATION_METHOD_SPI_STACK = 2
• BrickIMUV2.COMMUNICATION_METHOD_CHIBI = 3
• BrickIMUV2.COMMUNICATION_METHOD_RS485 = 4
• BrickIMUV2.COMMUNICATION_METHOD_WIFI = 5
• BrickIMUV2.COMMUNICATION_METHOD_ETHERNET = 6
• BrickIMUV2.COMMUNICATION_METHOD_WIFI_V2 = 7

New in version 2.0.7 (Firmware).

BrickIMUV2.setSPITFPBaudrate(brickletPort, baudrate[, returnCallback][, errorCallback])¶

Parameters:	brickletPort – Type: char, Range: ['a' to 'b'] baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Callback Parameters:	undefined
Returns:	undefined

Sets the baudrate for a specific Bricklet port.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see getSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig()).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.

New in version 2.0.5 (Firmware).

BrickIMUV2.getSPITFPBaudrate(brickletPort[, returnCallback][, errorCallback])¶

Parameters:	brickletPort – Type: char, Range: ['a' to 'b']
Callback Parameters:	baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Returns:	undefined

Returns the baudrate for a given Bricklet port, see setSPITFPBaudrate().

New in version 2.0.5 (Firmware).

BrickIMUV2.getSPITFPErrorCount(brickletPort[, returnCallback][, errorCallback])¶

Parameters:	brickletPort – Type: char, Range: ['a' to 'b']
Callback Parameters:	errorCountACKChecksum – Type: int, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1] errorCountFrame – Type: int, Range: [0 to 232 - 1] errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

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 Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.0.5 (Firmware).

BrickIMUV2.enableStatusLED([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Enables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

BrickIMUV2.disableStatusLED([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Disables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

BrickIMUV2.isStatusLEDEnabled([returnCallback][, errorCallback])¶

Callback Parameters:	enabled – Type: boolean, Default: true
Returns:	undefined

Returns true if the status LED is enabled, false otherwise.

BrickIMUV2.getChipTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-215 to 215 - 1]
Returns:	undefined

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

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

BrickIMUV2.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Calling this function will reset the Brick. Calling this function on a Brick inside of a stack will reset the whole stack.

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

BrickIMUV2.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['0' to '8'] 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 Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here. There is also a constant for the device identifier of this Brick.

Callback Configuration Functions¶

BrickIMUV2.on(callback_id, function[, errorCallback])¶

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.

BrickIMUV2.setAccelerationPeriod(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.

BrickIMUV2.getAccelerationPeriod([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 setAccelerationPeriod().

BrickIMUV2.setMagneticFieldPeriod(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_MAGNETIC_FIELD callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getMagneticFieldPeriod([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 setMagneticFieldPeriod().

BrickIMUV2.setAngularVelocityPeriod(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_ANGULAR_VELOCITY callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getAngularVelocityPeriod([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 setAngularVelocityPeriod().

BrickIMUV2.setTemperaturePeriod(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_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getTemperaturePeriod([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 setTemperaturePeriod().

BrickIMUV2.setOrientationPeriod(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_ORIENTATION callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getOrientationPeriod([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 setOrientationPeriod().

BrickIMUV2.setLinearAccelerationPeriod(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_LINEAR_ACCELERATION callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getLinearAccelerationPeriod([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 setLinearAccelerationPeriod().

BrickIMUV2.setGravityVectorPeriod(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_GRAVITY_VECTOR callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getGravityVectorPeriod([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 setGravityVectorPeriod().

BrickIMUV2.setQuaternionPeriod(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_QUATERNION callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getQuaternionPeriod([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 setQuaternionPeriod().

BrickIMUV2.setAllDataPeriod(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_ALL_DATA callback is triggered periodically. A value of 0 turns the callback off.

BrickIMUV2.getAllDataPeriod([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 setAllDataPeriod().

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:

imuV2.on(BrickIMUV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters are described below.

BrickIMUV2.CALLBACK_ACCELERATION¶

Callback Parameters:	x – Type: int, Unit: 1 cm/s², Range: ? y – Type: int, Unit: 1 cm/s², Range: ? z – Type: int, Unit: 1 cm/s², Range: ?

This callback is triggered periodically with the period that is set by setAccelerationPeriod(). The parameters are the acceleration for the x, y and z axis.

BrickIMUV2.CALLBACK_MAGNETIC_FIELD¶

Callback Parameters:	x – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] y – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] z – Type: int, Unit: 1/16 µT, Range: [-40000 to 40000]

This callback is triggered periodically with the period that is set by setMagneticFieldPeriod(). The parameters are the magnetic field for the x, y and z axis.

BrickIMUV2.CALLBACK_ANGULAR_VELOCITY¶

Callback Parameters:	x – Type: int, Unit: 1/16 °/s, Range: ? y – Type: int, Unit: 1/16 °/s, Range: ? z – Type: int, Unit: 1/16 °/s, Range: ?

This callback is triggered periodically with the period that is set by setAngularVelocityPeriod(). The parameters are the angular velocity for the x, y and z axis.

BrickIMUV2.CALLBACK_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-128 to 127]

This callback is triggered periodically with the period that is set by setTemperaturePeriod(). The parameter is the temperature.

BrickIMUV2.CALLBACK_LINEAR_ACCELERATION¶

Callback Parameters:	x – Type: int, Unit: 1 cm/s², Range: ? y – Type: int, Unit: 1 cm/s², Range: ? z – Type: int, Unit: 1 cm/s², Range: ?

This callback is triggered periodically with the period that is set by setLinearAccelerationPeriod(). The parameters are the linear acceleration for the x, y and z axis.

BrickIMUV2.CALLBACK_GRAVITY_VECTOR¶

Callback Parameters:	x – Type: int, Unit: 1 cm/s², Range: [-981 to 981] y – Type: int, Unit: 1 cm/s², Range: [-981 to 981] z – Type: int, Unit: 1 cm/s², Range: [-981 to 981]

This callback is triggered periodically with the period that is set by setGravityVectorPeriod(). The parameters gravity vector for the x, y and z axis.

BrickIMUV2.CALLBACK_ORIENTATION¶

Callback Parameters:	heading – Type: int, Unit: 1/16 °, Range: [0 to 5760] roll – Type: int, Unit: 1/16 °, Range: [-1440 to 1440] pitch – Type: int, Unit: 1/16 °, Range: [-2880 to 2880]

This callback is triggered periodically with the period that is set by setOrientationPeriod(). The parameters are the orientation (heading (yaw), roll, pitch) of the IMU Brick in Euler angles. See getOrientation() for details.

BrickIMUV2.CALLBACK_QUATERNION¶

Callback Parameters:	w – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] x – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] y – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] z – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]

This callback is triggered periodically with the period that is set by setQuaternionPeriod(). The parameters are the orientation (w, x, y, z) of the IMU Brick in quaternions. See getQuaternion() for details.

BrickIMUV2.CALLBACK_ALL_DATA¶

Callback Parameters:

acceleration – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1 cm/s², Range: ? 1: y – Type: int, Unit: 1 cm/s², Range: ? 2: z – Type: int, Unit: 1 cm/s², Range: ? magneticField – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] 1: y – Type: int, Unit: 1/16 µT, Range: [-20800 to 20800] 2: z – Type: int, Unit: 1/16 µT, Range: [-40000 to 40000] angularVelocity – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1/16 °/s, Range: ? 1: y – Type: int, Unit: 1/16 °/s, Range: ? 2: z – Type: int, Unit: 1/16 °/s, Range: ? eulerAngle – Type: [int, ...], Length: 3 0: heading – Type: int, Unit: 1/16 °, Range: [0 to 5760] 1: roll – Type: int, Unit: 1/16 °, Range: [-1440 to 1440] 2: pitch – Type: int, Unit: 1/16 °, Range: [-2880 to 2880] quaternion – Type: [int, ...], Length: 4 0: w – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 1: x – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 2: y – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 3: z – Type: int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] linearAcceleration – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1 cm/s², Range: ? 1: y – Type: int, Unit: 1 cm/s², Range: ? 2: z – Type: int, Unit: 1 cm/s², Range: ? gravityVector – Type: [int, ...], Length: 3 0: x – Type: int, Unit: 1 cm/s², Range: ? 1: y – Type: int, Unit: 1 cm/s², Range: ? 2: z – Type: int, Unit: 1 cm/s², Range: ? temperature – Type: int, Unit: 1 °C, Range: [-128 to 127] calibrationStatus – Type: int, Range: [0 to 255]

This callback is triggered periodically with the period that is set by setAllDataPeriod(). The parameters are as for getAllData().

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.

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

BrickIMUV2.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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickIMUV2.FUNCTION_LEDS_ON = 10
• BrickIMUV2.FUNCTION_LEDS_OFF = 11
• BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
• BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
• BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
• BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
• BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
• BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
• BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
• BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
• BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
• BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
• BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
• BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
• BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
• BrickIMUV2.FUNCTION_RESET = 243
• BrickIMUV2.FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickIMUV2.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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickIMUV2.FUNCTION_LEDS_ON = 10
• BrickIMUV2.FUNCTION_LEDS_OFF = 11
• BrickIMUV2.FUNCTION_SET_ACCELERATION_PERIOD = 14
• BrickIMUV2.FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
• BrickIMUV2.FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
• BrickIMUV2.FUNCTION_SET_TEMPERATURE_PERIOD = 20
• BrickIMUV2.FUNCTION_SET_ORIENTATION_PERIOD = 22
• BrickIMUV2.FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
• BrickIMUV2.FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
• BrickIMUV2.FUNCTION_SET_QUATERNION_PERIOD = 28
• BrickIMUV2.FUNCTION_SET_ALL_DATA_PERIOD = 30
• BrickIMUV2.FUNCTION_SET_SENSOR_CONFIGURATION = 41
• BrickIMUV2.FUNCTION_SET_SENSOR_FUSION_MODE = 43
• BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickIMUV2.FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickIMUV2.FUNCTION_ENABLE_STATUS_LED = 238
• BrickIMUV2.FUNCTION_DISABLE_STATUS_LED = 239
• BrickIMUV2.FUNCTION_RESET = 243
• BrickIMUV2.FUNCTION_WRITE_BRICKLET_PLUGIN = 246

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

Internal Functions¶

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

BrickIMUV2.getProtocol1BrickletName(port[, returnCallback][, errorCallback])¶

Parameters:	port – Type: char, Range: ['a' to 'b']
Callback Parameters:	protocolVersion – 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] name – Type: string, Length: up to 40
Returns:	undefined

Returns the firmware and protocol version and the name of the Bricklet for a given port.

This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.

BrickIMUV2.writeBrickletPlugin(port, offset, chunk[, returnCallback][, errorCallback])¶

Parameters:	port – Type: char, Range: ['a' to 'b'] offset – Type: int, Range: [0 to 255] chunk – Type: [int, ...], Length: 32, Range: [0 to 255]
Callback Parameters:	undefined
Returns:	undefined

Writes 32 bytes of firmware to the bricklet attached at the given port. The bytes are written to the position offset * 32.

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

BrickIMUV2.readBrickletPlugin(port, offset[, returnCallback][, errorCallback])¶

Parameters:	port – Type: char, Range: ['a' to 'b'] offset – Type: int, Range: [0 to 255]
Callback Parameters:	chunk – Type: [int, ...], Length: 32, Range: [0 to 255]
Returns:	undefined

Reads 32 bytes of firmware from the bricklet attached at the given port. The bytes are read starting at the position offset * 32.

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

Constants¶

BrickIMUV2.DEVICE_IDENTIFIER¶

This constant is used to identify a IMU Brick 2.0.

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.

BrickIMUV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a IMU Brick 2.0.