Document robot client GetPose, UploadDataFromPath, and missing TransformPCD/RestartModule methods#5185
Open
btshrewsbury-viam wants to merge 3 commits into
Open
Document robot client GetPose, UploadDataFromPath, and missing TransformPCD/RestartModule methods#5185btshrewsbury-viam wants to merge 3 commits into
btshrewsbury-viam wants to merge 3 commits into
Conversation
…on), RestartModule (Flutter) Four robot API methods existed in released SDKs but were missing from the API reference, flagged by the SDK method coverage job: - GetPose (TypeScript): the RobotService GetPose RPC, returning a component's pose in the frame system relative to a destination frame. - UploadDataFromPath (Python): upload a file or folder from the machine to the Viam cloud. - TransformPCD: the Python method (transform_pcd) for the existing documented proto row. - RestartModule: the Flutter method (restartModule) for the existing documented proto row. Adds CSV rows/columns, proto description overrides for the two new protos, and regenerates the robot API markdown. Refs #5142.
✅ 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
Two CI fixes for the robot API regeneration: - The docs restructure moved the API reference from /dev/reference/apis to /reference/apis, but the generator still hardcoded the old prefix, so the regenerated table links pointed at alias stubs and htmltest failed. Update the prefixes (same fix as #5184) and regenerate. - The scraped transform_pcd parameter descriptions from the Python SDK contain 'i.e.', which the vale style rules reject. Add parameter description override files with equivalent wording.
Collaborator
Author
|
Merge order: independent — can merge any time, before or after #5184 (it is based on main and touches only the robot API files). It duplicates #5184's /dev/reference→/reference generator fix in identical hunks, so whichever merges second resolves cleanly. Issue linkage: refs #5142 but does not close it (see #5184's comment for the full picture; remaining warnings tracked in #5188/#5189/#5190). Generated by Claude Code |
btshrewsbury-viam
requested review from
Devin T. Currie (DTCurrie),
Nick Hehr (HipsterBrown) and
Shannon Bradshaw (shannonbradshaw)
Collaborator
Author
|
Nick Hehr (@HipsterBrown) Devin T. Currie (@DTCurrie) would you mind reviewing please? Claude thinks you two might have introduced getPose and transform_pcd. (Clint would have been on the hook for the others, but is on leave) |
Nick Hehr (HipsterBrown)
requested changes
Jul 14, 2026
Nick Hehr (HipsterBrown)
approved these changes
Jul 14, 2026
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
3 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.
What this adds
Four machine/robot API methods that exist in released SDKs but were missing from the Machine Management API reference, flagged by the weekly SDK method coverage job (#5142):
getPose) — new proto row. Wraps theRobotService.GetPoseRPC: returns a component's pose in the machine's frame system relative to a destination frame, with optional supplemental transforms.upload_data_from_path) — new proto row. Uploads a file or folder from the machine to the Viam cloud.transform_pcd) on the already-documented proto row.restartModule) on the already-documented proto row.How
CSV rows/columns in
sdk_protos_map.csv, proto description override files for the two new protos, and regenerated robot API markdown viaupdate_sdk_methods.py(the regeneration also picks up the/reference/→/dev/reference/link drift in the table).Verification
Full local coverage run on this branch: all four warnings cleared, no missing-override warnings, sections render with the scraped signatures.
Part of a series addressing the #5142 warning backlog (see also #5184).
Refs #5142