Skip to content

Enhance docstring for get_robot_part method #1023

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

Merged
merged 1 commit into from
Oct 24, 2025
Merged

Enhance docstring for get_robot_part method #1023

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion src/viam/app/app_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1275,13 +1275,15 @@ async def get_robot_parts(self, robot_id: str) -> List[RobotPart]:
return [RobotPart.from_proto(robot_part=part) for part in response.parts]

async def get_robot_part(self, robot_part_id: str, dest: Optional[str] = None, indent: int = 4) -> RobotPart:
"""Get a machine part.
"""Get a machine part including its part config, part address, and other information.

::

my_robot_part = await cloud.get_robot_part(
robot_part_id="abc12345-1a23-1234-ab12-a22a22a2aa22"
)
# Get the part's config
machine_part_config = my_robot_part.robot_config
# Get the part's address
address = my_robot_part.fqdn
# Check if machine is live (last access time less than 10 sec ago)
Expand Down
Loading