174 lines
8.4 KiB
JavaScript
174 lines
8.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');
|
|
|
|
BrickletIndustrialQuadRelay.DEVICE_IDENTIFIER = 225;
|
|
BrickletIndustrialQuadRelay.DEVICE_DISPLAY_NAME = 'Industrial Quad Relay Bricklet';
|
|
BrickletIndustrialQuadRelay.CALLBACK_MONOFLOP_DONE = 8;
|
|
BrickletIndustrialQuadRelay.FUNCTION_SET_VALUE = 1;
|
|
BrickletIndustrialQuadRelay.FUNCTION_GET_VALUE = 2;
|
|
BrickletIndustrialQuadRelay.FUNCTION_SET_MONOFLOP = 3;
|
|
BrickletIndustrialQuadRelay.FUNCTION_GET_MONOFLOP = 4;
|
|
BrickletIndustrialQuadRelay.FUNCTION_SET_GROUP = 5;
|
|
BrickletIndustrialQuadRelay.FUNCTION_GET_GROUP = 6;
|
|
BrickletIndustrialQuadRelay.FUNCTION_GET_AVAILABLE_FOR_GROUP = 7;
|
|
BrickletIndustrialQuadRelay.FUNCTION_SET_SELECTED_VALUES = 9;
|
|
BrickletIndustrialQuadRelay.FUNCTION_GET_IDENTITY = 255;
|
|
|
|
function BrickletIndustrialQuadRelay(uid, ipcon) {
|
|
//4 galvanically isolated solid state relays
|
|
|
|
/*
|
|
Creates an object with the unique device ID *uid* and adds it to
|
|
the IP Connection *ipcon*.
|
|
*/
|
|
Device.call(this, this, uid, ipcon);
|
|
BrickletIndustrialQuadRelay.prototype = Object.create(Device);
|
|
this.responseExpected = {};
|
|
this.callbackFormats = {};
|
|
this.APIVersion = [2, 0, 0];
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_SET_VALUE] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_GET_VALUE] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_SET_MONOFLOP] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_GET_MONOFLOP] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_SET_GROUP] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_GET_GROUP] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_GET_AVAILABLE_FOR_GROUP] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.CALLBACK_MONOFLOP_DONE] = Device.RESPONSE_EXPECTED_ALWAYS_FALSE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_SET_SELECTED_VALUES] = Device.RESPONSE_EXPECTED_FALSE;
|
|
this.responseExpected[BrickletIndustrialQuadRelay.FUNCTION_GET_IDENTITY] = Device.RESPONSE_EXPECTED_ALWAYS_TRUE;
|
|
this.callbackFormats[BrickletIndustrialQuadRelay.CALLBACK_MONOFLOP_DONE] = 'H H';
|
|
|
|
this.setValue = function(valueMask, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay
|
|
closed and a 0 means relay open.
|
|
|
|
For example: The value 3 or 0b0011 will close the relay of pins 0-1 and open
|
|
the other pins.
|
|
|
|
If no groups are used (see :func:`SetGroup`), the pins correspond to the
|
|
markings on the Quad Relay Bricklet.
|
|
|
|
If groups are used, the pins correspond to the element in the group.
|
|
Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
|
|
pins 8-11 and element 4 pins 12-15.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_SET_VALUE, [valueMask], 'H', '', returnCallback, errorCallback);
|
|
};
|
|
this.getValue = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the bitmask as set by :func:`SetValue`.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_GET_VALUE, [], '', 'H', returnCallback, errorCallback);
|
|
};
|
|
this.setMonoflop = function(selectionMask, valueMask, time, returnCallback, errorCallback) {
|
|
/*
|
|
Configures a monoflop of the pins specified by the first parameter
|
|
bitmask.
|
|
|
|
The second parameter is a bitmask with the desired value of the specified
|
|
pins. A 1 in the bitmask means relay closed and a 0 means relay open.
|
|
|
|
The third parameter indicates the time (in ms) that the pins should hold
|
|
the value.
|
|
|
|
If this function is called with the parameters (9, 1, 1500) or
|
|
(0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0
|
|
will open and pin 3 will close again.
|
|
|
|
A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
|
|
have a RS485 bus and a Quad Relay Bricklet connected to one of the slave
|
|
stacks. You can now call this function every second, with a time parameter
|
|
of two seconds and pin 0 closed. Pin 0 will be closed all the time. If now
|
|
the RS485 connection is lost, then pin 0 will be opened in at most two seconds.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_SET_MONOFLOP, [selectionMask, valueMask, time], 'H H I', '', returnCallback, errorCallback);
|
|
};
|
|
this.getMonoflop = function(pin, returnCallback, errorCallback) {
|
|
/*
|
|
Returns (for the given pin) the current value and the time as set by
|
|
:func:`SetMonoflop` as well as the remaining time until the value flips.
|
|
|
|
If the timer is not running currently, the remaining time will be returned
|
|
as 0.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_GET_MONOFLOP, [pin], 'B', 'H I I', returnCallback, errorCallback);
|
|
};
|
|
this.setGroup = function(group, returnCallback, errorCallback) {
|
|
/*
|
|
Sets a group of Quad Relay Bricklets that should work together. You can
|
|
find Bricklets that can be grouped together with :func:`GetAvailableForGroup`.
|
|
|
|
The group consists of 4 elements. Element 1 in the group will get pins 0-3,
|
|
element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.
|
|
|
|
Each element can either be one of the ports ('a' to 'd') or 'n' if it should
|
|
not be used.
|
|
|
|
For example: If you have two Quad Relay Bricklets connected to port A and
|
|
port B respectively, you could call with ``['a', 'b', 'n', 'n']``.
|
|
|
|
Now the pins on the Quad Relay on port A are assigned to 0-3 and the
|
|
pins on the Quad Relay on port B are assigned to 4-7. It is now possible
|
|
to call :func:`SetValue` and control two Bricklets at the same time.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_SET_GROUP, [group], 'c4', '', returnCallback, errorCallback);
|
|
};
|
|
this.getGroup = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns the group as set by :func:`SetGroup`
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_GET_GROUP, [], '', 'c4', returnCallback, errorCallback);
|
|
};
|
|
this.getAvailableForGroup = function(returnCallback, errorCallback) {
|
|
/*
|
|
Returns a bitmask of ports that are available for grouping. For example the
|
|
value 5 or 0b0101 means: Port A and port C are connected to Bricklets that
|
|
can be grouped together.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 'B', returnCallback, errorCallback);
|
|
};
|
|
this.setSelectedValues = function(selectionMask, valueMask, returnCallback, errorCallback) {
|
|
/*
|
|
Sets the output value with a bitmask, according to the selection mask.
|
|
The bitmask is 16 bit long, *true* refers to a closed relay and
|
|
*false* refers to an open relay.
|
|
|
|
For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of
|
|
pin 0, open the relay of pin 1 and leave the others untouched.
|
|
|
|
If no groups are used (see :func:`SetGroup`), the pins correspond to the
|
|
markings on the Quad Relay Bricklet.
|
|
|
|
If groups are used, the pins correspond to the element in the group.
|
|
Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
|
|
pins 8-11 and element 4 pins 12-15.
|
|
*/
|
|
this.ipcon.sendRequest(this, BrickletIndustrialQuadRelay.FUNCTION_SET_SELECTED_VALUES, [selectionMask, valueMask], 'H H', '', 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, BrickletIndustrialQuadRelay.FUNCTION_GET_IDENTITY, [], '', 's8 s8 c B3 B3 H', returnCallback, errorCallback);
|
|
};
|
|
}
|
|
|
|
module.exports = BrickletIndustrialQuadRelay;
|