-
-
Notifications
You must be signed in to change notification settings - Fork 26
Setup Guide
I've tried to make the plugin as easy to setup as possible, and while it was already easy with this guide its even easier!
It boils down to 4 quick steps:
- Install the plugin
- Wire your LEDs to your Raspberry Pi
- Setup SPI on your Pi
- Configure the LED strip in the plugin.
It may sound intimidating, but its easy, I assure you!
Install via OctoPrint's bundled Plugin Manager or manually using this URL:
https://github.com/cp2004/OctoPrint-WS281x_LED_Status/archive/master.zip
Once you have installed and enabled the plugin, OctoPrint will prompt you to restart the server. Once it is back up, please note you may have to refresh the page in order for the wizard dialog to show up.
Please see the sub-page Wiring your LEDs for details of wiring LEDs to your Pi.
There is a wizard on load of the plugin (if necessary) to configure the underlying OS of your Raspberry Pi. This only needs to be done once, and all you'll need to do is type in your password and press a few buttons. See more about this here
The final step. All that's left now is for you to select the right strip type, and enter your number of LEDs, and off we go! You can read more about these steps in the LED Configuration sup-page.
Well, not a mandatory step. If you think the effort I have put in to creating this plugin in my free time was worth it, feel free to support it's development through Github Sponsors. Thank you for your support!
If you have any questions, please don't hesitate to get in touch! You can:
- Open an issue with the question template
- Get support on the OctoPrint Discord @cp2004
- Get support on the Community Forums @Charlie_Powell
I developed the plugin in my free time, so if you have enjoyed the plugin, you can sponsor its development here from as little as $1
The plugin is licensed under the terms of the AGPLv3 License. The author (Charlie Powell) assumes no liability for it's usage and the plugin comes with no warranty.