JavaScript - Accelerometer Bricklet

Dies ist die Beschreibung der JavaScript API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die JavaScript API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist 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

Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Funktion als Argumente aufgerufen, falls die Funktion ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

  • 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

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen

new BrickletAccelerometer(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • accelerometer – Typ: BrickletAccelerometer

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletAccelerometer.getAcceleration([returnCallback][, errorCallback])
Callback-Parameter:
  • x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
Rückgabe:
  • undefined

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/1000 (1gₙ = 9,80665m/s²). Der Wertebereich wird mit setConfiguration() konfiguriert.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit setAccelerationCallbackPeriod() vorzugeben.

BrickletAccelerometer.getTemperature([returnCallback][, errorCallback])
Callback-Parameter:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-103 bis 152]
Rückgabe:
  • undefined

Gibt die Temperatur des Beschleunigungssensors zurück.

BrickletAccelerometer.ledOn([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Aktiviert die LED auf dem Bricklet.

BrickletAccelerometer.ledOff([returnCallback][, errorCallback])
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Deaktiviert die LED auf dem Bricklet.

BrickletAccelerometer.isLEDOn([returnCallback][, errorCallback])
Callback-Parameter:
  • on – Typ: boolean, Standardwert: false
Rückgabe:
  • undefined

Gibt true zurück wenn die LED aktiviert ist, false sonst.

Fortgeschrittene Funktionen

BrickletAccelerometer.setConfiguration(dataRate, fullScale, filterBandwidth[, returnCallback][, errorCallback])
Parameter:
  • dataRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6
  • fullScale – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • filterBandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:

  • Datenrate zwischen 0Hz und 1600Hz.
  • Wertebereich von ±2gₙ bis zu ±16gₙ.
  • Filterbandbreite zwischen 50Hz und 800Hz.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Für 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

Für 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-Parameter:
  • dataRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6
  • fullScale – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • filterBandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:
  • undefined

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Für 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

Für 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-Parameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • undefined

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletAccelerometer.on(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: function
Rückgabe:
  • undefined

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletAccelerometer.setAccelerationCallbackPeriod(period[, returnCallback][, errorCallback])
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Periode mit welcher der CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_ACCELERATION Callback wird nur ausgelöst, wenn sich die Acceleration seit der letzten Auslösung geändert hat.

BrickletAccelerometer.getAccelerationCallbackPeriod([returnCallback][, errorCallback])
Callback-Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • undefined

Gibt die Periode zurück, wie von setAccelerationCallbackPeriod() gesetzt.

BrickletAccelerometer.setAccelerationCallbackThreshold(option, minX, maxX, minY, maxY, minZ, maxZ[, returnCallback][, errorCallback])
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • minX – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxX – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • minY – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxY – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • minZ – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxZ – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Schwellwert für den CALLBACK_ACCELERATION_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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-Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • minX – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxX – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • minY – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxY – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • minZ – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxZ – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • undefined

Gibt den Schwellwert zurück, wie von setAccelerationCallbackThreshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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])
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletAccelerometer.getDebouncePeriod([returnCallback][, errorCallback])
Callback-Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • undefined

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

accelerometer.on(BrickletAccelerometer.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletAccelerometer.CALLBACK_ACCELERATION
Callback-Parameter:
  • x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit setAccelerationCallbackPeriod(), ausgelöst. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit setConfiguration() konfiguriert.

Der CALLBACK_ACCELERATION Callback wird nur ausgelöst, wenn sich die Beschleunigung seit der letzten Auslösung geändert hat.

BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED
Callback-Parameter:
  • x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAccelerationCallbackThreshold() gesetzt, erreicht wird. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit setConfiguration() konfiguriert.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletAccelerometer.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletAccelerometer.getResponseExpected(functionId[, errorCallback])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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])
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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)
Parameter:
  • responseExpected – Typ: boolean
Rückgabe:
  • undefined

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickletAccelerometer.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Accelerometer Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletAccelerometer.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.