Struct tinkerforge::led_strip_bricklet::LedStripBricklet
source · pub struct LedStripBricklet { /* private fields */ }
Expand description
Controls up to 320 RGB LEDs
Implementations
sourceimpl LedStripBricklet
impl LedStripBricklet
pub const DEVICE_IDENTIFIER: u16 = 231u16
pub const DEVICE_DISPLAY_NAME: &'static str = "LED Strip Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> LedStripBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> LedStripBricklet
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: LedStripBrickletFunction
) -> Result<bool, GetResponseExpectedError>
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 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.
sourcepub fn set_response_expected(
&mut self,
fun: LedStripBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
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 send 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_frame_rendered_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>
pub fn get_frame_rendered_callback_receiver(
&self
) -> ConvertingCallbackReceiver<u16>
This receiver is triggered directly after a new frame is rendered. 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 RGB Values
.
sourcepub fn set_rgb_values(
&self,
index: u16,
length: u8,
r: [u8; 16],
g: [u8; 16],
b: [u8; 16]
) -> ConvertingReceiver<()>
pub fn set_rgb_values(
&self,
index: u16,
length: u8,
r: [u8; 16],
g: [u8; 16],
b: [u8; 16]
) -> ConvertingReceiver<()>
Sets the RGB values for the LEDs with the given length starting from index.
To make the colors show correctly you need to configure the chip type
([Set Chip Type) and a 3-channel channel mapping (
Set Channel Mapping`)
according to the connected LEDs.
The maximum length is 16, the index goes from 0 to 319 and the rgb values have 8 bits each.
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.
sourcepub fn get_rgb_values(
&self,
index: u16,
length: u8
) -> ConvertingReceiver<RgbValues>
pub fn get_rgb_values(
&self,
index: u16,
length: u8
) -> ConvertingReceiver<RgbValues>
Returns RGB value with the given length starting from the given index.
The values are the last values that were set by Set RGB Values
.
sourcepub fn set_frame_duration(&self, duration: u16) -> ConvertingReceiver<()>
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 RGB Values
.
Default value: 100ms (10 frames per second).
sourcepub fn get_frame_duration(&self) -> ConvertingReceiver<u16>
pub fn get_frame_duration(&self) -> ConvertingReceiver<u16>
Returns the frame duration in ms as set by Set Frame Duration
.
sourcepub fn get_supply_voltage(&self) -> ConvertingReceiver<u16>
pub fn get_supply_voltage(&self) -> ConvertingReceiver<u16>
Returns the current supply voltage of the LEDs. The voltage is given in mV.
sourcepub fn set_clock_frequency(&self, frequency: u32) -> ConvertingReceiver<()>
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.
Note
The frequency in firmware version 2.0.0 is fixed at 2MHz.
.. versionadded:: 2.0.1$nbsp;(Plugin)
sourcepub fn get_clock_frequency(&self) -> ConvertingReceiver<u32>
pub fn get_clock_frequency(&self) -> ConvertingReceiver<u32>
Returns the currently used clock frequency as set by Set Clock Frequency
.
.. versionadded:: 2.0.1$nbsp;(Plugin)
sourcepub fn set_chip_type(&self, chip: u16) -> ConvertingReceiver<()>
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).
.. versionadded:: 2.0.2$nbsp;(Plugin)
Associated constants:
- LED_STRIPBRICKLET_CHIP_TYPE_WS2801
- LED_STRIPBRICKLET_CHIP_TYPE_WS2811
- LED_STRIPBRICKLET_CHIP_TYPE_WS2812
- LED_STRIPBRICKLET_CHIP_TYPE_LPD8806
- LED_STRIPBRICKLET_CHIP_TYPE_APA102
sourcepub fn get_chip_type(&self) -> ConvertingReceiver<u16>
pub fn get_chip_type(&self) -> ConvertingReceiver<u16>
Returns the currently used chip type as set by Set Chip Type
.
.. versionadded:: 2.0.2$nbsp;(Plugin)
Associated constants:
- LED_STRIPBRICKLET_CHIP_TYPE_WS2801
- LED_STRIPBRICKLET_CHIP_TYPE_WS2811
- LED_STRIPBRICKLET_CHIP_TYPE_WS2812
- LED_STRIPBRICKLET_CHIP_TYPE_LPD8806
- LED_STRIPBRICKLET_CHIP_TYPE_APA102
sourcepub fn set_rgbw_values(
&self,
index: u16,
length: u8,
r: [u8; 12],
g: [u8; 12],
b: [u8; 12],
w: [u8; 12]
) -> ConvertingReceiver<()>
pub fn set_rgbw_values(
&self,
index: u16,
length: u8,
r: [u8; 12],
g: [u8; 12],
b: [u8; 12],
w: [u8; 12]
) -> ConvertingReceiver<()>
Sets the RGBW values for the LEDs with the given length starting from index.
To make the colors show correctly you need to configure the chip type
([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)
sourcepub fn get_rgbw_values(
&self,
index: u16,
length: u8
) -> ConvertingReceiver<RgbwValues>
pub fn get_rgbw_values(
&self,
index: u16,
length: u8
) -> ConvertingReceiver<RgbwValues>
Returns RGBW values with the given length starting from the given index.
The values are the last values that were set by Set RGBW Values
.
.. versionadded:: 2.0.6$nbsp;(Plugin)
sourcepub fn set_channel_mapping(&self, mapping: u8) -> ConvertingReceiver<()>
pub fn set_channel_mapping(&self, mapping: u8) -> ConvertingReceiver<()>
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.
The default value is BGR (36).
.. versionadded:: 2.0.6$nbsp;(Plugin)
Associated constants:
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RGB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RBG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BRG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BGR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GRB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GBR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RGBW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RGWB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RBGW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RBWG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RWGB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RWBG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GRWB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GRBW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GBWR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GBRW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GWBR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GWRB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BRGW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BRWG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BGRW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BGWR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BWRG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BWGR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WRBG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WRGB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WGBR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WGRB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WBGR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WBRG
sourcepub fn get_channel_mapping(&self) -> ConvertingReceiver<u8>
pub fn get_channel_mapping(&self) -> ConvertingReceiver<u8>
Returns the currently used channel mapping as set by Set Channel Mapping
.
.. versionadded:: 2.0.6$nbsp;(Plugin)
Associated constants:
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RGB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RBG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BRG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BGR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GRB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GBR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RGBW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RGWB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RBGW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RBWG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RWGB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_RWBG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GRWB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GRBW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GBWR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GBRW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GWBR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_GWRB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BRGW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BRWG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BGRW
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BGWR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BWRG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_BWGR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WRBG
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WRGB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WGBR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WGRB
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WBGR
- LED_STRIPBRICKLET_CHANNEL_MAPPING_WBRG
sourcepub fn enable_frame_rendered_callback(&self) -> ConvertingReceiver<()>
pub fn enable_frame_rendered_callback(&self) -> ConvertingReceiver<()>
Enables the get_frame_rendered_callback_receiver
receiver.
By default the receiver is enabled.
.. versionadded:: 2.0.6$nbsp;(Plugin)
sourcepub fn disable_frame_rendered_callback(&self) -> ConvertingReceiver<()>
pub fn disable_frame_rendered_callback(&self) -> ConvertingReceiver<()>
Disables the get_frame_rendered_callback_receiver
receiver.
By default the receiver is enabled.
.. versionadded:: 2.0.6$nbsp;(Plugin)
sourcepub fn is_frame_rendered_callback_enabled(&self) -> ConvertingReceiver<bool>
pub fn is_frame_rendered_callback_enabled(&self) -> ConvertingReceiver<bool>
Returns true if the get_frame_rendered_callback_receiver
receiver is enabled, false otherwise.
.. versionadded:: 2.0.6$nbsp;(Plugin)
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
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
sourceimpl Clone for LedStripBricklet
impl Clone for LedStripBricklet
sourcefn clone(&self) -> LedStripBricklet
fn clone(&self) -> LedStripBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more