Deutsch
English
Menu

JavaScript - Motorized Linear Poti Bricklet

This is the description of the JavaScript API bindings for the Motorized Linear Poti Bricklet. General information and technical specifications for the Motorized 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)

 1var Tinkerforge = require('tinkerforge');
 2
 3var HOST = 'localhost';
 4var PORT = 4223;
 5var UID = 'XYZ'; // Change XYZ to the UID of your Motorized Linear Poti Bricklet
 6
 7var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
 8var mlp = new Tinkerforge.BrickletMotorizedLinearPoti(UID, ipcon); // Create device object
 9
10ipcon.connect(HOST, PORT,
11    function (error) {
12        console.log('Error: ' + error);
13    }
14); // Connect to brickd
15// Don't use device before ipcon is connected
16
17ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
18    function (connectReason) {
19        // Get current position
20        mlp.getPosition(
21            function (position) {
22                console.log('Position: ' + position); // Range: 0 to 100
23            },
24            function (error) {
25                console.log('Error: ' + error);
26            }
27        );
28    }
29);
30
31console.log('Press key to exit');
32process.stdin.on('data',
33    function (data) {
34        ipcon.disconnect();
35        process.exit(0);
36    }
37);

Callback (Node.js)

Download (ExampleCallback.js)

 1var Tinkerforge = require('tinkerforge');
 2
 3var HOST = 'localhost';
 4var PORT = 4223;
 5var UID = 'XYZ'; // Change XYZ to the UID of your Motorized Linear Poti Bricklet
 6
 7var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
 8var mlp = new Tinkerforge.BrickletMotorizedLinearPoti(UID, ipcon); // Create device object
 9
10ipcon.connect(HOST, PORT,
11    function (error) {
12        console.log('Error: ' + error);
13    }
14); // Connect to brickd
15// Don't use device before ipcon is connected
16
17ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
18    function (connectReason) {
19        // Set period for position callback to 0.05s (50ms) without a threshold
20        mlp.setPositionCallbackConfiguration(50, false, 'x', 0, 0);
21    }
22);
23
24// Register position callback
25mlp.on(Tinkerforge.BrickletMotorizedLinearPoti.CALLBACK_POSITION,
26    // Callback function for position callback
27    function (position) {
28        console.log('Position: ' + position); // Range: 0 to 100
29    }
30);
31
32console.log('Press key to exit');
33process.stdin.on('data',
34    function (data) {
35        ipcon.disconnect();
36        process.exit(0);
37    }
38);

Motor (Node.js)

Download (ExampleMotor.js)

 1var Tinkerforge = require('tinkerforge');
 2
 3var HOST = 'localhost';
 4var PORT = 4223;
 5var UID = 'XYZ'; // Change XYZ to the UID of your Motorized Linear Poti Bricklet
 6
 7var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
 8var mlp = new Tinkerforge.BrickletMotorizedLinearPoti(UID, ipcon); // Create device object
 9
10ipcon.connect(HOST, PORT,
11    function (error) {
12        console.log('Error: ' + error);
13    }
14); // Connect to brickd
15// Don't use device before ipcon is connected
16
17ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
18    function (connectReason) {
19        // Move slider smooth to the middle
20        mlp.setMotorPosition(50,
21                             Tinkerforge.BrickletMotorizedLinearPoti.DRIVE_MODE_SMOOTH,
22                             false);
23    }
24);
25
26// Register position reached callback
27mlp.on(Tinkerforge.BrickletMotorizedLinearPoti.CALLBACK_POSITION_REACHED,
28    // Callback function for position reached callback
29    function (position) {
30        console.log('Position: ' + position); // Range: 0 to 100
31    }
32);
33
34console.log('Press key to exit');
35process.stdin.on('data',
36    function (data) {
37        ipcon.disconnect();
38        process.exit(0);
39    }
40);

Simple (HTML)

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

 1<!DOCTYPE html>
 2<html>
 3    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 4    <head>
 5        <title>Tinkerforge | JavaScript Example</title>
 6    </head>
 7    <body>
 8        <div style="text-align:center;">
 9            <h1>Motorized Linear Poti Bricklet Simple Example</h1>
