Struct tinkerforge::led_strip_v2_bricklet::LedStripV2Bricklet

pub struct LedStripV2Bricklet { /* private fields */ }

Controls up to 2048 RGB(W) LEDs

Implementations

impl LedStripV2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 2_103u16

pub const DEVICE_DISPLAY_NAME: &'static str = "LED Strip Bricklet 2.0"

pub fn new(uid: &str, ip_connection: &IpConnection) -> LedStripV2Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected(
    &mut self,
    fun: LedStripV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>

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.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(
    &mut self,
    fun: LedStripV2BrickletFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>

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.

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

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

pub fn get_frame_started_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u16>

This receiver 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 receiver was triggered.

For an explanation of the general approach see Set LED Values.

pub fn set_led_values_low_level(
    &self,
    index: u16,
    value_length: u16,
    value_chunk_offset: u16,
    value_chunk_data: [u8; 58]
) -> ConvertingReceiver<SetLedValuesLowLevel>

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

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

pub fn set_led_values(
    &self,
    index: u16,
    value: &[u8]
) -> Result<(), BrickletRecvTimeoutError>

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

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

pub fn get_led_values_low_level(
    &self,
    index: u16,
    length: u16
) -> ConvertingReceiver<LedValuesLowLevel>

Returns the RGB(W) values as set by Set LED Values.

pub fn get_led_values(
    &self,
    index: u16,
    length: u16
) -> Result<Vec<u8>, BrickletRecvTimeoutError>

Returns the RGB(W) values as set by Set LED Values.

pub fn set_frame_duration(&self, duration: u16) -> ConvertingReceiver<()>

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 Set LED Values.

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

pub fn get_frame_duration(&self) -> ConvertingReceiver<u16>

Returns the frame duration in ms as set by Set Frame Duration.

pub fn get_supply_voltage(&self) -> ConvertingReceiver<u16>

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

pub fn set_clock_frequency(&self, frequency: u32) -> ConvertingReceiver<()>

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 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 get_clock_frequency(&self) -> ConvertingReceiver<u32>

Returns the currently used clock frequency as set by Set Clock Frequency.

pub fn set_chip_type(&self, chip: u16) -> ConvertingReceiver<()>

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

Associated constants:

• LED_STRIP_V2BRICKLET_CHIP_TYPE_WS2801
• LED_STRIP_V2BRICKLET_CHIP_TYPE_WS2811
• LED_STRIP_V2BRICKLET_CHIP_TYPE_WS2812
• LED_STRIP_V2BRICKLET_CHIP_TYPE_LPD8806
• LED_STRIP_V2BRICKLET_CHIP_TYPE_APA102

pub fn get_chip_type(&self) -> ConvertingReceiver<u16>

Returns the currently used chip type as set by Set Chip Type.

Associated constants:

• LED_STRIP_V2BRICKLET_CHIP_TYPE_WS2801
• LED_STRIP_V2BRICKLET_CHIP_TYPE_WS2811
• LED_STRIP_V2BRICKLET_CHIP_TYPE_WS2812
• LED_STRIP_V2BRICKLET_CHIP_TYPE_LPD8806
• LED_STRIP_V2BRICKLET_CHIP_TYPE_APA102

pub fn set_channel_mapping(&self, mapping: u8) -> ConvertingReceiver<()>

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 default value is BGR (36).

Associated constants:

• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RGB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RBG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BRG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BGR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GRB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GBR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RGBW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RGWB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RBGW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RBWG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RWGB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RWBG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GRWB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GRBW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GBWR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GBRW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GWBR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GWRB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BRGW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BRWG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BGRW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BGWR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BWRG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BWGR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WRBG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WRGB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WGBR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WGRB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WBGR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WBRG

pub fn get_channel_mapping(&self) -> ConvertingReceiver<u8>

Returns the currently used channel mapping as set by Set Channel Mapping.

Associated constants:

• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RGB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RBG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BRG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BGR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GRB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GBR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RGBW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RGWB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RBGW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RBWG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RWGB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_RWBG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GRWB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GRBW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GBWR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GBRW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GWBR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_GWRB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BRGW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BRWG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BGRW
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BGWR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BWRG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_BWGR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WRBG
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WRGB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WGBR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WGRB
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WBGR
• LED_STRIP_V2BRICKLET_CHANNEL_MAPPING_WBRG

pub fn set_frame_started_callback_configuration(
    &self,
    enable: bool
) -> ConvertingReceiver<()>

Enables/disables the get_frame_started_callback_receiver receiver.

By default the receiver is enabled.

pub fn get_frame_started_callback_configuration(
    &self
) -> ConvertingReceiver<bool>

Returns the configuration as set by Set Frame Started Receiver Configuration.

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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 set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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.

Associated constants:

• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• LED_STRIP_V2BRICKLET_BOOTLOADER_STATUS_OK
• LED_STRIP_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• LED_STRIP_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• LED_STRIP_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• LED_STRIP_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• LED_STRIP_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• LED_STRIP_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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.

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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.

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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.

Associated constants:

• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_OFF
• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_ON
• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Status LED Config

Associated constants:

• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_OFF
• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_ON
• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• LED_STRIP_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

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 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 write_uid(&self, uid: u32) -> ConvertingReceiver<()>

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 read_uid(&self) -> ConvertingReceiver<u32>

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

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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

Trait Implementations

impl Clone for LedStripV2Bricklet

fn clone(&self) -> LedStripV2Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.