Motor resonance filter

[Frix-x]

WIP

Summary by Sourcery

This pull request introduces a motor resonance filter feature to Shake&Tune, allowing users to apply and remove motor resonance filters for X and Y axes. It also includes refactoring of the ShakeTune class for better configuration and command handling, enhancements to motor frequency profile computation, and updates to the documentation to reflect the new configuration options.

• New Features:
  • Introduced a motor resonance filter feature to Shake&Tune, allowing users to apply and remove motor resonance filters for X and Y axes.
• Enhancements:
  • Refactored the ShakeTune class to improve configuration initialization and command registration.
  • Enhanced the motor frequency profile computation by separating the calculation of motor characteristics and updating the plotting functions to include these characteristics.
• Documentation:
  • Updated README.md to include new configuration options for motor resonance filters, including motor_freq, motor_freq_x, motor_freq_y, motor_damping_ratio, motor_damping_ratio_x, and motor_damping_ratio_y.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a motor resonance filter feature to Shake&Tune, allowing users to apply and remove motor resonance filters. It also includes refactoring for better configuration initialization and command registration, and updates the documentation to reflect the new configuration options.

File-Level Changes

Files	Changes
shaketune/shaketune.py shaketune/motor_res_filter.py	Introduced motor resonance filter feature, including configuration, command registration, and filter application/removal logic.
shaketune/graph_creators/vibrations_graph_creator.py	Refactored motor profile computation and plotting to integrate motor resonance characteristics.
README.md	Updated documentation to reflect new motor resonance filter configuration options.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[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: 9 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 2 issues found

---

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 to tell me if it was helpful.}

[Frix-x]

@sourcery-ai review

[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: 8 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 3 issues found

---

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 to tell me if it was helpful.}

[Zeanon]

You only use damping_x here for both x and y (while technically they should be the same it doesnt make sense to have them seperate and then just ignore the value for y)
Same thing for the freuqncy

[Frix-x]

You are right, it's a mistake from my side, but it's due to the fact that currently I only compute an averaged set of values that are the same for both motors.

So I also need to decompose the frequency calculation to provide it for each motor instead of providing it like it's done for now