10            <p>
11                <input value="localhost" id="host" type="text" size="20">:
12                <input value="4280" id="port" type="text" size="5">,
13                <input value="uid" id="uid" type="text" size="5">
14                <input value="Start Example" id="start" type="button" onclick="startExample();">
15            </p>
16            <p>
17                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
18                          >Press "Start Example" to begin ...</textarea>
19            </p>
20        </div>
21        <script src="./Tinkerforge.js" type='text/javascript'></script>
22        <script type='text/javascript'>
23            var ipcon;
24            var textArea = document.getElementById("text");
25            function startExample() {
26                textArea.value = "";
27                var HOST = document.getElementById("host").value;
28                var PORT = parseInt(document.getElementById("port").value);
29                var UID = document.getElementById("uid").value;
30                if(ipcon !== undefined) {
31                    ipcon.disconnect();
32                }
33                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
34                var mlp = new Tinkerforge.BrickletMotorizedLinearPoti(UID, ipcon); // Create device object
35                ipcon.connect(HOST, PORT,
36                    function(error) {
37                        textArea.value += 'Error: ' + error + '\n';
38                    }
39                ); // Connect to brickd
40                // Don't use device before ipcon is connected
41
42                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
43                    function (connectReason) {
44                        // Get current position
45                        mlp.getPosition(
46                            function (position) {
47                                textArea.value += 'Position: ' + position + '\n'; // Range: 0 to 100
48                            },
49                            function (error) {
50                                textArea.value += 'Error: ' + error + '\n';
51                            }
52                        );
53                    }
54                );
55            }
56        </script>
57    </body>
58</html>

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

 1<!DOCTYPE html>
 2<html>
 3    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 4    <head>
 5        <title>Tinkerforge | JavaScript Example</title>
 6    </head>
 7    <body>
 8        <div style="text-align:center;">
 9            <h1>Motorized Linear Poti Bricklet Callback Example</h1>
10            <p>
11                <input value="localhost" id="host" type="text" size="20">:
12                <input value="4280" id="port" type="text" size="5">,
13                <input value="uid" id="uid" type="text" size="5">
14                <input value="Start Example" id="start" type="button" onclick="startExample();">
15            </p>
16            <p>
17                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
18                          >Press "Start Example" to begin ...</textarea>
19            </p>
20        </div>
21        <script src="./Tinkerforge.js" type='text/javascript'></script>
22        <script type='text/javascript'>
23            var ipcon;
24            var textArea = document.getElementById("text");
25            function startExample() {
26                textArea.value = "";
27                var HOST = document.getElementById("host").value;
28                var PORT = parseInt(document.getElementById("port").value);
29                var UID = document.getElementById("uid").value;
30                if(ipcon !== undefined) {
31                    ipcon.disconnect();
32                }
33                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
34                var mlp = new Tinkerforge.BrickletMotorizedLinearPoti(UID, ipcon); // Create device object
35                ipcon.connect(HOST, PORT,
36                    function(error) {
37                        textArea.value += 'Error: ' + error + '\n';
38                    }
39                ); // Connect to brickd
40                // Don't use device before ipcon is connected
41
42                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
43                    function (connectReason) {
44                        // Set period for position callback to 0.05s (50ms) without a threshold
45                        mlp.setPositionCallbackConfiguration(50, false, 'x', 0, 0);
46                    }
47                );
48
49                // Register position callback
50                mlp.on(Tinkerforge.BrickletMotorizedLinearPoti.CALLBACK_POSITION,
51                    // Callback function for position callback
52                    function (position) {
53                        textArea.value += 'Position: ' + position + '\n'; // Range: 0 to 100
54                        textArea.scrollTop = textArea.scrollHeight;
55                    }
56                );
57            }
58        </script>
59    </body>
60</html>

Motor (HTML)

