Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / LED Strip Bricklet 2.0

JavaScript - LED Strip Bricklet 2.0¶

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ls = new Tinkerforge.BrickletLEDStripV2(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) {
        // Set first 3 LEDs to red, green and blue
        ls.setLEDValues(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);
    }
);

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

Callback (Node.js)¶

Download (ExampleCallback.js)

var Tinkerforge = require('tinkerforge');

// FIXME: This example is incomplete

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ls = new Tinkerforge.BrickletLEDStripV2(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) {
        // Set frame duration to 50ms (20 frames per second)
        ls.setFrameDuration(50);
    }
);

// Register frame started callback
ls.on(Tinkerforge.BrickletLEDStripV2.CALLBACK_FRAME_STARTED,
    // Use frame started callback to move the active LED every frame
    function (length) {
        console.log('Length: ' + length);
    }
);

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>LED Strip 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 ls = new Tinkerforge.BrickletLEDStripV2(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) {
                        // Set first 3 LEDs to red, green and blue
                        ls.setLEDValues(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

Download (ExampleCallback.html), Test (ExampleCallback.html)

<!DOCTYPE html>

<!-- FIXME: This example is incomplete -->

<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>LED Strip Bricklet 2.0 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 ls = new Tinkerforge.BrickletLEDStripV2(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) {
                        // Set frame duration to 50ms (20 frames per second)
                        ls.setFrameDuration(50);
                    }
                );

                // Register frame started callback
                ls.on(Tinkerforge.BrickletLEDStripV2.CALLBACK_FRAME_STARTED,
                    // Use frame started callback to move the active LED every frame
                    function (length) {
                        textArea.value += 'Length: ' + length + '\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 BrickletLEDStripV2(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	ledStripV2 – Type: BrickletLEDStripV2

Creates an object with the unique device ID uid:

var ledStripV2 = new BrickletLEDStripV2("YOUR_DEVICE_UID", ipcon);

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

BrickletLEDStripV2.setLEDValues(index, value[, returnCallback][, errorCallback])¶

Parameters:	index – Type: int, Range: [0 to 6144] value – Type: [int, ...], Length: variable, Range: [0 to 255]
Callback Parameters:	undefined
Returns:	undefined

Sets the RGB(W) values for the LEDs starting from index. You can set at most 2048 RGB values or 1536 RGBW values (6144 byte each).

To make the colors show correctly you need to configure the chip type (see setChipType()) and a channel mapping (see setChannelMapping()) according to the connected LEDs.

If the channel mapping has 3 colors, you need to give the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you need to give data in the sequence RGBWRGBWRGBW...

The data is double buffered and the colors will be transfered to the LEDs when the next frame duration ends (see setFrameDuration()).

Generic approach:

Set the frame duration to a value that represents the number of frames per second you want to achieve.
Set all of the LED colors for one frame.
Wait for the CALLBACK_FRAME_STARTED callback.
Set all of the LED colors for next frame.
Wait for the CALLBACK_FRAME_STARTED callback.
And so on.

This approach ensures that you can change the LED colors with a fixed frame rate.

BrickletLEDStripV2.getLEDValues(index, length[, returnCallback][, errorCallback])¶

Parameters:	index – Type: int, Range: [0 to 6144] length – Type: int, Range: [0 to 6144]
Callback Parameters:	value – Type: [int, ...], Length: variable, Range: [0 to 255]
Returns:	undefined

Returns length RGB(W) values starting from the given index.

If the channel mapping has 3 colors, you will get the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the sequence RGBWRGBWRGBW... (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).

BrickletLEDStripV2.setFrameDuration(duration[, returnCallback][, errorCallback])¶

Parameters:	duration – Type: int, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 100
Callback Parameters:	undefined
Returns:	undefined

Sets the frame duration.

Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).

For an explanation of the general approach see setLEDValues().

Default value: 100ms (10 frames per second).

BrickletLEDStripV2.getFrameDuration([returnCallback][, errorCallback])¶

Callback Parameters:	duration – Type: int, Unit: 1 ms, Range: [0 to 2¹⁶ - 1], Default: 100
Returns:	undefined

Returns the frame duration as set by setFrameDuration().

BrickletLEDStripV2.getSupplyVoltage([returnCallback][, errorCallback])¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

Returns the current supply voltage of the LEDs.

BrickletLEDStripV2.setClockFrequency(frequency[, returnCallback][, errorCallback])¶

Parameters:	frequency – Type: int, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666
Callback Parameters:	undefined
Returns:	undefined

Sets the frequency of the clock.

The Bricklet will choose the nearest achievable frequency, which may be off by a few Hz. You can get the exact frequency that is used by calling getClockFrequency().

If you have problems with flickering LEDs, they may be bits flipping. You can fix this by either making the connection between the LEDs and the Bricklet shorter or by reducing the frequency.

With a decreasing frequency your maximum frames per second will decrease too.

BrickletLEDStripV2.getClockFrequency([returnCallback][, errorCallback])¶

Callback Parameters:	frequency – Type: int, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666
Returns:	undefined

Returns the currently used clock frequency as set by setClockFrequency().

BrickletLEDStripV2.setChipType(chip[, returnCallback][, errorCallback])¶

Parameters:	chip – Type: int, Range: See constants, Default: 2801
Callback Parameters:	undefined
Returns:	undefined

Sets the type of the LED driver chip. We currently support the chips

WS2801,
WS2811,
WS2812 / SK6812 / NeoPixel RGB,
SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
WS2813 / WS2815 (Chip Type = WS2812)
LPD8806 and
APA102 / DotStar.

The following constants are available for this function:

For chip:

BrickletLEDStripV2.CHIP_TYPE_WS2801 = 2801
BrickletLEDStripV2.CHIP_TYPE_WS2811 = 2811
BrickletLEDStripV2.CHIP_TYPE_WS2812 = 2812
BrickletLEDStripV2.CHIP_TYPE_LPD8806 = 8806
BrickletLEDStripV2.CHIP_TYPE_APA102 = 102

BrickletLEDStripV2.getChipType([returnCallback][, errorCallback])¶

Callback Parameters:	chip – Type: int, Range: See constants, Default: 2801
Returns:	undefined

Returns the currently used chip type as set by setChipType().

The following constants are available for this function:

For chip:

BrickletLEDStripV2.CHIP_TYPE_WS2801 = 2801
BrickletLEDStripV2.CHIP_TYPE_WS2811 = 2811
BrickletLEDStripV2.CHIP_TYPE_WS2812 = 2812
BrickletLEDStripV2.CHIP_TYPE_LPD8806 = 8806
BrickletLEDStripV2.CHIP_TYPE_APA102 = 102

BrickletLEDStripV2.setChannelMapping(mapping[, returnCallback][, errorCallback])¶

Parameters:	mapping – Type: int, Range: See constants, Default: 36
Callback Parameters:	undefined
Returns:	undefined

Sets the channel mapping for the connected LEDs.

If the mapping has 4 colors, the function setLEDValues() expects 4 values per pixel and if the mapping has 3 colors it expects 3 values per pixel.

The function always expects the order RGB(W). The connected LED driver chips might have their 3 or 4 channels in a different order. For example, the WS2801 chips typically use BGR order, then WS2812 chips typically use GRB order and the APA102 chips typically use WBGR order.

The APA102 chips are special. They have three 8-bit channels for RGB and an additional 5-bit channel for the overall brightness of the RGB LED making them 4-channel chips. Internally the brightness channel is the first channel, therefore one of the Wxyz channel mappings should be used. Then the W channel controls the brightness.

The following constants are available for this function:

For mapping:

BrickletLEDStripV2.CHANNEL_MAPPING_RGB = 6
BrickletLEDStripV2.CHANNEL_MAPPING_RBG = 9
BrickletLEDStripV2.CHANNEL_MAPPING_BRG = 33
BrickletLEDStripV2.CHANNEL_MAPPING_BGR = 36
BrickletLEDStripV2.CHANNEL_MAPPING_GRB = 18
BrickletLEDStripV2.CHANNEL_MAPPING_GBR = 24
BrickletLEDStripV2.CHANNEL_MAPPING_RGBW = 27
BrickletLEDStripV2.CHANNEL_MAPPING_RGWB = 30
BrickletLEDStripV2.CHANNEL_MAPPING_RBGW = 39
BrickletLEDStripV2.CHANNEL_MAPPING_RBWG = 45
BrickletLEDStripV2.CHANNEL_MAPPING_RWGB = 54
BrickletLEDStripV2.CHANNEL_MAPPING_RWBG = 57
BrickletLEDStripV2.CHANNEL_MAPPING_GRWB = 78
BrickletLEDStripV2.CHANNEL_MAPPING_GRBW = 75
BrickletLEDStripV2.CHANNEL_MAPPING_GBWR = 108
BrickletLEDStripV2.CHANNEL_MAPPING_GBRW = 99
BrickletLEDStripV2.CHANNEL_MAPPING_GWBR = 120
BrickletLEDStripV2.CHANNEL_MAPPING_GWRB = 114
BrickletLEDStripV2.CHANNEL_MAPPING_BRGW = 135
BrickletLEDStripV2.CHANNEL_MAPPING_BRWG = 141
BrickletLEDStripV2.CHANNEL_MAPPING_BGRW = 147
BrickletLEDStripV2.CHANNEL_MAPPING_BGWR = 156
BrickletLEDStripV2.CHANNEL_MAPPING_BWRG = 177
BrickletLEDStripV2.CHANNEL_MAPPING_BWGR = 180
BrickletLEDStripV2.CHANNEL_MAPPING_WRBG = 201
BrickletLEDStripV2.CHANNEL_MAPPING_WRGB = 198
BrickletLEDStripV2.CHANNEL_MAPPING_WGBR = 216
BrickletLEDStripV2.CHANNEL_MAPPING_WGRB = 210
BrickletLEDStripV2.CHANNEL_MAPPING_WBGR = 228
BrickletLEDStripV2.CHANNEL_MAPPING_WBRG = 225

BrickletLEDStripV2.getChannelMapping([returnCallback][, errorCallback])¶

Callback Parameters:	mapping – Type: int, Range: See constants, Default: 36
Returns:	undefined

Returns the currently used channel mapping as set by setChannelMapping().

The following constants are available for this function:

For mapping:

BrickletLEDStripV2.CHANNEL_MAPPING_RGB = 6
BrickletLEDStripV2.CHANNEL_MAPPING_RBG = 9
BrickletLEDStripV2.CHANNEL_MAPPING_BRG = 33
BrickletLEDStripV2.CHANNEL_MAPPING_BGR = 36
BrickletLEDStripV2.CHANNEL_MAPPING_GRB = 18
BrickletLEDStripV2.CHANNEL_MAPPING_GBR = 24
BrickletLEDStripV2.CHANNEL_MAPPING_RGBW = 27
BrickletLEDStripV2.CHANNEL_MAPPING_RGWB = 30
BrickletLEDStripV2.CHANNEL_MAPPING_RBGW = 39
BrickletLEDStripV2.CHANNEL_MAPPING_RBWG = 45
BrickletLEDStripV2.CHANNEL_MAPPING_RWGB = 54
BrickletLEDStripV2.CHANNEL_MAPPING_RWBG = 57
BrickletLEDStripV2.CHANNEL_MAPPING_GRWB = 78
BrickletLEDStripV2.CHANNEL_MAPPING_GRBW = 75
BrickletLEDStripV2.CHANNEL_MAPPING_GBWR = 108
BrickletLEDStripV2.CHANNEL_MAPPING_GBRW = 99
BrickletLEDStripV2.CHANNEL_MAPPING_GWBR = 120
BrickletLEDStripV2.CHANNEL_MAPPING_GWRB = 114
BrickletLEDStripV2.CHANNEL_MAPPING_BRGW = 135
BrickletLEDStripV2.CHANNEL_MAPPING_BRWG = 141
BrickletLEDStripV2.CHANNEL_MAPPING_BGRW = 147
BrickletLEDStripV2.CHANNEL_MAPPING_BGWR = 156
BrickletLEDStripV2.CHANNEL_MAPPING_BWRG = 177
BrickletLEDStripV2.CHANNEL_MAPPING_BWGR = 180
BrickletLEDStripV2.CHANNEL_MAPPING_WRBG = 201
BrickletLEDStripV2.CHANNEL_MAPPING_WRGB = 198
BrickletLEDStripV2.CHANNEL_MAPPING_WGBR = 216
BrickletLEDStripV2.CHANNEL_MAPPING_WGRB = 210
BrickletLEDStripV2.CHANNEL_MAPPING_WBGR = 228
BrickletLEDStripV2.CHANNEL_MAPPING_WBRG = 225

Advanced Functions¶

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

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

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

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

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

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

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

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

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

BrickletLEDStripV2.setFrameStartedCallbackConfiguration(enable[, returnCallback][, errorCallback])¶

Parameters:	enable – Type: boolean, Default: true
Callback Parameters:	undefined
Returns:	undefined

Enables/disables the CALLBACK_FRAME_STARTED callback.

BrickletLEDStripV2.getFrameStartedCallbackConfiguration([returnCallback][, errorCallback])¶

Callback Parameters:	enable – Type: boolean, Default: true
Returns:	undefined

Returns the configuration as set by setFrameStartedCallbackConfiguration().

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:

ledStripV2.on(BrickletLEDStripV2.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.

BrickletLEDStripV2.CALLBACK_FRAME_STARTED¶

Callback Parameters:	length – Type: int, Range: [0 to 6144]

This callback is triggered directly after a new frame render is started. The parameter is the number of LEDs in that frame.

You should send the data for the next frame directly after this callback was triggered.

For an explanation of the general approach see setLEDValues().

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.

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

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

BrickletLEDStripV2.FUNCTION_SET_LED_VALUES = 1
BrickletLEDStripV2.FUNCTION_SET_FRAME_DURATION = 3
BrickletLEDStripV2.FUNCTION_SET_CLOCK_FREQUENCY = 7
BrickletLEDStripV2.FUNCTION_SET_CHIP_TYPE = 9
BrickletLEDStripV2.FUNCTION_SET_CHANNEL_MAPPING = 11
BrickletLEDStripV2.FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
BrickletLEDStripV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLEDStripV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLEDStripV2.FUNCTION_RESET = 243
BrickletLEDStripV2.FUNCTION_WRITE_UID = 248

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

BrickletLEDStripV2.FUNCTION_SET_LED_VALUES = 1
BrickletLEDStripV2.FUNCTION_SET_FRAME_DURATION = 3
BrickletLEDStripV2.FUNCTION_SET_CLOCK_FREQUENCY = 7
BrickletLEDStripV2.FUNCTION_SET_CHIP_TYPE = 9
BrickletLEDStripV2.FUNCTION_SET_CHANNEL_MAPPING = 11
BrickletLEDStripV2.FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
BrickletLEDStripV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLEDStripV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLEDStripV2.FUNCTION_RESET = 243
BrickletLEDStripV2.FUNCTION_WRITE_UID = 248

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

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

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

For status:

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

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

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

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

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

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

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

BrickletLEDStripV2.DEVICE_IDENTIFIER¶

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

BrickletLEDStripV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a LED Strip Bricklet 2.0.