Git Product home page Git Product logo

octoprint-ws281x_led_status's Introduction

OctoPrint WS281x LED Status

Add some RGB LEDs to your 3D printer for a quick status update!

GitHub issues GitHub release (latest SemVer) GitHub release installs (latest by date) GitHub Repo stars GitHub GitHub Sponsors

rainbow effect

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.

rainbow effect

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:

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

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

Supporting my efforts

I created this project in my spare time, so if you have found it useful or enjoyed using it then please consider supporting it's development!. You can sponsor monthly or one time, for any amount you choose.

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.

💡

octoprint-ws281x_led_status's People

Contributors

cp2004 avatar 11chrisadams11 avatar andyshinn avatar dchauran avatar izk666 avatar thelm76 avatar samwiseg0 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.