jwillikers / smart-leds-fx

A lighting effects library built on the smart-leds library

Smart LEDs FX

A lighting effects library built on the smart-leds library.

Effects

As of right now, the only effect is a simple soft blink.

Examples

Examples for several boards cna be found in the boards directory.

Setup

1. First, clone the repository.

   git clone https://github.com/jwillikers/smart-leds-fx.git

2. Change to the project’s directory.

   cd smart-leds-fx

3. Install rustup and Rust.

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

4. Add Cargo’s directory to your PATH.

   fish_add_path ~/.cargo/bin

5. Install the Rust toolchain for the GD32 microcontroller, a RISC-V IMAC.

   rustup target add riscv32imac-unknown-none-elf

Todo

• Improve power consumption by using sleep modes and disabling unused peripherals for the examples.

Contributing

Contributions in the form of issues, feedback, and even pull requests are welcome. Make sure to adhere to the project’s Code of Conduct.

Open Source Software

This project is built on the hard work of countless open source contributors. Several of these projects are enumerated below.

• Asciidoctor

• fish

• Git

• Linux

• Python

• Rouge

• Ruby

• Rust

• smart-leds

• ws2812-spi-rs

Code of Conduct

Refer to the project’s Code of Conduct for details.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

© 2021-2024 Jordan Williams

Authors

Jordan Williams