Document camera Stream and missing arm/gantry/gripper SDK methods#5186
Document camera Stream and missing arm/gantry/gripper SDK methods#5186btshrewsbury-viam wants to merge 3 commits into
Conversation
…and gripper The SDK method coverage job flagged ten released component methods missing from the API reference. Nine are existing documented protos that gained an SDK implementation without the CSV column being filled: - arm: Flutter getKinematics, getGeometries - gantry: Go Geometries, Flutter getGeometries/getKinematics, TypeScript getKinematics - gripper: Flutter getCurrentInputs/goToInputs, TypeScript isHoldingSomething The tenth is Go's camera Stream method (live video frames), added as a new manually-mapped row following the existing convention for non-proto SDK methods. Regenerates the arm, gantry, gripper, and camera markdown. Refs #5142.
The previous commit accidentally included regeneration drift for app, robot, and base remote control files plus compiled Python bytecode, none of which belong in this PR.
# Conflicts: # static/include/components/apis/generated/camera-table.md
|
Merge order: merge #5184 first. This PR is stacked on the Issue linkage: refs #5142 but does not close it. The one arm method deliberately left undocumented here (Flutter Generated by Claude Code |
|
Hi Allison Chiang (@allisonschiang)! I think you might be the right person for the flutter arm & gantry changes, would you mind reviewing these changes? |
Allison Chiang (allisonschiang)
left a comment
Allison Chiang (allisonschiang)
left a comment
There was a problem hiding this comment.
I only worked on getGeometries and getKinematics for arm and gantry but those seem right to me
2 participants
What this adds
Ten released component methods flagged by the weekly SDK method coverage job (#5142). Nine are documented protos whose newer SDK implementations were missing a column in
sdk_protos_map.csv:getKinematics,getGeometriesGeometries, FluttergetGeometries/getKinematics, TypeScriptgetKinematicsgetCurrentInputs/goToInputs, TypeScriptisHoldingSomethingThe tenth is Go camera
Stream(live video frames), added as a new manually-mapped row following the existing convention for non-proto SDK methods (likeGetKinematics).Base branch note
Stacked on #5184 (GetStatus) because both regenerate the same component markdown files — this PR's diff shows only its own changes. Merge #5184 first; GitHub will retarget this to main automatically.
Verification
Full local coverage run: all ten warnings cleared (49 → 39 relative to the #5184 baseline), no missing-override warnings. Flutter arm
calculateMaxReachis deliberately not documented here — it is a client-side helper, tracked in the follow-up issue.Refs #5142