This is the description of the JavaScript API bindings for the Industrial Counter Bricklet. General information and technical specifications for the Industrial Counter 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 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 Counter Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ic = new Tinkerforge.BrickletIndustrialCounter(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 all counter callback to 1s (1000ms)
ic.setAllCounterCallbackConfiguration(1000, true);
}
);
// Register all counter callback
ic.on(Tinkerforge.BrickletIndustrialCounter.CALLBACK_ALL_COUNTER,
// Callback function for all counter callback
function (counter) {
console.log('Counter (Channel 0): ' + counter[0]);
console.log('Counter (Channel 1): ' + counter[1]);
console.log('Counter (Channel 2): ' + counter[2]);
console.log('Counter (Channel 3): ' + counter[3]);
console.log();
}
);
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 43 44 45 46 47 48 49 50 | var Tinkerforge = require('tinkerforge');
var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Counter Bricklet
var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ic = new Tinkerforge.BrickletIndustrialCounter(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 counter from channel 0
ic.getCounter(Tinkerforge.BrickletIndustrialCounter.CHANNEL_0,
function (counter) {
console.log('Counter (Channel 0): ' + counter);
},
function (error) {
console.log('Error: ' + error);
}
);
// Get current signal data from channel 0
ic.getSignalData(Tinkerforge.BrickletIndustrialCounter.CHANNEL_0,
function (dutyCycle, period, frequency, value) {
console.log('Duty Cycle (Channel 0): ' + dutyCycle/100.0 + ' %');
console.log('Period (Channel 0): ' + period + ' ns');
console.log('Frequency (Channel 0): ' + frequency/1000.0 + ' Hz');
console.log('Value (Channel 0): ' + value);
},
function (error) {
console.log('Error: ' + error);
}
);
}
);
console.log('Press key to exit');
process.stdin.on('data',
function (data) {
ipcon.disconnect();
process.exit(0);
}
);
|
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 Counter 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 ic = new Tinkerforge.BrickletIndustrialCounter(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 all counter callback to 1s (1000ms)
ic.setAllCounterCallbackConfiguration(1000, true);
}
);
// Register all counter callback
ic.on(Tinkerforge.BrickletIndustrialCounter.CALLBACK_ALL_COUNTER,
// Callback function for all counter callback
function (counter) {
textArea.value += 'Counter (Channel 0): ' + counter[0] + '\n';
textArea.value += 'Counter (Channel 1): ' + counter[1] + '\n';
textArea.value += 'Counter (Channel 2): ' + counter[2] + '\n';
textArea.value += 'Counter (Channel 3): ' + counter[3] + '\n';
textArea.value += '\n';
textArea.scrollTop = textArea.scrollHeight;
}
);
}
</script>
</body>
</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 69 70 71 | <!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 Counter 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 ic = new Tinkerforge.BrickletIndustrialCounter(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 counter from channel 0
ic.getCounter(Tinkerforge.BrickletIndustrialCounter.CHANNEL_0,
function (counter) {
textArea.value += 'Counter (Channel 0): ' + counter + '\n';
},
function (error) {
textArea.value += 'Error: ' + error + '\n';
}
);
// Get current signal data from channel 0
ic.getSignalData(Tinkerforge.BrickletIndustrialCounter.CHANNEL_0,
function (dutyCycle, period, frequency, value) {
textArea.value += 'Duty Cycle (Channel 0): ' + dutyCycle/100.0 + ' %\n';
textArea.value += 'Period (Channel 0): ' + period + ' ns\n';
textArea.value += 'Frequency (Channel 0): ' + frequency/1000.0 + ' Hz\n';
textArea.value += 'Value (Channel 0): ' + value + '\n';
},
function (error) {
textArea.value += 'Error: ' + error + '\n';
}
);
}
);
}
</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.*
.
BrickletIndustrialCounter
(uid, ipcon)¶Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid
:
var industrialCounter = new BrickletIndustrialCounter("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected.
BrickletIndustrialCounter.
getCounter
(channel[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the current counter value for the given channel.
The following constants are available for this function:
For channel:
BrickletIndustrialCounter.
getAllCounter
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the current counter values for all four channels.
BrickletIndustrialCounter.
setCounter
(channel, counter[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Sets the counter value for the given channel.
The default value for the counters on startup is 0.
The following constants are available for this function:
For channel:
BrickletIndustrialCounter.
setAllCounter
(counter[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Sets the counter values for all four channels.
The default value for the counters on startup is 0.
BrickletIndustrialCounter.
getSignalData
(channel[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the signal data (duty cycle, period, frequency and value) for the given channel.
The following constants are available for this function:
For channel:
BrickletIndustrialCounter.
getAllSignalData
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the signal data (duty cycle, period, frequency and value) for all four channels.
BrickletIndustrialCounter.
setCounterActive
(channel, active[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Activates/deactivates the counter of the given channel.
true = activate, false = deactivate.
By default all channels are activated.
The following constants are available for this function:
For channel:
BrickletIndustrialCounter.
setAllCounterActive
(active[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Activates/deactivates the counter of all four channels.
true = activate, false = deactivate.
By default all channels are activated.
BrickletIndustrialCounter.
getCounterActive
(channel[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the activation state of the given channel.
true = activated, false = deactivated.
The following constants are available for this function:
For channel:
BrickletIndustrialCounter.
getAllCounterActive
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the activation state of all four channels.
true = activated, false = deactivated.
BrickletIndustrialCounter.
setCounterConfiguration
(channel, countEdge, countDirection, dutyCyclePrescaler, frequencyIntegrationTime[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Sets the counter configuration for the given channel.
The following constants are available for this function:
For channel:
For count_edge:
For count_direction:
For duty_cycle_prescaler:
For frequency_integration_time:
BrickletIndustrialCounter.
getCounterConfiguration
(channel[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the counter configuration as set by setCounterConfiguration()
.
The following constants are available for this function:
For channel:
For count_edge:
For count_direction:
For duty_cycle_prescaler:
For frequency_integration_time:
BrickletIndustrialCounter.
setChannelLEDConfig
(channel, config[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.
The following constants are available for this function:
For channel:
For config:
BrickletIndustrialCounter.
getChannelLEDConfig
(channel[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
Returns the channel LED configuration as set by setChannelLEDConfig()
The following constants are available for this function:
For channel:
For config:
BrickletIndustrialCounter.
getSPITFPErrorCount
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
BrickletIndustrialCounter.
setStatusLEDConfig
(config[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
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:
BrickletIndustrialCounter.
getStatusLEDConfig
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the configuration as set by setStatusLEDConfig()
The following constants are available for this function:
For config:
BrickletIndustrialCounter.
getChipTemperature
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
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.
BrickletIndustrialCounter.
reset
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
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!
BrickletIndustrialCounter.
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.
BrickletIndustrialCounter.
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.
BrickletIndustrialCounter.
setAllCounterCallbackConfiguration
(period, valueHasToChange[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
The period is the period with which the CALLBACK_ALL_COUNTER
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.
BrickletIndustrialCounter.
getAllCounterCallbackConfiguration
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the callback configuration as set by
setAllCounterCallbackConfiguration()
.
BrickletIndustrialCounter.
setAllSignalDataCallbackConfiguration
(period, valueHasToChange[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
The period is the period with which the CALLBACK_ALL_SIGNAL_DATA
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.
BrickletIndustrialCounter.
getAllSignalDataCallbackConfiguration
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the callback configuration as set by
setAllSignalDataCallbackConfiguration()
.
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:
industrialCounter.on(BrickletIndustrialCounter.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.
BrickletIndustrialCounter.
CALLBACK_ALL_COUNTER
¶Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by
setAllCounterCallbackConfiguration()
.
The parameters are the same as getAllCounter()
.
BrickletIndustrialCounter.
CALLBACK_ALL_SIGNAL_DATA
¶Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by
setAllSignalDataCallbackConfiguration()
.
The parameters are the same as getAllSignalData()
.
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.
BrickletIndustrialCounter.
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.
BrickletIndustrialCounter.
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:
BrickletIndustrialCounter.
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:
BrickletIndustrialCounter.
setResponseExpectedAll
(responseExpected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
BrickletIndustrialCounter.
setBootloaderMode
(mode[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
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:
For status:
BrickletIndustrialCounter.
getBootloaderMode
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the current bootloader mode, see setBootloaderMode()
.
The following constants are available for this function:
For mode:
BrickletIndustrialCounter.
setWriteFirmwarePointer
(pointer[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
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.
BrickletIndustrialCounter.
writeFirmware
(data[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
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.
BrickletIndustrialCounter.
writeUID
(uid[, returnCallback][, errorCallback])¶Parameters: |
|
---|---|
Callback Parameters: |
|
Returns: |
|
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.
BrickletIndustrialCounter.
readUID
([returnCallback][, errorCallback])¶Callback Parameters: |
|
---|---|
Returns: |
|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
BrickletIndustrialCounter.
DEVICE_IDENTIFIER
¶This constant is used to identify a Industrial Counter 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.
BrickletIndustrialCounter.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Industrial Counter Bricklet.