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 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 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.

Sponsors

• @KenLucke
• @CmdrCody51

As well as 2 others supporting me regularly through GitHub Sponsors!

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! ❤️. 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! Or, if you're feeling nosy and want to see what else I'm working on, check out my GitHub profile.

Thanks

This was my first plugin and is still my favourite, so 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.

💡