Crate blinksy

Blinksy

Blinksy is a no-std, no-alloc LED control library designed for 1D, 2D, and 3D (audio-reactive) LED setups, inspired by FastLED and WLED.

• Define LED layouts in 1D, 2D, or 3D space
• Choose visual patterns (effects)
• Compute colors for each LED based on its position
• Drive various LED chipsets with each frame of colors

Core Features

• No-std, No-alloc: Designed to run on embedded targets.
• Layout Abstraction: Define 1D, 2D, or 3D LED positions with shapes (grids, lines, arcs, points, etc).
• Pattern (Effect) Library:
  • Rainbow: Gradual, colorful gradient transition across your layout.
  • Noise: Dynamic noise‑based visuals using noise functions (Perlin, Simplex, OpenSimplex, etc).
  • Make an issue if you want help to port a pattern from FastLED / WLED to Rust!
• Multi‑Chipset Support:
  • APA102
  • WS2812B
  • Make an issue if you want help to support a new chipset!
• Board Support Packages:
  • Gledopto: A great LED controller available on AliExpress: Gledopto GL-C-016WL-D
  • (TODO) QuinLED: The best DIY and pre-assembled LED controller boards
• Desktop Simulation: Run a simulation of a layout and pattern on your computer to experiment with ideas.
• (TODO) Audio-Reactive: Easily integrate audio reactivity into visual patterns.

Architecture

The library is organized into several modules:

• color: Color types and utilities
• control: Control system
• dimension: Dimension type-level markers
• driver: LED driver interface
• drivers: LED driver implementations
• layout: LED layout abstractions
• pattern: Pattern abstraction
• patterns: Pattern implementations
• time: Timing utilities

Quick Start

use blinksy::{ControlBuilder, layout1d, patterns::{Rainbow, RainbowParams}};

// Define a 1D layout with 60 LEDs
layout1d!(Layout, 60);

let mut control = ControlBuilder::new_1d()
    .with_layout::<Layout>()
    .with_pattern::<Rainbow>(RainbowParams::default())
    .with_driver(/* insert your LED driver here */)
    .build();

control.set_brightness(0.5);

loop {
    let time = /* obtain current time in milliseconds */;
    control.tick(time).unwrap();
}

Re-exports

pub use self::control::*;

Modules

color

Color Types and Utilities

control

Control System

dimension

Dimension Type Markers

driver

LED Driver Interface

drivers

LED Driver Implementations

layout

LED Layout Abstractions

pattern

Pattern Interface

patterns

Pattern Implementations

time

Timing Utilities

Macros

layout1d

Creates a one-dimensional LED layout.

layout2d

Creates a two-dimensional LED layout from a collection of shapes.