MATLAB/Octave - LED Strip Bricklet 2.0¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLEDStripV2;

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

    ipcon = IPConnection(); % Create IP connection
    ls = handle(BrickletLEDStripV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Set first 3 LEDs to red, green and blue
    ls.setLEDValues(0, [255 0 0 0 255 0 0 0 255]);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLEDStripV2;

    % FIXME: This example is incomplete

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

    ipcon = IPConnection(); % Create IP connection
    ls = handle(BrickletLEDStripV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Set frame duration to 50ms (20 frames per second)
    ls.setFrameDuration(50);

    % Register frame started callback to function cb_frame_started
    set(ls, 'FrameStartedCallback', @(h, e) cb_frame_started(e));

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Use frame started callback to move the active LED every frame
function cb_frame_started(e)
    fprintf('Length: %i\n', e.length);
end

Simple (Octave)¶

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your LED Strip Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ls = javaObject("com.tinkerforge.BrickletLEDStripV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Set first 3 LEDs to red, green and blue
    ls.setLEDValues(0, [255 0 0 0 255 0 0 0 255]);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

function octave_example_callback()
    more off;

    % FIXME: This example is incomplete

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your LED Strip Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ls = javaObject("com.tinkerforge.BrickletLEDStripV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Set frame duration to 50ms (20 frames per second)
    ls.setFrameDuration(50);

    % Register frame started callback to function cb_frame_started
    ls.addFrameStartedCallback(@cb_frame_started);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Use frame started callback to move the active LED every frame
function cb_frame_started(e)
    fprintf("Length: %d\n", e.length);
end

Basic Functions¶

class BrickletLEDStripV2(String uid, IPConnection ipcon)¶

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

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletLEDStripV2;

ledStripV2 = BrickletLEDStripV2('YOUR_DEVICE_UID', ipcon);

In Octave:

ledStripV2 = java_new("com.tinkerforge.BrickletLEDStripV2", "YOUR_DEVICE_UID", ipcon);

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

void BrickletLEDStripV2.setLEDValues(int index, int[] value)¶

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

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 FrameStartedCallback callback.
• Set all of the LED colors for next frame.
• Wait for the FrameStartedCallback callback.
• And so on.

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

int[] BrickletLEDStripV2.getLEDValues(int index, int length)¶

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

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

void BrickletLEDStripV2.setFrameDuration(int duration)¶

Parameters:	duration – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

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

int BrickletLEDStripV2.getFrameDuration()¶

Returns:	duration – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

Returns the frame duration as set by setFrameDuration().

int BrickletLEDStripV2.getSupplyVoltage()¶

Returns:	voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the current supply voltage of the LEDs.

void BrickletLEDStripV2.setClockFrequency(long frequency)¶

Parameters:	frequency – Type: long, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666

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.

long BrickletLEDStripV2.getClockFrequency()¶

Returns:	frequency – Type: long, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666

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

void BrickletLEDStripV2.setChipType(int chip)¶

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

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

int BrickletLEDStripV2.getChipType()¶

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

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

void BrickletLEDStripV2.setChannelMapping(int mapping)¶

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

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

int BrickletLEDStripV2.getChannelMapping()¶

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

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.SPITFPErrorCount BrickletLEDStripV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1] errorCountFrame – Type: long, Range: [0 to 232 - 1] errorCountOverflow – Type: long, Range: [0 to 232 - 1]

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.

void BrickletLEDStripV2.setStatusLEDConfig(int config)¶

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

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

int BrickletLEDStripV2.getStatusLEDConfig()¶

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

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

int BrickletLEDStripV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

void BrickletLEDStripV2.reset()¶

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.Identity BrickletLEDStripV2.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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¶

void BrickletLEDStripV2.setFrameStartedCallbackConfiguration(boolean enable)¶

Parameters:	enable – Type: boolean, Default: true

Enables/disables the FrameStartedCallback callback.

boolean BrickletLEDStripV2.getFrameStartedCallbackConfiguration()¶

Returns:	enable – Type: boolean, Default: true

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 "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

callback BrickletLEDStripV2.FrameStartedCallback¶

Event Object:	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().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addFrameStartedCallback() function. An added callback function can be removed with the removeFrameStartedCallback() function.

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.

short[] BrickletLEDStripV2.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, 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.

boolean BrickletLEDStripV2.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, 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 functionId:

• 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

void BrickletLEDStripV2.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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.

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 functionId:

• 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

void BrickletLEDStripV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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.

int BrickletLEDStripV2.setBootloaderMode(int mode)¶

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

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

int BrickletLEDStripV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

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

void BrickletLEDStripV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

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.

int BrickletLEDStripV2.writeFirmware(int[] data)¶

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

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.

void BrickletLEDStripV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 232 - 1]

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.

long BrickletLEDStripV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

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

Constants¶

int BrickletLEDStripV2.DEVICE_IDENTIFIER¶

This constant is used to identify a LED Strip Bricklet 2.0.

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletLEDStripV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a LED Strip Bricklet 2.0.