290 lines
13 KiB
JavaScript
290 lines
13 KiB
JavaScript
/* ***********************************************************
|
|
* This file was automatically generated on 2016-02-10. *
|
|
* *
|
|
* JavaScript Bindings Version 2.0.8 *
|
|
* *
|
|
* If you have a bugfix for this file and want to commit it, *
|
|
* please fix the bug in the generator. You can find a link *
|
|
* to the generators git repository on tinkerforge.com *
|
|
*************************************************************/
|
|
|
|
var Device = require('./Device');
|
|
|
|
BrickletAnalogIn.DEVICE_IDENTIFIER = 219;
|
|
BrickletAnalogIn.DEVICE_DISPLAY_NAME = 'Analog In Bricklet';
|
|
BrickletAnalogIn.CALLBACK_VOLTAGE = 13;
|
|
BrickletAnalogIn.CALLBACK_ANALOG_VALUE = 14;
|
|
BrickletAnalogIn.CALLBACK_VOLTAGE_REACHED = 15;
|
|
BrickletAnalogIn.CALLBACK_ANALOG_VALUE_REACHED = 16;
|
|
BrickletAnalogIn.FUNCTION_GET_VOLTAGE = 1;
|
|
BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE = 2;
|
|
BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3;
|
|
BrickletAnalogIn.FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD = 4;
|
|
BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5;
|
|
BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD = 6;
|
|
BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7;
|
|
BrickletAnalogIn.FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD = 8;
|
|
BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9;
|
|
BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD = 10;
|
|
BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 11;
|
|
BrickletAnalogIn.FUNCTION_GET_DEBOUNCE_PERIOD = 12;
|
|
BrickletAnalogIn.FUNCTION_SET_RANGE = 17;
|
|
BrickletAnalogIn.FUNCTION_GET_RANGE = 18;
|
|
BrickletAnalogIn.FUNCTION_SET_AVERAGING = 19;
|
|
BrickletAnalogIn.FUNCTION_GET_AVERAGING = 20;
|
|
BrickletAnalogIn.FUNCTION_GET_IDENTITY = 255;
|
|
BrickletAnalogIn.THRESHOLD_OPTION_OFF = 'x';
|
|
BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o';
|
|
BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = 'i';
|
|
BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = '<';
|
|
BrickletAnalogIn.THRESHOLD_OPTION_GREATER = '>';
|
|
BrickletAnalogIn.RANGE_AUTOMATIC = 0;
|
|
BrickletAnalogIn.RANGE_UP_TO_6V = 1;
|
|
BrickletAnalogIn.RANGE_UP_TO_10V = 2;
|
|
BrickletAnalogIn.RANGE_UP_TO_36V = 3;
|
|
BrickletAnalogIn.RANGE_UP_TO_45V = 4;
|
|
BrickletAnalogIn.RANGE_UP_TO_3V = 5;
|
|
|
|
function BrickletAnalogIn(uid, ipcon) {
|
|
//Measures DC voltage between 0V and 45V
|
|
|
|
/*
|
|
Creates an object with the unique device ID *uid* and adds it to
|
|
the IP Connection *ipcon*.
|
|
*/
|
|
Device.call(this, this, uid, ipcon);
|
|
BrickletAnalogIn.prototype = Object.create(Device);
|
|
this.responseExpected = {};
|
|
this.callbackFormats = {};
|
|
this.APIVersion = [2, 0, 3];
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_VOLTAGE] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_DEBOUNCE_PERIOD] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.CALLBACK_VOLTAGE] = Device.RESPONSE_EXPECTED_ALWAYS_FALSE;
|
|
this.responseExpected[BrickletAnalogIn.CALLBACK_ANALOG_VALUE] = Device.RESPONSE_EXPECTED_ALWAYS_FALSE;
|
|
this.responseExpected[BrickletAnalogIn.CALLBACK_VOLTAGE_REACHED] = Device.RESPONSE_EXPECTED_ALWAYS_FALSE;
|
|
this.responseExpected[BrickletAnalogIn.CALLBACK_ANALOG_VALUE_REACHED] = Device.RESPONSE_EXPECTED_ALWAYS_FALSE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_RANGE] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_RANGE] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_SET_AVERAGING] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_AVERAGING] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletAnalogIn.FUNCTION_GET_IDENTITY] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.callbackFormats[BrickletAnalogIn.CALLBACK_VOLTAGE] = 'H';
|
|
this.callbackFormats[BrickletAnalogIn.CALLBACK_ANALOG_VALUE] = 'H';
|
|
this.callbackFormats[BrickletAnalogIn.CALLBACK_VOLTAGE_REACHED] = 'H';
|
|
this.callbackFormats[BrickletAnalogIn.CALLBACK_ANALOG_VALUE_REACHED] = 'H';
|
|
|
|
this.getVoltage = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the voltage of the sensor. The value is in mV and
|
|
between 0V and 45V. The resolution between 0 and 6V is about 2mV.
|
|
Between 6 and 45V the resolution is about 10mV.
|
|
|
|
If you want to get the voltage periodically, it is recommended to use the
|
|
callback :func:`Voltage` and set the period with
|
|
:func:`SetVoltageCallbackPeriod`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_VOLTAGE, [], '', 'H', returnCallback, errorCallback);
|
|
};
|
|
this.getAnalogValue = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the value as read by a 12-bit analog-to-digital converter.
|
|
The value is between 0 and 4095.
|
|
|
|
.. note::
|
|
The value returned by :func:`GetVoltage` is averaged over several samples
|
|
to yield less noise, while :func:`GetAnalogValue` gives back raw
|
|
unfiltered analog values. The only reason to use :func:`GetAnalogValue` is,
|
|
if you need the full resolution of the analog-to-digital converter.
|
|
|
|
If you want the analog value periodically, it is recommended to use the
|
|
callback :func:`AnalogValue` and set the period with
|
|
:func:`SetAnalogValueCallbackPeriod`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE, [], '', 'H', returnCallback, errorCallback);
|
|
};
|
|
this.setVoltageCallbackPeriod = function(period, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the period in ms with which the :func:`Voltage` callback is triggered
|
|
periodically. A value of 0 turns the callback off.
|
|
|
|
:func:`Voltage` is only triggered if the voltage has changed since the
|
|
last triggering.
|
|
|
|
The default value is 0.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [period], 'I', '', returnCallback, errorCallback);
|
|
};
|
|
this.getVoltageCallbackPeriod = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the period as set by :func:`SetVoltageCallbackPeriod`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [], '', 'I', returnCallback, errorCallback);
|
|
};
|
|
this.setAnalogValueCallbackPeriod = function(period, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the period in ms with which the :func:`AnalogValue` callback is triggered
|
|
periodically. A value of 0 turns the callback off.
|
|
|
|
:func:`AnalogValue` is only triggered if the analog value has changed since the
|
|
last triggering.
|
|
|
|
The default value is 0.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'I', '', returnCallback, errorCallback);
|
|
};
|
|
this.getAnalogValueCallbackPeriod = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the period as set by :func:`SetAnalogValueCallbackPeriod`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 'I', returnCallback, errorCallback);
|
|
};
|
|
this.setVoltageCallbackThreshold = function(option, min, max, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the thresholds for the :func:`VoltageReached` callback.
|
|
|
|
The following options are possible:
|
|
|
|
.. csv-table::
|
|
:header: "Option", "Description"
|
|
:widths: 10, 100
|
|
|
|
"'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).
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [option, min, max], 'c H H', '', returnCallback, errorCallback);
|
|
};
|
|
this.getVoltageCallbackThreshold = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the threshold as set by :func:`SetVoltageCallbackThreshold`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 'c H H', returnCallback, errorCallback);
|
|
};
|
|
this.setAnalogValueCallbackThreshold = function(option, min, max, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the thresholds for the :func:`AnalogValueReached` callback.
|
|
|
|
The following options are possible:
|
|
|
|
.. csv-table::
|
|
:header: "Option", "Description"
|
|
:widths: 10, 100
|
|
|
|
"'x'", "Callback is turned off"
|
|
"'o'", "Callback is triggered when the analog value is *outside* the min and max values"
|
|
"'i'", "Callback is triggered when the analog value is *inside* the min and max values"
|
|
"'<'", "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
|
|
"'>'", "Callback is triggered when the analog value is greater than the min value (max is ignored)"
|
|
|
|
The default value is ('x', 0, 0).
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'c H H', '', returnCallback, errorCallback);
|
|
};
|
|
this.getAnalogValueCallbackThreshold = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the threshold as set by :func:`SetAnalogValueCallbackThreshold`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 'c H H', returnCallback, errorCallback);
|
|
};
|
|
this.setDebouncePeriod = function(debounce, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the period in ms with which the threshold callbacks
|
|
|
|
* :func:`VoltageReached`,
|
|
* :func:`AnalogValueReached`
|
|
|
|
are triggered, if the thresholds
|
|
|
|
* :func:`SetVoltageCallbackThreshold`,
|
|
* :func:`SetAnalogValueCallbackThreshold`
|
|
|
|
keep being reached.
|
|
|
|
The default value is 100.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'I', '', returnCallback, errorCallback);
|
|
};
|
|
this.getDebouncePeriod = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the debounce period as set by :func:`SetDebouncePeriod`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 'I', returnCallback, errorCallback);
|
|
};
|
|
this.setRange = function(range, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the measurement range. Possible ranges:
|
|
|
|
* 0: Automatically switched
|
|
* 1: 0V - 6.05V, ~1.48mV resolution
|
|
* 2: 0V - 10.32V, ~2.52mV resolution
|
|
* 3: 0V - 36.30V, ~8.86mV resolution
|
|
* 4: 0V - 45.00V, ~11.25mV resolution
|
|
* 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3$nbsp;(Plugin)
|
|
|
|
The default measurement range is 0.
|
|
|
|
.. versionadded:: 2.0.1$nbsp;(Plugin)
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_RANGE, [range], 'B', '', returnCallback, errorCallback);
|
|
};
|
|
this.getRange = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the measurement range as set by :func:`SetRange`.
|
|
|
|
.. versionadded:: 2.0.1$nbsp;(Plugin)
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_RANGE, [], '', 'B', returnCallback, errorCallback);
|
|
};
|
|
this.setAveraging = function(average, returnCallback, errorCallback) {
|
|
/*
|
|
Set the length of a averaging for the voltage value.
|
|
|
|
Setting the length to 0 will turn the averaging completely off. If the
|
|
averaging is off, there is more noise on the data, but the data is without
|
|
delay.
|
|
|
|
The default value is 50.
|
|
|
|
.. versionadded:: 2.0.3$nbsp;(Plugin)
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_SET_AVERAGING, [average], 'B', '', returnCallback, errorCallback);
|
|
};
|
|
this.getAveraging = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the averaging configuration as set by :func:`SetAveraging`.
|
|
|
|
.. versionadded:: 2.0.3$nbsp;(Plugin)
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_AVERAGING, [], '', 'B', returnCallback, errorCallback);
|
|
};
|
|
this.getIdentity = function(returnCallback, errorCallback) {
|
|
/*
|
|
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 :ref:`here <device_identifier>`.
|
|
|device_identifier_constant|
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletAnalogIn.FUNCTION_GET_IDENTITY, [], '', 's8 s8 c B3 B3 H', returnCallback, errorCallback);
|
|
};
|
|
}
|
|
|
|
module.exports = BrickletAnalogIn;
|