Software / API Bindings / Rust / API Reference and Examples / Bricklets (Discontinued) / LED Strip Bricklet

Rust - LED Strip Bricklet¶

This is the description of the Rust API bindings for the LED Strip Bricklet. General information and technical specifications for the LED Strip Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples¶

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

Simple¶

Download (example_simple.rs)

use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, led_strip_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your LED Strip Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ls = LedStripBricklet::new(UID, &ipcon); // Create device object.

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

    // Set first 10 LEDs to green
    ls.set_rgb_values(
        0,
        10,
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    )
    .recv()?;

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, led_strip_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your LED Strip Bricklet.
const NUM_LEDS: u8 = 16;

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ls = LedStripBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // 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);

    let frame_rendered_receiver = ls.get_frame_rendered_callback_receiver();

    let r = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
    let g = [255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0];
    let mut b = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
    ls.set_rgb_values(0, NUM_LEDS, r, g, b);

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ls` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        let mut r_index = 0u8;
        for _frame_rendered in frame_rendered_receiver {
            b[r_index as usize] = 0;
            if r_index == NUM_LEDS - 1 {
                r_index = 0;
            } else {
                r_index += 1;
            }
            b[r_index as usize] = 255;

            // Set new data for next render cycle
            ls.set_rgb_values(0, NUM_LEDS, r, g, b);
        }
    });

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API¶

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occurred.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions¶

pub fn LedStripBricklet::new(uid: &str, ip_connection: &IpConnection) → LedStripBricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	led_strip – Type: LedStripBricklet

Creates a new LedStripBricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let led_strip = LedStripBricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn LedStripBricklet::set_rgb_values(&self, index: u16, length: u8, r: [u8; 16], g: [u8; 16], b: [u8; 16]) → ConvertingReceiver<()>¶

Parameters:	index – Type: u16, Range: [0 to 319] length – Type: u8, Range: [0 to 16] r – Type: [u8; 16], Range: [0 to 255] g – Type: [u8; 16], Range: [0 to 255] b – Type: [u8; 16], Range: [0 to 255]

Sets length RGB values for the LEDs starting from index.

To make the colors show correctly you need to configure the chip type (LedStripBricklet::set_chip_type) and a 3-channel channel mapping (LedStripBricklet::set_channel_mapping) according to the connected LEDs.

Example: If you set

index to 5,
length to 3,
r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

the LED with index 5 will be red, 6 will be green and 7 will be blue.

Note

Depending on the LED circuitry colors can be permuted.

The colors will be transfered to actual LEDs when the next frame duration ends, see LedStripBricklet::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 LedStripBricklet::get_frame_rendered_callback_receiver callback.
Set all of the LED colors for next frame.
Wait for the LedStripBricklet::get_frame_rendered_callback_receiver callback.
and so on.

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

The actual number of controllable LEDs depends on the number of free Bricklet ports. See here for more information. A call of LedStripBricklet::set_rgb_values with index + length above the bounds is ignored completely.

pub fn LedStripBricklet::get_rgb_values(&self, index: u16, length: u8) → ConvertingReceiver<RgbValues>¶

Parameters:	index – Type: u16, Range: [0 to 319] length – Type: u8, Range: [0 to 16]
Return Object:	r – Type: [u8; 16], Range: [0 to 255] g – Type: [u8; 16], Range: [0 to 255] b – Type: [u8; 16], Range: [0 to 255]

Returns length R, G and B values starting from the given LED index.

The values are the last values that were set by LedStripBricklet::set_rgb_values.

pub fn LedStripBricklet::set_frame_duration(&self, duration: u16) → ConvertingReceiver<()>¶

Parameters:	duration – Type: u16, Unit: 1 ms, Range: [0 to 2¹⁶ - 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 LedStripBricklet::set_rgb_values.

pub fn LedStripBricklet::get_frame_duration(&self) → ConvertingReceiver<u16>¶

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

Returns the frame duration as set by LedStripBricklet::set_frame_duration.

pub fn LedStripBricklet::get_supply_voltage(&self) → ConvertingReceiver<u16>¶

Returns:	voltage – Type: u16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

Returns the current supply voltage of the LEDs.

pub fn LedStripBricklet::set_clock_frequency(&self, frequency: u32) → ConvertingReceiver<()>¶

Parameters:	frequency – Type: u32, 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 LedStripBricklet::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.

Note

The frequency in firmware version 2.0.0 is fixed at 2MHz.

New in version 2.0.1 (Plugin).

pub fn LedStripBricklet::get_clock_frequency(&self) → ConvertingReceiver<u32>¶

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

Returns the currently used clock frequency as set by LedStripBricklet::set_clock_frequency.

New in version 2.0.1 (Plugin).

pub fn LedStripBricklet::set_chip_type(&self, chip: u16) → ConvertingReceiver<()>¶

Parameters:	chip – Type: u16, 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),
LPD8806 and
APA102 / DotStar.

The following constants are available for this function:

For chip:

LED_STRIP_BRICKLET_CHIP_TYPE_WS2801 = 2801
LED_STRIP_BRICKLET_CHIP_TYPE_WS2811 = 2811
LED_STRIP_BRICKLET_CHIP_TYPE_WS2812 = 2812
LED_STRIP_BRICKLET_CHIP_TYPE_LPD8806 = 8806
LED_STRIP_BRICKLET_CHIP_TYPE_APA102 = 102

New in version 2.0.2 (Plugin).

pub fn LedStripBricklet::get_chip_type(&self) → ConvertingReceiver<u16>¶

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

Returns the currently used chip type as set by LedStripBricklet::set_chip_type.

The following constants are available for this function:

For chip:

LED_STRIP_BRICKLET_CHIP_TYPE_WS2801 = 2801
LED_STRIP_BRICKLET_CHIP_TYPE_WS2811 = 2811
LED_STRIP_BRICKLET_CHIP_TYPE_WS2812 = 2812
LED_STRIP_BRICKLET_CHIP_TYPE_LPD8806 = 8806
LED_STRIP_BRICKLET_CHIP_TYPE_APA102 = 102

New in version 2.0.2 (Plugin).

pub fn LedStripBricklet::set_rgbw_values(&self, index: u16, length: u8, r: [u8; 12], g: [u8; 12], b: [u8; 12], w: [u8; 12]) → ConvertingReceiver<()>¶

Parameters:	index – Type: u16, Range: [0 to 239] length – Type: u8, Range: [0 to 12] r – Type: [u8; 12], Range: [0 to 255] g – Type: [u8; 12], Range: [0 to 255] b – Type: [u8; 12], Range: [0 to 255] w – Type: [u8; 12], Range: [0 to 255]

Sets length RGBW values for the LEDs starting from index.

To make the colors show correctly you need to configure the chip type (LedStripBricklet::set_chip_type) and a 4-channel channel mapping (LedStripBricklet::set_channel_mapping) according to the connected LEDs.

The maximum length is 12, the index goes from 0 to 239 and the rgbw values have 8 bits each.

Example: If you set

index to 5,
length to 4,
r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
w to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0]

the LED with index 5 will be red, 6 will be green, 7 will be blue and 8 will be white.

Note

Depending on the LED circuitry colors can be permuted.

The colors will be transfered to actual LEDs when the next frame duration ends, see LedStripBricklet::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 LedStripBricklet::get_frame_rendered_callback_receiver callback.
Set all of the LED colors for next frame.
Wait for the LedStripBricklet::get_frame_rendered_callback_receiver callback.
and so on.

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

The actual number of controllable LEDs depends on the number of free Bricklet ports. See here for more information. A call of LedStripBricklet::set_rgbw_values with index + length above the bounds is ignored completely.

The LPD8806 LED driver chips have 7-bit channels for RGB. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 2 to make them 7-bit. Therefore, you can just use the normal value range (0-255) for LPD8806 LEDs.

The brightness channel of the APA102 LED driver chips has 5-bit. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 8 to make them 5-bit. Therefore, you can just use the normal value range (0-255) for the brightness channel of APA102 LEDs.

New in version 2.0.6 (Plugin).

pub fn LedStripBricklet::get_rgbw_values(&self, index: u16, length: u8) → ConvertingReceiver<RgbwValues>¶

Parameters:	index – Type: u16, Range: [0 to 239] length – Type: u8, Range: [0 to 12]
Return Object:	r – Type: [u8; 12], Range: [0 to 255] g – Type: [u8; 12], Range: [0 to 255] b – Type: [u8; 12], Range: [0 to 255] w – Type: [u8; 12], Range: [0 to 255]

Returns length RGBW values starting from the given index.

The values are the last values that were set by LedStripBricklet::set_rgbw_values.

New in version 2.0.6 (Plugin).

pub fn LedStripBricklet::set_channel_mapping(&self, mapping: u8) → ConvertingReceiver<()>¶

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

Sets the channel mapping for the connected LEDs.

LedStripBricklet::set_rgb_values and LedStripBricklet::set_rgbw_values take the data in RGB(W) order. But 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, the 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.

If a 3-channel mapping is selected then LedStripBricklet::set_rgb_values has to be used. Calling LedStripBricklet::set_rgbw_values with a 3-channel mapping will produce incorrect results. Vice-versa if a 4-channel mapping is selected then LedStripBricklet::set_rgbw_values has to be used. Calling LedStripBricklet::set_rgb_values with a 4-channel mapping will produce incorrect results.

The following constants are available for this function:

For mapping:

LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGB = 6
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBG = 9
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRG = 33
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGR = 36
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRB = 18
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBR = 24
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGBW = 27
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGWB = 30
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBGW = 39
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBWG = 45
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWGB = 54
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWBG = 57
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRWB = 78
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRBW = 75
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBWR = 108
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBRW = 99
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWBR = 120
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWRB = 114
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRGW = 135
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRWG = 141
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGRW = 147
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGWR = 156
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWRG = 177
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWGR = 180
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRBG = 201
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRGB = 198
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGBR = 216
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGRB = 210
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBGR = 228
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBRG = 225

New in version 2.0.6 (Plugin).

pub fn LedStripBricklet::get_channel_mapping(&self) → ConvertingReceiver<u8>¶

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

Returns the currently used channel mapping as set by LedStripBricklet::set_channel_mapping.

The following constants are available for this function:

For mapping:

LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGB = 6
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBG = 9
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRG = 33
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGR = 36
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRB = 18
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBR = 24
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGBW = 27
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGWB = 30
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBGW = 39
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBWG = 45
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWGB = 54
LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWBG = 57
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRWB = 78
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRBW = 75
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBWR = 108
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBRW = 99
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWBR = 120
LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWRB = 114
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRGW = 135
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRWG = 141
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGRW = 147
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGWR = 156
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWRG = 177
LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWGR = 180
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRBG = 201
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRGB = 198
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGBR = 216
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGRB = 210
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBGR = 228
LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBRG = 225

New in version 2.0.6 (Plugin).

Advanced Functions¶

pub fn LedStripBricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connected_uid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] firmware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connected_uid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardware_version – Type: [u8; 3]

0: major – Type: u8, Range: [0 to 255]
1: minor – Type: u8, Range: [0 to 255]
2: revision – Type: u8, Range: [0 to 255]

firmware_version – Type: [u8; 3]

0: major – Type: u8, Range: [0 to 255]
1: minor – Type: u8, Range: [0 to 255]
2: revision – Type: u8, Range: [0 to 255]

device_identifier – Type: u16, Range: [0 to 2¹⁶ - 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¶

pub fn LedStripBricklet::enable_frame_rendered_callback(&self) → ConvertingReceiver<()>¶

Enables the LedStripBricklet::get_frame_rendered_callback_receiver callback.

By default the callback is enabled.

New in version 2.0.6 (Plugin).

pub fn LedStripBricklet::disable_frame_rendered_callback(&self) → ConvertingReceiver<()>¶

Disables the LedStripBricklet::get_frame_rendered_callback_receiver callback.

By default the callback is enabled.

New in version 2.0.6 (Plugin).

pub fn LedStripBricklet::is_frame_rendered_callback_enabled(&self) → ConvertingReceiver<bool>¶

Returns:	enabled – Type: bool, Default: true

Returns true if the LedStripBricklet::get_frame_rendered_callback_receiver callback is enabled, false otherwise.

New in version 2.0.6 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

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.

pub fn LedStripBricklet::get_frame_rendered_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	length – Type: u16, Range: [0 to 320]

Receivers created with this function receive Frame Rendered events.

This callback is triggered directly after a new frame is rendered. The received variable is the number of RGB or RGBW 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 LedStripBricklet::set_rgb_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.

pub fn LedStripBricklet::get_api_version(&self) → [u8; 3]¶

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

pub fn LedStripBricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameters:	function_id – Type: u8, 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 LedStripBricklet::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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

LED_STRIP_BRICKLET_FUNCTION_SET_RGB_VALUES = 1
LED_STRIP_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
LED_STRIP_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
LED_STRIP_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
LED_STRIP_BRICKLET_FUNCTION_SET_RGBW_VALUES = 11
LED_STRIP_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 13
LED_STRIP_BRICKLET_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
LED_STRIP_BRICKLET_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

pub fn LedStripBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameters:	function_id – Type: u8, Range: See constants response_expected – Type: bool

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:

LED_STRIP_BRICKLET_FUNCTION_SET_RGB_VALUES = 1
LED_STRIP_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
LED_STRIP_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
LED_STRIP_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
LED_STRIP_BRICKLET_FUNCTION_SET_RGBW_VALUES = 11
LED_STRIP_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 13
LED_STRIP_BRICKLET_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
LED_STRIP_BRICKLET_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16

pub fn LedStripBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()¶

Parameters:	response_expected – Type: bool

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

Constants¶

pub const LedStripBricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a LED Strip Bricklet.

The LedStripBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const LedStripBricklet::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a LED Strip Bricklet.