Software / API Bindings / JavaScript / API Reference and Examples / Bricklets (Discontinued) / Remote Switch Bricklet

JavaScript - Remote Switch Bricklet¶

This is the description of the JavaScript API bindings for the Remote Switch Bricklet. General information and technical specifications for the Remote Switch Bricklet are summarized in its hardware description.

An installation guide for the JavaScript API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Switch Socket (Node.js)¶

Download (ExampleSwitchSocket.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Remote Switch Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs = new Tinkerforge.BrickletRemoteSwitch(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) {
        // Switch on a type A socket with house code 17 and receiver code 1.
        // House code 17 is 10001 in binary (least-significant bit first)
        // and means that the DIP switches 1 and 5 are on and 2-4 are off.
        // Receiver code 1 is 10000 in binary (least-significant bit first)
        // and means that the DIP switch A is on and B-E are off.
        rs.switchSocketA(17, 1, Tinkerforge.BrickletRemoteSwitch.SWITCH_TO_ON);
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Switch Socket (HTML)¶

Download (ExampleSwitchSocket.html), Test (ExampleSwitchSocket.html)

<!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>Remote Switch Bricklet Switch Socket 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 rs = new Tinkerforge.BrickletRemoteSwitch(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) {
                        // Switch on a type A socket with house code 17 and receiver code 1.
                        // House code 17 is 10001 in binary (least-significant bit first)
                        // and means that the DIP switches 1 and 5 are on and 2-4 are off.
                        // Receiver code 1 is 10000 in binary (least-significant bit first)
                        // and means that the DIP switch A is on and B-E are off.
                        rs.switchSocketA(17, 1, Tinkerforge.BrickletRemoteSwitch.SWITCH_TO_ON);
                    }
                );
            }
        </script>
    </body>
</html>

API¶

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:

IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions¶

new BrickletRemoteSwitch(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	remoteSwitch – Type: BrickletRemoteSwitch

Creates an object with the unique device ID uid:

var remoteSwitch = new BrickletRemoteSwitch("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

BrickletRemoteSwitch.switchSocket(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])¶

Parameters:	houseCode – Type: int, Range: [0 to 31] receiverCode – Type: int, Range: [0 to 31] switchTo – Type: int, Range: See constants
Callback Parameters:	undefined
Returns:	undefined

This function is deprecated, use switchSocketA() instead.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

BrickletRemoteSwitch.getSwitchingState([returnCallback][, errorCallback])¶

Callback Parameters:	state – Type: int, Range: See constants
Returns:	undefined

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any requests to switch sockets until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see setRepeats().

The following constants are available for this function:

For state:

BrickletRemoteSwitch.SWITCHING_STATE_READY = 0
BrickletRemoteSwitch.SWITCHING_STATE_BUSY = 1

BrickletRemoteSwitch.switchSocketA(houseCode, receiverCode, switchTo[, returnCallback][, errorCallback])¶

Parameters:	houseCode – Type: int, Range: [0 to 31] receiverCode – Type: int, Range: [0 to 31] switchTo – Type: int, Range: See constants
Callback Parameters:	undefined
Returns:	undefined

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

BrickletRemoteSwitch.switchSocketB(address, unit, switchTo[, returnCallback][, errorCallback])¶

Parameters:	address – Type: int, Range: [0 to 2²⁶ - 1] unit – Type: int, Range: [0 to 15, 255] switchTo – Type: int, Range: See constants
Callback Parameters:	undefined
Returns:	undefined

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

BrickletRemoteSwitch.dimSocketB(address, unit, dimValue[, returnCallback][, errorCallback])¶

Parameters:	address – Type: int, Range: [0 to 2²⁶ - 1] unit – Type: int, Range: [0 to 15, 255] dimValue – Type: int, Range: [0 to 255]
Callback Parameters:	undefined
Returns:	undefined

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

New in version 2.0.1 (Plugin).

BrickletRemoteSwitch.switchSocketC(systemCode, deviceCode, switchTo[, returnCallback][, errorCallback])¶

Parameters:	systemCode – Type: char, Range: ['A' to 'P'] deviceCode – Type: int, Range: [1 to 16] switchTo – Type: int, Range: See constants
Callback Parameters:	undefined
Returns:	undefined

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitch.SWITCH_TO_OFF = 0
BrickletRemoteSwitch.SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

Advanced Functions¶

BrickletRemoteSwitch.setRepeats(repeats[, returnCallback][, errorCallback])¶

Parameters:	repeats – Type: int, Range: [0 to 255], Default: 5
Callback Parameters:	undefined
Returns:	undefined

Sets the number of times the code is sent when one of the switch socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

BrickletRemoteSwitch.getRepeats([returnCallback][, errorCallback])¶

Callback Parameters:	repeats – Type: int, Range: [0 to 255], Default: 5
Returns:	undefined

Returns the number of repeats as set by setRepeats().

BrickletRemoteSwitch.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

Callback Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

firmwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns:

undefined

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.

Callback Configuration Functions¶

BrickletRemoteSwitch.on(callback_id, function[, errorCallback])¶

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

Callbacks¶

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:

remoteSwitch.on(BrickletRemoteSwitch.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.

BrickletRemoteSwitch.CALLBACK_SWITCHING_DONE¶

Callback Parameters:	undefined

This callback is triggered whenever the switching state changes from busy to ready, see getSwitchingState().

Virtual Functions¶

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.

BrickletRemoteSwitch.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

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.

BrickletRemoteSwitch.getResponseExpected(functionId[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants
Returns:	responseExpected – 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9

BrickletRemoteSwitch.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

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.

The following constants are available for this function:

For function_id:

BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9

BrickletRemoteSwitch.setResponseExpectedAll(responseExpected)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

BrickletRemoteSwitch.DEVICE_IDENTIFIER¶

This constant is used to identify a Remote Switch 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.

BrickletRemoteSwitch.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Remote Switch Bricklet.