OctoPrint WS281x LED Status
Add some RGB LEDs to your 3D printer for a quick status update!
A highly configurable plugin for supporting WS2811, WS2812 and SK6812 LEDs attached to your Raspberry Pi.
With lots of effects to choose from, you can customise the plugin to do things exactly as you want them, to display the status from your 3D printer from a simple strip of LEDs.
Features include:
- Reacting to printing events
- Tracking heating & printing progress
- Intercepting M150 commands
- Quick on/off button from the navbar
- 'Torch' function, to light up your printer
- A timer to turn the LEDs on or off at certain times of day
- Easy to use but highly configurable settings interface, you can turn pretty much anything on or off and configure it to how you like it.
- LED Strip test
- Power calculator
- ... and more!
You can take a look at the documentation 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 the heavy lifting done for you via a configuration wizard:
- Wiring your LEDs
- Configuring SPI
- Configuring plugin settings
Follow the detailed setup guide in the documentation to get up and running.
Getting help
Please read the Get Help Guide as well as the rest of the documentation, to see if your question has been answered there. Still got questions? Get in touch:
- On the OctoPrint Discord
- On the Community Forums
- Open an issue with the question template
Reporting problems
Whilst I don't like bugs, I want to hear about them! Let me know by opening an issue
Contributing
I accept many forms of contribution, from fixing bugs, documentation and new features. Please see the Contributing Guidelines for more details or get in touch if you don't know where to start.
Support my work!
I created this plugin in my spare time, so if you have enjoyed using it then please support it's development!
Thanks to JetBrains for supporting an open source license for their brilliant IDEs!
Thanks
This was my first plugin and still my favourite, I have to say thanks for helping me develop it:
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 for creating OctoPrint and such a great community around it.