Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jwillikers/smart-leds-fx
A lighting effects library built on the smart-leds library
https://github.com/jwillikers/smart-leds-fx
adafruit-feather atsamd51 blinky feather-m4 led neopixel rust
Last synced: 10 days ago
JSON representation
A lighting effects library built on the smart-leds library
- Host: GitHub
- URL: https://github.com/jwillikers/smart-leds-fx
- Owner: jwillikers
- License: apache-2.0
- Created: 2021-09-06T15:11:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T20:51:01.000Z (9 months ago)
- Last Synced: 2024-02-10T21:35:17.340Z (9 months ago)
- Topics: adafruit-feather, atsamd51, blinky, feather-m4, led, neopixel, rust
- Language: Rust
- Homepage:
- Size: 218 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.adoc
Awesome Lists containing this project
README
= Smart LEDs FX
Jordan Williams
:experimental:
:icons: font
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]
:Asciidoctor-link: https://asciidoctor.org[Asciidoctor]
:fish: https://fishshell.com/[fish]
:Git: https://git-scm.com/[Git]
:Linux: https://www.linuxfoundation.org/[Linux]
:Neopixel: https://learn.adafruit.com/adafruit-neopixel-uberguide[Neopixel]
:Python: https://www.python.org/[Python]
:rustup: https://rustup.rs/[rustup]
:Rouge: https://rouge.jneen.net/[Rouge]
:Ruby: https://www.ruby-lang.org/en/[Ruby]
:Rust: https://www.rust-lang.org/[Rust]
:smart-leds: https://github.com/smart-leds-rs/smart-leds[smart-leds]
:soft-blink: https://en.wikipedia.org/wiki/Pulse-width_modulation#Soft-blinking_LED_indicator[soft blink]
:ws2812-spi-rs: https://github.com/smart-leds-rs/ws2812-spi-rs[ws2812-spi-rs]
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 link:boards[boards] directory.
=== Setup
. First, clone the repository.
+
[,sh]
----
git clone https://github.com/jwillikers/smart-leds-fx.git
----
. Change to the project's directory.
+
[,sh]
----
cd smart-leds-fx
----
. Install {rustup} and {Rust}.
+
[,sh]
----
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
----
. Add Cargo's directory to your `PATH`.
+
[,sh]
----
fish_add_path ~/.cargo/bin
----
. Install the Rust toolchain for the GD32 microcontroller, a RISC-V IMAC.
+
[,sh]
----
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 link:CODE_OF_CONDUCT.adoc[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-link}
* {fish}
* {Git}
* {Linux}
* {Python}
* {Rouge}
* {Ruby}
* {Rust}
* {smart-leds}
* {ws2812-spi-rs}
== Code of Conduct
Refer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct] for details.
== License
Licensed under either of
* Apache License, Version 2.0 (link:LICENSE-APACHE[LICENSE-APACHE] or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (link:LICENSE-MIT[LICENSE-MIT] or http://opensource.org/licenses/MIT)
at your option.
© 2021-2024 Jordan Williams
== Authors
mailto:{email}[{author}]