Skip to content

Document robot client GetPose, UploadDataFromPath, and missing TransformPCD/RestartModule methods #5185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
btshrewsbury-viam wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document robot client GetPose, UploadDataFromPath, and missing TransformPCD/RestartModule methods #5185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c96eba2
Document robot client GetPose, UploadDataFromPath, TransformPCD (Pyth…
btshrewsbury-viam Jul 13, 2026
635590d
Fix generated anchor links and vale errors in robot regeneration
btshrewsbury-viam Jul 13, 2026
6a95929
Apply suggestion from @btshrewsbury-viam
btshrewsbury-viam Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/sdk_protos_map.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,15 +513,17 @@ robot,CancelOperation,,cancel_operation,,,cancelOperation
robot,BlockForOperation,,block_for_operation,,,blockForOperation
robot,FrameSystemConfig,,get_frame_system_config,,,frameSystemConfig
robot,TransformPose,,transform_pose,,,transformPose
robot,TransformPCD,,,,,transformPCD
robot,GetPose,,,,,getPose
robot,TransformPCD,,transform_pcd,,,transformPCD
robot,StreamStatus,,,,,
# DEPRECATED robot,DiscoverComponents,,discover_components,DiscoverComponents,,discoverComponents
robot,GetModelsFromModules,,get_models_from_modules,GetModelsFromModules,getModelsFromModules,getModelsFromModules
robot,StopAll,,stop_all,StopAll,,stopAll
robot,RestartModule,,restart_module,RestartModule,,restartModule
robot,RestartModule,,restart_module,RestartModule,restartModule,restartModule
robot,StartSession,,,,,
robot,SendSessionHeartbeat,,,,,
robot,Log,,log,,,
robot,UploadDataFromPath,,upload_data_from_path,,,
robot,GetCloudMetadata,,get_cloud_metadata,CloudMetadata,getCloudMetadata,getCloudMetadata
robot,GetVersion,,get_version,Version,,getVersion
## HACK: Robot (python) provides additional helper function, adding 4 pseudo-entries:
Expand Down
30 changes: 15 additions & 15 deletions .github/workflows/update_sdk_methods.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@
"organization settings page": "/manage/reference/organize/",
"image tags": "/data-ai/train/create-dataset/#label-your-images",
"API key": "/fleet/cli/#authenticate",
"board model": "/dev/reference/apis/components/board/"
"board model": "/reference/apis/components/board/"
}

## Map sdk language to specific code fence formatting syntax for that language:
Expand Down Expand Up @@ -459,7 +459,7 @@ def get_proto_apis():

## Link matching text, used in write_markdown():
## NOTE: Currently does not support formatting for link titles
## (EXAMPLE: bolded DATA tab here: https://docs.viam.com/dev/reference/apis/data-client/#binarydatabyfilter)
## (EXAMPLE: bolded DATA tab here: https://docs.viam.com/reference/apis/data-client/#binarydatabyfilter)
def link_description(format_type, full_description, link_text, link_url):

