Skip to content

v2.5.0
Compare
Choose a tag to compare
@Frix-x Frix-x released this 09 Jan 14:44
· 132 commits to main since this release
v2.5.0
84c406b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

This release is primarily a major rework of Shake&Tune. Around 75-80% of the code was modified after some tracing and analysis in order to optimize it and lower the memory requirements. This leads to improvements in memory usage and speed. For example, on my testing rig, I was able to lower the RAM requirement by 75% and speed up the belt graph generation by 10x. Moreover, the updated code is confirmed to be functional on devices with limited resources, like the PiZero2W and Rpi2, using a total of around 100MB of RAM!

Breaking change

As I discovered that moonraker is not calling the install script automatically, the new dependencies are not added correctly. So after the update, please replace your moonraker update section by the new one (to fix it for the next updates):

[update_manager Klippain-ShakeTune]
type: git_repo
origin: https://github.com/Frix-x/klippain-shaketune.git
path: ~/klippain_shaketune
virtualenv: ~/klippain_shaketune-env
requirements: requirements.txt
system_dependencies: system-dependencies.json
primary_branch: main
managed_services: klipper

And for this time, run over SSH:

cd ~/klippain_shaketune && git pull
./install.sh

Other changes and new features

  • Motor shaft resonance analysis added to the vibration measurements. While currently, it doesn't offer immediate practical applications, it enables the measurement of the motor shaft's main resonance in your machine. It's important to note that this data represents a physical parameter of the motor and serves primarily as informational for now. However, exciting future plans are in the works on this topic – stay tuned!

  • Alongside the code optimizations, a major refactoring of the code was done in order to avoid code duplication and keep it easier to maintain and understand. I hope this will make it easier for the community to create PRs on Shake&Tune :)

  • Shake&Tune entrypoint script parameters handling was improved in order to be more flexible and robust. This update allows users to adjust settings like the number of results to retain in the folder, and whether to keep CSV files alongside the PNG result graphs directly from the Klipper macros! These improvements aim to make Shake&Tune more user-friendly and adaptable to various needs.

  • The last point also allowed to also use the accelerometer chip name as a parameter as well. This means that Shake&Tune now supports a wider range of accelerometer chips beyond the ADXL345, including the LIS2DW that start to become more common, but also all the others compatible accelerometer with Klipper.

  • Added a small watermark in the top right corner to indicate the Shake&Tune version used. This allows easier debugging and understanding of the data for every graph shared on the internet.

  • Improved some parts of the documentation and especially added some bits about the new motor frequency profile of the vibration measurement graphs.

Full Changelog: v2.0.0...v2.5.0

Assets 2
Loading