Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / Tilt Bricklet

JavaScript - Tilt Bricklet¶

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

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var t = new Tinkerforge.BrickletTilt(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 tilt state
        t.getTiltState(
            function (state) {
                if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED) {
                    console.log('Tilt State: Closed');
                }
                else if(state === Tinkerforge.BrickletTilt.TILT_STATE_OPEN) {
                    console.log('Tilt State: Open');
                }
                else if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED_VIBRATING) {
                    console.log('Tilt State: Closed Vibrating');
                }
            },
            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 Tilt Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var t = new Tinkerforge.BrickletTilt(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) {
        // Enable tilt state callback
        t.enableTiltStateCallback();
    }
);

// Register tilt state callback
t.on(Tinkerforge.BrickletTilt.CALLBACK_TILT_STATE,
    // Callback function for tilt state callback
    function (state) {
        if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED) {
            console.log('Tilt State: Closed');
        }
        else if(state === Tinkerforge.BrickletTilt.TILT_STATE_OPEN) {
            console.log('Tilt State: Open');
        }
        else if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED_VIBRATING) {
            console.log('Tilt State: Closed Vibrating');
        }
    }
);

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>Tilt 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 t = new Tinkerforge.BrickletTilt(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 tilt state
                        t.getTiltState(
                            function (state) {
                                if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED) {
                                    textArea.value += 'Tilt State: Closed\n';
                                }
                                else if(state === Tinkerforge.BrickletTilt.TILT_STATE_OPEN) {
                                    textArea.value += 'Tilt State: Open\n';
                                }
                                else if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED_VIBRATING) {
                                    textArea.value += 'Tilt State: Closed Vibrating\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>Tilt 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 t = new Tinkerforge.BrickletTilt(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) {
                        // Enable tilt state callback
                        t.enableTiltStateCallback();
                    }
                );

                // Register tilt state callback
                t.on(Tinkerforge.BrickletTilt.CALLBACK_TILT_STATE,
                    // Callback function for tilt state callback
                    function (state) {
                        if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED) {
                            textArea.value += 'Tilt State: Closed\n';
                        }
                        else if(state === Tinkerforge.BrickletTilt.TILT_STATE_OPEN) {
                            textArea.value += 'Tilt State: Open\n';
                        }
                        else if(state === Tinkerforge.BrickletTilt.TILT_STATE_CLOSED_VIBRATING) {
                            textArea.value += 'Tilt State: Closed Vibrating\n';
                        }
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</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 BrickletTilt(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	tilt – Type: BrickletTilt

Creates an object with the unique device ID uid:

var tilt = new BrickletTilt("YOUR_DEVICE_UID", ipcon);

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

BrickletTilt.getTiltState([returnCallback][, errorCallback])¶

Callback Parameters:	state – Type: int, Range: See constants
Returns:	undefined

Returns the current tilt state. The state can either be

0 = Closed: The ball in the tilt switch closes the circuit.
1 = Open: The ball in the tilt switch does not close the circuit.
2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).

The following constants are available for this function:

For state:

BrickletTilt.TILT_STATE_CLOSED = 0
BrickletTilt.TILT_STATE_OPEN = 1
BrickletTilt.TILT_STATE_CLOSED_VIBRATING = 2

Advanced Functions¶

BrickletTilt.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

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 2¹⁶ - 1]
Returns:	undefined

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 2¹⁶ - 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¶

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

BrickletTilt.enableTiltStateCallback([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Enables the CALLBACK_TILT_STATE callback.

BrickletTilt.disableTiltStateCallback([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Disables the CALLBACK_TILT_STATE callback.

BrickletTilt.isTiltStateCallbackEnabled([returnCallback][, errorCallback])¶

Callback Parameters:	enabled – Type: boolean, Default: false
Returns:	undefined

Returns true if the CALLBACK_TILT_STATE callback is enabled.

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:

tilt.on(BrickletTilt.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.

BrickletTilt.CALLBACK_TILT_STATE¶

Callback Parameters:	state – Type: int, Range: See constants

This callback provides the current tilt state. It is called every time the state changes.

See getTiltState() for a description of the states.

The following constants are available for this function:

For state:

BrickletTilt.TILT_STATE_CLOSED = 0
BrickletTilt.TILT_STATE_OPEN = 1
BrickletTilt.TILT_STATE_CLOSED_VIBRATING = 2

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.

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

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

BrickletTilt.FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
BrickletTilt.FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

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

The following constants are available for this function:

For function_id:

BrickletTilt.FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
BrickletTilt.FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

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

Constants¶

BrickletTilt.DEVICE_IDENTIFIER¶

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

BrickletTilt.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Tilt Bricklet.