Download (ExampleMotor.html), Test (ExampleMotor.html)

 1<!DOCTYPE html>
 2<html>
 3    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 4    <head>
 5        <title>Tinkerforge | JavaScript Example</title>
 6    </head>
 7    <body>
 8        <div style="text-align:center;">
 9            <h1>Motorized Linear Poti Bricklet Motor Example</h1>
10            <p>
11                <input value="localhost" id="host" type="text" size="20">:
12                <input value="4280" id="port" type="text" size="5">,
13                <input value="uid" id="uid" type="text" size="5">
14                <input value="Start Example" id="start" type="button" onclick="startExample();">
15            </p>
16            <p>
17                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
18                          >Press "Start Example" to begin ...</textarea>
19            </p>
20        </div>
21        <script src="./Tinkerforge.js" type='text/javascript'></script>
22        <script type='text/javascript'>
23            var ipcon;
24            var textArea = document.getElementById("text");
25            function startExample() {
26                textArea.value = "";
27                var HOST = document.getElementById("host").value;
28                var PORT = parseInt(document.getElementById("port").value);
29                var UID = document.getElementById("uid").value;
30                if(ipcon !== undefined) {
31                    ipcon.disconnect();
32                }
33                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
34                var mlp = new Tinkerforge.BrickletMotorizedLinearPoti(UID, ipcon); // Create device object
35                ipcon.connect(HOST, PORT,
36                    function(error) {
37                        textArea.value += 'Error: ' + error + '\n';
38                    }
39                ); // Connect to brickd
40                // Don't use device before ipcon is connected
41
42                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
43                    function (connectReason) {
44                        // Move slider smooth to the middle
45                        mlp.setMotorPosition(50,
46                                             Tinkerforge.BrickletMotorizedLinearPoti.DRIVE_MODE_SMOOTH,
47                                             false);
48                    }
49                );
50
51                // Register position reached callback
52                mlp.on(Tinkerforge.BrickletMotorizedLinearPoti.CALLBACK_POSITION_REACHED,
53                    // Callback function for position reached callback
54                    function (position) {
55                        textArea.value += 'Position: ' + position + '\n'; // Range: 0 to 100
56                        textArea.scrollTop = textArea.scrollHeight;
57                    }
58                );
59            }
60        </script>
61    </body>
62</html>

API

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. 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

  • 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

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletMotorizedLinearPoti(uid, ipcon)
Parameters:
  • uid – Type: string
  • ipcon – Type: IPConnection
Returns:
  • motorizedLinearPoti – Type: BrickletMotorizedLinearPoti

Creates an object with the unique device ID uid:

var motorizedLinearPoti = new BrickletMotorizedLinearPoti("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

BrickletMotorizedLinearPoti.getPosition([returnCallback][, errorCallback])
Callback Parameters:
  • position – Type: int, Range: [0 to 100]
Returns:
  • undefined

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

If you want to get the value periodically, it is recommended to use the CALLBACK_POSITION callback. You can set the callback configuration with setPositionCallbackConfiguration().

BrickletMotorizedLinearPoti.setMotorPosition(position, driveMode, holdPosition[, returnCallback][, errorCallback])
Parameters:
  • position – Type: int, Range: [0 to 100]
  • driveMode – Type: int, Range: See constants
  • holdPosition – Type: boolean
Callback Parameters:
  • undefined
Returns:
  • undefined

Sets the position of the potentiometer. The motorized potentiometer will immediately start to approach the position. Depending on the chosen drive mode, the position will either be reached as fast as possible or in a slow but smooth motion.

The position has to be between 0 (slider down) and 100 (slider up).

If you set the hold position parameter to true, the position will automatically be retained. If a user changes the position of the potentiometer, it will automatically drive back to the original set point.

If the hold position parameter is set to false, the potentiometer can be changed again by the user as soon as the set point was reached once.

The following constants are available for this function:

For drive_mode:

  • BrickletMotorizedLinearPoti.DRIVE_MODE_FAST = 0

  • BrickletMotorizedLinearPoti.DRIVE_MODE_SMOOTH = 1

BrickletMotorizedLinearPoti.getMotorPosition([returnCallback][, errorCallback])
Callback Parameters:
  • position – Type: int, Range: [0 to 100]
  • driveMode – Type: int, Range: See constants
  • holdPosition – Type: boolean
  • positionReached – Type: boolean
Returns:
  • undefined

Returns the last motor position as set by setMotorPosition(). This is not the current position (use getPosition() to get the current position). This is the last used set point and configuration.

The position reached parameter is true if the position has been reached at one point. The position may have been changed again in the meantime by the user.

The following constants are available for this function:

For drive_mode:

  • BrickletMotorizedLinearPoti.DRIVE_MODE_FAST = 0

  • BrickletMotorizedLinearPoti.DRIVE_MODE_SMOOTH = 1

Advanced Functions

BrickletMotorizedLinearPoti.calibrate([returnCallback][, errorCallback])
Callback Parameters:
  • undefined
Returns:
  • undefined

Starts a calibration procedure. The potentiometer will be driven to the extreme points to calibrate the potentiometer.

The calibration is saved in flash, it does not have to be called on every start up.

The Motorized Linear Poti Bricklet is already factory-calibrated during testing at Tinkerforge.

BrickletMotorizedLinearPoti.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback Parameters:
  • errorCountAckChecksum – Type: int, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1]
  • errorCountFrame – Type: int, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,

  • message checksum errors,

  • framing errors and

  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletMotorizedLinearPoti.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameters:
  • config – Type: int, Range: See constants, Default: 3
