Crate blinksy

Crate blinksy 

Source
Expand description

§Blinksy

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

§How Blinksy works

  • Define your LED layout in 1D, 2D, or 3D space
  • Create your visual pattern (effect), or choose from our built-in patterns library
    • The pattern will compute colors for each LED based on its position
  • Setup a driver to send each frame of colors to your LEDs, using our built-in drivers library.

§Features

  • No-std, no-alloc: Designed for embedded targets.
  • Spatial in 1D, 2D, or 3D: Map out the shape of your LEDs in space.
  • Async support: Supports blocking or asynchronous execution.
  • Full color support: Supports modern and classic color spaces.
  • Global settings: Control overall brightness and color correction.
  • Desktop simulation: Simulate your LEDs on your desktop to play with ideas.
  • RGB+W support: Supports RGB + White color channels

§Multi‑Chipset Support

  • clockless: One-wire (only data, no clock)
    • WS2812B: Affordable RGB LED, aka NeoPixel
  • clocked: Two-wire (data and clock)
    • APA102: High-FPS RGB LED, aka DotStar

If you want help to support a new chipset, make an issue!

§Pattern (Effect) Library:

  • Rainbow: A basic scrolling rainbow
  • Noise: A flow through random noise functions.

If you want help to port a pattern from FastLED / WLED to Rust, make an issue!

§Board Support Packages

If you want help to support a new target, make an issue!

§Quick Start

To quickstart a project, see:

To start using the library, see control.

§1D Strip with Rainbow Pattern (Blocking)

ⓘ
use blinksy::{ControlBuilder, layout1d, patterns::rainbow::{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 {
    control.tick(/* current time in milliseconds */).unwrap();
}

§1D Strip with Rainbow Pattern (Async)

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

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

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

control.set_brightness(0.5);

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

§2D Grid with Noise Pattern (Blocking)

ⓘ
use blinksy::{
    ControlBuilder,
    layout::{Shape2d, Vec2},
    layout2d,
    patterns::noise::{noise_fns, Noise2d, NoiseParams},
};

layout2d!(
    Layout,
    [Shape2d::Grid {
        start: Vec2::new(-1., -1.),
        horizontal_end: Vec2::new(1., -1.),
        vertical_end: Vec2::new(-1., 1.),
        horizontal_pixel_count: 16,
        vertical_pixel_count: 16,
        serpentine: true,
    }]
);
let mut control = ControlBuilder::new_2d()
    .with_layout::<Layout>()
    .with_pattern::<Noise2d<noise_fns::Perlin>>(NoiseParams::default())
    .with_driver(/* insert your LED driver here */)
    .build();

control.set_brightness(0.5);

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

§3D Cube with Noise Pattern (Blocking)

ⓘ
#![no_std]
#![no_main]

use blinksy::{
    layout::{Layout3d, Shape3d, Vec3},
    layout3d,
    patterns::noise::{noise_fns, Noise3d, NoiseParams},
    ControlBuilder,
};

layout3d!(
    Layout,
    [
        // bottom face
        Shape3d::Grid {
            start: Vec3::new(1., -1., 1.),           // right bottom front
            horizontal_end: Vec3::new(-1., -1., 1.), // left bottom front
            vertical_end: Vec3::new(1., -1., -1.),   // right bottom back
            horizontal_pixel_count: 16,
            vertical_pixel_count: 16,
            serpentine: true,
        },
        // back face
        Shape3d::Grid {
            start: Vec3::new(-1., -1., -1.),         // left bottom back
            horizontal_end: Vec3::new(-1., 1., -1.), // left top back
            vertical_end: Vec3::new(1., -1., -1.),   // right bottom back
            horizontal_pixel_count: 16,
            vertical_pixel_count: 16,
            serpentine: true,
        },
        // right face
        Shape3d::Grid {
            start: Vec3::new(1., 1., -1.),         // right top back
            horizontal_end: Vec3::new(1., 1., 1.), // right top front
            vertical_end: Vec3::new(1., -1., -1.), // right bottom back
            horizontal_pixel_count: 16,
            vertical_pixel_count: 16,
            serpentine: true,
        },
        // front face
        Shape3d::Grid {
            start: Vec3::new(-1., -1., 1.),         // left bottom front
            horizontal_end: Vec3::new(1., -1., 1.), // right bottom front
            vertical_end: Vec3::new(-1., 1., 1.),   // left top front
            horizontal_pixel_count: 16,
            vertical_pixel_count: 16,
            serpentine: true,
        },
        // left face
        Shape3d::Grid {
            start: Vec3::new(-1., 1., -1.),           // left top back
            horizontal_end: Vec3::new(-1., -1., -1.), // left bottom back
            vertical_end: Vec3::new(-1., 1., 1.),     // left top front
            horizontal_pixel_count: 16,
            vertical_pixel_count: 16,
            serpentine: true,
        },
        // top face
        Shape3d::Grid {
            start: Vec3::new(1., 1., 1.),           // right top front
            horizontal_end: Vec3::new(1., 1., -1.), // right top back
            vertical_end: Vec3::new(-1., 1., 1.),   // left top front
            horizontal_pixel_count: 16,
            vertical_pixel_count: 16,
            serpentine: true,
        }
    ]
);

let mut control = ControlBuilder::new_3d()
    .with_layout::<Layout>()
    .with_pattern::<Noise3d<noise_fns::Perlin>>(NoiseParams::default())
    .with_driver(/* insert your LED driver here */)
    .build();

control.set_brightness(0.2);

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

Re-exports§

pub use self::control::*;

Modules§

color
Color Types and Utilities
control
Control System
driver
Driver Interface
drivers
LED Driver Implementations
layout
LED Layouts
markers
Type Markers
pattern
Pattern Interface
patterns
Pattern Implementations
time
Time Library
util

Macros§

layout1d
Creates a one-dimensional LED layout from a pixel count.
layout2d
Creates a two-dimensional LED layout from a collection of shapes.
layout3d