Skip to content

Commit

Permalink
DOCS-2947: Add config revision to machine status method (#741)
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Sep 24, 2024
1 parent c21e396 commit 1604538
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/viam/robot/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -907,15 +907,16 @@ async def get_version(self) -> GetVersionResponse:

async def get_machine_status(self) -> GetMachineStatusResponse:
"""
Get status information about the machine.
Get status information about the machine's resources and configuration.
::
machine_status = await machine.get_machine_status()
resource_statuses = machine_status.resources
config_status = machine_status.config
Returns:
viam.proto.robot.GetMachineStatusResponse: current status of the resources (List[ResourceStatus]) of the machine.
viam.proto.robot.GetMachineStatusResponse: current status of the resources (List[ResourceStatus]) and config of the machine.
For more information, see `Machine Management API <https://docs.viam.com/appendix/apis/robot/>`_.
"""
Expand Down

0 comments on commit 1604538

Please sign in to comment.