Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / Remote Switch Bricklet 2.0

JavaScript - Remote Switch Bricklet 2.0¶

This is the description of the JavaScript API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch Bricklet 2.0 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 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs = new Tinkerforge.BrickletRemoteSwitchV2(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.BrickletRemoteSwitchV2.SWITCH_TO_ON);
    }
);

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

Remote Callback (Node.js)¶

Download (ExampleRemoteCallback.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var rs = new Tinkerforge.BrickletRemoteSwitchV2(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) {
        // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
        rs.setRemoteConfiguration(Tinkerforge.BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1,
                                  true);
    }
);

// Register remote status a callback
rs.on(Tinkerforge.BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A,
    // Callback function for remote status a callback
    function (houseCode, receiverCode, switchTo, repeats) {
        console.log('House Code: ' + houseCode);
        console.log('Receiver Code: ' + receiverCode);

        if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_OFF) {
            console.log('Switch To: Off');
        }
        else if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_ON) {
            console.log('Switch To: On');
        }

        console.log('Repeats: ' + repeats);
        console.log();
    }
);

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 2.0 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.BrickletRemoteSwitchV2(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.BrickletRemoteSwitchV2.SWITCH_TO_ON);
                    }
                );
            }
        </script>
    </body>
</html>

Remote Callback (HTML)¶

Download (ExampleRemoteCallback.html), Test (ExampleRemoteCallback.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 2.0 Remote Callback 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.BrickletRemoteSwitchV2(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) {
                        // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
                        rs.setRemoteConfiguration(Tinkerforge.BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1,
                                                  true);
                    }
                );

                // Register remote status a callback
                rs.on(Tinkerforge.BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A,
                    // Callback function for remote status a callback
                    function (houseCode, receiverCode, switchTo, repeats) {
                        textArea.value += 'House Code: ' + houseCode + '\n';
                        textArea.value += 'Receiver Code: ' + receiverCode + '\n';

                        if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_OFF) {
                            textArea.value += 'Switch To: Off\n';
                        }
                        else if(switchTo === Tinkerforge.BrickletRemoteSwitchV2.SWITCH_TO_ON) {
                            textArea.value += 'Switch To: On\n';
                        }

                        textArea.value += 'Repeats: ' + repeats + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </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 BrickletRemoteSwitchV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	remoteSwitchV2 – Type: BrickletRemoteSwitchV2

Creates an object with the unique device ID uid:

var remoteSwitchV2 = new BrickletRemoteSwitchV2("YOUR_DEVICE_UID", ipcon);

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

BrickletRemoteSwitchV2.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 calls of switch socket functions 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:

BrickletRemoteSwitchV2.SWITCHING_STATE_READY = 0
BrickletRemoteSwitchV2.SWITCHING_STATE_BUSY = 1

BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.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.

BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.setRemoteConfiguration(remoteType, minimumRepeats, callbackEnabled[, returnCallback][, errorCallback])¶

Parameters:	remoteType – Type: int, Range: See constants, Default: 0 minimumRepeats – Type: int, Range: [0 to 2¹⁶ - 1], Default: 2 callbackEnabled – Type: boolean, Default: false
Callback Parameters:	undefined
Returns:	undefined

Sets the configuration for receiving data from a remote of type A, B or C.

Remote Type: A, B or C depending on the type of remote you want to receive.
Minimum Repeats: The minimum number of repeated data packets until the callback is triggered (if enabled).
Callback Enabled: Enable or disable callback (see CALLBACK_REMOTE_STATUS_A callback, CALLBACK_REMOTE_STATUS_B callback and CALLBACK_REMOTE_STATUS_C callback).

The following constants are available for this function:

For remote_type:

BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2

BrickletRemoteSwitchV2.getRemoteConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	remoteType – Type: int, Range: See constants, Default: 0 minimumRepeats – Type: int, Range: [0 to 2¹⁶ - 1], Default: 2 callbackEnabled – Type: boolean, Default: false
Returns:	undefined

Returns the remote configuration as set by setRemoteConfiguration()

The following constants are available for this function:

For remote_type:

BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2

BrickletRemoteSwitchV2.getRemoteStatusA([returnCallback][, errorCallback])¶

Callback Parameters:	houseCode – Type: int, Range: [0 to 31] receiverCode – Type: int, Range: [0 to 31] switchTo – Type: int, Range: See constants repeats – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see setRemoteConfiguration() and CALLBACK_REMOTE_STATUS_A callback.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.getRemoteStatusB([returnCallback][, errorCallback])¶

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

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see setRemoteConfiguration() and CALLBACK_REMOTE_STATUS_B callback.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.getRemoteStatusC([returnCallback][, errorCallback])¶

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

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see setRemoteConfiguration() and CALLBACK_REMOTE_STATUS_C callback.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Advanced Functions¶

BrickletRemoteSwitchV2.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.

BrickletRemoteSwitchV2.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().

BrickletRemoteSwitchV2.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback Parameters:	errorCountAckChecksum – Type: int, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: int, Range: [0 to 2³² - 1] errorCountFrame – Type: int, Range: [0 to 2³² - 1] errorCountOverflow – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletRemoteSwitchV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameters:	config – Type: int, Range: See constants, Default: 3
Callback Parameters:	undefined
Returns:	undefined

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletRemoteSwitchV2.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback Parameters:	config – Type: int, Range: See constants, Default: 3
Returns:	undefined

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletRemoteSwitchV2.getChipTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]
Returns:	undefined

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletRemoteSwitchV2.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletRemoteSwitchV2.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¶

BrickletRemoteSwitchV2.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:

remoteSwitchV2.on(BrickletRemoteSwitchV2.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.

BrickletRemoteSwitchV2.CALLBACK_SWITCHING_DONE¶

Callback Parameters:	undefined

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

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_A¶

Callback Parameters:	houseCode – Type: int, Range: [0 to 31] receiverCode – Type: int, Range: [0 to 31] switchTo – Type: int, Range: See constants repeats – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with setRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_B¶

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

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

BrickletRemoteSwitchV2.CALLBACK_REMOTE_STATUS_C¶

Callback Parameters:	systemCode – Type: char, Range: ['A' to 'P'] deviceCode – Type: int, Range: [1 to 16] switchTo – Type: int, Range: See constants repeats – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

The following constants are available for this function:

For switch_to:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

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.

BrickletRemoteSwitchV2.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.

BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRemoteSwitchV2.FUNCTION_RESET = 243
BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248

BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRemoteSwitchV2.FUNCTION_RESET = 243
BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248

BrickletRemoteSwitchV2.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.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletRemoteSwitchV2.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

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

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BrickletRemoteSwitchV2.BOOTLOADER_STATUS_OK = 0
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletRemoteSwitchV2.getBootloaderMode([returnCallback][, errorCallback])¶

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletRemoteSwitchV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletRemoteSwitchV2.writeFirmware(data[, returnCallback][, errorCallback])¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:	status – Type: int, Range: [0 to 255]
Returns:	undefined

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletRemoteSwitchV2.writeUID(uid[, returnCallback][, errorCallback])¶

Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletRemoteSwitchV2.readUID([returnCallback][, errorCallback])¶

Callback Parameters:	uid – Type: int, Range: [0 to 2³² - 1]
Returns:	undefined

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletRemoteSwitchV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Remote Switch Bricklet 2.0.

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.

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