JavaScript - DC Bricklet 2.0¶

Configuration (Node.js)¶

Download (ExampleConfiguration.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 DC Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dc = new Tinkerforge.BrickletDCV2(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) {
        dc.setDriveMode(Tinkerforge.BrickletDCV2.DRIVE_MODE_DRIVE_COAST);
        dc.setPWMFrequency(10000); // Use PWM frequency of 10 kHz
        dc.setMotion(4096,
                     16384); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
        dc.setVelocity(32767); // Full speed forward (100 %)
        dc.setEnabled(true); // Enable motor power
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        dc.setVelocity(0); // Stop motor before disabling motor power

        setTimeout(function () {
            dc.setEnabled(false); // Disable motor power

            ipcon.disconnect();
            process.exit(0);
        }, 2000); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    }
);

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dc = new Tinkerforge.BrickletDCV2(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) {
        // The acceleration has to be smaller or equal to the maximum
        // acceleration of the DC motor, otherwise the velocity reached
        // callback will be called too early
        dc.setMotion(4096,
                     16384); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
        dc.setVelocity(32767); // Full speed forward (100 %)

        // Enable motor power
        dc.setEnabled(true);
    }
);

// Register velocity reached callback
dc.on(Tinkerforge.BrickletDCV2.CALLBACK_VELOCITY_REACHED,
    // Use velocity reached callback to swing back and forth
    // between full speed forward and full speed backward
    function (velocity) {
        if(velocity == 32767) {
            console.log('Velocity: Full speed forward, now turning backward');
            dc.setVelocity(-32767);
        }
        else if(velocity === -32767) {
            console.log('Velocity: Full speed backward, now turning forward');
            dc.setVelocity(32767);
        }
        else {
            console.log('Error'); // Can only happen if another program sets velocity
        }
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        dc.setVelocity(0); // Stop motor before disabling motor power

        setTimeout(function () {
            dc.setEnabled(false); // Disable motor power

            ipcon.disconnect();
            process.exit(0);
        }, 2000); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    }
);

Configuration (HTML)¶

Download (ExampleConfiguration.html), Test (ExampleConfiguration.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

<!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>DC Bricklet 2.0 Configuration 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 dc = new Tinkerforge.BrickletDCV2(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) {
                        dc.setDriveMode(Tinkerforge.BrickletDCV2.DRIVE_MODE_DRIVE_COAST);
                        dc.setPWMFrequency(10000); // Use PWM frequency of 10 kHz
                        dc.setMotion(4096,
                                     16384); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
                        dc.setVelocity(32767); // Full speed forward (100 %)
                        dc.setEnabled(true); // Enable motor power
                    }
                );
            }
        </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
66
67
68
69
70
71
72
73
74
75
76
77
78
79