## Supports 'md' link styling or 'html' link styling.
Expand Down Expand Up @@ -930,31 +930,31 @@ def write_markdown(type, names, methods):
if type == 'component':
## Replace underscores, and convert generic_component to just generic:
resource_adjusted = resource.replace('generic_component', 'generic').replace('_','-')
proto_anchor_link = '/dev/reference/apis/components/' + resource_adjusted + '/#' + proto_link
proto_anchor_link = '/reference/apis/components/' + resource_adjusted + '/#' + proto_link
elif type == 'service' and resource in ['base_remote_control', 'motion', 'slam', 'vision']:
proto_anchor_link = '/dev/reference/apis/services/' + resource.replace('base_remote_control', 'base-rc') + '/#' + proto_link
proto_anchor_link = '/reference/apis/services/' + resource.replace('base_remote_control', 'base-rc') + '/#' + proto_link
elif type == 'service' and resource == 'data_manager':
proto_anchor_link = '/dev/reference/apis/services/data/#' + proto_link
proto_anchor_link = '/reference/apis/services/data/#' + proto_link
elif type == 'service' and resource == 'discovery':
proto_anchor_link = '/dev/reference/apis/services/discovery/#' + proto_link
proto_anchor_link = '/reference/apis/services/discovery/#' + proto_link
elif type == 'service' and resource == 'generic_service':
proto_anchor_link = '/dev/reference/apis/services/generic/#' + proto_link
proto_anchor_link = '/reference/apis/services/generic/#' + proto_link
elif type == 'service' and resource == 'audio_in':
proto_anchor_link = '/dev/reference/apis/services/audio-in/#' + proto_link
proto_anchor_link = '/reference/apis/services/audio-in/#' + proto_link
elif type == 'service' and resource == 'audio_out':
proto_anchor_link = '/dev/reference/apis/services/audio-out/#' + proto_link
proto_anchor_link = '/reference/apis/services/audio-out/#' + proto_link
elif type == 'service' and resource == 'mlmodel':
proto_anchor_link = '/dev/reference/apis/services/ml/#' + proto_link
proto_anchor_link = '/reference/apis/services/ml/#' + proto_link
elif type == 'service' and resource == 'world_state_store':
proto_anchor_link = '/dev/reference/apis/services/world-state-store/#' + proto_link
proto_anchor_link = '/reference/apis/services/world-state-store/#' + proto_link
elif type == 'app' and resource == 'app':
proto_anchor_link = '/dev/reference/apis/fleet/#' + proto_link
proto_anchor_link = '/reference/apis/fleet/#' + proto_link
elif type == 'app' and resource in ["billing", "mltraining"]:
proto_anchor_link = '/dev/reference/apis/' + resource.replace('mltraining','ml-training') + '-client/#' + proto_link
proto_anchor_link = '/reference/apis/' + resource.replace('mltraining','ml-training') + '-client/#' + proto_link
elif type == 'app' and resource in ["data", "dataset", "data_sync"]:
proto_anchor_link = '/dev/reference/apis/data-client/#' + proto_link
proto_anchor_link = '/reference/apis/data-client/#' + proto_link
elif type == 'robot':
proto_anchor_link = '/dev/reference/apis/' + resource + '/#' + proto_link
proto_anchor_link = '/reference/apis/' + resource + '/#' + proto_link

## Fetch just the first sentence from the proto_override_file (first text string terminated by '.\n'), ignoring hugo
## shortcodes like alerts ('{{%.*%}}.*{{% \[a-b].* %}}'), which precede some override files' (proto descriptions')
Expand Down
2 changes: 2 additions & 0 deletions static/include/robot/apis/generated/robot-table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@
| [`BlockForOperation`](/reference/apis/robot/#blockforoperation) | Blocks on the specified operation on the machine. |
| [`FrameSystemConfig`](/reference/apis/robot/#framesystemconfig) | Get the configuration of the frame system of a given machine. |
| [`TransformPose`](/reference/apis/robot/#transformpose) | Transform a given source Pose from the original reference frame to a new destination reference frame. |
| [`GetPose`](/reference/apis/robot/#getpose) | Get the pose of a component in the frame system of the machine, relative to a specified destination frame. |
| [`TransformPCD`](/reference/apis/robot/#transformpcd) | Transforms the pointcloud to the desired frame in the robot's frame system. |
| [`GetModelsFromModules`](/reference/apis/robot/#getmodelsfrommodules) | Get a list of all models provided by local and registry modules on the machine. |
| [`StopAll`](/reference/apis/robot/#stopall) | Cancel all current and outstanding operations for the machine and stop all actuators and movement. |
| [`RestartModule`](/reference/apis/robot/#restartmodule) | Reload a module as if its config changed. |
| [`Log`](/reference/apis/robot/#log) | Create a LogEntry object from the log to send to the RDK over gRPC. |
| [`UploadDataFromPath`](/reference/apis/robot/#uploaddatafrompath) | Upload data from a file or folder path on the machine to the Viam cloud. |
| [`GetCloudMetadata`](/reference/apis/robot/#getcloudmetadata) | Get app-related information about the robot. |
| [`GetVersion`](/reference/apis/robot/#getversion) | Return version information about the machine. |
| [`Options.with_api_key`](/reference/apis/robot/#optionswith_api_key) | Create a `RobotClient.Options` using an API key as credentials. |
Expand Down
Loading
Loading