Rust - LED Strip Bricklet 2.0

This is the description of the Rust 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 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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
use std::{error::Error, io};

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

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

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

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

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

Callback

Download (example_callback.rs)

 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
36
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, led_strip_v2_bricklet::*};

// FIXME: This example is incomplete

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection
    let led_strip_v2_bricklet = LedStripV2Bricklet::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)
    led_strip_v2_bricklet.set_frame_duration(50);

    let frame_started_receiver = led_strip_v2_bricklet.get_frame_started_callback_receiver();

    // Spawn thread to handle received events.
    // This thread ends when the `led_strip_v2_bricklet` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for event in frame_started_receiver {
            println!("Length: {}", event);
        }
    });

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

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 LedStripV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → LedStripV2Bricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • led_strip_v2 – Type: LedStripV2Bricklet

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

let led_strip_v2 = LedStripV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected (see examples above).

pub fn LedStripV2Bricklet::set_led_values(&self, index: u16, value: &[u8]) → Result<(), BrickletRecvTimeoutError>
Parameters:
  • index – Type: u16, Range: [0 to 216 - 1]
  • value – Type: &[u8], 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.

To make the colors show correctly you need to configure the chip type (see LedStripV2Bricklet::set_chip_type) and a channel mapping (see LedStripV2Bricklet::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 LedStripV2Bricklet::set_frame_duration).

Generic approach:

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

pub fn LedStripV2Bricklet::get_led_values(&self, index: u16, length: u16) → Result<Vec<u8>, BrickletRecvTimeoutError>
Parameters:
  • index – Type: u16, Range: [0 to 216 - 1]
  • length – Type: u16, Range: [0 to 216 - 1]
Returns:
  • value – Type: Vec<u8>, Range: [0 to 255]

Returns the RGB(W) values as set by LedStripV2Bricklet::set_led_values.

pub fn LedStripV2Bricklet::set_frame_duration(&self, duration: u16) → ConvertingReceiver<()>
Parameters:
  • duration – Type: u16, Range: [0 to 216 - 1]

Sets the frame duration in ms.

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 LedStripV2Bricklet::set_led_values.

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

pub fn LedStripV2Bricklet::get_frame_duration(&self) → ConvertingReceiver<u16>
Returns:
  • duration – Type: u16, Range: [0 to 216 - 1]

Returns the frame duration in ms as set by LedStripV2Bricklet::set_frame_duration.

pub fn LedStripV2Bricklet::get_supply_voltage(&self) → ConvertingReceiver<u16>
Returns:
  • voltage – Type: u16, Range: [0 to 216 - 1]

Returns the current supply voltage of the LEDs. The voltage is given in mV.

pub fn LedStripV2Bricklet::set_clock_frequency(&self, frequency: u32) → ConvertingReceiver<()>
Parameters:
  • frequency – Type: u32, Range: [0 to 232 - 1]

Sets the frequency of the clock in Hz. The range is 10000Hz (10kHz) up to 2000000Hz (2MHz).

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

The default value is 1.66MHz.

pub fn LedStripV2Bricklet::get_clock_frequency(&self) → ConvertingReceiver<u32>
Returns:
  • frequency – Type: u32, Range: [0 to 232 - 1]

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

pub fn LedStripV2Bricklet::set_chip_type(&self, chip: u16) → ConvertingReceiver<()>
Parameters:
  • chip – Type: u16, Range: See constants

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 default value is WS2801 (2801).

The following constants are available for this function:

For chip:

  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2801 = 2801
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2811 = 2811
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2812 = 2812
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_LPD8806 = 8806
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_APA102 = 102
pub fn LedStripV2Bricklet::get_chip_type(&self) → ConvertingReceiver<u16>
Returns:
  • chip – Type: u16, Range: See constants

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

The following constants are available for this function:

For chip:

  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2801 = 2801
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2811 = 2811
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2812 = 2812
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_LPD8806 = 8806
  • LED_STRIP_V2_BRICKLET_CHIP_TYPE_APA102 = 102
pub fn LedStripV2Bricklet::set_channel_mapping(&self, mapping: u8) → ConvertingReceiver<()>
Parameters:
  • mapping – Type: u8, Range: See constants

Sets the channel mapping for the connected LEDs.

If the mapping has 4 colors, the function LedStripV2Bricklet::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 default value is BGR (36).

The following constants are available for this function:

