Software / API Bindings / JavaScript / API Reference and Examples / Bricklets (Discontinued) / Industrial Digital In 4 Bricklet

JavaScript - Industrial Digital In 4 Bricklet¶

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4(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 value as bitmask
        idi4.getValue(
            function (valueMask) {
                console.log('Value Mask: ' + valueMask.toString(2));
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

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

Interrupt (Node.js)¶

Download (ExampleInterrupt.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Digital In 4 Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4(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 interrupt on pin 0
        idi4.setInterrupt(1 << 0);
    }
);

// Register interrupt callback
idi4.on(Tinkerforge.BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT,
    // Callback function for interrupt callback
    function (interruptMask, valueMask) {
        console.log('Interrupt Mask: ' + interruptMask.toString(2));
        console.log('Value Mask: ' + valueMask.toString(2));
        console.log();
    }
);

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

Simple (HTML)¶

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

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Industrial Digital In 4 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 idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4(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 value as bitmask
                        idi4.getValue(
                            function (valueMask) {
                                textArea.value += 'Value Mask: ' + valueMask.toString(2) + '\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Interrupt (HTML)¶

Download (ExampleInterrupt.html), Test (ExampleInterrupt.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>Industrial Digital In 4 Bricklet Interrupt 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 idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4(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 interrupt on pin 0
                        idi4.setInterrupt(1 << 0);
                    }
                );

                // Register interrupt callback
                idi4.on(Tinkerforge.BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT,
                    // Callback function for interrupt callback
                    function (interruptMask, valueMask) {
                        textArea.value += 'Interrupt Mask: ' + interruptMask.toString(2) + '\n';
                        textArea.value += 'Value Mask: ' + valueMask.toString(2) + '\n';
                        textArea.value += '\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 BrickletIndustrialDigitalIn4(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	industrialDigitalIn4 – Type: BrickletIndustrialDigitalIn4

Creates an object with the unique device ID uid:

var industrialDigitalIn4 = new BrickletIndustrialDigitalIn4("YOUR_DEVICE_UID", ipcon);

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

BrickletIndustrialDigitalIn4.getValue([returnCallback][, errorCallback])¶

Callback Parameters:	valueMask – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

Returns the input value with a bitmask. The bitmask is 16bit long, true refers to high and false refers to low.

For example: The value 3 or 0b0011 means that pins 0-1 are high and the other pins are low.

If no groups are used (see setGroup()), the pins correspond to the markings on the IndustrialDigital In 4 Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

BrickletIndustrialDigitalIn4.getEdgeCount(pin, resetCounter[, returnCallback][, errorCallback])¶

Parameters:	pin – Type: int, Range: [0 to 3] resetCounter – Type: boolean
Callback Parameters:	count – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with setEdgeCountConfig().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The edge counters use the grouping as set by setGroup().

New in version 2.0.1 (Plugin).

Advanced Functions¶

BrickletIndustrialDigitalIn4.setGroup(group[, returnCallback][, errorCallback])¶

Parameters:	group – Type: [char, ...], Length: 4, Range: ['a' to 'd', 'n']
Callback Parameters:	undefined
Returns:	undefined

Sets a group of Digital In 4 Bricklets that should work together. You can find Bricklets that can be grouped together with getAvailableForGroup().

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Digital In 4 Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Digital In 4 on port A are assigned to 0-3 and the pins on the Digital In 4 on port B are assigned to 4-7. It is now possible to call getValue() and read out two Bricklets at the same time.

Changing the group configuration resets all edge counter configurations and values.

BrickletIndustrialDigitalIn4.getGroup([returnCallback][, errorCallback])¶

Callback Parameters:	group – Type: [char, ...], Length: 4, Range: ['a' to 'd', 'n']
Returns:	undefined

Returns the group as set by setGroup()

BrickletIndustrialDigitalIn4.getAvailableForGroup([returnCallback][, errorCallback])¶

Callback Parameters:	available – Type: int, Range: [0 to 15]
Returns:	undefined

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

BrickletIndustrialDigitalIn4.setEdgeCountConfig(selectionMask, edgeType, debounce[, returnCallback][, errorCallback])¶

Parameters:	selectionMask – Type: int, Range: [0 to 2¹⁶ - 1] edgeType – Type: int, Range: See constants, Default: 0 debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100
Callback Parameters:	undefined
Returns:	undefined

Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will enable the edge counter for pins 0 and 3.

The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

0 = rising
1 = falling
2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The edge counters use the grouping as set by setGroup().

The following constants are available for this function:

For edge_type:

BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4.getEdgeCountConfig(pin[, returnCallback][, errorCallback])¶

Parameters:	pin – Type: int, Range: [0 to 255]
Callback Parameters:	edgeType – Type: int, Range: See constants, Default: 0 debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100
Returns:	undefined

Returns the edge type and debounce time for the selected pin as set by setEdgeCountConfig().

The following constants are available for this function:

For edge_type:

BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2

New in version 2.0.1 (Plugin).

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

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

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

Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Callback Parameters:	undefined
Returns:	undefined

Sets the debounce period of the CALLBACK_INTERRUPT callback.

For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the Digital In 4 Bricklet, such as a button.

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

Callback Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Returns:	undefined

Returns the debounce period as set by setDebouncePeriod().

BrickletIndustrialDigitalIn4.setInterrupt(interruptMask[, returnCallback][, errorCallback])¶

Parameters:	interruptMask – Type: int, Range: [0 to 2¹⁶ - 1]
Callback Parameters:	undefined
Returns:	undefined

Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

For example: An interrupt bitmask of 9 or 0b1001 will enable the interrupt for pins 0 and 3.

The interrupts use the grouping as set by setGroup().

The interrupt is delivered with the CALLBACK_INTERRUPT callback.

BrickletIndustrialDigitalIn4.getInterrupt([returnCallback][, errorCallback])¶

Callback Parameters:	interruptMask – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

Returns the interrupt bitmask as set by setInterrupt().

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:

industrialDigitalIn4.on(BrickletIndustrialDigitalIn4.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.

BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT¶

Callback Parameters:	interruptMask – Type: int, Range: [0 to 2¹⁶ - 1] valueMask – Type: int, Range: [0 to 2¹⁶ - 1]

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with setInterrupt().

The values are a bitmask that specifies which interrupts occurred and the current value bitmask.

For example:

(1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
(9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.

The interrupts use the grouping as set by setGroup().

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.

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

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

BrickletIndustrialDigitalIn4.FUNCTION_SET_GROUP = 2
BrickletIndustrialDigitalIn4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
BrickletIndustrialDigitalIn4.FUNCTION_SET_INTERRUPT = 7
BrickletIndustrialDigitalIn4.FUNCTION_SET_EDGE_COUNT_CONFIG = 11

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

BrickletIndustrialDigitalIn4.FUNCTION_SET_GROUP = 2
BrickletIndustrialDigitalIn4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
BrickletIndustrialDigitalIn4.FUNCTION_SET_INTERRUPT = 7
BrickletIndustrialDigitalIn4.FUNCTION_SET_EDGE_COUNT_CONFIG = 11

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

BrickletIndustrialDigitalIn4.DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Digital In 4 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.

BrickletIndustrialDigitalIn4.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Digital In 4 Bricklet.