Struct LedStripBricklet

Source

pub struct LedStripBricklet { /* private fields */ }

Expand description

Controls up to 320 RGB LEDs

Implementations§

Source §

pub fn new(uid: Uid, connection: AsyncIpConnection) -> LedStripBricklet

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

Source

pub fn get_response_expected( &mut self, fun: LedStripBrickletFunction, ) -> 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.

Source

pub fn set_response_expected( &mut self, fun: LedStripBrickletFunction, 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.

Source

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.

Source

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.

Source

pub async fn get_frame_rendered_callback_receiver( &mut self, ) -> impl Stream<Item = u16>

This receiver is triggered directly after a new frame is rendered. The parameter is the number of RGB or RGBW 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_rgb_values.

Source

pub async fn set_rgb_values( &mut self, index: u16, length: u8, r: &[u8; 16], g: &[u8; 16], b: &[u8; 16], ) -> Result<(), TinkerforgeError>

Sets length RGB values for the LEDs starting from index.

To make the colors show correctly you need to configure the chip type (:func:[Set Chip Type) and a 3-channel channel mapping ([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 [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_rendered_callback_receiver] receiver.
Set all of the LED colors for next frame.
Wait for the [get_frame_rendered_callback_receiver] receiver.
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](led_strip_bricklet_ram_constraints) for more information. A call of [set_rgb_values`] with index + length above the bounds is ignored completely.

Source

pub async fn get_rgb_values( &mut self, index: u16, length: u8, ) -> Result<RgbValues, TinkerforgeError>

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

The values are the last values that were set by [set_rgb_values].

Source

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_rgb_values].

Source

pub async fn get_frame_duration(&mut self) -> Result<u16, TinkerforgeError>

Returns the frame duration as set by [set_frame_duration].

Source

pub async fn get_supply_voltage(&mut self) -> Result<u16, TinkerforgeError>

Returns the current supply voltage of the LEDs.

Source

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.

§Note

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

.. versionadded:: 2.0.1$nbsp;(Plugin)

Source

pub async fn get_clock_frequency(&mut self) -> Result<u32, TinkerforgeError>

Returns the currently used clock frequency as set by [set_clock_frequency].

.. versionadded:: 2.0.1$nbsp;(Plugin)

Source

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),
LPD8806 and
APA102 / DotStar.

.. versionadded:: 2.0.2$nbsp;(Plugin)

Associated constants:

LED_STRIP_BRICKLET_CHIP_TYPE_WS2801
LED_STRIP_BRICKLET_CHIP_TYPE_WS2811
LED_STRIP_BRICKLET_CHIP_TYPE_WS2812
LED_STRIP_BRICKLET_CHIP_TYPE_LPD8806
LED_STRIP_BRICKLET_CHIP_TYPE_APA102

Source

pub async fn get_chip_type(&mut self) -> Result<u16, TinkerforgeError>

Returns the currently used chip type as set by [set_chip_type].

.. versionadded:: 2.0.2$nbsp;(Plugin)

Associated constants:

LED_STRIP_BRICKLET_CHIP_TYPE_WS2801
LED_STRIP_BRICKLET_CHIP_TYPE_WS2811
LED_STRIP_BRICKLET_CHIP_TYPE_WS2812
LED_STRIP_BRICKLET_CHIP_TYPE_LPD8806
LED_STRIP_BRICKLET_CHIP_TYPE_APA102

Source

pub async fn set_rgbw_values( &mut self, index: u16, length: u8, r: &[u8; 12], g: &[u8; 12], b: &[u8; 12], w: &[u8; 12], ) -> Result<(), TinkerforgeError>

Sets length RGBW values for the LEDs starting from index.

To make the colors show correctly you need to configure the chip type (:func:[Set Chip Type) and a 4-channel channel mapping ([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 [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_rendered_callback_receiver] receiver.
Set all of the LED colors for next frame.
Wait for the [get_frame_rendered_callback_receiver] receiver.
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](led_strip_bricklet_ram_constraints) for more information. A call of [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.

.. versionadded:: 2.0.6$nbsp;(Plugin)

Source

pub async fn get_rgbw_values( &mut self, index: u16, length: u8, ) -> Result<RgbwValues, TinkerforgeError>

Returns length RGBW values starting from the given index.

The values are the last values that were set by [set_rgbw_values].

.. versionadded:: 2.0.6$nbsp;(Plugin)

Source

pub async fn set_channel_mapping( &mut self, mapping: u8, ) -> Result<(), TinkerforgeError>

Sets the channel mapping for the connected LEDs.

[set_rgb_values] and [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 [set_rgb_values] has to be used. Calling [set_rgbw_values] with a 3-channel mapping will produce incorrect results. Vice-versa if a 4-channel mapping is selected then [set_rgbw_values] has to be used. Calling [set_rgb_values] with a 4-channel mapping will produce incorrect results.

.. versionadded:: 2.0.6$nbsp;(Plugin)

Associated constants: