JavaScript - Industrial Digital In 4 Bricklet 2.0¶

Simple (Node.js)¶

Download (ExampleSimple.js)

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

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 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4V2(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
        idi4.getValue(
            function (value) {
                console.log('Channel 0: ' + value[0]);
                console.log('Channel 1: ' + value[1]);
                console.log('Channel 2: ' + value[2]);
                console.log('Channel 3: ' + value[3]);
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

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

Edge Count (Node.js)¶

Download (ExampleEdgeCount.js)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

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 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4V2(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) {
        // Configure rising edge count (channel 3) with 10ms debounce
        idi4.setEdgeCountConfiguration(3, 0, 10);

        // Get edge count 10 times with 1s delay
        for(var i = 0; i < 10; ++i) {
            setTimeout(function () {
                // Get current edge count
                idi4.getEdgeCount(3, false,
                    function (count) {
                        console.log('Count: ' + count);
                    },
                    function (error) {
                        console.log('Error: ' + error);
                    }
                );
            }, 1000 * i + 1000);
        }
    }
);

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
41
42
43
44
45
46
47
48
49
50
51
52
53

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 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4V2(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 value (channel 1) callback to 0.1s (100ms)
        idi4.setValueCallbackConfiguration(1, 100, false);
    }
);

// Register value callback
idi4.on(Tinkerforge.BrickletIndustrialDigitalIn4V2.CALLBACK_VALUE,
    // Callback function for value callback
    function (channel, changed, value) {
        if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_0) {
            console.log('Channel: 0');
        }
        else if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_1) {
            console.log('Channel: 1');
        }
        else if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_2) {
            console.log('Channel: 2');
        }
        else if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_3) {
            console.log('Channel: 3');
        }

        console.log('Changed: ' + changed);
        console.log('Value: ' + value);
        console.log();
    }
);

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

Simple (HTML)¶

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

<!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 2.0 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.BrickletIndustrialDigitalIn4V2(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
                        idi4.getValue(
                            function (value) {
                                textArea.value += 'Channel 0: ' + value[0] + '\n';
                                textArea.value += 'Channel 1: ' + value[1] + '\n';
                                textArea.value += 'Channel 2: ' + value[2] + '\n';
                                textArea.value += 'Channel 3: ' + value[3] + '\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Edge Count (HTML)¶

Download (ExampleEdgeCount.html), Test (ExampleEdgeCount.html)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

<!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 2.0 Edge Count 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.BrickletIndustrialDigitalIn4V2(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) {
                        // Configure rising edge count (channel 3) with 10ms debounce
                        idi4.setEdgeCountConfiguration(3, 0, 10);

                        // Get edge count 10 times with 1s delay
                        for(var i = 0; i < 10; ++i) {
                            setTimeout(function () {
                                // Get current edge count
                                idi4.getEdgeCount(3, false,
                                    function (count) {
                                        textArea.value += 'Count: ' + count + '\n';
                                    },
                                    function (error) {
                                        textArea.value += 'Error: ' + error + '\n';
                                    }
                                );
                            }, 1000 * i + 1000);
                        }
                    }
                );
            }
        </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
63
64
65
66
67
68
69
70
71
72
73
74
75

<!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 2.0 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 idi4 = new Tinkerforge.BrickletIndustrialDigitalIn4V2(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 value (channel 1) callback to 0.1s (100ms)
                        idi4.setValueCallbackConfiguration(1, 100, false);
                    }
                );

                // Register value callback
                idi4.on(Tinkerforge.BrickletIndustrialDigitalIn4V2.CALLBACK_VALUE,
                    // Callback function for value callback
                    function (channel, changed, value) {
                        if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_0) {
                            textArea.value += 'Channel: 0\n';
                        }
                        else if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_1) {
                            textArea.value += 'Channel: 1\n';
                        }
                        else if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_2) {
                            textArea.value += 'Channel: 2\n';
                        }
                        else if(channel === Tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_3) {
                            textArea.value += 'Channel: 3\n';
                        }

                        textArea.value += 'Changed: ' + changed + '\n';
                        textArea.value += 'Value: ' + value + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Basic Functions¶

new BrickletIndustrialDigitalIn4V2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	industrialDigitalIn4V2 – Type: BrickletIndustrialDigitalIn4V2

Creates an object with the unique device ID uid:

var industrialDigitalIn4V2 = new BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon);

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

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

Callback Parameters:	value – Type: [boolean, ...], Length: 4
Returns:	undefined

Returns the input value as bools, true refers to high and false refers to low.

BrickletIndustrialDigitalIn4V2.setChannelLEDConfig(channel, config[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants config – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

For config:

• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

BrickletIndustrialDigitalIn4V2.getChannelLEDConfig(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants
Callback Parameters:	config – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

For config:

• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

BrickletIndustrialDigitalIn4V2.getEdgeCount(channel, resetCounter[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants resetCounter – Type: boolean
Callback Parameters:	count – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

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

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

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.setEdgeCountConfiguration(channel, edgeType, debounce[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants 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 a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. 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 following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

For edge_type:

• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

BrickletIndustrialDigitalIn4V2.getEdgeCountConfiguration(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants
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 channel as set by setEdgeCountConfiguration().

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

For edge_type:

• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

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

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

• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

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

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

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

BrickletIndustrialDigitalIn4V2.setValueCallbackConfiguration(channel, period, valueHasToChange[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Callback Parameters:	undefined
Returns:	undefined

This callback can be configured per channel.

The period is the period with which the CALLBACK_VALUE 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.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.getValueCallbackConfiguration(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: See constants
Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Returns:	undefined

Returns the callback configuration for the given channel as set by setValueCallbackConfiguration().

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.setAllValueCallbackConfiguration(period, valueHasToChange[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Callback Parameters:	undefined
Returns:	undefined

The period is the period with which the CALLBACK_ALL_VALUE 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.

BrickletIndustrialDigitalIn4V2.getAllValueCallbackConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false
Returns:	undefined

Returns the callback configuration as set by setAllValueCallbackConfiguration().

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:

industrialDigitalIn4V2.on(BrickletIndustrialDigitalIn4V2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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

BrickletIndustrialDigitalIn4V2.CALLBACK_VALUE¶

Callback Parameters:	channel – Type: int, Range: See constants changed – Type: boolean value – Type: boolean

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

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2.CALLBACK_ALL_VALUE¶

Callback Parameters:	changed – Type: [boolean, ...], Length: 4 value – Type: [boolean, ...], Length: 4

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

The parameters are the same as getValue(). Additional the changed parameter is true if the value has changed since the last callback.

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.

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

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

• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
• BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248

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

• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
• BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248

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

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

• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_OK = 0
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

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

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

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

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

BrickletIndustrialDigitalIn4V2.DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Digital In 4 Bricklet 2.0.

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.

BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.