docs(api): add note about speeds that cause resonance #14653
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sfoster1
approved these changes
Mar 13, 2024
| @@ -219,6 +219,9 @@ Movement Speeds | |||
|
|
|||
| In addition to instructing the robot where to move a pipette, you can also control the speed at which it moves. Speed controls can be applied either to all pipette motions or to movement along a particular axis. | |||
|
|
|||
| .. note:: | |||
| Like all mechanical systems, Opentrons robots have resonant frequencies that depend on their construction and current configuration. It's possible to set a speed that causes your robot to resonate, producing louder sounds than typical operation. This is safe, but if you find it annoying, increase or decrease the speed slightly. | |||
There was a problem hiding this comment.
do we want to give an explicit amount instead of "slightly", like 10% or something?
There was a problem hiding this comment.
This OT-2 support page didn't offer much more than "try faster or slower". If someone has a number in mind, I'm happy to use it. But if we're just guessing, I think we should leave it as-is.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #14653 +/- ##
=======================================
Coverage 67.34% 67.34%
=======================================
Files 2485 2485
Lines 71439 71418 -21
Branches 9057 9042 -15
=======================================
- Hits 48114 48100 -14
Misses 21173 21173
+ Partials 2152 2145 -7
Flags with carried forward coverage won't be shown. Click here to find out more. |
jwwojak
approved these changes
Mar 13, 2024
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
We got some questions about Flex making loud noises at certain speeds. This note gives reassurance and guidance to users who have found how to make their robot resonate 🙉
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
We got some questions about Flex making loud noises at certain speeds. This note gives reassurance and guidance to users who have found how to make their robot resonate 🙉
Test Plan
Sandbox
Changelog
Just the note block. Relevant methods link to this page from the API Reference, so I don't think we need to duplicate the text there.
Review requests
Good message, good words?
Risk assessment
zero