README.md

Klipper Shake&Tune plugin

Shake&Tune is a Klipper plugin from the Klippain ecosystem, designed to create insightful visualizations to help you troubleshoot your mechanical problems and give you tools to better calibrate the input shaper filters on your 3D printer. It can be installed on any Klipper machine and is not limited to those using the full Klippain.

Check out the detailed documentation here.

Installation

Follow these steps to install Shake&Tune on your printer:

1. Be sure to have a working accelerometer on your machine and a [resonance_tester] section defined. You can follow the official Measuring Resonances Klipper documentation to configure it.
2. Install Shake&Tune by running over SSH on your printer:

   wget -O - https://raw.githubusercontent.com/Frix-x/klippain-shaketune/main/install.sh | bash

3. Then, append the following to your printer.cfg file and restart Klipper:

   [shaketune]
   # result_folder: ~/printer_data/config/ShakeTune_results
   #    The folder where the results will be stored. It will be created if it doesn't exist.
   # number_of_results_to_keep: 3
   #    The number of results to keep in the result_folder. The oldest results will
   #    be automatically deleted after each runs.
   # keep_raw_csv: False
   #    If True, the raw CSV files will be kept in the result_folder alongside the
   #    PNG graphs. If False, they will be deleted and only the graphs will be kept.
   # show_macros_in_webui: True
   #    Mainsail and Fluidd doesn't create buttons for "system" macros that are not in the
   #    printer.cfg file. If you want to see the macros in the webui, set this to True.
   # timeout: 300
   #    The maximum time in seconds to let Shake&Tune process the CSV files and generate the graphs.
   

Don't forget to check out Shake&Tune documentation here.