Crate ws2812_esp32_rmt_driver
source ·Expand description
§ws2812-esp32-rmt-driver
A rust driver library to control WS2812B (NeoPixel) RGB LED pixels/strips using ESP32 RMT (Remote Control) module.
By disabling the carrier generator of the RMT’s transmitter , it can be used as just a PWM signal generator for WS2812B data signal. This control way is the same as major Arduino/C++ library such as FastLED, Adafruit_NeoPixel.
The RMT (Remote Control) module is specific to ESP32. Hence, it can be used only for ESP32 SoC.
This library also support SK6812-RGBW 4-color LED pixels/strips (smart-leds API only).
§Usage
Install rust with Xtensa support. Refer esp-rs/rust-build for the setup instruction.
Add following dependency to your Cargo.toml
. Note that version is stripped in this example but it is recommended to
specify version explicitly in your project.
[dependencies]
esp-idf-sys = { version = "*", features = ["binstart"] }
esp-idf-hal = "*"
smart-leds = "*"
ws2812-esp32-rmt-driver = { version = "*", features = ["smart-leds-trait"] }
[build-dependencies]
embuild = "*"
anyhow = "1"
Refer examples/
directory for the source code.
Make ensure esp
toolchain is available and xtensa-esp32-elf-clang
is in your $PATH
. And then, run as follows
$ cargo build
$ cargo espflash
§Features
features = ["embedded-graphics-core"]
to enable embedded-graphics APIws2812_esp32_rmt_driver::lib_embedded_graphics
.features = ["smart-leds-trait"]
to enable smart-leds APIws2812_esp32_rmt_driver::lib_smart_leds
.- default feature to enable just only driver API.
§Development
To run the test locally, specify the local toolchain (stable
, nightly
, etc…) and target explicitly and disable
example builds (specify --lib
)
.
$ cargo +stable test --target x86_64-unknown-linux-gnu --lib
Re-exports§
pub use driver::Ws2812Esp32RmtDriver;
pub use driver::Ws2812Esp32RmtDriverError;
pub use lib_smart_leds::LedPixelEsp32Rmt;
smart-leds-trait
pub use lib_smart_leds::Ws2812Esp32Rmt;
smart-leds-trait
pub use lib_smart_leds::RGBW8;
smart-leds-trait
Modules§
- Low-level LED pixel driver API.
- lib_embedded_graphics
embedded-graphics-core
embedded-graphics draw target API. - lib_smart_leds
smart-leds-trait
smart-leds driver wrapper API.
Type Aliases§
- RGB8
smart-leds-trait
8-bit RGB