Update joint limits docs for velocity and acceleration - #5274
Update joint limits docs for velocity and acceleration#5274Shannon Bradshaw (shannonbradshaw) wants to merge 2 commits into
Conversation
rdk#6361 added max_velocity and max_acceleration fields to the Limit struct and JointConfig, allowing kinematics files and input_range_override to specify per-joint speed and acceleration bounds. Update the kinematics reference and motion service config docs to reflect the new fields and the tighten-only override behavior for velocity and acceleration limits. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01298XYtF1zNjPzamW1BSWy4
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Adversarial reviewRan an adversarial check on this PR, cross-referenced against the RDK source PR it documents (viamrobotics/rdk#6361, merged 2026-08-19). Found 4 issues: 1. Docs state the limits are enforced today, but nothing consumes them yet (
|
- Add caution alerts noting that max_velocity and max_acceleration are stored in the kinematic model but not yet enforced by the planner (rdk#6361 states nothing consumes the limits yet; TrajectoryLimits is referenced only from tests) - Document that position overrides replace kinematic limits outright with no clamping, unlike velocity/acceleration which tighten only - Document that an explicit 0 differs from an omitted field: 0 means the joint cannot move, omitted means unbounded - Reword the joint limits intro so it covers speed bounds, not just range of motion Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01298XYtF1zNjPzamW1BSWy4
|
Thanks — accepted all four. Fixed in 1. Limits not enforced yet. Confirmed against the source: 2. Position-override safety caveat. You're right that the asymmetry was misleading. Restructured 3. 4. Intro sentence scope. Reworded to "Every joint declares position bounds and, optionally, speed bounds" so the velocity and acceleration bullets don't read as position-limit variants. prettier, markdownlint, and vale all pass; the new cross-page anchor ( Generated by Claude Code |

RDK#6361 added
max_velocityandmax_accelerationfields to theLimitstruct andJointConfig, allowing kinematics files andinput_range_overrideto specify per-joint speed and acceleration bounds.Source changes
Docs changes
docs/motion-planning/reference/kinematics.md: Expanded the "Joint limits" section to document optionalmax_velocityandmax_accelerationfields. Added the two new fields to the SVA JSON field reference list. Updated the mimic joint constraint to note that mimic joints must not declare velocity or acceleration limits.docs/motion-planning/reference/motion-service.md: Updated theinput_range_overrideattribute description to document the newmax_velocityandmax_accelerationoverride fields and the tighten-only behavior (overrides can slow a joint down but never speed it up past what the kinematics file declares).How I found these
config-xref.mdandflows.mdmotion planning referencesinput_range_override,joint.*limit,max_velocity,max_acceleration,JointConfig, andkinematics.*fileacross the entire docs repoGenerated by daily docs change agent
Generated by Claude Code