Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Motor resonance filter #131

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Motor resonance filter #131

wants to merge 5 commits into from

Conversation

Frix-x
Copy link
Owner

@Frix-x Frix-x commented Jun 23, 2024

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.

@Frix-x Frix-x changed the base branch from main to develop June 23, 2024 21:32
@Frix-x Frix-x added the enhancement New feature or request label Jun 23, 2024
@Frix-x Frix-x marked this pull request as ready for review June 24, 2024 17:11
Copy link

sourcery-ai bot commented Jun 24, 2024

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.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

shaketune/shaketune.py Show resolved Hide resolved
shaketune/shaketune.py Outdated Show resolved Hide resolved
shaketune/shaketune.py Show resolved Hide resolved
shaketune/shaketune.py Show resolved Hide resolved
shaketune/shaketune.py Show resolved Hide resolved
shaketune/motor_res_filter.py Show resolved Hide resolved
shaketune/motor_res_filter.py Show resolved Hide resolved
shaketune/motor_res_filter.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Frix-x
Copy link
Owner Author

Frix-x commented Jun 29, 2024

@sourcery-ai review

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

shaketune/shaketune.py Show resolved Hide resolved
shaketune/shaketune.py Show resolved Hide resolved
shaketune/shaketune.py Show resolved Hide resolved
shaketune/graph_creators/vibrations_graph_creator.py Outdated Show resolved Hide resolved
shaketune/graph_creators/vibrations_graph_creator.py Outdated Show resolved Hide resolved
shaketune/motor_res_filter.py Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
shaketune/motor_res_filter.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants