reijii/klippain-shaketune-telegramm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation draft

Browse Source
This commit is contained in:
Félix Boisselier
2023-10-17 00:12:55 +02:00
parent fe490855c3
commit ff8eff9115
6 changed files with 215 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -5,16 +5,12 @@ This Klippain "Shake&Tune" repository is a standalone module from the [Klippain]
![logo banner](./docs/banner.png)
It operates in two steps:
1. 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.
2. Then a custom Python script is called to:
1. 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..)
2. Relocates the graphs and associated CSV files to your Klipper config folder for easy access via Mainsail/Fluidd to eliminate the need for SSH.
3. Manages the folder by retaining only the most recent results (default setting of keeping the latest three sets).
If needed, refer to [my IS graphs documentation](./docs/input_shaper.md) for tips on interpreting the generated graphs.
| Belts graphs | X graphs | Y graphs | Vibrations measurement |
|:----------------:|:------------:|:------------:|:---------------------:|
| ![](./docs/images/belts_example.png) | ![](./docs/images/X_example.png) | ![](./docs/images/Y_example.png) | ![](./docs/images/vibrations_example.png) |
@@ -30,7 +26,7 @@ For those not using the full [Klippain](https://github.com/Frix-x/klippain), fol
```
[include K-ShakeTune/*.cfg]
```
3. If you want to get automatic updates, add the following to your `moonraker.cfg` file:
3. Optionally, if you want to get automatic updates, add the following to your `moonraker.cfg` file:
```
[update_manager Klippain-ShakeTune]
type: git_repo
@@ -50,4 +46,4 @@ Ensure your machine is homed, then invoke one of the following macros as needed:
- `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.
Retrieve the results from the results folder, accessible directly via Mainsail/Fluidd WebUI. For further insight on reading the results, refer to my documentation on [interpreting the IS graphs](./docs/input_shaper.md).
For further insights on the usage of the macros and the generated graphs, refer to the [K-Shake&Tune module documentation](./docs/k_shaketune.md).