This Klippain "Shake&Tune" repository is a standalone module from the Klippain ecosystem, designed to automate and calibrate the input shaper system on your Klipper 3D printer with a streamlined workflow and insightful vizualisations.
It operates in two steps:
- Utilizing specially tailored Klipper macros, it initiates tests on either the belts or the printer X/Y axis to measure the machine axes behavior. This is basically an automated call to the Klipper
TEST_RESONANCES
macro with custom parameters. - Then a custom Python script is called to:
- Generate insightful and improved graphs, aiding in parameter tuning for the Klipper
[input_shaper]
system (including best shaper choice, resonant frequency and damping ratio) or diagnosing and rectifying mechanical issues (like belt tension, defective bearings, etc..) - Relocates the graphs and associated CSV files to your Klipper config folder for easy access via Mainsail/Fluidd to eliminate the need for SSH.
- Manages the folder by retaining only the most recent results (default setting of keeping the latest three sets).
- Generate insightful and improved graphs, aiding in parameter tuning for the Klipper
The detailed documentation is here.
Belts graphs | Axis graphs | Vibrations measurement |
---|---|---|
For those not using the full Klippain, follow these steps to integrate this Shake&Tune module in your setup:
- Run the install script over SSH on your printer:
wget -O - https://raw.githubusercontent.com/Frix-x/klippain-shaketune/main/install.sh | bash
- Append the following to your
printer.cfg
file:[include K-ShakeTune/*.cfg]
- Optionally, if you want to get automatic updates, add the following to your
moonraker.cfg
file:[update_manager Klippain-ShakeTune] type: git_repo path: ~/klippain_shaketune channel: beta origin: https://github.com/Frix-x/klippain-shaketune.git primary_branch: main managed_services: klipper install_script: install.sh
Note:
If already using my old IS workflow scripts, please remove everything before installing this new module. This include the macros, the Python scripts, the
plot_graph.sh
and the[gcode_shell_command plot_graph]
section.
Ensure your machine is homed, then invoke one of the following macros as needed:
BELTS_SHAPER_CALIBRATION
for belt resonance graphs, useful for verifying belt tension and differential belt paths behavior.AXES_SHAPER_CALIBRATION
for input shaper graphs to mitigate ringing/ghosting by tuning Klipper's input shaper system.VIBRATIONS_CALIBRATION
for machine vibration graphs to optimize your slicer speed profiles.EXCITATE_AXIS_AT_FREQ
to sustain a specific excitation frequency, useful to let you inspect and find out what is resonating.
For further insights on the usage of the macros and the generated graphs, refer to the K-Shake&Tune module documentation.