JavaScript - Voltage/Current Bricklet¶

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 Voltage/Current Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var vc = new Tinkerforge.BrickletVoltageCurrent(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 callback to 1s (1000ms)
        // Note: The current callback is only called every second
        //       if the current has changed since the last call!
        vc.setCurrentCallbackPeriod(1000);
    }
);

// Register current callback
vc.on(Tinkerforge.BrickletVoltageCurrent.CALLBACK_CURRENT,
    // Callback function for current callback
    function (current) {
        console.log('Current: ' + current/1000.0 + ' A');
    }
);

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 Voltage/Current Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var vc = new Tinkerforge.BrickletVoltageCurrent(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 threshold callbacks with a debounce time of 10 seconds (10000ms)
        vc.setDebouncePeriod(10000);

        // Configure threshold for power "greater than 10 W"
        vc.setPowerCallbackThreshold('>', 10*1000, 0);
    }
);

// Register power reached callback
vc.on(Tinkerforge.BrickletVoltageCurrent.CALLBACK_POWER_REACHED,
    // Callback function for power reached callback
    function (power) {
        console.log('Power: ' + power/1000.0 + ' W');
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(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
41
42
43
44
45
46
47

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var vc = new Tinkerforge.BrickletVoltageCurrent(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 voltage
        vc.getVoltage(
            function (voltage) {
                console.log('Voltage: ' + voltage/1000.0 + ' V');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );

        // Get current current
        vc.getCurrent(
            function (current) {
                console.log('Current: ' + current/1000.0 + ' A');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

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

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>Voltage/Current Bricklet Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var vc = new Tinkerforge.BrickletVoltageCurrent(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 callback to 1s (1000ms)
                        // Note: The current callback is only called every second
                        //       if the current has changed since the last call!
                        vc.setCurrentCallbackPeriod(1000);
                    }
                );

                // Register current callback
                vc.on(Tinkerforge.BrickletVoltageCurrent.CALLBACK_CURRENT,
                    // Callback function for current callback
                    function (current) {
                        textArea.value += 'Current: ' + current/1000.0 + ' A\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>Voltage/Current Bricklet 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 vc = new Tinkerforge.BrickletVoltageCurrent(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 threshold callbacks with a debounce time of 10 seconds (10000ms)
                        vc.setDebouncePeriod(10000);

                        // Configure threshold for power "greater than 10 W"
                        vc.setPowerCallbackThreshold('>', 10*1000, 0);
                    }
                );

                // Register power reached callback
                vc.on(Tinkerforge.BrickletVoltageCurrent.CALLBACK_POWER_REACHED,
                    // Callback function for power reached callback
                    function (power) {
                        textArea.value += 'Power: ' + power/1000.0 + ' W\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

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
62
63
64
65
66
67
68

<!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>Voltage/Current 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 vc = new Tinkerforge.BrickletVoltageCurrent(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 voltage
                        vc.getVoltage(
                            function (voltage) {
                                textArea.value += 'Voltage: ' + voltage/1000.0 + ' V\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );

                        // Get current current
                        vc.getCurrent(
                            function (current) {
                                textArea.value += 'Current: ' + current/1000.0 + ' A\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Basic Functions¶

new BrickletVoltageCurrent(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	voltageCurrent – Type: BrickletVoltageCurrent

Creates an object with the unique device ID uid:

var voltageCurrent = new BrickletVoltageCurrent("YOUR_DEVICE_UID", ipcon);

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

BrickletVoltageCurrent.getCurrent([returnCallback][, errorCallback])¶

Callback Parameters:	current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]
Returns:	undefined

Returns the current.

If you want to get the current periodically, it is recommended to use the CALLBACK_CURRENT callback and set the period with setCurrentCallbackPeriod().

BrickletVoltageCurrent.getVoltage([returnCallback][, errorCallback])¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 36000]
Returns:	undefined

Returns the voltage.

If you want to get the voltage periodically, it is recommended to use the CALLBACK_VOLTAGE callback and set the period with setVoltageCallbackPeriod().

BrickletVoltageCurrent.getPower([returnCallback][, errorCallback])¶

Callback Parameters:	power – Type: int, Unit: 1 mW, Range: [0 to 720000]
Returns:	undefined

Returns the power.

If you want to get the power periodically, it is recommended to use the CALLBACK_POWER callback and set the period with setPowerCallbackPeriod().

BrickletVoltageCurrent.setConfiguration(averaging, voltageConversionTime, currentConversionTime[, returnCallback][, errorCallback])¶

Parameters:	averaging – Type: int, Range: See constants, Default: 3 voltageConversionTime – Type: int, Range: See constants, Default: 4 currentConversionTime – Type: int, Range: See constants, Default: 4
Callback Parameters:	undefined
Returns:	undefined

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

The following constants are available for this function:

For averaging:

• BrickletVoltageCurrent.AVERAGING_1 = 0
• BrickletVoltageCurrent.AVERAGING_4 = 1
• BrickletVoltageCurrent.AVERAGING_16 = 2
• BrickletVoltageCurrent.AVERAGING_64 = 3
• BrickletVoltageCurrent.AVERAGING_128 = 4
• BrickletVoltageCurrent.AVERAGING_256 = 5
• BrickletVoltageCurrent.AVERAGING_512 = 6
• BrickletVoltageCurrent.AVERAGING_1024 = 7

For voltage_conversion_time:

• BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

For current_conversion_time:

• BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

BrickletVoltageCurrent.getConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	averaging – Type: int, Range: See constants, Default: 3 voltageConversionTime – Type: int, Range: See constants, Default: 4 currentConversionTime – Type: int, Range: See constants, Default: 4
Returns:	undefined

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For averaging:

• BrickletVoltageCurrent.AVERAGING_1 = 0
• BrickletVoltageCurrent.AVERAGING_4 = 1
• BrickletVoltageCurrent.AVERAGING_16 = 2
• BrickletVoltageCurrent.AVERAGING_64 = 3
• BrickletVoltageCurrent.AVERAGING_128 = 4
• BrickletVoltageCurrent.AVERAGING_256 = 5
• BrickletVoltageCurrent.AVERAGING_512 = 6
• BrickletVoltageCurrent.AVERAGING_1024 = 7

For voltage_conversion_time:

• BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

For current_conversion_time:

• BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Advanced Functions¶

BrickletVoltageCurrent.setCalibration(gainMultiplier, gainDivisor[, returnCallback][, errorCallback])¶

Parameters:	gainMultiplier – Type: int, Range: [0 to 216 - 1] gainDivisor – Type: int, Range: [0 to 216 - 1]
Callback Parameters:	undefined
Returns:	undefined

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

BrickletVoltageCurrent.getCalibration([returnCallback][, errorCallback])¶

Callback Parameters:	gainMultiplier – Type: int, Range: [0 to 216 - 1] gainDivisor – Type: int, Range: [0 to 216 - 1]
Returns:	undefined

Returns the calibration as set by setCalibration().

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

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

BrickletVoltageCurrent.setCurrentCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

Sets the period with which the CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletVoltageCurrent.getCurrentCallbackPeriod([returnCallback][, errorCallback])¶

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

Returns the period as set by setCurrentCallbackPeriod().

BrickletVoltageCurrent.setVoltageCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

Sets the period with which the CALLBACK_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

BrickletVoltageCurrent.getVoltageCallbackPeriod([returnCallback][, errorCallback])¶

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

Returns the period as set by setVoltageCallbackPeriod().

BrickletVoltageCurrent.setPowerCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

Sets the period with which the CALLBACK_POWER callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_POWER callback is only triggered if the power has changed since the last triggering.

BrickletVoltageCurrent.getPowerCallbackPeriod([returnCallback][, errorCallback])¶

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

Returns the period as set by getPowerCallbackPeriod().

BrickletVoltageCurrent.setCurrentCallbackThreshold(option, min, max[, returnCallback][, errorCallback])¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the current is outside the min and max values
'i'	Callback is triggered when the current is inside the min and max values
'<'	Callback is triggered when the current is smaller than the min value (max is ignored)
'>'	Callback is triggered when the current is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

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

BrickletVoltageCurrent.getCurrentCallbackThreshold([returnCallback][, errorCallback])¶

Callback Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 mA, Range: [-231 to 231 - 1], Default: 0
Returns:	undefined

Returns the threshold as set by setCurrentCallbackThreshold().

The following constants are available for this function:

For option:

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

BrickletVoltageCurrent.setVoltageCallbackThreshold(option, min, max[, returnCallback][, errorCallback])¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the voltage is outside the min and max values
'i'	Callback is triggered when the voltage is inside the min and max values
'<'	Callback is triggered when the voltage is smaller than the min value (max is ignored)
'>'	Callback is triggered when the voltage is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

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

BrickletVoltageCurrent.getVoltageCallbackThreshold([returnCallback][, errorCallback])¶

Callback Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [-231 to 231 - 1], Default: 0
Returns:	undefined

Returns the threshold as set by setVoltageCallbackThreshold().

The following constants are available for this function:

For option:

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

BrickletVoltageCurrent.setPowerCallbackThreshold(option, min, max[, returnCallback][, errorCallback])¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets the thresholds for the CALLBACK_POWER_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the power is outside the min and max values
'i'	Callback is triggered when the power is inside the min and max values
'<'	Callback is triggered when the power is smaller than the min value (max is ignored)
'>'	Callback is triggered when the power is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

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

BrickletVoltageCurrent.getPowerCallbackThreshold([returnCallback][, errorCallback])¶

Callback Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 mW, Range: [-231 to 231 - 1], Default: 0
Returns:	undefined

Returns the threshold as set by setPowerCallbackThreshold().

The following constants are available for this function:

For option:

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

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

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

Sets the period with which the threshold callbacks

• CALLBACK_CURRENT_REACHED,
• CALLBACK_VOLTAGE_REACHED,
• CALLBACK_POWER_REACHED

are triggered, if the thresholds

• setCurrentCallbackThreshold(),
• setVoltageCallbackThreshold(),
• setPowerCallbackThreshold()

keep being reached.

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

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

Returns the debounce period as set by setDebouncePeriod().

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:

voltageCurrent.on(BrickletVoltageCurrent.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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

BrickletVoltageCurrent.CALLBACK_CURRENT¶

Callback Parameters:	current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered periodically with the period that is set by setCurrentCallbackPeriod(). The parameter is the current of the sensor.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

BrickletVoltageCurrent.CALLBACK_VOLTAGE¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 36000]

This callback is triggered periodically with the period that is set by setVoltageCallbackPeriod(). The parameter is the voltage of the sensor.

The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the last triggering.

BrickletVoltageCurrent.CALLBACK_POWER¶

Callback Parameters:	power – Type: int, Unit: 1 mW, Range: [0 to 720000]

This callback is triggered periodically with the period that is set by setPowerCallbackPeriod(). The parameter is the power of the sensor.

The CALLBACK_POWER callback is only triggered if the power has changed since the last triggering.

BrickletVoltageCurrent.CALLBACK_CURRENT_REACHED¶

Callback Parameters:	current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered when the threshold as set by setCurrentCallbackThreshold() is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

BrickletVoltageCurrent.CALLBACK_VOLTAGE_REACHED¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 36000]

This callback is triggered when the threshold as set by setVoltageCallbackThreshold() is reached. The parameter is the voltage of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

BrickletVoltageCurrent.CALLBACK_POWER_REACHED¶

Callback Parameters:	power – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered when the threshold as set by setPowerCallbackThreshold() is reached. The parameter is the power of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

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.

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

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

• BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
• BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
• BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
• BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
• BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
• BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
• BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
• BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
• BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20

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

• BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
• BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
• BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
• BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
• BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
• BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
• BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
• BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
• BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20

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

BrickletVoltageCurrent.DEVICE_IDENTIFIER¶

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

BrickletVoltageCurrent.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Voltage/Current Bricklet.