<!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>DC 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 dc = new Tinkerforge.BrickletDCV2(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) {
                        // The acceleration has to be smaller or equal to the maximum
                        // acceleration of the DC motor, otherwise the velocity reached
                        // callback will be called too early
                        dc.setMotion(4096,
                                     16384); // Slow acceleration (12.5 %/s), fast decceleration (50 %/s) for stopping
                        dc.setVelocity(32767); // Full speed forward (100 %)

                        // Enable motor power
                        dc.setEnabled(true);
                    }
                );

                // Register velocity reached callback
                dc.on(Tinkerforge.BrickletDCV2.CALLBACK_VELOCITY_REACHED,
                    // Use velocity reached callback to swing back and forth
                    // between full speed forward and full speed backward
                    function (velocity) {
                        if(velocity == 32767) {
                            textArea.value += 'Velocity: Full speed forward, now turning backward\n';
                            dc.setVelocity(-32767);
                        }
                        else if(velocity === -32767) {
                            textArea.value += 'Velocity: Full speed backward, now turning forward\n';
                            dc.setVelocity(32767);
                        }
                        else {
                            textArea.value += 'Error\n'; // Can only happen if another program sets velocity
                        }
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Grundfunktionen¶

new BrickletDCV2(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	dcV2 – Typ: BrickletDCV2

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

var dcV2 = new BrickletDCV2("YOUR_DEVICE_UID", ipcon)

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

BrickletDCV2.setEnabled(enabled[, returnCallback][, errorCallback])¶

Parameter:	enabled – Typ: boolean
Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

BrickletDCV2.getEnabled([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: false
Rückgabe:	undefined

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

BrickletDCV2.setVelocity(velocity[, returnCallback][, errorCallback])¶

Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe setMotion()) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe setPWMFrequency().

BrickletDCV2.getVelocity([returnCallback][, errorCallback])¶

Callback-Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0
Rückgabe:	undefined

Gibt die Geschwindigkeit zurück, wie gesetzt von setVelocity().

BrickletDCV2.getCurrentVelocity([returnCallback][, errorCallback])¶

Callback-Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0
Rückgabe:	undefined

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von getVelocity(), sobald der Motor auf einen neuen Zielwert, wie von setVelocity() vorgegeben, beschleunigt.

BrickletDCV2.setMotion(acceleration, deceleration[, returnCallback][, errorCallback])¶

Parameter:	acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Beschleunigung/Debeschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.

BrickletDCV2.getMotion([returnCallback][, errorCallback])¶

Callback-Parameter:	acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:	undefined

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von setMotion().

BrickletDCV2.fullBrake([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von setVelocity() mit 0 erlaubt einen normalen Stopp des Motors.

BrickletDCV2.getPWMFrequency([returnCallback][, errorCallback])¶

Callback-Parameter:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Rückgabe:	undefined

Gibt die PWM Frequenz zurück, wie gesetzt von setPWMFrequency().

BrickletDCV2.getPowerStatistics([returnCallback][, errorCallback])¶

Callback-Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
Rückgabe:	undefined

Gibt die Eingangsspannung und den Stromverbrauch des Treibers zurück.

Fortgeschrittene Funktionen¶

BrickletDCV2.setDriveMode(mode[, returnCallback][, errorCallback])¶

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

Setzt den Fahrmodus. Verfügbare Modi sind:

• 0 = Fahren/Bremsen
• 1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

• BrickletDCV2.DRIVE_MODE_DRIVE_BRAKE = 0
• BrickletDCV2.DRIVE_MODE_DRIVE_COAST = 1

BrickletDCV2.getDriveMode([returnCallback][, errorCallback])¶

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

Gibt den Fahrmodus zurück, wie von setDriveMode() gesetzt.

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

Für mode:

• BrickletDCV2.DRIVE_MODE_DRIVE_BRAKE = 0
• BrickletDCV2.DRIVE_MODE_DRIVE_COAST = 1

BrickletDCV2.setPWMFrequency(frequency[, returnCallback][, errorCallback])¶

Parameter:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

BrickletDCV2.setErrorLEDConfig(config[, returnCallback][, errorCallback])¶

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

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.

Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:

• Aus: Es liegt kein Fehler vor.
• 1s Intervall-Blinken: Eingangsspannung zu klein (unter 6V).
• 250ms Intervall-Blinken: Übertemperatur oder Überstrom.

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

Für config:

• BrickletDCV2.ERROR_LED_CONFIG_OFF = 0
• BrickletDCV2.ERROR_LED_CONFIG_ON = 1
• BrickletDCV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2.ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletDCV2.getErrorLEDConfig([returnCallback][, errorCallback])¶

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

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

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

Für config:

• BrickletDCV2.ERROR_LED_CONFIG_OFF = 0
• BrickletDCV2.ERROR_LED_CONFIG_ON = 1
• BrickletDCV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2.ERROR_LED_CONFIG_SHOW_ERROR = 3

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

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 232 - 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.

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

• BrickletDCV2.STATUS_LED_CONFIG_OFF = 0
• BrickletDCV2.STATUS_LED_CONFIG_ON = 1
• BrickletDCV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

• BrickletDCV2.STATUS_LED_CONFIG_OFF = 0
• BrickletDCV2.STATUS_LED_CONFIG_ON = 1
• BrickletDCV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDCV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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.

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

BrickletDCV2.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', '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 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¶

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

BrickletDCV2.setEmergencyShutdownCallbackConfiguration(enabled[, returnCallback][, errorCallback])¶

Parameter:	enabled – Typ: boolean, Standardwert: false
Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert/Deaktiviert CALLBACK_EMERGENCY_SHUTDOWN Callback.

BrickletDCV2.getEmergencyShutdownCallbackConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: true
Rückgabe:	undefined

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

BrickletDCV2.setVelocityReachedCallbackConfiguration(enabled[, returnCallback][, errorCallback])¶

Parameter:	enabled – Typ: boolean, Standardwert: false
Callback-Parameter:	undefined
Rückgabe:	undefined

Aktiviert/Deaktiviert CALLBACK_VELOCITY_REACHED Callback.

BrickletDCV2.getVelocityReachedCallbackConfiguration([returnCallback][, errorCallback])¶

Callback-Parameter:	enabled – Typ: boolean, Standardwert: false
Rückgabe:	undefined

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

BrickletDCV2.setCurrentVelocityCallbackConfiguration(period, valueHasToChange[, returnCallback][, errorCallback])¶

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

Die Periode ist die Periode mit der der CALLBACK_CURRENT_VELOCITY 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.

BrickletDCV2.getCurrentVelocityCallbackConfiguration([returnCallback][, errorCallback])¶

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

Gibt die Callback-Konfiguration zurück, wie mittels setCurrentVelocityCallbackConfiguration() 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:

dcV2.on(BrickletDCV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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

BrickletDCV2.CALLBACK_EMERGENCY_SHUTDOWN¶

Callback-Parameter:	undefined

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet setEnabled() muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe setDriveMode()). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

BrickletDCV2.CALLBACK_VELOCITY_REACHED¶

Callback-Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der CALLBACK_VELOCITY_REACHED Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe setMotion()) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

BrickletDCV2.CALLBACK_CURRENT_VELOCITY¶

Callback-Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setCurrentVelocityCallbackConfiguration(), ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der CALLBACK_CURRENT_VELOCITY Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

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.

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

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

• BrickletDCV2.FUNCTION_SET_ENABLED = 1
• BrickletDCV2.FUNCTION_SET_VELOCITY = 3
• BrickletDCV2.FUNCTION_SET_MOTION = 6
• BrickletDCV2.FUNCTION_FULL_BRAKE = 8
• BrickletDCV2.FUNCTION_SET_DRIVE_MODE = 9
• BrickletDCV2.FUNCTION_SET_PWM_FREQUENCY = 11
• BrickletDCV2.FUNCTION_SET_ERROR_LED_CONFIG = 14
• BrickletDCV2.FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
• BrickletDCV2.FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
• BrickletDCV2.FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
• BrickletDCV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDCV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDCV2.FUNCTION_RESET = 243
• BrickletDCV2.FUNCTION_WRITE_UID = 248

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

• BrickletDCV2.FUNCTION_SET_ENABLED = 1
• BrickletDCV2.FUNCTION_SET_VELOCITY = 3
• BrickletDCV2.FUNCTION_SET_MOTION = 6
• BrickletDCV2.FUNCTION_FULL_BRAKE = 8
• BrickletDCV2.FUNCTION_SET_DRIVE_MODE = 9
• BrickletDCV2.FUNCTION_SET_PWM_FREQUENCY = 11
• BrickletDCV2.FUNCTION_SET_ERROR_LED_CONFIG = 14
• BrickletDCV2.FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
• BrickletDCV2.FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
• BrickletDCV2.FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
• BrickletDCV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDCV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDCV2.FUNCTION_RESET = 243
• BrickletDCV2.FUNCTION_WRITE_UID = 248

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

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

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

Für status:

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

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

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

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

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 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.

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

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

Parameter:	uid – Typ: int, Wertebereich: [0 bis 232 - 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.

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

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 232 - 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¶

BrickletDCV2.DEVICE_IDENTIFIER¶

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

BrickletDCV2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines DC Bricklet 2.0 dar.