pub struct LedStripV2Bricklet { /* private fields */ }Expand description
Controls up to 2048 RGB(W) LEDs
Implementations§
Source§impl LedStripV2Bricklet
impl LedStripV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 2_103u16
pub const DEVICE_DISPLAY_NAME: &'static str = "LED Strip Bricklet 2.0"
Sourcepub fn new(uid: Uid, connection: AsyncIpConnection) -> LedStripV2Bricklet
pub fn new(uid: Uid, connection: AsyncIpConnection) -> LedStripV2Bricklet
Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.
Sourcepub fn get_response_expected(
&mut self,
fun: LedStripV2BrickletFunction,
) -> Result<bool, GetResponseExpectedError>
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 sent 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.
Sourcepub fn set_response_expected(
&mut self,
fun: LedStripV2BrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError>
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 sent and errors are silently ignored, because they cannot be detected.
Sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
Sourcepub fn get_api_version(&self) -> [u8; 3]
pub fn get_api_version(&self) -> [u8; 3]
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.
Sourcepub async fn get_frame_started_callback_receiver(
&mut self,
) -> impl Stream<Item = u16>
pub async fn get_frame_started_callback_receiver( &mut self, ) -> impl Stream<Item = 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.
Sourcepub async fn set_led_values_low_level(
&mut self,
index: u16,
value_length: u16,
value_chunk_offset: u16,
value_chunk_data: &[u8; 58],
) -> Result<SetLedValuesLowLevel, TinkerforgeError>
pub async fn set_led_values_low_level( &mut self, index: u16, value_length: u16, value_chunk_offset: u16, value_chunk_data: &[u8; 58], ) -> Result<SetLedValuesLowLevel, TinkerforgeError>
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 [
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.
Sourcepub async fn get_led_values_low_level(
&mut self,
index: u16,
length: u16,
) -> Result<LedValuesLowLevel, TinkerforgeError>
pub async fn get_led_values_low_level( &mut self, index: u16, length: u16, ) -> Result<LedValuesLowLevel, TinkerforgeError>
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)).
Sourcepub async fn set_frame_duration(
&mut self,
duration: u16,
) -> Result<(), TinkerforgeError>
pub async fn set_frame_duration( &mut self, duration: u16, ) -> Result<(), TinkerforgeError>
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).
Sourcepub async fn get_frame_duration(&mut self) -> Result<u16, TinkerforgeError>
pub async fn get_frame_duration(&mut self) -> Result<u16, TinkerforgeError>
Returns the frame duration as set by [set_frame_duration].
Sourcepub async fn get_supply_voltage(&mut self) -> Result<u16, TinkerforgeError>
pub async fn get_supply_voltage(&mut self) -> Result<u16, TinkerforgeError>
Returns the current supply voltage of the LEDs.
Sourcepub async fn set_clock_frequency(
&mut self,
frequency: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_clock_frequency( &mut self, frequency: u32, ) -> Result<(), TinkerforgeError>
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.
Sourcepub async fn get_clock_frequency(&mut self) -> Result<u32, TinkerforgeError>
pub async fn get_clock_frequency(&mut self) -> Result<u32, TinkerforgeError>
Returns the currently used clock frequency as set by [set_clock_frequency].
Sourcepub async fn set_chip_type(&mut self, chip: u16) -> Result<(), TinkerforgeError>
pub async fn set_chip_type(&mut self, chip: u16) -> Result<(), TinkerforgeError>
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.
Associated constants:
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2801
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2811
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2812
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_LPD8806
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_APA102
Sourcepub async fn get_chip_type(&mut self) -> Result<u16, TinkerforgeError>
pub async fn get_chip_type(&mut self) -> Result<u16, TinkerforgeError>
Returns the currently used chip type as set by [set_chip_type].
Associated constants:
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2801
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2811
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2812
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_LPD8806
- LED_STRIP_V2_BRICKLET_CHIP_TYPE_APA102
Sourcepub async fn set_channel_mapping(
&mut self,
mapping: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_channel_mapping( &mut self, mapping: u8, ) -> Result<(), TinkerforgeError>
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.
Associated constants:
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGBW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGWB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBGW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBWG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWGB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWBG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRWB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRBW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBWR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBRW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWBR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWRB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRGW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRWG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGRW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGWR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWRG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWGR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRBG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRGB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGBR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGRB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBGR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBRG
Sourcepub async fn get_channel_mapping(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_channel_mapping(&mut self) -> Result<u8, TinkerforgeError>
Returns the currently used channel mapping as set by [set_channel_mapping].
Associated constants:
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGBW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGWB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBGW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBWG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWGB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWBG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRWB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRBW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBWR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBRW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWBR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWRB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRGW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRWG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGRW
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGWR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWRG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWGR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRBG
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRGB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGBR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGRB
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBGR
- LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBRG
Sourcepub async fn set_frame_started_callback_configuration(
&mut self,
enable: bool,
) -> Result<(), TinkerforgeError>
pub async fn set_frame_started_callback_configuration( &mut self, enable: bool, ) -> Result<(), TinkerforgeError>
Enables/disables the [get_frame_started_callback_receiver] receiver.
Sourcepub async fn get_frame_started_callback_configuration(
&mut self,
) -> Result<bool, TinkerforgeError>
pub async fn get_frame_started_callback_configuration( &mut self, ) -> Result<bool, TinkerforgeError>
Returns the configuration as set by
[set_frame_started_callback_configuration].
Sourcepub async fn get_spitfp_error_count(
&mut self,
) -> Result<SpitfpErrorCount, TinkerforgeError>
pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>
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.
Sourcepub async fn set_bootloader_mode(
&mut self,
mode: u8,
) -> Result<u8, TinkerforgeError>
pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>
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_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_OK
- LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
Sourcepub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>
Returns the current bootloader mode, see [set_bootloader_mode].
Associated constants:
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
Sourcepub async fn set_write_firmware_pointer(
&mut self,
pointer: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>
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.
Sourcepub async fn write_firmware(
&mut self,
data: &[u8; 64],
) -> Result<u8, TinkerforgeError>
pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>
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.
Sourcepub async fn set_status_led_config(
&mut self,
config: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>
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_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_ON
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Sourcepub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>
Returns the configuration as set by [set_status_led_config]
Associated constants:
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_ON
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Sourcepub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>
pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>
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.
Sourcepub async fn reset(&mut self) -> Result<(), TinkerforgeError>
pub async fn reset(&mut self) -> Result<(), TinkerforgeError>
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!
Sourcepub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>
pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>
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.
Sourcepub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>
pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
Sourcepub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>
pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>
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. |device_identifier_constant|
Trait Implementations§
Source§impl Clone for LedStripV2Bricklet
impl Clone for LedStripV2Bricklet
Source§fn clone(&self) -> LedStripV2Bricklet
fn clone(&self) -> LedStripV2Bricklet
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more