Initial Port of Klippain v5.1.1 for Qidi Plus 4

Author: stew675

README.md

@@ -1,5 +1,7 @@
 # Klipper Shake&Tune plugin
 
+This is a dedicated port of the Klippain Shake&Tune v5.1.1 module for installation on the Qidi Plus4 3D Printer
+
 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)**.
@@ -10,12 +12,18 @@ Check out the **[detailed documentation here](./docs/README.md)**.
 ## 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. Very Important:
+
+     If you have an automated update section named `[update_manager Klippain-ShakeTune]` in your `moonraker.cfg` file, please delete it before proceeding
+  1. Install Shake&Tune on your Plus4 by running over SSH on your printer:
      ```
-  1. Then, append the following to your `printer.cfg` file and restart Klipper:
+     cd /home/mks
+     git clone https://github.com/qidi-community/klippain_v511_for_qidi_plus4.git
+     cd klippain_v511_for_qidi_plus4
+     ./install.sh
+
+     ```
+  1. Then, insert the following into your `printer.cfg` file BEFORE the `SAVE_CONFIG` section and restart Klipper:
      ```
      [shaketune]
      # result_folder: ~/printer_data/config/ShakeTune_results
@@ -57,4 +65,15 @@ Follow these steps to install Shake&Tune on your printer:
      #    without using too much RAM to generate them. Usually, you shouldn't need to change this value.
      ```
 
+## Documentation
+
 Don't forget to check out **[Shake&Tune documentation here](./docs/README.md)**.
+
+
+## Acknowledgement
+
+This repository is a fork modified and tailored for the Qidi Plus 4 3D Printer.
+
+It should be noted that all of Klippain-Shaketune is authored by Félix Boisselier <[email protected]>
+
+All acknowledgement and respect to Félix for his excellent work!

backups/README.md

@@ -0,0 +1 @@
+A place-holder for where config backups can be placed

docs/README.md

