JavaScript - Joystick Bricklet

This is the description of the JavaScript API bindings for the Joystick Bricklet. General information and technical specifications for the Joystick Bricklet are summarized in its hardware description.

An installation guide for the JavaScript API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple (Node.js)

Download (ExampleSimple.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your 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)

 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
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)

 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
<!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)

 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>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)

 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
<!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

Generally, every method of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback is called with the return values as parameters, if the method returns something. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

  • 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

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletJoystick(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected (see examples above).

BrickletJoystick.getPosition([returnCallback][, errorCallback])
Callback:
  • x -- int
  • y -- int

Returns the position of the Joystick. The value ranges between -100 and 100 for both axis. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see calibrate()).

If you want to get the position periodically, it is recommended to use the CALLBACK_POSITION callback and set the period with setPositionCallbackPeriod().

BrickletJoystick.isPressed([returnCallback][, errorCallback])
Callback:
  • pressed -- boolean

Returns true if the button is pressed and false otherwise.

It is recommended to use the CALLBACK_PRESSED and CALLBACK_RELEASED callbacks to handle the button.

Advanced Functions

BrickletJoystick.getAnalogValue([returnCallback][, errorCallback])
Callback:
  • x -- int
  • y -- int

Returns the values as read by a 12-bit analog-to-digital converter. The values are between 0 and 4095 for both axis.

Note

The values returned by getPosition() are averaged over several samples to yield less noise, while getAnalogValue() gives back raw unfiltered analog values. The only reason to use getAnalogValue() is, if you need the full resolution of the analog-to-digital converter.

If you want the analog values periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with setAnalogValueCallbackPeriod().

BrickletJoystick.calibrate([returnCallback][, errorCallback])
Callback:undefined

Calibrates the middle position of the Joystick. If your Joystick Bricklet does not return x=0 and y=0 in the middle position, call this function while the Joystick is standing still in the middle position.

The resulting calibration will be saved on the EEPROM of the Joystick Bricklet, thus you only have to calibrate it once.

BrickletJoystick.getAPIVersion()
Return type:[int, int, int]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletJoystick.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId -- int
Return type:

boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

BrickletJoystick.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId -- int
  • responseExpected -- boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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)
Parameters:
  • responseExpected -- boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletJoystick.getIdentity([returnCallback][, errorCallback])
Callback:
  • uid -- string
  • connectedUid -- string
  • position -- char
  • hardwareVersion -- [int, int, int]
  • firmwareVersion -- [int, int, int]
  • deviceIdentifier -- int

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletJoystick.on(callback_id, function)
Parameters:
  • callback_id -- int
  • function -- function

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletJoystick.setPositionCallbackPeriod(period[, returnCallback][, errorCallback])
Parameters:
  • period -- int
Callback:

undefined

Sets the period in ms with which the CALLBACK_POSITION callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_POSITION callback is only triggered if the position has changed since the last triggering.

The default value is 0.

BrickletJoystick.getPositionCallbackPeriod([returnCallback][, errorCallback])
Callback:
  • period -- int

Returns the period as set by setPositionCallbackPeriod().

BrickletJoystick.setAnalogValueCallbackPeriod(period[, returnCallback][, errorCallback])
Parameters:
  • period -- int
Callback:

undefined

Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ANALOG_VALUE callback is only triggered if the analog values have changed since the last triggering.

The default value is 0.

BrickletJoystick.getAnalogValueCallbackPeriod([returnCallback][, errorCallback])
Callback:
  • period -- int

Returns the period as set by setAnalogValueCallbackPeriod().

BrickletJoystick.setPositionCallbackThreshold(option, minX, maxX, minY, maxY[, returnCallback][, errorCallback])
Parameters:
  • option -- char
  • minX -- int
  • maxX -- int
  • minY -- int
  • maxY -- int
Callback:

undefined

Sets the thresholds for the CALLBACK_POSITION_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the position is outside the min and max values
'i' Callback is triggered when the position is inside the min and max values
'<' Callback is triggered when the position is smaller than the min values (max is ignored)
'>' Callback is triggered when the position is greater than the min values (max is ignored)

The default value is ('x', 0, 0, 0, 0).

The following constants are available for this function:

  • 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:
  • option -- char
  • minX -- int
  • maxX -- int
  • minY -- int
  • maxY -- int

Returns the threshold as set by setPositionCallbackThreshold().

The following constants are available for this function:

  • 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])
Parameters:
  • option -- char
  • minX -- int
  • maxX -- int
  • minY -- int
  • maxY -- int
Callback:

undefined

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the analog values are outside the min and max values
'i' Callback is triggered when the analog values are inside the min and max values
'<' Callback is triggered when the analog values are smaller than the min values (max is ignored)
'>' Callback is triggered when the analog values are greater than the min values (max is ignored)

The default value is ('x', 0, 0, 0, 0).

The following constants are available for this function:

  • 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:
  • option -- char
  • minX -- int
  • maxX -- int
  • minY -- int
  • maxY -- int

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

  • 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])
Parameters:
  • debounce -- int
Callback:

undefined

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletJoystick.getDebouncePeriod([returnCallback][, errorCallback])
Callback:
  • debounce -- int

Returns the debounce period as set by setDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

joystick.on(BrickletJoystick.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletJoystick.CALLBACK_POSITION
Parameters:
  • x -- int
  • y -- int

This callback is triggered periodically with the period that is set by setPositionCallbackPeriod(). The parameter is the position of the Joystick.

The CALLBACK_POSITION callback is only triggered if the position has changed since the last triggering.

BrickletJoystick.CALLBACK_ANALOG_VALUE
Parameters:
  • x -- int
  • y -- int

This callback is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameters are the analog values of the Joystick.

The CALLBACK_ANALOG_VALUE callback is only triggered if the values have changed since the last triggering.

BrickletJoystick.CALLBACK_POSITION_REACHED
Parameters:
  • x -- int
  • y -- int

This callback is triggered when the threshold as set by setPositionCallbackThreshold() is reached. The parameters are the position of the Joystick.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

BrickletJoystick.CALLBACK_ANALOG_VALUE_REACHED
Parameters:
  • x -- int
  • y -- int

This callback is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameters are the analog values of the Joystick.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

BrickletJoystick.CALLBACK_PRESSED

This callback is triggered when the button is pressed.

BrickletJoystick.CALLBACK_RELEASED

This callback is triggered when the button is released.

Constants

BrickletJoystick.DEVICE_IDENTIFIER

This constant is used to identify a Joystick Bricklet.

The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletJoystick.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Joystick Bricklet.