fix and add sweeping compatibility

[Frix-x]

Summary by Sourcery

Update resonance testing to support Klipper's new sweeping method and maintain compatibility with the old pulse-only method.

New Features:

• Introduce a sweeping vibration test method, which superimposes a slow motion sweep on top of the usual back-and-forth pulses, to filter out random motor and mechanical noise.

Tests:

• Update the resonance test manager to handle both the old and new Klipper logic.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces sweeping compatibility to ShakeTune by updating the resonance test methods to support both the old pulse-only method and the new sweeping method. It also refactors the resonance testing logic into a dedicated ResonanceTestManager class to handle both old and new Klipper versions.

Class diagram showing resonance testing compatibility changes

classDiagram
    class ResonanceTester {
        +test [old]
        +generator [new]
        +probe_points [new]
    }

    class Test {
        +min_freq
        +max_freq
        +accel_per_hz
        +get_start_test_points()
    }

    class VibrationGenerator {
        +min_freq
        +max_freq
        +accel_per_hz
    }

    ResonanceTester -- Test : has >  
    ResonanceTester -- VibrationGenerator : has >

    note for ResonanceTester "Supports both old and new Klipper versions"
    note for Test "Used in old Klipper (pre Dec 6, 2024)"
    note for VibrationGenerator "Used in new Klipper (post Dec 6, 2024)"

Loading

State diagram for resonance testing modes

stateDiagram-v2
    [*] --> CheckKlipperVersion
    CheckKlipperVersion --> OldVersion: has test attribute
    CheckKlipperVersion --> NewVersion: has generator attribute

    state OldVersion {
        [*] --> PulseOnlyTest
        PulseOnlyTest --> GetTestPoints
        GetTestPoints --> ExecuteTest
    }

    state NewVersion {
        [*] --> SweepingTest
        SweepingTest --> GetProbePoints
        GetProbePoints --> ExecuteTest
    }

    OldVersion --> [*]
    NewVersion --> [*]

Loading

File-Level Changes

Change	Details	Files
Refactored resonance testing logic into the ResonanceTestManager class.	Created the ResonanceTestManager class to encapsulate resonance testing logic. Handles both old and new Klipper versions using the is_old_klipper property. Implemented vibrate_axis and vibrate_axis_at_static_freq methods in the new class. Moved the core vibration generation logic to separate generator classes: BaseVibrationGenerator, SweepingVibrationGenerator, and StaticFrequencyVibrationGenerator. Updated the vibrate_axis and vibrate_axis_at_static_freq functions to use the new ResonanceTestManager class. Added Sweeping test support	shaketune/helpers/resonance_test.py
Updated command implementations to use the new resonance testing logic.	Updated the commands to use the new vibrate_axis function which uses the ResonanceTestManager. Added support for getting default parameter values from both old and new Klipper versions. Updated the commands to pass the res_tester object to the vibrate_axis function. Added documentation about the sweeping test	shaketune/commands/axes_shaper_calibration.py shaketune/commands/compare_belts_responses.py shaketune/commands/excitate_axis_at_freq.py
Added documentation for the sweeping test.	Added a new section explaining the sweeping test and its benefits. Explained the difference between the sweeping and pulse-only tests. Provided guidance on when to use each test type. Added documentation about the sweeping test	docs/is_tuning_generalities.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Frix-x - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}