Repository navigation
Document arm manual mode and GetProperties in arm guides - #5409
Merged
Merged
Conversation
Replace the pick-and-place tutorial's enter_manual_mode DoCommand workaround with the Control card's ManualMode controls, add manual mode and per-model feature support to the add-an-arm guide, and note on the move-an-arm overview that arms without Cartesian support must be moved through the motion service. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Eliza Farley (elizafarley)
requested a review
from Jeremy Rose (jeremyrose-viam)
October 13, 2026 16:24
Jeremy Rose (jeremyrose-viam)
approved these changes
Oct 13, 2026
Jeremy Rose (jeremyrose-viam)
approved these changes
Oct 13, 2026
Member
|
Suggestion on the manual mode caution: in |
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
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
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.

Refs DOCS-4938 (epic RSDK-14445)
The API reference for
SetManualMode,GetManualModeandGetPropertieslanded in #5360. This PR updates the prose pages that still described the old workaround or didn't mention the new API.Changes
03-static-positions.md): replaces the{"enter_manual_mode": true}DoCommand workaround with the Control card's ManualMode row: Enter/Exit, the Enable after countdown and the Enabled for limit. Labels and defaults come fromviamrobotics/test-widgets(arm/manual-mode.svelte). Also adds a warning to support the arm, since some arms release their joints entirely in manual mode. The tutorial'sviam:ufactory:xArm6supports the new API (RSDK-14460). Phase 6 explainsdo_commandon its own, so removing the DoCommand explanation here leaves nothing dangling.add-an-arm.md): adds manual mode to Concepts, notes that manual mode and direct end-effector commands vary by model (check withGetProperties), and adds a test step for the ManualMode row.move-an-arm/overview.md): notes that arms reportingsupport_cartesian_commands: falsedon't implementMoveToPositionand must be moved through the motion service, and that the Control card locks to Motion service mode for them (RSDK-14472).Not in this PR
arm.Arminterface (RDK v1.7.0+) and the PythonArmclass (SDK v0.82.0+) now require the three new methods. This is deferred to a follow-up.Checks
scripts/frontmatter_rules.pypasses.make build-prodpasses, and the#getpropertieslinks resolve in the built site.🤖 Generated with Claude Code