Releases: cp2004/OctoPrint-WS281x_LED_Status
0.7.0rc2 (Release Candidate)
0.7.0 Release Candidate 2
⚠️ This is a pre-release version of WS281x LED Status ⚠️
You should only run this if you are comfortable with testing development builds. Bugs may occur.
Please provide general feedback on this release in the feedback ticket here. An 'all is working fine' comment is valuable feedback, since it lets me know people are testing this release. If you run into any bugs please open a new issue with the full template - logs are required!
If you enjoy using this plugin, please consider supporting it's development! Big thank you to everyone who is supporting me, it makes a huge difference no matter how small.
⬆️ Improvements
M150 W<value>now uses 'dedicated white' if enabled (#122)- Some additional debug logging for M150 commands.
🐛 Fixes
- Fix two typos in the settings UI
⚙️ Installing the release candidate
Head to the software update section of OctoPrint, then switch the release channel from 'Stable' to `Release Candidate':
Not running OctoPrint 1.5.0+?
You can install manually using this URL in the plugin manager > get more > ...from URL box:
https://github.com/cp2004/OctoPrint-WS281x_LED_Status/releases/download/0.7.0rc2/release.zip
0.7.0rc1 (Release Candidate)
0.7.0 Release Candidate 1
⚠️ This is a pre-release version of WS281x LED Status ⚠️
You should only run this if you are comfortable with testing development builds. Bugs may occur.
Please provide general feedback on this release in the feedback ticket here. An 'all is working fine' is valuable feedback, since it lets me know people are testing this release. If you run into any bugs please open a new issue with the full template - logs are required!
If you enjoy using this plugin, please consider supporting it's development! Big thank you to everyone who is supporting me, it makes a huge difference no matter how small.
Release stats
- 143 commits
- 61 changed files
- 3688 additions and 2413 deletions (net +1275)
✨ New Features
- Fade in/out on light switch
- Colour correction values (#80)
- Option to auto configure torch when opening the control tab (#74)
- More progress effects
- Use white LEDs on RGBW Strip (#91 & #93, thanks to @samwiseg0)
- Store lights on/off state across restarts (#65)
- Idle timeout feature (#69)
- Test any RGB colour in LED test (#117 & #118, thanks to @dchauran)
- Brand new documentation
- All documentation is now hosted on Gitbook. This has made it far easier to read, use and maintain. It allows for versioned documentation as well as contributions from Github - found a problem in the docs? You can contribute! Documentation fixes are sometimes the best way to get involved in your favourite open source project to help others.
- All links in the plugin have been updated, and as I can use branches for versions, there is no more need for the additional clicks to the wiki and then onto the docs 🥳.
⬆️ Improvements
- Added some CI tests and build process
- The test suite is currently limited, to be expanded in the future. Are you a Python testing guru? Please get in touch, I could do with some help here!
- Migrate settings to new structure, which is far more organised, and avoids an additional settings parsing step.
- Stable API - breaking change - though from now on the API is documented and mostly stable.
- Majority of inputs have IDs and linked labels for accessibility improvements.
- Check sys modules for
spidev.bufsiz(#77) - Made OS configuration test smarter, it now provides reasons for test failures and can handle missing files properly (#77/#75)
- Detect
core_freq=250on Raspberry Pi 4, and ask to remove it manually (#75) - Bump rpi-ws281x to >4.2.5 (#73)
- Stability improvements, bugfixes, refactoring and more to improve the maintainability of the code. This was performed across the majority of the plugin code, it is way more readable and understandable now!
- Make wizard use OS configuration test to reduce code duplication
- Redesign of cluttered strip settings modal
- Handle errors in effects and report them properly to the log
- Move plugin API to separate class
- Make wizard/OS config stuff a separate class
- Move settings to separate file
- More efficient M150 parsing
- Additional logging of issues
- Improve utilities with KO bindings (#39)
- Rework effect running for better performance and stability
- Use built-in user group management rather than relying on the
piuser - Use Jinja macros and sub-templates efficiently to make the UI more maintainable
- Add note to setup wizard if docker is detected
- Add development channel to SW update
🐛 Bug Fixes
- Fix cooling progress tracking bed heater (#58)
- Do not trigger OS configuration notification if wizard is not loaded (#53)
- Fix startup effect not disabling
- Cooling effect will not end if new print is started before cooldown finished (#105)
- Don't let M150 cancel heating
- Fix file not found error crashing the UI (#96)
- Fix lights on/off reporting on the websocket
- Make sure auto-connect printer is reflected on the strip (#88)
⚙️ Installing the release candidate
Head to the software update section of OctoPrint, then switch the release channel from 'Stable' to `Release Candidate':
Not running OctoPrint 1.5.0+?
You can install manually using this URL in the plugin manager > get more > ...from URL box:
https://github.com/cp2004/OctoPrint-WS281x_LED_Status/releases/download/0.7.0rc1/release.zip
0.6.0 (Stable Release!)
0.6.0 Stable Release 🎉
Stable release of 0.6.0 has arrived! This is packed with lots of changes, from new features to improvements to loads of little things.
Thank you to everyone who provided feedback on the release candidate to help me test, it was very appreciated!
There's a feedback ticket for this release here: #52 Let me know what you think of this release!
Special thank you to @11chrisadams11 for their PR.
If you enjoy using this plugin, please consider supporting it's development!
This release was developed over 69 days, with 71 commits covering 5005 additions and 789 deletions, with 2 contributors.
New Features
- (#16) Cooldown tracking - track the progress of your printer cooling down while hot, at the end of a print
- (#14, #37, #48) Add option to reverse progress effect - contributed by @11chrisadams11 (Thank you!!)
- (#32) Allow setting baseline temperature for heating scale
- Set this to room temperature to make the progress bar look as though it starts at '0'
- (#35) Add option to make torch mode a toggle, instead of timed
- (#40) Added
@commands for torch mode:- @WS_TORCH for timed mode, @WS_TORCH_ON/OFF for toggle mode
- Added an OS configuration test dialog
- Accessed under Settings > Utilities > OS Config test, this allows you to check your system is configured properly for the plugin.
- Added pre-release update channel to SW update hook
- From OctoPrint 1.5.0, you will be able to select 'Release Candidate' pre-release channel in the software updater. So you won't have to install RCs like this manually!
- Added links to documentation throughout. You can now click all those little blue (i) symbols, to get more information.
Improvements
- (#19) Allow non-integer values in the delay field. Ever wanted to fine-tune the speed of effects? Now you can!
- (#29) Heating display 'finishes' when print starts, no longer continues until new event is processed.
- In addition, all events are saved in a buffer so that torch mode and lights on/off always go back to previous state.
- (#33) Ignore W parameter in M150 commands, if R/G/B is provided
- Now full compatibility with the M150 Control plugin
- (#44) Progress bar resumes straight away on 'Resume Print'
- Appended a
Cto temperature input - Re-wrote wizard client code to fully utilise the power of knockout, better UX with request spinners, and popovers.
- In addition, the wizard is now skippable, but it will warn you that the configuration is not complete.
- Overview tab now includes features enabled/disabled
- Re-wrote navbar icon client code:
- Use the power of knockout
- Send push events when the icons change, to sync the UI - no more confusing states there.
- Wizard implementation extracted to sub-module, for maintainability.
- Added pre-commit configuration that runs black formatting, OctoPrint's codemods, isort, Flake8, Prettier for various optimisations & formatting changes.
- Log settings in debug mode, for issue analysis
- Add
__plugin_check__function, so it only runs on a Raspberry Pi. - Added OctoPrint's custom python-versioneer for automatic versioning.
- Performance increase for event reacting handlers
Bug Fixes
- (#29) Make sure progress is 0 at the start of a print
- (#31) Fix bouncy balls effect crashing by trying to have half-pixels - ensure always an integer
- (#30) M150 commands are no longer sent to printer when intercept is on
- Prevent ZeroDivisionError calculating progress
- (#50) (regression?) Fix detection of Pi zero in wizard code
0.6.0rc1 (Release Candidate)
0.6.0 Release Candidate 🎉
⚠️ This is a pre-release version of OctoPrint WS281x LED Status ⚠️
You should only run this if you are comfortable with testing development builds. Bugs may occur.
Please provide general feedback on this release in the feedback ticket here an 'all is working fine' is valuable feedback, since it lets me know people are testing this release. If you run into any bugs please open a new issue with the full template - logs are required!
If you enjoy using this plugin, please consider supporting it's development!
This release was developed over 66 days, with 70 commits covering 5001 additions and 788 deletions.
New Features
- (#16) Cooldown tracking - track the progress of your printer cooling down while hot, at the end of a print
- (#32) Allow setting baseline temperature for heating scale
- Set this to room temperature to make the progress bar look as though it starts at '0'
- Added an OS configuration test dialog
- Accessed under Settings > Utilities > OS Config test, this allows you to check your system is configured properly for the plugin.
- Added pre-release update channel to SW update hook
- From OctoPrint 1.5.0, you will be able to select 'Release Candidate' pre-release channel in the software updater. So you won't have to install RCs like this manually!
- (#14, #37, #48) Add option to reverse progress effect - contributed by @11chrisadams11 (Thank you!!)
- (#35) Add option to make torch mode a toggle, instead of timed
- (#40) Added
@commands for torch mode:- @WS_TORCH for timed mode, @WS_TORCH_ON/OFF for toggle mode
- Added links to documentation throughout. You can now click all those little blue (i) symbols, to get more information.
Improvements
- (#19) Allow non-integer values in the delay field. Ever wanted to fine-tune the speed of effects? Now you can!
- (#33) Ignore W parameter in M150 commands, if R/G/B is provided
- Now full compatibility with the M150 Control plugin
- (#44) Progress bar resumes straight away on 'Resume Print'
- (#29) Heating display 'finishes' when print starts, no longer continues until new event is processed.
- In addition, all events are saved in a buffer so that torch mode and lights on/off always go back to previous state.
- Appended a
Cto temperature input - Re-wrote wizard client code to fully utilise the power of knockout, better UX with request spinners, and popovers.
- In addition, the wizard is now skippable, but it will warn you that the configuration is not complete.
- Overview tab now includes features enabled/disabled
- Re-wrote navbar icon client code:
- Use the power of knockout
- Send push events when the icons change, to sync the UI - no more confusing states there.
- Wizard implementation extracted to sub-module, for maintainability.
- Added pre-commit configuration that runs black formatting, OctoPrint's codemods, isort, Flake8, Prettier for various optimisations & formatting changes.
- Log settings in debug mode, for issue analysis
- Add
__plugin_check__function, so it only runs on a Raspberry Pi. - Added OctoPrint's custom python-versioneer for automatic versioning.
- Performance increase for event reacting handlers
Bug Fixes
- (#31) Fix bouncy balls effect crashing by trying to have half-pixels - ensure always an integer
- (#30) M150 commands are no longer sent to printer when intercept is on
- Prevent ZeroDivisionError calculating progress
- (#29) Make sure progress is 0 at the start of a print
- Remove some random text I thought had been deleted already...
V0.5.1 Couple of fixes
This release addresses some issues reported/discovered in usage of the plugin. Covering 12 commits, 43 additions with 26 deletions. See them here.
Support my work on this plugin! You can donate through Github Sponsors from as little as 1$
Feedback wanted! Please see feedback ticket for 0.5.x versions for details: #18
Fixes
- (#21) Fix power calculator output
- (#23) Work around some visibility issues in themeify
- Minor performance increase to gcode hook (You probably won't notice...)
- Add missing help text to 'Return to idle setting' surrounding how to stop it
- Make sure test buttons are disabled if M150 support is.
As always, let me know what you think, bug reports, feature requests and I will get back to you as soon as possible!
V0.5.0 Effects - and more!
Covering 58 commits, 407 additions and 4,738 deletions across just over 2 weeks, I present V0.5.0! You can see them all here.
As always, this release has been extensively tested through development, however if you do find something wrong please let me know and I will fix it as soon as I can.
Support my work!
Sponsor the development of the plugin on Github - https://github.com/sponsors/cp2004
Greatly encourages development, and maybe even some shiny new features...👀
Feedback wanted!
Please see ticket here
Please take a moment to fill out the Google form, it won't take more than a minute and would be greatly appreciated. Thanks a lot!
Features
- Added 'torch' button to the navbar
- Enables a trigger for an effect manually, for a configurable length of time.
- (#7) Added return to idle setting
- After print success event, wait and then return to the idle effect
- Added blink effect
- Note about blink - you'll want a high delay time here.
- (#17) Added random effect
- Added crossover effect
- Added solo bounce effect
- Added bouncy balls effect
- May not work well on low numbers of LEDs
- Added LED test tab
- Useful if you need to diagnose issues with a specific colour on your strip.
- Added contributors & sponsor button to 'about' tab
Improvements
- (#11) Progress bars now have finer granularity, thanks to @11chrisadams11
- The bar 'blends' between the two colours.
- Make bounce effect wider & with a fade to the edges
- All 'delay' inputs (and some others) have units appended, so it is clearer what they mean
- Move debug logging to 'features' tab
- Add calculator icon to power calculator
- Clean up some unused files and imports.
Fixes
- Make default printing effect delay 1ms
- Prevents high CPU if solid effect is started
- Make sure progress effect is put back if settings change mid-print
- Remove incorrect system command logging
- Fix effect stop-start logging
Thanks to JetBrains for sponsoring an open source license, it has really helped out with development.
V0.4.0 - Features!
First feature release since registering on the repo! Covers 19 commits, see them here
Features
- Added power calculation tab to help make sure your power supply is up to it
- (#2) Added 'Printing' effect if you don't want progress. Can be set to solid white to light print area.
- (#6) React to Gcode @ commands
@WS_LIGHTSONand@WS_LIGHTSOFF - (#5) Intercept M150 commands to set the LED Strip colour. More details
All of the above features can be turned on or off, as you choose.
If you find any bugs in the plugin, please report them in the repo as soon as possible
While these changes have been extensively tested, some bugs may slip in. Lets hope not....
V0.3.3 Bug Fix
Fixes
- (#4) Fix an issue where (commonly caused by incorrect settings) the runner process would crash and was unable to be restarted, until was OctoPrint restarted
V0.3.2 Fix update info
Fixes
- In preparation for release on the repo, fixing update info.
V0.3.1 Polish for official release
Fixes
- Tidy up some notes, add a warning of the current timezone for clarity