Callback Parameters:
  • undefined
Returns:
  • undefined

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_OFF = 0

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_ON = 1

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletMotorizedLinearPoti.getStatusLEDConfig([returnCallback][, errorCallback])
Callback Parameters:
  • config – Type: int, Range: See constants, Default: 3
Returns:
  • undefined

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_OFF = 0

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_ON = 1

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

  • BrickletMotorizedLinearPoti.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletMotorizedLinearPoti.getChipTemperature([returnCallback][, errorCallback])
Callback Parameters:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • undefined

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletMotorizedLinearPoti.reset([returnCallback][, errorCallback])
Callback Parameters:
  • undefined
Returns:
  • undefined

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletMotorizedLinearPoti.getIdentity([returnCallback][, errorCallback])
Callback Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • firmwareVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]
Returns:
  • undefined

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions

BrickletMotorizedLinearPoti.on(callback_id, function[, errorCallback])
Parameters:
  • callback_id – Type: int
  • function – Type: function
Returns:
  • undefined

Registers the given function with the given callback_id.

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

BrickletMotorizedLinearPoti.setPositionCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Range: [0 to 216 - 1], Default: 0
Callback Parameters:
  • undefined
Returns:
  • undefined

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_POSITION callback.

The following options are possible:

Option

Description

'x'

Threshold is turned off

'o'

Threshold is triggered when the value is outside the min and max values

'i'

Threshold is triggered when the value is inside or equal to the min and max values

'<'

Threshold is triggered when the value is smaller than the min value (max is ignored)

'>'

Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_OFF = 'x'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_SMALLER = '<'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_GREATER = '>'

BrickletMotorizedLinearPoti.getPositionCallbackConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Range: [0 to 216 - 1], Default: 0
Returns:
  • undefined

Returns the callback configuration as set by setPositionCallbackConfiguration().

The following constants are available for this function:

For option:

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_OFF = 'x'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_SMALLER = '<'

  • BrickletMotorizedLinearPoti.THRESHOLD_OPTION_GREATER = '>'

BrickletMotorizedLinearPoti.setPositionReachedCallbackConfiguration(enabled[, returnCallback][, errorCallback])
Parameters:
  • enabled – Type: boolean, Default: true
Callback Parameters:
  • undefined
Returns:
  • undefined

Enables/Disables CALLBACK_POSITION_REACHED callback.

BrickletMotorizedLinearPoti.getPositionReachedCallbackConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • enabled – Type: boolean, Default: true
Returns:
  • undefined

Returns the CALLBACK_POSITION_REACHED callback configuration as set by setPositionReachedCallbackConfiguration().

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:

