Struct Ws2812Esp32RmtDriver

pub struct Ws2812Esp32RmtDriver<'d> {
    pub pixel_data: Option<Vec<u8>>,
    /* private fields */
}

WS2812 ESP32 RMT driver wrapper.

Examples

#[cfg(not(target_vendor = "espressif"))]
use ws2812_esp32_rmt_driver::mock::esp_idf_hal;

use esp_idf_hal::peripherals::Peripherals;
use ws2812_esp32_rmt_driver::driver::Ws2812Esp32RmtDriver;
use ws2812_esp32_rmt_driver::driver::color::{LedPixelColor, LedPixelColorGrb24};

let peripherals = Peripherals::take().unwrap();
let led_pin = peripherals.pins.gpio27;
let channel = peripherals.rmt.channel0;
let mut driver = Ws2812Esp32RmtDriver::new(channel, led_pin).unwrap();

// Single LED with RED color.
let red = LedPixelColorGrb24::new_with_rgb(30, 0, 0);
let pixel: [u8; 3] = red.as_ref().try_into().unwrap();
assert_eq!(pixel, [0, 30, 0]);

driver.write_blocking(pixel.clone().into_iter()).unwrap();

Fields

pixel_data: Option<Vec<u8>>

Available on non-target_vendor="espressif" only.

Pixel binary array to be written

If the target vendor does not equals to “espressif”, pixel data is written into this instead of genuine encoder.

Implementations

impl<'d> Ws2812Esp32RmtDriver<'d>

pub fn new<C: RmtChannel>( channel: impl Peripheral<P = C> + 'd, pin: impl Peripheral<P = impl OutputPin> + 'd, ) -> Result<Self, Ws2812Esp32RmtDriverError>

Creates a WS2812 ESP32 RMT driver wrapper.

RMT driver of channel shall be initialized and installed for pin. channel shall be different between different pin.

Errors

Returns an error if the RMT driver initialization failed.

pub fn new_with_rmt_driver( tx: TxRmtDriver<'d>, ) -> Result<Self, Ws2812Esp32RmtDriverError>

pub fn write_blocking<'a, 'b, T>( &'a mut self, pixel_sequence: T, ) -> Result<(), Ws2812Esp32RmtDriverError>

where T: Iterator<Item = u8> + Send + 'b, 'b: 'a,

Writes pixel data from a pixel-byte sequence to the IO pin.

Byte count per LED pixel and channel order is not handled by this method. The pixel data sequence has to be correctly laid out depending on the LED strip model.

Errors

Returns an error if an RMT driver error occurred.

Warning

Iteration of pixel_sequence happens inside an interrupt handler so beware of side-effects that don’t work in interrupt handlers. See esp_idf_hal::rmt::TxRmtDriver for details.

pub fn write<'b, T>( &'static mut self, pixel_sequence: T, ) -> Result<(), Ws2812Esp32RmtDriverError>

where T: Iterator<Item = u8> + Send + 'static,

Available on crate feature alloc only.

Writes pixel data from a pixel-byte sequence to the IO pin.

Byte count per LED pixel and channel order is not handled by this method. The pixel data sequence has to be correctly laid out depending on the LED strip model.

Note that this requires pixel_sequence to be Boxed for an allocation free version see Self::write_blocking.

Errors

Returns an error if an RMT driver error occurred.

Warning

Iteration of pixel_sequence happens inside an interrupt handler so beware of side-effects that don’t work in interrupt handlers. See esp_idf_hal::rmt::TxRmtDriver for details.