Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cp2004/octoprint-ws281x_led_status
Add some RGB LEDs to your printer for a quick status update!
https://github.com/cp2004/octoprint-ws281x_led_status
led neopixel octoprint octoprint-plugin raspberry-pi rgb-led ws281x
Last synced: 15 days ago
JSON representation
Add some RGB LEDs to your printer for a quick status update!
- Host: GitHub
- URL: https://github.com/cp2004/octoprint-ws281x_led_status
- Owner: cp2004
- License: agpl-3.0
- Created: 2020-07-01T18:59:36.000Z (over 4 years ago)
- Default Branch: 0.8.x
- Last Pushed: 2023-12-27T13:00:31.000Z (11 months ago)
- Last Synced: 2024-05-02T04:04:47.416Z (7 months ago)
- Topics: led, neopixel, octoprint, octoprint-plugin, raspberry-pi, rgb-led, ws281x
- Language: Python
- Homepage: https://plugins.octoprint.org/plugins/ws281x_led_status
- Size: 6.24 MB
- Stars: 111
- Watchers: 4
- Forks: 26
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# OctoPrint WS281x LED Status
Add some RGB LEDs to your 3D printer for a quick status update!
A highly configurable yet easy to use plugin for attaching WS2811, WS2812 and SK6812 or LEDs to your Raspberry Pi for a printer status update!
With lots of options effects and integrations to choose from, you can customise the plugin to do things _exactly_ as you want them.
Most prominent features include:
- Printer status effects
- Tracking heating, printing and cooling progress
- Intercepting M150 commands & controlling with @ commands
- Easy controls for turning lights on and off from the navbar
- Theme-friendly torch button to temporarily light up your printer
- Timers to turn the LEDs off at certain times of day or after a print is done.
- Custom Triggers - add your own events, @ commands or gcode matching to trigger effects
- Powerful integration with OctoApp for Android
- ...and more!
You can take a look at the [documentation](https://cp2004.gitbook.io/ws281x-led-status/) for more information about all that the plugin has to offer.
## Setup
Setting up the plugin couldn't be easier! There are 3 main steps, with configuration made easy with the setup wizard.
- Wiring your LEDs
- Configuring SPI
- Configuring plugin settings
Follow the detailed [setup guide](https://cp2004.gitbook.io/ws281x-led-status/guides/setup-guide-1) in the documentation to get up and running.
## Getting help
Please read the [Get Help Guide](https://cp2004.gitbook.io/ws281x-led-status/guides/get-help-guide) as well as the [rest of the documentation](https://cp2004.gitbook.io/ws281x-led-status/), to see if your question has been answered there. Still got questions? Get in touch:
- On the [OctoPrint Discord](https://discord.octoprint.org)
- On the [Community Forums](https://community.octoprint.org)
- Open an issue with the [question template](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/issues/new?assignees=&labels=type%3A+question&template=question.md&title=)
## Reporting problems
Whilst I don't like bugs, I want to hear about them! Let me know by [opening an issue](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/issues/new?assignees=&labels=type%3A+potential+bug&template=bug_report.md&title=%5BBug%5D)
## Contributing
I accept many forms of contribution, from fixing bugs, documentation and new features.
Please see the [Contributing Guidelines](https://github.com/cp2004/OctoPrint-WS281x_LED_Status/blob/master/CONTRIBUTING.md) for more details or get
in touch if you don't know where to start.
## Sponsors
- [@KenLucke](https://github.com/KenLucke)
- [@CmdrCody51](https://github.com/CmdrCody51)
As well as 2 others supporting me regularly through [GitHub Sponsors](https://github.com/sponsors/cp2004)!
## Supporting my efforts
I created this project in my spare time, and do my best to support the community with issues and help using it. If you have found this useful or enjoyed using it then please consider [supporting it's development! ❤️](https://github.com/sponsors/cp2004). You can sponsor monthly or one time, for any amount you choose.
## Check out my other plugins
You can see all of my published OctoPrint plugins [on the OctoPrint Plugin Repository!](https://plugins.octoprint.org/by_author/#charlie-powell) Or, if you're feeling nosy and want to see what else I'm working on, check out my [GitHub profile](https://github.com/cp2004).
## Thanks
This was my first plugin and is still my favourite, so I have to say thanks for helping me develop it:
[jneilliii](https://github.com/jneilliii) for always answering my questions on discord, and making great plugins I could use as examples.
Andreas C. for jumping at the opportunity to beta-test, and providing great feedback as I was creating this!
And, of course, [Gina Häußge](https://github.com/foosel) for creating OctoPrint and such a great community around it.
# 💡