motorizedLinearPoti.on(BrickletMotorizedLinearPoti.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.

BrickletMotorizedLinearPoti.CALLBACK_POSITION
Callback Parameters:
  • position – Type: int, Range: [0 to 100]

This callback is triggered periodically according to the configuration set by setPositionCallbackConfiguration().

The parameter is the same as getPosition().

BrickletMotorizedLinearPoti.CALLBACK_POSITION_REACHED
Callback Parameters:
  • position – Type: int, Range: [0 to 100]

This callback is triggered if a new position as set by setMotorPosition() is reached.

The parameter is the current position.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletMotorizedLinearPoti.getAPIVersion()
Returns:
  • apiVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletMotorizedLinearPoti.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
Returns:
  • responseExpected – 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletMotorizedLinearPoti.FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 2

  • BrickletMotorizedLinearPoti.FUNCTION_SET_MOTOR_POSITION = 5

  • BrickletMotorizedLinearPoti.FUNCTION_CALIBRATE = 7

  • BrickletMotorizedLinearPoti.FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 8

  • BrickletMotorizedLinearPoti.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

  • BrickletMotorizedLinearPoti.FUNCTION_SET_STATUS_LED_CONFIG = 239

  • BrickletMotorizedLinearPoti.FUNCTION_RESET = 243

  • BrickletMotorizedLinearPoti.FUNCTION_WRITE_UID = 248

BrickletMotorizedLinearPoti.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
  • responseExpected – Type: boolean
Returns:
  • undefined

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletMotorizedLinearPoti.FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 2

  • BrickletMotorizedLinearPoti.FUNCTION_SET_MOTOR_POSITION = 5

  • BrickletMotorizedLinearPoti.FUNCTION_CALIBRATE = 7

  • BrickletMotorizedLinearPoti.FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 8

  • BrickletMotorizedLinearPoti.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

  • BrickletMotorizedLinearPoti.FUNCTION_SET_STATUS_LED_CONFIG = 239

  • BrickletMotorizedLinearPoti.FUNCTION_RESET = 243

  • BrickletMotorizedLinearPoti.FUNCTION_WRITE_UID = 248

BrickletMotorizedLinearPoti.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected – Type: boolean
Returns:
  • undefined

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

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletMotorizedLinearPoti.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameters:
  • mode – Type: int, Range: See constants
Callback Parameters:
  • status – Type: int, Range: See constants
Returns:
  • undefined

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_BOOTLOADER = 0

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_FIRMWARE = 1

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BrickletMotorizedLinearPoti.BOOTLOADER_STATUS_OK = 0

  • BrickletMotorizedLinearPoti.BOOTLOADER_STATUS_INVALID_MODE = 1

  • BrickletMotorizedLinearPoti.BOOTLOADER_STATUS_NO_CHANGE = 2

  • BrickletMotorizedLinearPoti.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

  • BrickletMotorizedLinearPoti.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

  • BrickletMotorizedLinearPoti.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletMotorizedLinearPoti.getBootloaderMode([returnCallback][, errorCallback])
Callback Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • undefined

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_BOOTLOADER = 0

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_FIRMWARE = 1

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

  • BrickletMotorizedLinearPoti.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletMotorizedLinearPoti.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameters:
  • pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Callback Parameters:
  • undefined
Returns:
  • undefined

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletMotorizedLinearPoti.writeFirmware(data[, returnCallback][, errorCallback])
Parameters:
  • data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:
  • status – Type: int, Range: [0 to 255]
Returns:
  • undefined

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletMotorizedLinearPoti.writeUID(uid[, returnCallback][, errorCallback])
Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]
Callback Parameters:
  • undefined
Returns:
  • undefined

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletMotorizedLinearPoti.readUID([returnCallback][, errorCallback])
Callback Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants

BrickletMotorizedLinearPoti.DEVICE_IDENTIFIER

This constant is used to identify a Motorized Linear Poti Bricklet.

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

BrickletMotorizedLinearPoti.DEVICE_DISPLAY_NAME

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