164 lines
7.4 KiB
JavaScript
164 lines
7.4 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');
|
|
|
|
BrickletHallEffect.DEVICE_IDENTIFIER = 240;
|
|
BrickletHallEffect.DEVICE_DISPLAY_NAME = 'Hall Effect Bricklet';
|
|
BrickletHallEffect.CALLBACK_EDGE_COUNT = 10;
|
|
BrickletHallEffect.FUNCTION_GET_VALUE = 1;
|
|
BrickletHallEffect.FUNCTION_GET_EDGE_COUNT = 2;
|
|
BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3;
|
|
BrickletHallEffect.FUNCTION_GET_EDGE_COUNT_CONFIG = 4;
|
|
BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5;
|
|
BrickletHallEffect.FUNCTION_GET_EDGE_INTERRUPT = 6;
|
|
BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7;
|
|
BrickletHallEffect.FUNCTION_GET_EDGE_COUNT_CALLBACK_PERIOD = 8;
|
|
BrickletHallEffect.FUNCTION_EDGE_INTERRUPT = 9;
|
|
BrickletHallEffect.FUNCTION_GET_IDENTITY = 255;
|
|
BrickletHallEffect.EDGE_TYPE_RISING = 0;
|
|
BrickletHallEffect.EDGE_TYPE_FALLING = 1;
|
|
BrickletHallEffect.EDGE_TYPE_BOTH = 2;
|
|
|
|
function BrickletHallEffect(uid, ipcon) {
|
|
//Detects presence of magnetic field
|
|
|
|
/*
|
|
Creates an object with the unique device ID *uid* and adds it to
|
|
the IP Connection *ipcon*.
|
|
*/
|
|
Device.call(this, this, uid, ipcon);
|
|
BrickletHallEffect.prototype = Object.create(Device);
|
|
this.responseExpected = {};
|
|
this.callbackFormats = {};
|
|
this.APIVersion = [2, 0, 0];
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_GET_VALUE] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_GET_EDGE_COUNT] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_GET_EDGE_COUNT_CONFIG] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_GET_EDGE_INTERRUPT] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD] = Device.RESPONSE_EXPECTED_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_GET_EDGE_COUNT_CALLBACK_PERIOD] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_EDGE_INTERRUPT] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletHallEffect.CALLBACK_EDGE_COUNT] = Device.RESPONSE_EXPECTED_ALWAYS_FALSE;
|
|
this.responseExpected[BrickletHallEffect.FUNCTION_GET_IDENTITY] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.callbackFormats[BrickletHallEffect.CALLBACK_EDGE_COUNT] = 'I ?';
|
|
|
|
this.getValue = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns *true* if a magnetic field of 35 Gauss (3.5mT) or greater is detected.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_GET_VALUE, [], '', '?', returnCallback, errorCallback);
|
|
};
|
|
this.getEdgeCount = function(resetCounter, returnCallback, errorCallback) {
|
|
/*
|
|
Returns the current value of the edge counter. You can configure
|
|
edge type (rising, falling, both) that is counted with
|
|
:func:`SetEdgeCountConfig`.
|
|
|
|
If you set the reset counter to *true*, the count is set back to 0
|
|
directly after it is read.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_GET_EDGE_COUNT, [resetCounter], '?', 'I', returnCallback, errorCallback);
|
|
};
|
|
this.setEdgeCountConfig = function(edgeType, debounce, returnCallback, errorCallback) {
|
|
/*
|
|
The edge type parameter configures if rising edges, falling edges or
|
|
both are counted. Possible edge types are:
|
|
|
|
* 0 = rising (default)
|
|
* 1 = falling
|
|
* 2 = both
|
|
|
|
A magnetic field of 35 Gauss (3.5mT) or greater causes a falling edge and a
|
|
magnetic field of 25 Gauss (2.5mT) or smaller causes a rising edge.
|
|
|
|
If a magnet comes near the Bricklet the signal goes low (falling edge), if
|
|
a magnet is removed from the vicinity the signal goes high (rising edge).
|
|
|
|
The debounce time is given in ms.
|
|
|
|
Configuring an edge counter resets its value to 0.
|
|
|
|
If you don't know what any of this means, just leave it at default. The
|
|
default configuration is very likely OK for you.
|
|
|
|
Default values: 0 (edge type) and 100ms (debounce time)
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG, [edgeType, debounce], 'B B', '', returnCallback, errorCallback);
|
|
};
|
|
this.getEdgeCountConfig = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the edge type and debounce time as set by :func:`SetEdgeCountConfig`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_GET_EDGE_COUNT_CONFIG, [], '', 'B B', returnCallback, errorCallback);
|
|
};
|
|
this.setEdgeInterrupt = function(edges, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the number of edges until an interrupt is invoked.
|
|
|
|
If *edges* is set to n, an interrupt is invoked for every n-th detected edge.
|
|
|
|
If *edges* is set to 0, the interrupt is disabled.
|
|
|
|
Default value is 0.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT, [edges], 'I', '', returnCallback, errorCallback);
|
|
};
|
|
this.getEdgeInterrupt = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the edges as set by :func:`SetEdgeInterrupt`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_GET_EDGE_INTERRUPT, [], '', 'I', returnCallback, errorCallback);
|
|
};
|
|
this.setEdgeCountCallbackPeriod = function(period, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the period in ms with which the :func:`EdgeCount` callback is triggered
|
|
periodically. A value of 0 turns the callback off.
|
|
|
|
:func:`EdgeCount` is only triggered if the edge count has changed since the
|
|
last triggering.
|
|
|
|
The default value is 0.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD, [period], 'I', '', returnCallback, errorCallback);
|
|
};
|
|
this.getEdgeCountCallbackPeriod = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the period as set by :func:`SetEdgeCountCallbackPeriod`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_GET_EDGE_COUNT_CALLBACK_PERIOD, [], '', 'I', returnCallback, errorCallback);
|
|
};
|
|
this.edgeInterrupt = function(returnCallback, errorCallback) {
|
|
/*
|
|
This callback is triggered every n-th count, as configured with
|
|
:func:`SetEdgeInterrupt`. The parameters are the
|
|
current count and the current value (see :func:`GetValue` and :func:`GetEdgeCount`).
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletHallEffect.FUNCTION_EDGE_INTERRUPT, [], '', 'I ?', 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, BrickletHallEffect.FUNCTION_GET_IDENTITY, [], '', 's8 s8 c B3 B3 H', returnCallback, errorCallback);
|
|
};
|
|
}
|
|
|
|
module.exports = BrickletHallEffect;
|