# OctoPrint-WS281x_LED_Status

**Repository Path**: xwillin/OctoPrint-WS281x_LED_Status

## Basic Information

- **Project Name**: OctoPrint-WS281x_LED_Status
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: 0.7.x
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-16
- **Last Updated**: 2025-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OctoPrint WS281x LED Status

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

![GitHub issues](https://img.shields.io/github/issues/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
![GitHub branch checks state](https://img.shields.io/github/checks-status/cp2004/OctoPrint-WS281x_LED_STATUS/0.7.x?style=flat-square)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cp2004/OctoPrint-WS281x_LED_Status?label=latest%20release&sort=semver&style=flat-square)
![GitHub release installs (latest by date)](https://img.shields.io/github/downloads/cp2004/OctoPrint-WS281x_LED_Status/latest/total?label=New%20installs%40latest&style=flat-square)
![GitHub Release Date](https://img.shields.io/github/release-date/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
![GitHub Repo stars](https://img.shields.io/github/stars/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
![GitHub](https://img.shields.io/github/license/cp2004/OctoPrint-WS281x_LED_Status?style=flat-square)
![GitHub Sponsors](https://img.shields.io/github/sponsors/cp2004?style=flat-square)

![rainbow effect](/assets/rainbow.gif)

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
- Powerful intergration with OctoApp
- ... 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.

![rainbow effect](/assets/color_wipe.gif)

## 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](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

* [@iFrostizz](https://github.com/iFrostizz)
* [@KenLucke](https://github.com/KenLucke)

As well as 7 others supporting me through [GitHub Sponsors](https://github.com/sponsors/cp2004)!

## 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!](https://github.com/sponsors/cp2004). You can sponsor monthly or one time, for any amount you choose.
## Thanks

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

# 💡