JavaScript - Linear Poti Bricklet

This is the description of the JavaScript API bindings for the Linear Poti Bricklet. General information and technical specifications for the Linear Poti 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
var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lp = new Tinkerforge.BrickletLinearPoti(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
        lp.getPosition(
            function (position) {
                console.log('Position: ' + position); // Range: 0 to 100
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

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

Callback (Node.js)

Download (ExampleCallback.js)

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

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var lp = new Tinkerforge.BrickletLinearPoti(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Set period for position callback to 0.05s (50ms)
        // Note: The position callback is only called every 0.05 seconds
        //       if the position has changed since the last call!
        lp.setPositionCallbackPeriod(50);
    }
);

// Register position callback
lp.on(Tinkerforge.BrickletLinearPoti.CALLBACK_POSITION,
    // Callback function for position callback
    function (position) {
        console.log('Position: ' + position); // Range: 0 to 100
    }
);

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

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.html)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Linear Poti 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 lp = new Tinkerforge.BrickletLinearPoti(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
                        lp.getPosition(
                            function (position) {
                                textArea.value += 'Position: ' + position + '\n'; // Range: 0 to 100
                            },
                            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>Linear Poti 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 lp = new Tinkerforge.BrickletLinearPoti(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Set period for position callback to 0.05s (50ms)
                        // Note: The position callback is only called every 0.05 seconds
                        //       if the position has changed since the last call!
                        lp.setPositionCallbackPeriod(50);
                    }
                );

                // Register position callback
                lp.on(Tinkerforge.BrickletLinearPoti.CALLBACK_POSITION,
                    // Callback function for position callback
                    function (position) {
                        textArea.value += 'Position: ' + position + '\n'; // Range: 0 to 100
                        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 BrickletLinearPoti(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

var linearPoti = new BrickletLinearPoti("YOUR_DEVICE_UID", ipcon);

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

BrickletLinearPoti.getPosition([returnCallback][, errorCallback])
Callback:
  • position -- int

Returns the position of the linear potentiometer. The value is between 0 (slider down) and 100 (slider up).

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

Advanced Functions

BrickletLinearPoti.getAnalogValue([returnCallback][, errorCallback])
Callback:
  • value -- int

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by getPosition() is 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 value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with setAnalogValueCallbackPeriod().

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

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

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

  • BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletLinearPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletLinearPoti.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected -- boolean

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

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

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

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

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

Returns the period as set by setPositionCallbackPeriod().

BrickletLinearPoti.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 value has changed since the last triggering.

The default value is 0.

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

Returns the period as set by setAnalogValueCallbackPeriod().

BrickletLinearPoti.setPositionCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
Parameters:
  • option -- char
  • min -- int
  • max -- 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 value (max is ignored)
'>' Callback is triggered when the position is greater than the min value (max is ignored)

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

The following constants are available for this function:

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti.getPositionCallbackThreshold([returnCallback][, errorCallback])
Callback:
  • option -- char
  • min -- int
  • max -- int

Returns the threshold as set by setPositionCallbackThreshold().

The following constants are available for this function:

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti.setAnalogValueCallbackThreshold(option, min, max[, returnCallback][, errorCallback])
Parameters:
  • option -- char
  • min -- int
  • max -- 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 value is outside the min and max values
'i' Callback is triggered when the analog value is inside the min and max values
'<' Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>' Callback is triggered when the analog value is greater than the min value (max is ignored)

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

The following constants are available for this function:

  • BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
  • BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'
BrickletLinearPoti.getAnalogValueCallbackThreshold([returnCallback][, errorCallback])
Callback:
  • option -- char
  • min -- int
  • max -- int

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

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

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

linearPoti.on(BrickletLinearPoti.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.

BrickletLinearPoti.CALLBACK_POSITION
Parameters:
  • position -- int

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

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

BrickletLinearPoti.CALLBACK_ANALOG_VALUE
Parameters:
  • value -- int

This callback is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameter is the analog value of the Linear Potentiometer.

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

BrickletLinearPoti.CALLBACK_POSITION_REACHED
Parameters:
  • position -- int

This callback is triggered when the threshold as set by setPositionCallbackThreshold() is reached. The parameter is the position of the linear potentiometer.

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

BrickletLinearPoti.CALLBACK_ANALOG_VALUE_REACHED
Parameters:
  • value -- int

This callback is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the linear potentiometer.

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

Constants

BrickletLinearPoti.DEVICE_IDENTIFIER

This constant is used to identify a Linear Poti 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.

BrickletLinearPoti.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Linear Poti Bricklet.