Doc: clarify that Servo::read() does not read the servo angle #136
Conversation
This file contains hidden or 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
“The current angle of the servo” could be misunderstood as its physical orientation.
per1234
requested changes
Apr 19, 2025
per1234
added
type: enhancement
Co-authored-by: Per Tillisch <[email protected]>
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.
The documentation of
Servo::read()states:This is misleading: the servo has no way of reporting its current angle. Although the sentence in parentheses attempts to clarify that this is “the value passed to the last call to write()”, this clarification is not prominent enough. I have witnessed students use
Servo::read()as a way to check that the requested position has been reached.This pull request makes absolutely clear that
Servo::read()reads the servo setpoint, and that there is no way to read its current angular position.