diff --git a/KISSY/IS_shaper_calibrate.cfg b/K-ShakeTune/IS_shaper_calibrate.cfg similarity index 100% rename from KISSY/IS_shaper_calibrate.cfg rename to K-ShakeTune/IS_shaper_calibrate.cfg diff --git a/KISSY/IS_vibrations_measurements.cfg b/K-ShakeTune/IS_vibrations_measurements.cfg similarity index 100% rename from KISSY/IS_vibrations_measurements.cfg rename to K-ShakeTune/IS_vibrations_measurements.cfg diff --git a/K-ShakeTune/IS_workflow_cmd.cfg b/K-ShakeTune/IS_workflow_cmd.cfg new file mode 100644 index 0000000..4664227 --- /dev/null +++ b/K-ShakeTune/IS_workflow_cmd.cfg @@ -0,0 +1,4 @@ +[gcode_shell_command plot_graph] +command: ~/printer_data/config/K-ShakeTune/scripts/is_workflow.py +timeout: 600.0 +verbose: True diff --git a/KISSY/scripts/graph_belts.py b/K-ShakeTune/scripts/graph_belts.py similarity index 100% rename from KISSY/scripts/graph_belts.py rename to K-ShakeTune/scripts/graph_belts.py diff --git a/KISSY/scripts/graph_shaper.py b/K-ShakeTune/scripts/graph_shaper.py similarity index 100% rename from KISSY/scripts/graph_shaper.py rename to K-ShakeTune/scripts/graph_shaper.py diff --git a/KISSY/scripts/graph_vibrations.py b/K-ShakeTune/scripts/graph_vibrations.py similarity index 100% rename from KISSY/scripts/graph_vibrations.py rename to K-ShakeTune/scripts/graph_vibrations.py diff --git a/KISSY/scripts/is_workflow.py b/K-ShakeTune/scripts/is_workflow.py similarity index 99% rename from KISSY/scripts/is_workflow.py rename to K-ShakeTune/scripts/is_workflow.py index 4a70e2a..21f6fd6 100755 --- a/KISSY/scripts/is_workflow.py +++ b/K-ShakeTune/scripts/is_workflow.py @@ -35,7 +35,7 @@ import tarfile from datetime import datetime ################################################################################################################# -RESULTS_FOLDER = os.path.expanduser('~/printer_data/config/KISSY_results') +RESULTS_FOLDER = os.path.expanduser('~/printer_data/config/K-ShakeTune_results') KLIPPER_FOLDER = os.path.expanduser('~/klipper') STORE_RESULTS = 3 ################################################################################################################# diff --git a/KISSY/IS_workflow_cmd.cfg b/KISSY/IS_workflow_cmd.cfg deleted file mode 100644 index 36ee5da..0000000 --- a/KISSY/IS_workflow_cmd.cfg +++ /dev/null @@ -1,4 +0,0 @@ -[gcode_shell_command plot_graph] -command: ~/printer_data/config/KISSY/scripts/is_workflow.py -timeout: 600.0 -verbose: True diff --git a/README.md b/README.md index dc86ae9..4ac4e6b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# KISSY: Klippain Input Shaper SYstem +# Klippain Shake&Tune Module -KISSY *Klippain Input Shaper System* is a module from the [Klippain](https://github.com/Frix-x/klippain) ecosystem, designed to automate and calibrate the input shaper system on your Klipper 3D printer with a streamlined workflow and insightful vizualisations. +This Klippain "Shake&Tune" repository is a standalone module from the [Klippain](https://github.com/Frix-x/klippain) ecosystem, designed to automate and calibrate the input shaper system on your Klipper 3D printer with a streamlined workflow and insightful vizualisations. -![KISSY](./docs/kissy.png) +![logo banner](./docs/banner.png) It operates in two steps: @@ -15,7 +15,7 @@ It operates in two steps: > **Note**: > -> KISSY is part of the [Klippain](https://github.com/Frix-x/klippain) ecosystem. If you already have a full Klippain installation on your machine, no additional installation is required for you! +> This module is part of the [Klippain](https://github.com/Frix-x/klippain) ecosystem. If you already have a full Klippain installation on your machine, no additional installation is required for you! If needed, refer to [my IS graphs documentation](./docs/input_shaper.md) for tips on interpreting the generated graphs. @@ -25,10 +25,10 @@ If needed, refer to [my IS graphs documentation](./docs/input_shaper.md) for tip ## Installation -For those not using the full [Klippain](https://github.com/Frix-x/klippain), follow these steps to integrate KISSY in your setup: - 1. Add the [KISSY folder](./KISSY/) and its contents to the root of your config directory (e.g., `~/printer_data/config/`). +For those not using the full [Klippain](https://github.com/Frix-x/klippain), follow these steps to integrate this Shake&Tune module in your setup: + 1. Add the [K-ShakeTune folder](./K-ShakeTune/) and its contents to the root of your config directory (e.g., `~/printer_data/config/`). 2. Ensure the `gcode_shell_command.py` Klipper extension is installed. Use the advanced section of [KIAUH](https://github.com/dw-0/kiauh) for a straightforward installation. - 3. Make the scripts executable via SSH within the folder (`cd ~/printer_data/config/KISSY/scripts`): + 3. Make the scripts executable via SSH within the folder (`cd ~/printer_data/config/K-ShakeTune/scripts`): ```bash chmod +x ./is_workflow.py chmod +x ./graph_belts.py @@ -37,7 +37,7 @@ For those not using the full [Klippain](https://github.com/Frix-x/klippain), fol ``` 4. Append the following to your `printer.cfg` file: ``` - [include KISSY/*.cfg] + [include K-ShakeTune/*.cfg] ``` ## Usage diff --git a/docs/banner.png b/docs/banner.png new file mode 100644 index 0000000..ed01e7d Binary files /dev/null and b/docs/banner.png differ diff --git a/docs/kissy.png b/docs/kissy.png deleted file mode 100644 index 23be255..0000000 Binary files a/docs/kissy.png and /dev/null differ