Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Frix-x/klippain-shaketune

Klipper streamlined input shaper workflow and calibration tools
https://github.com/Frix-x/klippain-shaketune

accelerometer axis klippain klipper machine resonance tuning vibrations

Last synced: 6 months ago
JSON representation

Klipper streamlined input shaper workflow and calibration tools

Awesome Lists containing this project

README 

          
# Klipper Shake&Tune plugin



Shake&Tune is a Klipper plugin from the [Klippain](https://github.com/Frix-x/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](./docs/README.md)**.



![logo banner](./docs/banner.png)



## 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](https://www.klipper3d.org/Measuring_Resonances.html) to configure it.

  1. Install Shake&Tune by running over SSH on your printer:

     ```bash

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

     ```

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

     ```

     [shaketune]

     # result_folder: ~/printer_data/config/ShakeTune_results

     #    Path where the processed results will be stored. If the folder doesn't exist,

     #    it will be automatically created. You can change this if you'd like to store 

     #    results in a different location.

     # number_of_results_to_keep: 10

     #    This setting defines how many results you want to keep in the result folder.

     #    Once the specified number is exceeded, older results will be automatically deleted

     #    to free up space on the SD card and avoid cluttering the results folder.

     # keep_raw_data: False

     #    If set to True, Shake&Tune will store both the processed graphs and the raw accelerometer

     #    .stdata files in the results folder. This can be useful for debugging or archiving purposes.

     #    Please always attach them when reporting any issues on GitHub or Discord.

     # show_macros_in_webui: True

     #    Mainsail and Fluidd doesn't create buttons for system commands (macros that are not part

     #    of the printer.cfg file). This option allow Shake&Tune to inject them into the webui at runtime.

     #    If set to False, the macros will be hidden but still accessible from the console by typing

     #    their names manually, which can be useful if you prefer to encapsulate them into your own macros.

     # timeout: 600

     #    This defines the maximum processing time (in seconds) to allows to Shake&Tune for generating 

     #    graphs from a .stdata file. 10 minutes should be more than enough in most cases, but if you have

     #    slower hardware (e.g., older SD cards or low-performance devices), increase it to prevent timeouts.

     # measurements_chunk_size: 2

     #    Each Shake&Tune command uses the accelerometer to take multiple measurements. By default,

     #    Shake&Tune will write a chunk of data to disk every two measurements, and at the end of the

     #    command will merge these chunks into the final .stdata file for processing. "2" is a very

     #    conservative setting to avoid Klipper Timer Too Close errors on lower end devices with little

     #    RAM, and should work for everyone. However, if you are using a powerful computer, you may

     #    wish to increase this value to keep more measurements in memory (e.g., 15-20) before writing

     #    the chunk and avoid stressing the filesystem too much.

     # max_freq: 200

     #    This setting defines the maximum frequency at which the calculation of the power spectral density

     #    is cutoff. The default value should be fine for most machines and accelerometer combinations and

     #    avoid touching it unless you know what you're doing.

     # dpi: 300

     #    Controls the resolution of the generated graphs. The default value of 300 dpi was optimized

     #    and strikes a balance between performance and readability, ensuring that graphs are clear

     #    without using too much RAM to generate them. Usually, you shouldn't need to change this value.

     ```



Don't forget to check out **[Shake&Tune documentation here](./docs/README.md)** for more details and how to use the macros or the CLI.