@@ -14,7 +14,6 @@ First, you may want to read the **[input shaping and tuning generalities](./is_t
 
 | Shake&Tune command | Resulting graphs example |
 |:------|:-------:|
-|[`AXES_MAP_CALIBRATION`](./macros/axes_map_calibration.md)<br /><br />Verify that your accelerometer is working correctly and automatically find its Klipper's `axes_map` parameter | [<img src="./images/axesmap_example.png">](./macros/axes_map_calibration.md) |
 |[`COMPARE_BELTS_RESPONSES`](./macros/compare_belts_responses.md)<br /><br />Generate a differential belt resonance graph to verify relative belt tensions and belt path behaviors on a CoreXY or CoreXZ printer | [<img src="./images/belts_example.png">](./macros/compare_belts_responses.md) |
 |[`AXES_SHAPER_CALIBRATION`](./macros/axes_shaper_calibrations.md)<br /><br />Create the usual input shaper graphs to tune Klipper's input shaper filters and reduce ringing/ghosting | [<img src="./images/axis_example.png">](./macros/axes_shaper_calibrations.md) |
 |[`CREATE_VIBRATIONS_PROFILE`](./macros/create_vibrations_profile.md)<br /><br />Measure your global machine vibrations as a function of toolhead direction and speed to find problematic ranges where the printer could be exposed to more VFAs in order to optimize your slicer speed profiles and TMC drivers parameters | [<img src="./images/vibrations_example.png">](./macros/create_vibrations_profile.md) |

docs/images/axes_map_inaccuracy.png

@@ -6,7 +6,7 @@ KLIPPER_PATH="${HOME}/klipper"
 KLIPPER_VENV_PATH="${KLIPPER_VENV:-${HOME}/klippy-env}"
 
 OLD_K_SHAKETUNE_VENV="${HOME}/klippain_shaketune-env"
-K_SHAKETUNE_PATH="${HOME}/klippain_shaketune"
+K_SHAKETUNE_PATH="${HOME}/klippain_v511_for_qidi_plus4"
 
 set -eu
 export LC_ALL=C
@@ -30,6 +30,21 @@ function preflight_checks {
         exit -1
     fi
 
+    if [ ! -e resonance_tester.py ]; then
+	echo "[ERROR] Please run the install script from within the directory where the install script is located"
+	exit -1
+    fi
+
+    if [ ! -e shaper_calibrate.py ]; then
+	echo "[ERROR] Please run the install script from within the directory where the install script is located"
+	exit -1
+    fi
+
+    if [ ! -e install.sh ]; then
+	echo "[ERROR] Please run the install script from within the directory where the install script is located"
+	exit -1
+    fi
+
     install_package_requirements
 }
 
@@ -57,25 +72,6 @@ function install_package_requirements {
     fi
 }
 
-function check_download {
-    local shaketunedirname shaketunebasename
-    shaketunedirname="$(dirname ${K_SHAKETUNE_PATH})"
-    shaketunebasename="$(basename ${K_SHAKETUNE_PATH})"
-
-    if [ ! -d "${K_SHAKETUNE_PATH}" ]; then
-        echo "[DOWNLOAD] Downloading Klippain Shake&Tune module repository..."
-        if git -C $shaketunedirname clone https://github.com/Frix-x/klippain-shaketune.git $shaketunebasename; then
-            chmod +x ${K_SHAKETUNE_PATH}/install.sh
-            printf "[DOWNLOAD] Download complete!\n\n"
-        else
-            echo "[ERROR] Download of Klippain Shake&Tune module git repository failed!"
-            exit -1
-        fi
-    else
-        printf "[DOWNLOAD] Klippain Shake&Tune module repository already found locally. Continuing...\n\n"
-    fi
-}
-
 function setup_venv {
     if [ ! -d "${KLIPPER_VENV_PATH}" ]; then
         echo "[ERROR] Klipper's Python virtual environment not found!"
@@ -87,6 +83,7 @@ function setup_venv {
         rm -rf "${OLD_K_SHAKETUNE_VENV}"
     fi
 
+    declare -x PS1=""
     source "${KLIPPER_VENV_PATH}/bin/activate"
     echo "[SETUP] Installing/Updating K-Shake&Tune dependencies..."
     pip install --upgrade pip
@@ -112,32 +109,16 @@ function link_extension {
 }
 
 function link_module {
-    if [ ! -d "${KLIPPER_PATH}/klippy/extras/shaketune" ]; then
-        echo "[INSTALL] Linking Shake&Tune module to Klipper extras"
-        ln -frsn ${K_SHAKETUNE_PATH}/shaketune ${KLIPPER_PATH}/klippy/extras/shaketune
-    else
-        printf "[INSTALL] Klippain Shake&Tune Klipper module is already installed. Continuing...\n\n"
-    fi
+    echo "[INSTALL] Linking Shake&Tune module to Klipper extras"
+    ln -frsn ${K_SHAKETUNE_PATH}/shaketune ${KLIPPER_PATH}/klippy/extras/shaketune
 }
 
-function add_updater {
-    update_section=$(grep -c '\[update_manager[a-z ]* Klippain-ShakeTune\]' $MOONRAKER_CONFIG || true)
-    if [ "$update_section" -eq 0 ]; then
-        echo -n "[INSTALL] Adding update manager to moonraker.conf..."
-        cat <<EOF >>$MOONRAKER_CONFIG
-
-## Klippain Shake&Tune automatic update management
-[update_manager Klippain-ShakeTune]
-type: git_repo
-origin: https://github.com/Frix-x/klippain-shaketune.git
-path: ~/klippain_shaketune
-virtualenv: ${KLIPPER_VENV_PATH}
-requirements: requirements.txt
-system_dependencies: system-dependencies.json
-primary_branch: main
-managed_services: klipper
-EOF
-    fi
+function update_klipper {
+    DATE=$(date +"%Y%m%d%H%M%S")
+    mkdir -p ${K_SHAKETUNE_PATH}/backups
+    cp /home/mks/klipper/klippy/extras/resonance_tester.py ${K_SHAKETUNE_PATH}/backups/resonance_tester.py.$DATE
+    cp /home/mks/klipper/klippy/extras/shaper_calibrate.py ${K_SHAKETUNE_PATH}/backups/shaper_calibrate.py.$DATE
+    cp resonance_tester.py shaper_calibrate.py /home/mks/klipper/klippy/extras
 }
 
 function restart_klipper {
@@ -150,18 +131,16 @@ function restart_moonraker {
     sudo systemctl restart moonraker
 }
 
-
 printf "\n=============================================\n"
 echo "- Klippain Shake&Tune module install script -"
 printf "=============================================\n\n"
 
 
 # Run steps
 preflight_checks
-check_download
 setup_venv
 link_extension
 link_module
-add_updater
+update_klipper
 restart_klipper
 restart_moonraker

docs/images/axesmap_example.png

@@ -16,7 +16,7 @@ Issues = "https://github.com/Frix-x/klippain-shaketune/issues"
 Changelog = "https://github.com/Frix-x/klippain-shaketune/releases"
 
 [tool.ruff]
-line-length = 120 # We all have modern screens now and I believe this should be brought in line with current technology
+line-length = 160 # We all have modern screens now and I believe this should be brought in line with current technology
 indent-width = 4
 target-version = "py39"
 

docs/macros/axes_map_calibration.md

@@ -0,0 +1,6 @@
+GitPython==3.1.41
+matplotlib==3.8.2
+numpy==1.26.2
+scipy==1.11.4
+PyWavelets==1.6.0
+zstandard==0.23.0

install.sh

@@ -1,6 +1,6 @@
 GitPython==3.1.41
-matplotlib==3.8.2
-numpy==1.26.2
-scipy==1.11.4
-PyWavelets==1.6.0
-zstandard==0.23.0
+matplotlib==3.5.3
+numpy==1.21.6
+scipy==1.7.3
+PyWavelets==1.3.0
+zstandard==0.21.0