For mapping:

  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGB = 6
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBG = 9
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRG = 33
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGR = 36
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRB = 18
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBR = 24
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGBW = 27
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGWB = 30
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBGW = 39
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBWG = 45
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWGB = 54
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWBG = 57
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRWB = 78
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRBW = 75
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBWR = 108
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBRW = 99
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWBR = 120
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWRB = 114
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRGW = 135
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRWG = 141
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGRW = 147
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGWR = 156
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWRG = 177
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWGR = 180
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRBG = 201
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRGB = 198
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGBR = 216
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGRB = 210
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBGR = 228
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBRG = 225
pub fn LedStripV2Bricklet::get_channel_mapping(&self) → ConvertingReceiver<u8>
Returns:
  • mapping – Type: u8, Range: See constants

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

The following constants are available for this function:

For mapping:

  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGB = 6
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBG = 9
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRG = 33
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGR = 36
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRB = 18
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBR = 24
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGBW = 27
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGWB = 30
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBGW = 39
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBWG = 45
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWGB = 54
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWBG = 57
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRWB = 78
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRBW = 75
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBWR = 108
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBRW = 99
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWBR = 120
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWRB = 114
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRGW = 135
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRWG = 141
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGRW = 147
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGWR = 156
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWRG = 177
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWGR = 180
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRBG = 201
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRGB = 198
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGBR = 216
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGRB = 210
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBGR = 228
  • LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBRG = 225

Advanced Functions

pub fn LedStripV2Bricklet::get_api_version(&self) → [u8; 3]
Returns:
  • api_version – Type: [u8; 3], Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) 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 LedStripV2Bricklet::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 LedStripV2Bricklet::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:

  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_LED_VALUES = 1
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 11
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • LED_STRIP_V2_BRICKLET_FUNCTION_RESET = 243
  • LED_STRIP_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn LedStripV2Bricklet::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.

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:

  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_LED_VALUES = 1
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 11
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • LED_STRIP_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • LED_STRIP_V2_BRICKLET_FUNCTION_RESET = 243
  • LED_STRIP_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn LedStripV2Bricklet::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.

pub fn LedStripV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Return Object:
  • error_count_ack_checksum – Type: u32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: u32, Range: [0 to 232 - 1]
  • error_count_frame – Type: u32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: u32, 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.

pub fn LedStripV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameters:
  • mode – Type: u8, Range: See constants
Returns:
  • status – Type: u8, 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:

  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn LedStripV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Returns:
  • mode – Type: u8, Range: See constants

Returns the current bootloader mode, see LedStripV2Bricklet::set_bootloader_mode.

The following constants are available for this function:

For mode:

  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn LedStripV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameters:
  • pointer – Type: u32, Range: [0 to 232 - 1]

Sets the firmware pointer for LedStripV2Bricklet::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.

pub fn LedStripV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameters:
  • data – Type: [u8; 64], Range: [0 to 255]
Returns:
  • status – Type: u8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by LedStripV2Bricklet::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.

pub fn LedStripV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameters:
  • config – Type: u8, Range: See constants

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:

  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn LedStripV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Returns:
  • config – Type: u8, Range: See constants

Returns the configuration as set by LedStripV2Bricklet::set_status_led_config

The following constants are available for this function:

For config:

  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn LedStripV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Returns:
  • temperature – Type: i16, Range: [-215 to 215 - 1]

Returns the temperature in °C 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.

pub fn LedStripV2Bricklet::reset(&self) → ConvertingReceiver<()>

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!

pub fn LedStripV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameters:
  • uid – Type: u32, 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.

pub fn LedStripV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Returns:
  • uid – Type: u32, Range: [0 to 232 - 1]

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

pub fn LedStripV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>
Return Object:
  • uid – Type: String, Length: up to 8
  • connected_uid – Type: String, Length: up to 8
  • position – Type: char
  • hardware_version – Type: [u8; 3], Range: [0 to 255]
  • firmware_version – Type: [u8; 3], Range: [0 to 255]
  • device_identifier – Type: u16, 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' or 'd'.

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 LedStripV2Bricklet::set_frame_started_callback_configuration(&self, enable: bool) → ConvertingReceiver<()>
Parameters:
  • enable – Type: bool

Enables/disables the LedStripV2Bricklet::get_frame_started_callback_receiver callback.

By default the callback is enabled.

pub fn LedStripV2Bricklet::get_frame_started_callback_configuration(&self) → ConvertingReceiver<bool>
Returns:
  • enable – Type: bool

Returns the configuration as set by LedStripV2Bricklet::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 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 LedStripV2Bricklet::get_frame_started_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • length – Type: u16, Range: [0 to 216 - 1]

Receivers created with this function receive Frame Started events.

This callback is triggered directly after a new frame render is started. The received variable 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 LedStripV2Bricklet::set_led_values.

Constants

pub const LedStripV2Bricklet::DEVICE_IDENTIFIER

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

The LedStripV2Bricklet::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 LedStripV2Bricklet::DEVICE_DISPLAY_NAME

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