JavaScript - Industrial Dual 0-20mA 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

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var id020 = new Tinkerforge.BrickletIndustrialDual020mAV2(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 current from channel 0
        id020.getCurrent(0,
            function (current) {
                console.log('Current (Channel 0): ' + current/1000000.0 + ' mA');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

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

Callback (Node.js)¶

Download (ExampleCallback.js)

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

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var id020 = new Tinkerforge.BrickletIndustrialDual020mAV2(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 current (channel 0) callback to 1s (1000ms) without a threshold
        id020.setCurrentCallbackConfiguration(0, 1000, false, 'x', 0, 0);
    }
);

// Register current callback
id020.on(Tinkerforge.BrickletIndustrialDual020mAV2.CALLBACK_CURRENT,
    // Callback function for current callback
    function (channel, current) {
        console.log('Channel: ' + channel);
        console.log('Current: ' + current/1000000.0 + ' mA');
        console.log();
    }
);

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

Threshold (Node.js)¶

Download (ExampleThreshold.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

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var id020 = new Tinkerforge.BrickletIndustrialDual020mAV2(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 threshold for current (channel 0) "greater than 10 mA"
        // with a debounce period of 10s (10000ms)
        id020.setCurrentCallbackConfiguration(0, 10000, false, '>', 10*1000000, 0);
    }
);

// Register current callback
id020.on(Tinkerforge.BrickletIndustrialDual020mAV2.CALLBACK_CURRENT,
    // Callback function for current callback
    function (channel, current) {
        console.log('Channel: ' + channel);
        console.log('Current: ' + current/1000000.0 + ' mA');
        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

<!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 Dual 0-20mA 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 id020 = new Tinkerforge.BrickletIndustrialDual020mAV2(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 current from channel 0
                        id020.getCurrent(0,
                            function (current) {
                                textArea.value += 'Current (Channel 0): ' + current/1000000.0 + ' mA\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

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

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

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Industrial Dual 0-20mA 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 id020 = new Tinkerforge.BrickletIndustrialDual020mAV2(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 current (channel 0) callback to 1s (1000ms) without a threshold
                        id020.setCurrentCallbackConfiguration(0, 1000, false, 'x', 0, 0);
                    }
                );

                // Register current callback
                id020.on(Tinkerforge.BrickletIndustrialDual020mAV2.CALLBACK_CURRENT,
                    // Callback function for current callback
                    function (channel, current) {
                        textArea.value += 'Channel: ' + channel + '\n';
                        textArea.value += 'Current: ' + current/1000000.0 + ' mA\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Threshold (HTML)¶

Download (ExampleThreshold.html), Test (ExampleThreshold.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

<!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 Dual 0-20mA Bricklet 2.0 Threshold 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 id020 = new Tinkerforge.BrickletIndustrialDual020mAV2(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 threshold for current (channel 0) "greater than 10 mA"
                        // with a debounce period of 10s (10000ms)
                        id020.setCurrentCallbackConfiguration(0, 10000, false, '>', 10*1000000, 0);
                    }
                );

                // Register current callback
                id020.on(Tinkerforge.BrickletIndustrialDual020mAV2.CALLBACK_CURRENT,
                    // Callback function for current callback
                    function (channel, current) {
                        textArea.value += 'Channel: ' + channel + '\n';
                        textArea.value += 'Current: ' + current/1000000.0 + ' mA\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Basic Functions¶

new BrickletIndustrialDual020mAV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	industrialDual020mAV2 – Type: BrickletIndustrialDual020mAV2

Creates an object with the unique device ID uid:

var industrialDual020mAV2 = new BrickletIndustrialDual020mAV2("YOUR_DEVICE_UID", ipcon);

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

BrickletIndustrialDual020mAV2.getCurrent(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 1]
Callback Parameters:	current – Type: int, Unit: 1 nA, Range: [0 to 22505322]
Returns:	undefined

Returns the current of the specified channel.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.

If the returned current is below 4mA, there is likely no sensor connected or the connected sensor is defective. If the returned current is over 20mA, there might be a short circuit or the sensor is defective.

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

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

Parameters:	channel – Type: int, Range: [0 to 1] 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 can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with setChannelLEDStatusConfig().

The following constants are available for this function:

For config:

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

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

Parameters:	channel – Type: int, Range: [0 to 1]
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 config:

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

BrickletIndustrialDual020mAV2.setChannelLEDStatusConfig(channel, min, max, config[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 1] min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 4000000 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 20000000 config – Type: int, Range: See constants, Default: 1
Callback Parameters:	undefined
Returns:	undefined

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see setChannelLEDConfig().

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in nA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the "max" parameter to the threshold value in nA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA.

In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.

The following constants are available for this function:

For config:

• BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialDual020mAV2.getChannelLEDStatusConfig(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 1]
Callback Parameters:	min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 4000000 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 20000000 config – Type: int, Range: See constants, Default: 1
Returns:	undefined

Returns the channel LED status configuration as set by setChannelLEDStatusConfig().

The following constants are available for this function:

For config:

• BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions¶

BrickletIndustrialDual020mAV2.setSampleRate(rate[, returnCallback][, errorCallback])¶

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

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value	Description
0	240 samples per second, 12 bit resolution
1	60 samples per second, 14 bit resolution
2	15 samples per second, 16 bit resolution
3	4 samples per second, 18 bit resolution

The following constants are available for this function:

For rate:

• BrickletIndustrialDual020mAV2.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mAV2.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mAV2.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mAV2.SAMPLE_RATE_4_SPS = 3

BrickletIndustrialDual020mAV2.getSampleRate([returnCallback][, errorCallback])¶

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

Returns the sample rate as set by setSampleRate().

The following constants are available for this function:

For rate:

• BrickletIndustrialDual020mAV2.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mAV2.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mAV2.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mAV2.SAMPLE_RATE_4_SPS = 3

BrickletIndustrialDual020mAV2.setGain(gain[, returnCallback][, errorCallback])¶

Parameters:	gain – Type: int, Range: See constants, Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution.

Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.

The following constants are available for this function:

For gain:

• BrickletIndustrialDual020mAV2.GAIN_1X = 0
• BrickletIndustrialDual020mAV2.GAIN_2X = 1
• BrickletIndustrialDual020mAV2.GAIN_4X = 2
• BrickletIndustrialDual020mAV2.GAIN_8X = 3

BrickletIndustrialDual020mAV2.getGain([returnCallback][, errorCallback])¶

Callback Parameters:	gain – Type: int, Range: See constants, Default: 0
Returns:	undefined

Returns the gain as set by setGain().

The following constants are available for this function:

For gain:

• BrickletIndustrialDual020mAV2.GAIN_1X = 0
• BrickletIndustrialDual020mAV2.GAIN_2X = 1
• BrickletIndustrialDual020mAV2.GAIN_4X = 2
• BrickletIndustrialDual020mAV2.GAIN_8X = 3

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

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

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

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

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

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

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

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

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

BrickletIndustrialDual020mAV2.setCurrentCallbackConfiguration(channel, period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 1] 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, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

The period is the period with which the CALLBACK_CURRENT 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_CURRENT 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:

• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_GREATER = '>'

BrickletIndustrialDual020mAV2.getCurrentCallbackConfiguration(channel[, returnCallback][, errorCallback])¶

Parameters:	channel – Type: int, Range: [0 to 1]
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, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
Returns:	undefined

Returns the callback configuration as set by setCurrentCallbackConfiguration().

The following constants are available for this function:

For option:

• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_GREATER = '>'

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:

industrialDual020mAV2.on(BrickletIndustrialDual020mAV2.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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

BrickletIndustrialDual020mAV2.CALLBACK_CURRENT¶

Callback Parameters:	channel – Type: int, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

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

The parameter is the same as getCurrent().

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.

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

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

• BrickletIndustrialDual020mAV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDual020mAV2.FUNCTION_SET_SAMPLE_RATE = 5
• BrickletIndustrialDual020mAV2.FUNCTION_SET_GAIN = 7
• BrickletIndustrialDual020mAV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDual020mAV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
• BrickletIndustrialDual020mAV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDual020mAV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDual020mAV2.FUNCTION_RESET = 243
• BrickletIndustrialDual020mAV2.FUNCTION_WRITE_UID = 248

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

• BrickletIndustrialDual020mAV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDual020mAV2.FUNCTION_SET_SAMPLE_RATE = 5
• BrickletIndustrialDual020mAV2.FUNCTION_SET_GAIN = 7
• BrickletIndustrialDual020mAV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDual020mAV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
• BrickletIndustrialDual020mAV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDual020mAV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDual020mAV2.FUNCTION_RESET = 243
• BrickletIndustrialDual020mAV2.FUNCTION_WRITE_UID = 248

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

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

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

For status:

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

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

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

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

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

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

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

BrickletIndustrialDual020mAV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Dual 0-20mA 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.

BrickletIndustrialDual020mAV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet 2.0.