This is the description of the JavaScript API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA Bricklet are summarized in its hardware description.
An installation guide for the JavaScript API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var id020 = new Tinkerforge.BrickletIndustrialDual020mA(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 sensor 1
id020.getCurrent(1,
function (current) {
console.log('Current (Sensor 1): ' + 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);
}
);
|
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 | 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
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var id020 = new Tinkerforge.BrickletIndustrialDual020mA(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 (sensor 1) callback to 1s (1000ms)
// Note: The current (sensor 1) callback is only called every second
// if the current (sensor 1) has changed since the last call!
id020.setCurrentCallbackPeriod(1, 1000);
}
);
// Register current callback
id020.on(Tinkerforge.BrickletIndustrialDual020mA.CALLBACK_CURRENT,
// Callback function for current callback
function (sensor, current) {
console.log('Sensor: ' + sensor);
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);
}
);
|
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 42 43 | 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
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var id020 = new Tinkerforge.BrickletIndustrialDual020mA(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)
id020.setDebouncePeriod(10000);
// Configure threshold for current (sensor 1) "greater than 10 mA"
id020.setCurrentCallbackThreshold(1, '>', 10*1000000, 0);
}
);
// Register current reached callback
id020.on(Tinkerforge.BrickletIndustrialDual020mA.CALLBACK_CURRENT_REACHED,
// Callback function for current reached callback
function (sensor, current) {
console.log('Sensor: ' + sensor);
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);
}
);
|
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 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.BrickletIndustrialDual020mA(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 sensor 1
id020.getCurrent(1,
function (current) {
textArea.value += 'Current (Sensor 1): ' + current/1000000.0 + ' mA\n';
},
function (error) {
textArea.value += 'Error: ' + error + '\n';
}
);
}
);
}
</script>
</body>
</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 | <!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 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.BrickletIndustrialDual020mA(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 (sensor 1) callback to 1s (1000ms)
// Note: The current (sensor 1) callback is only called every second
// if the current (sensor 1) has changed since the last call!
id020.setCurrentCallbackPeriod(1, 1000);
}
);
// Register current callback
id020.on(Tinkerforge.BrickletIndustrialDual020mA.CALLBACK_CURRENT,
// Callback function for current callback
function (sensor, current) {
textArea.value += 'Sensor: ' + sensor + '\n';
textArea.value += 'Current: ' + current/1000000.0 + ' mA\n';
textArea.value += '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
}
</script>
</body>
</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 64 65 | <!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 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.BrickletIndustrialDual020mA(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)
id020.setDebouncePeriod(10000);
// Configure threshold for current (sensor 1) "greater than 10 mA"
id020.setCurrentCallbackThreshold(1, '>', 10*1000000, 0);
}
);
// Register current reached callback
id020.on(Tinkerforge.BrickletIndustrialDual020mA.CALLBACK_CURRENT_REACHED,
// Callback function for current reached callback
function (sensor, current) {
textArea.value += 'Sensor: ' + sensor + '\n';
textArea.value += 'Current: ' + current/1000000.0 + ' mA\n';
textArea.value += '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
}
</script>
</body>
</html>
|
Generally, every function of the JavaScript bindings can take two optional
parameters, returnCallback
and errorCallback
. These are two user
defined callback functions. The returnCallback
function is called with the
results as arguments, if the function returns its results asynchronously. The
errorCallback
is called with an error code in case of an error. The error
code can be one of the following values:
The namespace for the JavaScript bindings is Tinkerforge.*
.
BrickletIndustrialDual020mA
(uid, ipcon)¶Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid
:
var industrialDual020mA = new BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected.
BrickletIndustrialDual020mA.
getCurrent
(sensor[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the current of the specified sensor.
It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.
If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.
If you want to get the current periodically, it is recommended to use the
CALLBACK_CURRENT
callback and set the period with
setCurrentCallbackPeriod()
.
BrickletIndustrialDual020mA.
setSampleRate
(rate[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
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:
BrickletIndustrialDual020mA.
getSampleRate
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the sample rate as set by setSampleRate()
.
The following constants are available for this function:
For rate:
BrickletIndustrialDual020mA.
getIdentity
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
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.
BrickletIndustrialDual020mA.
on
(callback_id, function[, errorCallback])¶Parameters: |
|
---|---|
Returns: |
|
Registers the given function
with the given callback_id
.
The available callback IDs with corresponding function signatures are listed below.
BrickletIndustrialDual020mA.
setCurrentCallbackPeriod
(sensor, period[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Sets the period with which the CALLBACK_CURRENT
callback is triggered
periodically for the given sensor. A value of 0 turns the callback off.
The CALLBACK_CURRENT
callback is only triggered if the current has changed since the
last triggering.
BrickletIndustrialDual020mA.
getCurrentCallbackPeriod
(sensor[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the period as set by setCurrentCallbackPeriod()
.
BrickletIndustrialDual020mA.
setCurrentCallbackThreshold
(sensor, option, min, max[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Sets the thresholds for the CALLBACK_CURRENT_REACHED
callback for the given
sensor.
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:
BrickletIndustrialDual020mA.
getCurrentCallbackThreshold
(sensor[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the threshold as set by setCurrentCallbackThreshold()
.
The following constants are available for this function:
For option:
BrickletIndustrialDual020mA.
setDebouncePeriod
(debounce[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Sets the period with which the threshold callback
is triggered, if the threshold
keeps being reached.
BrickletIndustrialDual020mA.
getDebouncePeriod
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the debounce period as set by setDebouncePeriod()
.
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:
industrialDual020mA.on(BrickletIndustrialDual020mA.CALLBACK_EXAMPLE,
function (param) {
console.log(param);
}
);
The available constants with inherent number and type of parameters are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
BrickletIndustrialDual020mA.
CALLBACK_CURRENT
¶Callback Parameters: |
|
---|
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.
BrickletIndustrialDual020mA.
CALLBACK_CURRENT_REACHED
¶Callback Parameters: |
|
---|
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()
.
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.
BrickletIndustrialDual020mA.
getAPIVersion
()¶Returns: |
|
---|
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.
BrickletIndustrialDual020mA.
getResponseExpected
(functionId[, errorCallback])¶Parameters: |
|
---|---|
Returns: |
|
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:
BrickletIndustrialDual020mA.
setResponseExpected
(functionId, responseExpected[, errorCallback])¶Parameters: |
|
---|---|
Returns: |
|
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:
BrickletIndustrialDual020mA.
setResponseExpectedAll
(responseExpected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
BrickletIndustrialDual020mA.
DEVICE_IDENTIFIER
¶This constant is used to identify a Industrial Dual 0-20mA 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.
BrickletIndustrialDual020mA.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.