WLED is an awesome project, as is OctoPrint. What could be better than an OctoPrint plugin for connecting the two?
This plugin allows you to configure a WLED device to connect to OctoPrint, and the LEDs can react to different events to display the status of your prints with ease!
Inspired by my other plugin, OctoPrint WS281x LED Status, it aims to provide a similar experience of high configurability with ease of use.
- Reacting to printer states including:
- Idle
- Disconnected
- Print started
- Print success
- Print failed
- Print paused
- Displaying printing progress
- Highly configurable settings
- Easy to use UI
- ... and more!
This project is still under development, please be patient as bugs are fixed and features are added!
This plugin will only install on Python 3 systems. For a guide to upgrading (it's easy!), please see my blog post (octoprint.org).
In addition, I can also only guarantee compatibility with OctoPrint 1.5.0 and newer.
Install via the bundled Plugin Manager or manually using this URL:
https://github.com/cp2004/OctoPrint-WLED/releases/latest/download/release.zip
If you install the plugin by downloading the source code from GitHub directly, it will not work.
This is because the frontend code is built as part of the release process. For details of building this see below.
Configuration can be performed in the OctoPrint UI, under Settings > WLED Integration.
I created this plugin in my spare time, for the community. If you have enjoyed using it, please consider supporting its development through GitHub sponsors. Monthly, one-time or a custom amount, you choose!
Contributions are welcome, full contributing guidelines are coming soon.
If you are feeling like contributing a new feature, feel free to open an issue so we can discuss!
To setup the node environment for frontend stuff:
- Install:
npm install - Watch JS development mode:
npm run dev - Watch CSS development mode:
npm run dev-css - Build both assets in release mode:
npm run release
These files should not be checked in, they are built on release automatically by a GitHub action.
This plugin wouldn't be possible without the great work from @frenck with the python-wled Python module that I was able to use. It has been slightly modified to work better within an OctoPrint plugin, but it is a great module to work with. Thank you!