Repository navigation
Update frame system and robot API docs for Python RobotClient.get_pose - #5395
Merged
Eliza Farley (elizafarley) merged 4 commits intoOct 12, 2026
Merged
Conversation
viam-python-sdk#1270 (RSDK-14587) added RobotClient.get_pose, released in v0.83.0 and now on python.viam.dev. Fill the Python column of the robot GetPose row, regenerate the robot API reference, and correct the frame system API page, which said the Python RobotClient does not expose GetPose. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01J5WsNbGP1yKuqz7GyobaFN
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
The motion API reference still said Python callers use the motion service GetPose, and the agent guide's get_pose example called the deprecated motion service method. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Link both GetPose methods from the motion API note, name the machine-client method per SDK, and note that Flutter has no machine-client version. Add the same deprecation pointer to the generated motion API reference through its proto override. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Eliza Farley (elizafarley)
approved these changes
Oct 12, 2026
Eliza Farley (elizafarley)
deleted the
claude/update-robot-get-pose-python
branch
October 12, 2026 15:47
|
🔎💬 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
4 participants
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.
Source changes
RobotClient.get_pose(component_name, destination_frame="", supplemental_transforms=None), the robot serviceGetPose. Released in Python SDK v0.83.0 (git tag --contains 514477fb), and now on python.viam.dev.RobotClient::get_pose, documented on cpp.viam.dev. The docs-agent backlog held this item until Python had the method too.Documents: no DOCS ticket found for RSDK-14587 or RSDK-13760.
Docs changes
.github/workflows/sdk_protos_map.csv: fill the Python column of therobot,GetPoserow (get_pose).static/include/robot/apis/generated/robot.md: regenerated withupdate_sdk_methods.py "" robot. Adds the Python tab forGetPose; no other method changed.static/include/services/apis/overrides/protos/motion.GetPose.mdand the regeneratedstatic/include/services/apis/generated/motion.md: the motion serviceGetPosenow says it's deprecated in favor of the machine client'sGetPose(Python v0.83.0+, Go, TypeScript), and that Flutter, which has no machine-client version, still uses the motion service method.docs/motion-planning/reference/frame-system-api.md: theGetPosesection said "The PythonRobotClientdoes not exposeGetPose" and sent Python users to the deprecated motion serviceget_pose. The Python tab now callsmachine.get_pose(v0.83.0 and later), the "Python goes through the motion service" subsection now describes both paths and when to use the motion service one, the kwarg note namesRobotClient.get_pose, and the worked example callsmachine.get_pose.docs/motion-planning/reference/api.md: theGetPose (deprecated)entry no longer says Python callers use the motion service; it names the machine-client method per SDK and the Flutter exception.docs/build-apps/use-viam-from-an-agent.md: theget_poseexample usesmachine.get_pose, and theResourceNamecompatibility note is scoped to the motion service'sget_pose(the newRobotClient.get_posehas always taken a string).How I found these
service-api-xref.md(RobotServiceGetPose) and the docs-agent backlog itemviam-cpp-sdk-ded6cb8-robot-get-pose.frame-system-api.md,api.md,use-viam-from-an-agent.md) fromget_pose,GetPose()and "does not expose".Checks: prettier, markdownlint, vale,
make build-prodall pass.Generated by daily docs change agent
🤖 Generated with Claude Code
https://claude.ai/code/session_01J5WsNbGP1yKuqz7GyobaFN