Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / Solid State Relay Bricklet 2.0

JavaScript - Solid State Relay Bricklet 2.0¶

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

Simple (Node.js)¶

Download (ExampleSimple.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Solid State Relay Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ssr = new Tinkerforge.BrickletSolidStateRelayV2(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) {
        // Turn relay on/off 10 times with 1 second delay
        for(var i = 0; i < 5; ++i) {
            setTimeout(function () {
                ssr.setState(true);
            }, 2000 * i + 1000);
            setTimeout(function () {
                ssr.setState(false);
            }, 2000 * i + 2000);
        }
    }
);

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

Simple (HTML)¶

Download (ExampleSimple.html), Test (ExampleSimple.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>Solid State Relay Bricklet 2.0 Simple 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 ssr = new Tinkerforge.BrickletSolidStateRelayV2(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) {
                        // Turn relay on/off 10 times with 1 second delay
                        for(var i = 0; i < 5; ++i) {
                            setTimeout(function () {
                                ssr.setState(true);
                            }, 2000 * i + 1000);
                            setTimeout(function () {
                                ssr.setState(false);
                            }, 2000 * i + 2000);
                        }
                    }
                );
            }
        </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 BrickletSolidStateRelayV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	solidStateRelayV2 – Type: BrickletSolidStateRelayV2

Creates an object with the unique device ID uid:

var solidStateRelayV2 = new BrickletSolidStateRelayV2("YOUR_DEVICE_UID", ipcon);

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

BrickletSolidStateRelayV2.setState(state[, returnCallback][, errorCallback])¶

Parameters:	state – Type: boolean, Default: false
Callback Parameters:	undefined
Returns:	undefined

Sets the state of the relays true means on and false means off.

A running monoflop timer will be aborted if this function is called.

BrickletSolidStateRelayV2.getState([returnCallback][, errorCallback])¶

Callback Parameters:	state – Type: boolean, Default: false
Returns:	undefined

Returns the state of the relay, true means on and false means off.

Advanced Functions¶

BrickletSolidStateRelayV2.setMonoflop(state, time[, returnCallback][, errorCallback])¶

Parameters:	state – Type: boolean time – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1]
Callback Parameters:	undefined
Returns:	undefined

The first parameter is the desired state of the relay (true means on and false means off). The second parameter indicates the time that the relay should hold the state.

If this function is called with the parameters (true, 1500): The relay will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The relay will be on all the time. If now the RS485 connection is lost, the relay will turn off in at most two seconds.

BrickletSolidStateRelayV2.getMonoflop([returnCallback][, errorCallback])¶

Callback Parameters:	state – Type: boolean time – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1] timeRemaining – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1]
Returns:	undefined

Returns the current state and the time as set by setMonoflop() as well as the remaining time until the state flips.

If the timer is not running currently, the remaining time will be returned as 0.

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

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

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

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

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

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

BrickletSolidStateRelayV2.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!

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

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

solidStateRelayV2.on(BrickletSolidStateRelayV2.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.

BrickletSolidStateRelayV2.CALLBACK_MONOFLOP_DONE¶

Callback Parameters:	state – Type: boolean

This callback is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).

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.

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

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

BrickletSolidStateRelayV2.FUNCTION_SET_STATE = 1
BrickletSolidStateRelayV2.FUNCTION_SET_MONOFLOP = 3
BrickletSolidStateRelayV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletSolidStateRelayV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletSolidStateRelayV2.FUNCTION_RESET = 243
BrickletSolidStateRelayV2.FUNCTION_WRITE_UID = 248

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

BrickletSolidStateRelayV2.FUNCTION_SET_STATE = 1
BrickletSolidStateRelayV2.FUNCTION_SET_MONOFLOP = 3
BrickletSolidStateRelayV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletSolidStateRelayV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletSolidStateRelayV2.FUNCTION_RESET = 243
BrickletSolidStateRelayV2.FUNCTION_WRITE_UID = 248

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

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

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

For status:

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

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

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

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

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

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

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

BrickletSolidStateRelayV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Solid State Relay 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.

BrickletSolidStateRelayV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Solid State Relay Bricklet 2.0.