Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the JavaScript API bindings for the Industrial Dual Analog In Bricklet. General information and technical specifications for the Industrial Dual Analog In 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).
Generally, every method of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback is called with the return values as parameters, if the method returns something. 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.*.
The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.
Parameters: |
|
---|
Creates an object with the unique device ID uid:
var industrialDualAnalogIn = new BrickletIndustrialDualAnalogIn("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected (see examples above).
Parameters: |
|
---|---|
Callback: |
|
Returns the voltage for the given channel in mV.
If you want to get the voltage periodically, it is recommended to use the callback CALLBACK_VOLTAGE and set the period with setVoltageCallbackPeriod().
Parameters: |
|
---|---|
Callback: | undefined |
Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.
The following constants are available for this function:
Callback: |
|
---|
Returns the sample rate as set by setSampleRate().
The following constants are available for this function:
Parameters: |
|
---|---|
Callback: | undefined |
Sets offset and gain of MCP3911 internal calibration registers.
See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function
Callback: |
|
---|
Returns the calibration as set by setCalibration().
Callback: |
|
---|
Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see setCalibration().
Return type: | [int, int, int] |
---|
Returns the version of the API definition (major, minor, revision) 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.
Parameters: |
|
---|---|
Return 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 send and errors are silently ignored, because they cannot be detected.
See setResponseExpected() for the list of function ID constants available for this function.
Parameters: |
|
---|
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 and callbacks it is always disabled.
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 send and errors are silently ignored, because they cannot be detected.
The following function ID constants are available for this function:
Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Callback: |
|
---|
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' or 'd'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
Parameters: |
|
---|
Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.
Parameters: |
|
---|---|
Callback: | undefined |
Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered periodically for the given channel. A value of 0 turns the callback off.
CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
The default value is 0.
Parameters: |
|
---|---|
Callback: |
|
Returns the period as set by setVoltageCallbackPeriod().
Parameters: |
|
---|---|
Callback: | undefined |
Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback for the given channel.
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 default value is ('x', 0, 0).
The following constants are available for this function:
Parameters: |
|
---|---|
Callback: |
|
Returns the threshold as set by setVoltageCallbackThreshold().
The following constants are available for this function:
Parameters: |
|
---|---|
Callback: | undefined |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Callback: |
|
---|
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:
industrialDualAnalogIn.on(BrickletIndustrialDualAnalogIn.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.
Parameters: |
|
---|
This callback is triggered periodically with the period that is set by setVoltageCallbackPeriod(). The parameter is the voltage of the channel.
CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
Parameters: |
|
---|
This callback is triggered when the threshold as set by setVoltageCallbackThreshold() is reached. The parameter is the voltage of the channel.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().
This constant is used to identify a Industrial Dual Analog In Bricklet.
The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.