Perl - LED Strip Bricklet 2.0

This is the description of the Perl 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 Perl API bindings is part of their general description.

Examples

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

Simple

Download (example_simple.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLEDStripV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LED Strip Bricklet 2.0

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ls = Tinkerforge::BrickletLEDStripV2->new(&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->set_led_values(0, [255, 0, 0, 0, 255, 0, 0, 0, 255]);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Callback

Download (example_callback.pl)

 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
31
32
33
34
35
#!/usr/bin/perl

# FIXME: This example is incomplete

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletLEDStripV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your LED Strip Bricklet 2.0

# Use frame started callback to move the active LED every frame
sub cb_frame_started
{
    my ($length) = @_;

    print "Length: $length\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ls = Tinkerforge::BrickletLEDStripV2->new(&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->set_frame_duration(50);

# Register frame started callback to subroutine cb_frame_started
$ls->register_callback($ls->CALLBACK_FRAME_STARTED, 'cb_frame_started');

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Generally, every subroutine of the Perl bindings can report an error as Tinkerforge::Error object via croak(). The object has a get_code() and a get_message() subroutine. There are different error code:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71

All functions listed below are thread-safe.

Basic Functions

BrickletLEDStripV2->new($uid, $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $led_strip_v2 – Type: BrickletLEDStripV2

Creates an object with the unique device ID $uid:

$led_strip_v2 = BrickletLEDStripV2->new("YOUR_DEVICE_UID", $ipcon);

This object can then be used after the IP Connection is connected (see examples above).

BrickletLEDStripV2->set_led_values($index, @value)
Parameters:
  • $index – Type: int, Range: [0 to 6144]
  • @value – Type: [int, ...], Length: variable, Range: [0 to 255]
Returns:
  • undef

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 set_chip_type()) and a channel mapping (see set_channel_mapping()) 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 set_frame_duration()).

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->get_led_values($index, $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)).

BrickletLEDStripV2->set_frame_duration($duration)
Parameters:
  • $duration – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100
Returns:
  • undef

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

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

BrickletLEDStripV2->get_frame_duration()
Returns:
  • $duration – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

Returns the frame duration as set by set_frame_duration().

BrickletLEDStripV2->get_supply_voltage()
Returns:
  • $voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the current supply voltage of the LEDs.

BrickletLEDStripV2->set_clock_frequency($frequency)
Parameters:
  • $frequency – Type: int, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666
Returns:
  • undef

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

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->get_clock_frequency()
Returns:
  • $frequency – Type: int, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666

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

BrickletLEDStripV2->set_chip_type($chip)
Parameters:
  • $chip – Type: int, Range: See constants, Default: 2801
Returns:
  • undef

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->get_chip_type()
Returns:
  • $chip – Type: int, Range: See constants, Default: 2801

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

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->set_channel_mapping($mapping)
Parameters:
  • $mapping – Type: int, Range: See constants, Default: 36
Returns:
  • undef

Sets the channel mapping for the connected LEDs.

If the mapping has 4 colors, the function set_led_values() 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->get_channel_mapping()
Returns:
  • $mapping – Type: int, Range: See constants, Default: 36

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

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->get_spitfp_error_count()
Return Array:
  • 0: $error_count_ack_checksum – Type: int, Range: [0 to 232 - 1]
  • 1: $error_count_message_checksum – Type: int, Range: [0 to 232 - 1]
  • 2: $error_count_frame – Type: int, Range: [0 to 232 - 1]
  • 3: $error_count_overflow – Type: int, 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.

BrickletLEDStripV2->set_bootloader_mode($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
BrickletLEDStripV2->get_bootloader_mode()
Returns:
  • $mode – Type: int, Range: See constants

Returns the current bootloader mode, see set_bootloader_mode().

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->set_write_firmware_pointer($pointer)
Parameters:
  • $pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • undef

Sets the firmware pointer for write_firmware(). 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->write_firmware(@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 set_write_firmware_pointer() 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->set_status_led_config($config)
Parameters:
  • $config – Type: int, Range: See constants, Default: 3
Returns:
  • undef

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->get_status_led_config()
Returns:
  • $config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by set_status_led_config()

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

BrickletLEDStripV2->reset()
Returns:
  • undef

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->write_uid($uid)
Parameters:
  • $uid – Type: int, Range: [0 to 232 - 1]
Returns:
  • undef

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->read_uid()
Returns:
  • $uid – Type: int, Range: [0 to 232 - 1]

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

BrickletLEDStripV2->get_identity()
Return Array:
  • 0: $uid – Type: string, Length: up to 8
  • 1: $connected_uid – Type: string, Length: up to 8
  • 2: $position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • 3: @hardware_version – 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]
  • 4: @firmware_version – 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]
  • 5: $device_identifier – 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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->register_callback($callback_id, $function)
Parameters:
  • $callback_id – Type: int
  • $function – Type: string
Returns:
  • undef

Registers the given $function name with the given $callback_id.

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

BrickletLEDStripV2->set_frame_started_callback_configuration($enable)
Parameters:
  • $enable – Type: bool, Default: 1
Returns:
  • undef

Enables/disables the CALLBACK_FRAME_STARTED callback.

BrickletLEDStripV2->get_frame_started_callback_configuration()
Returns:
  • $enable – Type: bool, Default: 1

Returns the configuration as set by set_frame_started_callback_configuration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function name:

sub my_callback
{
    print "@_[0]";
}

$led_strip_v2->register_callback(BrickletLEDStripV2->CALLBACK_EXAMPLE, 'my_callback')

The callback function will be called from an internal thread of the IP Connection. In contrast to many other programming languages, variables are not automatically shared between threads in Perl. If you want to share a global variable between a callback function and the rest for your program it has to be marked as :shared. See the documentation of the threads::shared Perl module for more details.

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

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->get_api_version()
Return Array:
  • 0: @api_version – 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->get_response_expected($function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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 set_response_expected(). 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 send 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->set_response_expected($function_id, $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool
Returns:
  • undef

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 send 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->set_response_expected_all($response_expected)
Parameters:
  • $response_expected – Type: bool
Returns:
  • undef

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

Constants

BrickletLEDStripV2->DEVICE_IDENTIFIER

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

The get_identity() 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.