Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / Accelerometer Bricklet 2.0

JavaScript - Accelerometer Bricklet 2.0¶

Dies ist die Beschreibung der JavaScript API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 2.0 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)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var a = new Tinkerforge.BrickletAccelerometerV2(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/10000.0 + ' g');
                console.log('Acceleration [Y]: ' + y/10000.0 + ' g');
                console.log('Acceleration [Z]: ' + z/10000.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)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var a = new Tinkerforge.BrickletAccelerometerV2(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)
        a.setAccelerationCallbackConfiguration(1000, false);
    }
);

// Register acceleration callback
a.on(Tinkerforge.BrickletAccelerometerV2.CALLBACK_ACCELERATION,
    // Callback function for acceleration callback
    function (x, y, z) {
        console.log('Acceleration [X]: ' + x/10000.0 + ' g');
        console.log('Acceleration [Y]: ' + y/10000.0 + ' g');
        console.log('Acceleration [Z]: ' + z/10000.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)

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

Callback (HTML)¶

Download (ExampleCallback.html), Test (ExampleCallback.html)

<!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 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 a = new Tinkerforge.BrickletAccelerometerV2(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)
                        a.setAccelerationCallbackConfiguration(1000, false);
                    }
                );

                // Register acceleration callback
                a.on(Tinkerforge.BrickletAccelerometerV2.CALLBACK_ACCELERATION,
                    // Callback function for acceleration callback
                    function (x, y, z) {
                        textArea.value += 'Acceleration [X]: ' + x/10000.0 + ' g\n';
                        textArea.value += 'Acceleration [Y]: ' + y/10000.0 + ' g\n';
                        textArea.value += 'Acceleration [Z]: ' + z/10000.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
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen¶

new BrickletAccelerometerV2(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	accelerometerV2 – Typ: BrickletAccelerometerV2

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

var accelerometerV2 = new BrickletAccelerometerV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

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

Callback-Parameter:	x – Typ: int, Einheit: 1/10000 gₙ, Wertebereich: ? y – Typ: int, Einheit: 1/10000 gₙ, Wertebereich: ? z – Typ: int, Einheit: 1/10000 gₙ, Wertebereich: ?
Rückgabe:	undefined

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/10000 (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 setAccelerationCallbackConfiguration() vorzugeben.

BrickletAccelerometerV2.setConfiguration(dataRate, fullScale[, returnCallback][, errorCallback])¶

Parameter:	dataRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7 fullScale – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

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

Datenrate zwischen 0,781Hz und 25600Hz.
Wertebereich von ±2g bis zu ±8g.

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:

BrickletAccelerometerV2.DATA_RATE_0_781HZ = 0
BrickletAccelerometerV2.DATA_RATE_1_563HZ = 1
BrickletAccelerometerV2.DATA_RATE_3_125HZ = 2
BrickletAccelerometerV2.DATA_RATE_6_2512HZ = 3
BrickletAccelerometerV2.DATA_RATE_12_5HZ = 4
BrickletAccelerometerV2.DATA_RATE_25HZ = 5
BrickletAccelerometerV2.DATA_RATE_50HZ = 6
BrickletAccelerometerV2.DATA_RATE_100HZ = 7
BrickletAccelerometerV2.DATA_RATE_200HZ = 8
BrickletAccelerometerV2.DATA_RATE_400HZ = 9
BrickletAccelerometerV2.DATA_RATE_800HZ = 10
BrickletAccelerometerV2.DATA_RATE_1600HZ = 11
BrickletAccelerometerV2.DATA_RATE_3200HZ = 12
BrickletAccelerometerV2.DATA_RATE_6400HZ = 13
BrickletAccelerometerV2.DATA_RATE_12800HZ = 14
BrickletAccelerometerV2.DATA_RATE_25600HZ = 15

Für full_scale:

BrickletAccelerometerV2.FULL_SCALE_2G = 0
BrickletAccelerometerV2.FULL_SCALE_4G = 1
BrickletAccelerometerV2.FULL_SCALE_8G = 2

BrickletAccelerometerV2.getConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	dataRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7 fullScale – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
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:

BrickletAccelerometerV2.DATA_RATE_0_781HZ = 0
BrickletAccelerometerV2.DATA_RATE_1_563HZ = 1
BrickletAccelerometerV2.DATA_RATE_3_125HZ = 2
BrickletAccelerometerV2.DATA_RATE_6_2512HZ = 3
BrickletAccelerometerV2.DATA_RATE_12_5HZ = 4
BrickletAccelerometerV2.DATA_RATE_25HZ = 5
BrickletAccelerometerV2.DATA_RATE_50HZ = 6
BrickletAccelerometerV2.DATA_RATE_100HZ = 7
BrickletAccelerometerV2.DATA_RATE_200HZ = 8
BrickletAccelerometerV2.DATA_RATE_400HZ = 9
BrickletAccelerometerV2.DATA_RATE_800HZ = 10
BrickletAccelerometerV2.DATA_RATE_1600HZ = 11
BrickletAccelerometerV2.DATA_RATE_3200HZ = 12
BrickletAccelerometerV2.DATA_RATE_6400HZ = 13
BrickletAccelerometerV2.DATA_RATE_12800HZ = 14
BrickletAccelerometerV2.DATA_RATE_25600HZ = 15

Für full_scale:

BrickletAccelerometerV2.FULL_SCALE_2G = 0
BrickletAccelerometerV2.FULL_SCALE_4G = 1
BrickletAccelerometerV2.FULL_SCALE_8G = 2

BrickletAccelerometerV2.setInfoLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

Für config:

BrickletAccelerometerV2.INFO_LED_CONFIG_OFF = 0
BrickletAccelerometerV2.INFO_LED_CONFIG_ON = 1
BrickletAccelerometerV2.INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

BrickletAccelerometerV2.getInfoLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	undefined

Gibt die LED-Konfiguration zurück, wie von setInfoLEDConfig() gesetzt.

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

Für config:

BrickletAccelerometerV2.INFO_LED_CONFIG_OFF = 0
BrickletAccelerometerV2.INFO_LED_CONFIG_ON = 1
BrickletAccelerometerV2.INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

Fortgeschrittene Funktionen¶

BrickletAccelerometerV2.setFilterConfiguration(iirBypass, lowPassFilter[, returnCallback][, errorCallback])¶

Parameter:	iirBypass – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 lowPassFilter – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Konfiguriert den IIR Bypass Filter Modus und die Grenzfrequenz des Tiefpassfilters.

Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe oder ein Neuntel der Ausgabe-Datenrate sein.

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

Für iir_bypass:

BrickletAccelerometerV2.IIR_BYPASS_APPLIED = 0
BrickletAccelerometerV2.IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

BrickletAccelerometerV2.LOW_PASS_FILTER_NINTH = 0
BrickletAccelerometerV2.LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

BrickletAccelerometerV2.getFilterConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	iirBypass – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 lowPassFilter – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	undefined

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

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

Für iir_bypass:

BrickletAccelerometerV2.IIR_BYPASS_APPLIED = 0
BrickletAccelerometerV2.IIR_BYPASS_BYPASSED = 1

Für low_pass_filter:

BrickletAccelerometerV2.LOW_PASS_FILTER_NINTH = 0
BrickletAccelerometerV2.LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

BrickletAccelerometerV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletAccelerometerV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

BrickletAccelerometerV2.STATUS_LED_CONFIG_OFF = 0
BrickletAccelerometerV2.STATUS_LED_CONFIG_ON = 1
BrickletAccelerometerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAccelerometerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletAccelerometerV2.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

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

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

Für config:

BrickletAccelerometerV2.STATUS_LED_CONFIG_OFF = 0
BrickletAccelerometerV2.STATUS_LED_CONFIG_ON = 1
BrickletAccelerometerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAccelerometerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	undefined

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

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

Callback-Parameter:	undefined
Rückgabe:	undefined

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

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

Callback-Parameter:

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', '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 2¹⁶ - 1]
Rückgabe:	undefined

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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¶

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

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.

BrickletAccelerometerV2.setAccelerationCallbackConfiguration(period, valueHasToChange[, returnCallback][, errorCallback])¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false
Callback-Parameter:	undefined
Rückgabe:	undefined

Die Periode ist die Periode mit der der CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Wenn dieser Callback aktiviert ist, werden der CALLBACK_CONTINUOUS_ACCELERATION_16_BIT Callback und CALLBACK_CONTINUOUS_ACCELERATION_8_BIT Callback automatisch deaktiviert.

BrickletAccelerometerV2.getAccelerationCallbackConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false
Rückgabe:	undefined

Gibt die Callback-Konfiguration zurück, wie mittels setAccelerationCallbackConfiguration() gesetzt.

BrickletAccelerometerV2.setContinuousAccelerationConfiguration(enableX, enableY, enableZ, resolution[, returnCallback][, errorCallback])¶

Parameter:	enableX – Typ: boolean, Standardwert: false enableY – Typ: boolean, Standardwert: false enableZ – Typ: boolean, Standardwert: false resolution – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die CALLBACK_CONTINUOUS_ACCELERATION_16_BIT oder CALLBACK_CONTINUOUS_ACCELERATION_8_BIT Callbacks genutzt werden.

Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.

Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung, wird der CALLBACK_CONTINUOUS_ACCELERATION_8_BIT-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der CALLBACK_CONTINUOUS_ACCELERATION_16_BIT-Callback aktiviert.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von getAcceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem eingestellten Wertebereich (siehe setConfiguration()):

16-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
16-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
16-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024

Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:

8-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
8-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
8-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024

Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der "Continuous Callbacks" genutzt wird, wird der CALLBACK_ACCELERATION-Callback automatisch deaktiviert.

Der maximale Durchsatz hängt von der Konfiguration ab:

Anzahl aktiviert Achsen	Durchsatz 8-Bit	Durchsatz 16-Bit
1	25600Hz	25600Hz
2	25600Hz	15000Hz
3	20000Hz	10000Hz

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

Für resolution:

BrickletAccelerometerV2.RESOLUTION_8BIT = 0
BrickletAccelerometerV2.RESOLUTION_16BIT = 1

BrickletAccelerometerV2.getContinuousAccelerationConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	enableX – Typ: boolean, Standardwert: false enableY – Typ: boolean, Standardwert: false enableZ – Typ: boolean, Standardwert: false resolution – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	undefined

Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels setContinuousAccelerationConfiguration() gesetzt.

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

Für resolution:

BrickletAccelerometerV2.RESOLUTION_8BIT = 0
BrickletAccelerometerV2.RESOLUTION_16BIT = 1

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:

accelerometerV2.on(BrickletAccelerometerV2.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.

BrickletAccelerometerV2.CALLBACK_ACCELERATION¶

Callback-Parameter:	x – Typ: int, Einheit: 1/10000 gₙ, Wertebereich: ? y – Typ: int, Einheit: 1/10000 gₙ, Wertebereich: ? z – Typ: int, Einheit: 1/10000 gₙ, Wertebereich: ?

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setAccelerationCallbackConfiguration() gesetzten Konfiguration.

Die Parameter sind die gleichen wie getAcceleration().

BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_16_BIT¶

Callback-Parameter:	acceleration – Typ: [int, ...], Länge: 30, Einheit: ? gₙ, Wertebereich: ?

Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate kann mit der Funktion setConfiguration() eingestellt werden und der Callback kann per setContinuousAccelerationConfiguration() aktiviert werden.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von getAcceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe setConfiguration()):

Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

x, y, z aktiviert: "x, y, z, ..." 10x wiederholt
x, z aktiviert: "x, z, ..." 15x wiederholt
y aktiviert: "y, ..." 30x wiederholt

BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_8_BIT¶

Callback-Parameter:	acceleration – Typ: [int, ...], Länge: 60, Einheit: ? gₙ, Wertebereich: ?

Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate kann mit der Funktion setConfiguration() eingestellt werden und der Callback kann per setContinuousAccelerationConfiguration() aktiviert werden.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit gₙ/10000 (gleiche Einheit wie von getAcceleration() zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe setConfiguration()):

Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

x, y, z aktiviert: "x, y, z, ..." 20x wiederholt
x, z aktiviert: "x, z, ..." 30x wiederholt
y aktiviert: "y, ..." 60x wiederholt

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.

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

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

BrickletAccelerometerV2.FUNCTION_SET_CONFIGURATION = 2
BrickletAccelerometerV2.FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
BrickletAccelerometerV2.FUNCTION_SET_INFO_LED_CONFIG = 6
BrickletAccelerometerV2.FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
BrickletAccelerometerV2.FUNCTION_SET_FILTER_CONFIGURATION = 13
BrickletAccelerometerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAccelerometerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAccelerometerV2.FUNCTION_RESET = 243
BrickletAccelerometerV2.FUNCTION_WRITE_UID = 248

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

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

Für function_id:

BrickletAccelerometerV2.FUNCTION_SET_CONFIGURATION = 2
BrickletAccelerometerV2.FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
BrickletAccelerometerV2.FUNCTION_SET_INFO_LED_CONFIG = 6
BrickletAccelerometerV2.FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
BrickletAccelerometerV2.FUNCTION_SET_FILTER_CONFIGURATION = 13
BrickletAccelerometerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAccelerometerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAccelerometerV2.FUNCTION_RESET = 243
BrickletAccelerometerV2.FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletAccelerometerV2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	status – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

BrickletAccelerometerV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletAccelerometerV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletAccelerometerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletAccelerometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletAccelerometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletAccelerometerV2.BOOTLOADER_STATUS_OK = 0
BrickletAccelerometerV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletAccelerometerV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletAccelerometerV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletAccelerometerV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletAccelerometerV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletAccelerometerV2.getBootloaderMode([returnCallback][, errorCallback])¶

Callback-Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

BrickletAccelerometerV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletAccelerometerV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletAccelerometerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletAccelerometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletAccelerometerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletAccelerometerV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletAccelerometerV2.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Callback-Parameter:	status – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletAccelerometerV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletAccelerometerV2.readUID([returnCallback][, errorCallback])¶

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

BrickletAccelerometerV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Accelerometer Bricklet 2.0 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.

BrickletAccelerometerV2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.