Get Help Guide

Need help using the plugin? Read this page first.

Please select the area that most describes what you need help with:

• Configuration of the plugin

• Connecting LEDs and getting them to work

• Reporting a bug in the plugin

Configuration of the plugin

There's a lot of documentation here, that describes in detail the configuration options and the features of the plugin. Be sure to read the pages under the configuration section, such as LED Strip Configuration

Still struggling? Please seek help on the OctoPrint community forums, or the Discord Server. I'm often there, or there are other users of the plugin who can help out.

Connecting LEDs and making them work

Probably the step that has the most problems, you're not alone here.

Please double check that you have wired the LEDs exactly as shown in the Wiring Guide and double check all connections.

Next up is the troubleshooting guide, where there's a list of common problems identified with solutions. Please check there and make sure your problem isn't listed, or try some of the recommended solutions.

Still won't work?

Before asking for help, please ensure that your LED strip works with other devices if possible. The best thing to check is with an Arduino, since these work more reliably than Raspberry Pi & Python.

You can seek support by opening a 'Get Help' issue, on the OctoPrint community forums, or the Discord Server. Helpful people are around most of the time to get your problems solved.

Reporting a bug with the plugin

Really? You found a bug? Ok then, best make sure it is fixed.

Please open a bug report issue providing as much information as possible, including:

• (Always) octoprint.log file

• (Always)plugin_ws281x_led_status_debug.log file, preferably with debug logging enabled.
• Clear, easy steps to reproduce.

• The hardware you are using (if relevant)

• Screenshots/video showing the problems (if necessary - these can help quite a lot)

Please use the bug report template!