JavaScript - Load Cell Bricklet

Dies ist die Beschreibung der JavaScript API Bindings für das Load Cell Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Load Cell 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
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lc = new Tinkerforge.BrickletLoadCell(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 weight
        lc.getWeight(
            function (weight) {
                console.log('Weight: ' + weight + ' 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
var Tinkerforge = require('tinkerforge');

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

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

// Register weight callback
lc.on(Tinkerforge.BrickletLoadCell.CALLBACK_WEIGHT,
    // Callback function for weight callback
    function (weight) {
        console.log('Weight: ' + weight + ' g');
    }
);

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

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lc = new Tinkerforge.BrickletLoadCell(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 1 second (1000ms)
        lc.setDebouncePeriod(1000);

        // Configure threshold for weight "greater than 200 g"
        lc.setWeightCallbackThreshold('>', 200, 0);
    }
);

// Register weight reached callback
lc.on(Tinkerforge.BrickletLoadCell.CALLBACK_WEIGHT_REACHED,
    // Callback function for weight reached callback
    function (weight) {
        console.log('Weight: ' + weight + ' g');
    }
);

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
<!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>Load Cell 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 lc = new Tinkerforge.BrickletLoadCell(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 weight
                        lc.getWeight(
                            function (weight) {
                                textArea.value += 'Weight: ' + weight + ' 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
<!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>Load Cell 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 lc = new Tinkerforge.BrickletLoadCell(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 weight callback to 1s (1000ms)
                        // Note: The weight callback is only called every second
                        //       if the weight has changed since the last call!
                        lc.setWeightCallbackPeriod(1000);
                    }
                );

                // Register weight callback
                lc.on(Tinkerforge.BrickletLoadCell.CALLBACK_WEIGHT,
                    // Callback function for weight callback
                    function (weight) {
                        textArea.value += 'Weight: ' + weight + ' g\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
<!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>Load Cell 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 lc = new Tinkerforge.BrickletLoadCell(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 1 second (1000ms)
                        lc.setDebouncePeriod(1000);

                        // Configure threshold for weight "greater than 200 g"
                        lc.setWeightCallbackThreshold('>', 200, 0);
                    }
                );

                // Register weight reached callback
                lc.on(Tinkerforge.BrickletLoadCell.CALLBACK_WEIGHT_REACHED,
                    // Callback function for weight reached callback
                    function (weight) {
                        textArea.value += 'Weight: ' + weight + ' g\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 BrickletLoadCell(uid, ipcon)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: IPConnection
Rückgabe:
  • loadCell – Typ: BrickletLoadCell

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

var loadCell = new BrickletLoadCell("YOUR_DEVICE_UID", ipcon)

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

BrickletLoadCell.getWeight([returnCallback][, errorCallback])
Callback-Parameter:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • undefined

Gibt das aktuell gemessene Gewicht zurück.

Wenn das Gewicht periodisch abgefragt werden soll, wird empfohlen den CALLBACK_WEIGHT Callback zu nutzen und die Periode mit setWeightCallbackPeriod() vorzugeben.

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

Aktiviert die LED.

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

Deaktiviert die LED.

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

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

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

Setzt das aktuell gemessene Gewicht als Leergewicht.

Fortgeschrittene Funktionen

BrickletLoadCell.setMovingAverage(average[, returnCallback][, errorCallback])
Parameter:
  • average – Typ: int, Wertebereich: [1 bis 40], Standardwert: 4
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt die Länge eines gleitenden Mittelwerts für den Gewichtswert.

Wenn die Länge auf 1 gesetzt wird, ist das Averaging aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

BrickletLoadCell.getMovingAverage([returnCallback][, errorCallback])
Callback-Parameter:
  • average – Typ: int, Wertebereich: [1 bis 40], Standardwert: 4
Rückgabe:
  • undefined

Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.

BrickletLoadCell.calibrate(weight[, returnCallback][, errorCallback])
Parameter:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [0 bis 232 - 1]
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Zum Kalibrieren des Load Cell Bricklet müssen die folgenden zwei Schritte durchgeführt werden:

  • Die Waage leeren und die Funktion mit 0 aufrufen.
  • Eine bekanntes Gewicht auf die Waage legen und die Funktion mit dem Gewicht aufrufen.

Die Kalibrierung wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Kalibrierung über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

BrickletLoadCell.setConfiguration(rate, gain[, returnCallback][, errorCallback])
Parameter:
  • rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gain – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Für die Messungen sind Rate und Gain konfigurierbar.

Die Rate kann auf 10Hz oder 80Hz gesetzt werden. Eine schnellere Rate erzeugt mehr Störungen. Zusätzlich ist es möglich einen gleitenden Mittelwert auf die Werte anzuwenden (siehe setMovingAverage()).

Der Gain kann zwischen 128x, 64x und 32x konfiguriert werden. Er repräsentiert einen Messbereich von ±20mV, ±40mV und ±80mV respektive. Das Load Cell Bricklet nutzt eine Erregerspannung (Excitation Voltage) von 5V und die meisten Wägezellen haben eine Ausgabe von 2mV/V. Dies bedeutet, der Spannungsbereich ist ±15mV für die meisten Wägezellen (d.h. ein Gain von 128x ist am geeignetsten). Falls nicht klar ist was dies alles bedeutet, ein Gain von 128x ist höchstwahrscheinlich korrekt.

Die Konfiguration wird auf dem EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

Wir empfehlen die Konfiguration über den Brick Viewer zu setzen, diese Funktion muss nicht im Quelltext genutzt werden.

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

Für rate:

  • BrickletLoadCell.RATE_10HZ = 0
  • BrickletLoadCell.RATE_80HZ = 1

Für gain:

  • BrickletLoadCell.GAIN_128X = 0
  • BrickletLoadCell.GAIN_64X = 1
  • BrickletLoadCell.GAIN_32X = 2
BrickletLoadCell.getConfiguration([returnCallback][, errorCallback])
Callback-Parameter:
  • rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • gain – 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 rate:

  • BrickletLoadCell.RATE_10HZ = 0
  • BrickletLoadCell.RATE_80HZ = 1

Für gain:

  • BrickletLoadCell.GAIN_128X = 0
  • BrickletLoadCell.GAIN_64X = 1
  • BrickletLoadCell.GAIN_32X = 2
BrickletLoadCell.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

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

BrickletLoadCell.setWeightCallbackPeriod(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_WEIGHT Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_WEIGHT Callback wird nur ausgelöst, wenn sich das Gewicht seit der letzten Auslösung geändert hat.

BrickletLoadCell.getWeightCallbackPeriod([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 setWeightCallbackPeriod() gesetzt.

BrickletLoadCell.setWeightCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Callback-Parameter:
  • undefined
Rückgabe:
  • undefined

Setzt den Schwellwert für den CALLBACK_WEIGHT_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletLoadCell.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCell.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCell.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCell.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCell.THRESHOLD_OPTION_GREATER = '>'
BrickletLoadCell.getWeightCallbackThreshold([returnCallback][, errorCallback])
Callback-Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • undefined

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

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

Für option:

  • BrickletLoadCell.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLoadCell.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLoadCell.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLoadCell.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLoadCell.THRESHOLD_OPTION_GREATER = '>'
BrickletLoadCell.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.

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

loadCell.on(BrickletLoadCell.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.

BrickletLoadCell.CALLBACK_WEIGHT
Callback-Parameter:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setWeightCallbackPeriod(), ausgelöst. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

Der CALLBACK_WEIGHT Callback wird nur ausgelöst, wenn sich das Gewicht seit der letzten Auslösung geändert hat.

BrickletLoadCell.CALLBACK_WEIGHT_REACHED
Callback-Parameter:
  • weight – Typ: int, Einheit: 1 g, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setWeightCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist das Gewicht wie von der Wägezelle gemessen.

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.

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

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

  • BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
  • BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
  • BrickletLoadCell.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletLoadCell.FUNCTION_SET_MOVING_AVERAGE = 8
  • BrickletLoadCell.FUNCTION_LED_ON = 10
  • BrickletLoadCell.FUNCTION_LED_OFF = 11
  • BrickletLoadCell.FUNCTION_CALIBRATE = 13
  • BrickletLoadCell.FUNCTION_TARE = 14
  • BrickletLoadCell.FUNCTION_SET_CONFIGURATION = 15
BrickletLoadCell.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:

  • BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
  • BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
  • BrickletLoadCell.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletLoadCell.FUNCTION_SET_MOVING_AVERAGE = 8
  • BrickletLoadCell.FUNCTION_LED_ON = 10
  • BrickletLoadCell.FUNCTION_LED_OFF = 11
  • BrickletLoadCell.FUNCTION_CALIBRATE = 13
  • BrickletLoadCell.FUNCTION_TARE = 14
  • BrickletLoadCell.FUNCTION_SET_CONFIGURATION = 15
BrickletLoadCell.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

BrickletLoadCell.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Load Cell 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.

BrickletLoadCell.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Load Cell Bricklet dar.