Update ProfiledPIDController docs to use calculateWithVelocities #3139
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.
Summary
Updates the ProfiledPIDController documentation to use the correct
calculateWithVelocities(currentVelocity, nextVelocity)
API instead of the deprecatedcalculate(velocity, acceleration)
pattern for SimpleMotorFeedforward.Changes
feedforward.calculateWithVelocities(lastSpeed, controller.getSetpoint().velocity)
feedforward.calculateWithVelocities(self.lastSpeed, self.controller.getSetpoint().velocity)
lastTime
tracking in Java exampleNote: C++ example already uses the correct API (
feedforward.Calculate()
which takes two velocity parameters in C++).Fixes #2963