Software / API Bindings / JavaScript / API Referenz und Beispiele / Bricklets / Joystick Bricklet

JavaScript - Joystick Bricklet¶

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

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var j = new Tinkerforge.BrickletJoystick(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 position
        j.getPosition(
            function (x, y) {
                console.log('Position [X]: ' + x);
                console.log('Position [Y]: ' + y);
            },
            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 Joystick Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var j = new Tinkerforge.BrickletJoystick(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

// Register pressed callback
j.on(Tinkerforge.BrickletJoystick.CALLBACK_PRESSED,
    // Callback function for pressed callback
    function () {
        console.log('Pressed');
    }
);

// Register released callback
j.on(Tinkerforge.BrickletJoystick.CALLBACK_RELEASED,
    // Callback function for released callback
    function () {
        console.log('Released');
    }
);

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

Find Borders (Node.js)¶

Download (ExampleFindBorders.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var j = new Tinkerforge.BrickletJoystick(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 0.2 seconds (200ms)
        j.setDebouncePeriod(200);

        // Configure threshold for position "outside of -99, -99 to 99, 99"
        j.setPositionCallbackThreshold('o', -99, 99, -99, 99);
    }
);

// Register position reached callback
j.on(Tinkerforge.BrickletJoystick.CALLBACK_POSITION_REACHED,
    // Callback function for position reached callback
    function (x, y) {
        if(y === 100) {
            console.log('Top');
        }
        else if(y === -100) {
            console.log('Bottom');
        }

        if(x === 100) {
            console.log('Right');
        }
        else if(x === -100) {
            console.log('Left');
        }

        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>Joystick 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 j = new Tinkerforge.BrickletJoystick(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 position
                        j.getPosition(
                            function (x, y) {
                                textArea.value += 'Position [X]: ' + x + '\n';
                                textArea.value += 'Position [Y]: ' + y + '\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>Joystick 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 j = new Tinkerforge.BrickletJoystick(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

                // Register pressed callback
                j.on(Tinkerforge.BrickletJoystick.CALLBACK_PRESSED,
                    // Callback function for pressed callback
                    function () {
                        textArea.value += 'Pressed\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );

                // Register released callback
                j.on(Tinkerforge.BrickletJoystick.CALLBACK_RELEASED,
                    // Callback function for released callback
                    function () {
                        textArea.value += 'Released\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Find Borders (HTML)¶

Download (ExampleFindBorders.html), Test (ExampleFindBorders.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>Joystick Bricklet Find Borders 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 j = new Tinkerforge.BrickletJoystick(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 0.2 seconds (200ms)
                        j.setDebouncePeriod(200);

                        // Configure threshold for position "outside of -99, -99 to 99, 99"
                        j.setPositionCallbackThreshold('o', -99, 99, -99, 99);
                    }
                );

                // Register position reached callback
                j.on(Tinkerforge.BrickletJoystick.CALLBACK_POSITION_REACHED,
                    // Callback function for position reached callback
                    function (x, y) {
                        if(y === 100) {
                            textArea.value += 'Top ';
                        }
                        else if(y === -100) {
                            textArea.value += 'Bottom ';
                        }

                        if(x === 100) {
                            textArea.value += 'Right ';
                        }
                        else if(x === -100) {
                            textArea.value += 'Left ';
                        }

                        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 BrickletJoystick(uid, ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	joystick – Typ: BrickletJoystick

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

var joystick = new BrickletJoystick("YOUR_DEVICE_UID", ipcon)

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

BrickletJoystick.getPosition([returnCallback][, errorCallback])¶

Callback-Parameter:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]
Rückgabe:	undefined

Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe calibrate()).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_POSITION Callback zu nutzen und die Periode mit setPositionCallbackPeriod() vorzugeben.

BrickletJoystick.isPressed([returnCallback][, errorCallback])¶

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

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die CALLBACK_PRESSED und CALLBACK_RELEASED Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

BrickletJoystick.getAnalogValue([returnCallback][, errorCallback])¶

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

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von getPosition() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

BrickletJoystick.calibrate([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

BrickletJoystick.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¶

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

BrickletJoystick.setPositionCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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

The CALLBACK_POSITION Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

BrickletJoystick.getPositionCallbackPeriod([returnCallback][, errorCallback])¶

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

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

BrickletJoystick.setAnalogValueCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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

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

BrickletJoystick.getAnalogValueCallbackPeriod([returnCallback][, errorCallback])¶

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

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

BrickletJoystick.setPositionCallbackThreshold(option, minX, maxX, minY, maxY[, returnCallback][, errorCallback])¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Schwellwert für den CALLBACK_POSITION_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

BrickletJoystick.getPositionCallbackThreshold([returnCallback][, errorCallback])¶

Callback-Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Rückgabe:	undefined

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

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

Für option:

BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

BrickletJoystick.setAnalogValueCallbackThreshold(option, minX, maxX, minY, maxY[, returnCallback][, errorCallback])¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

BrickletJoystick.getAnalogValueCallbackThreshold([returnCallback][, errorCallback])¶

Callback-Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Rückgabe:	undefined

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

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

Für option:

BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'
BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'
BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'
BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

BrickletJoystick.setDebouncePeriod(debounce[, returnCallback][, errorCallback])¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_POSITION_REACHED,
CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

setPositionCallbackThreshold(),
setAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

BrickletJoystick.getDebouncePeriod([returnCallback][, errorCallback])¶

Callback-Parameter:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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:

joystick.on(BrickletJoystick.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.

BrickletJoystick.CALLBACK_POSITION¶

Callback-Parameter:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]

Dieser Callback wird mit der Periode, wie gesetzt mit setPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Joysticks.

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

BrickletJoystick.CALLBACK_ANALOG_VALUE¶

Callback-Parameter:	x – Typ: int, Wertebereich: [0 bis 2¹² - 1] y – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

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

BrickletJoystick.CALLBACK_POSITION_REACHED¶

Callback-Parameter:	x – Typ: int, Wertebereich: [-100 bis 100] y – Typ: int, Wertebereich: [-100 bis 100]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

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

BrickletJoystick.CALLBACK_ANALOG_VALUE_REACHED¶

Callback-Parameter:	x – Typ: int, Wertebereich: [0 bis 2¹² - 1] y – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

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

BrickletJoystick.CALLBACK_PRESSED¶

Callback-Parameter:	undefined

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

BrickletJoystick.CALLBACK_RELEASED¶

Callback-Parameter:	undefined

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.

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.

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

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

BrickletJoystick.FUNCTION_CALIBRATE = 4
BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

BrickletJoystick.FUNCTION_CALIBRATE = 4
BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletJoystick.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¶

BrickletJoystick.DEVICE_IDENTIFIER¶

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

BrickletJoystick.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.