Skip to content

Commit edf35cf

Browse files
authored
DOCS-1869: Add robot client examples (#548)
1 parent 4988daf commit edf35cf

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/viam/robot/client.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ async def connect():
8484
# Replace "<API-KEY-ID>" (including brackets) with your machine's API key ID
8585
api_key_id='<API-KEY-ID>'
8686
)
87-
return await RobotClient.at_address('ADDRESS FROM THE VIAM APP', opts)
87+
return await RobotClient.at_address('<ADDRESS-FROM-THE-VIAM-APP>', opts)
8888
8989
9090
async def main():
@@ -145,7 +145,7 @@ def with_api_key(cls, api_key: str, api_key_id: str, **kwargs) -> Self:
145145
146146
opts = RobotClient.Options.with_api_key(api_key, api_key_id)
147147
148-
robot = await RobotClient.at_address('ADDRESS FROM THE VIAM APP', opts)
148+
robot = await RobotClient.at_address('<ADDRESS-FROM-THE-VIAM-APP>', opts)
149149
150150
Args:
151151
api_key (str): your API key
@@ -169,6 +169,7 @@ async def at_address(cls, address: str, options: Options) -> Self:
169169
::
170170
171171
async def connect():
172+
172173
opts = RobotClient.Options.with_api_key(
173174
# Replace "<API-KEY>" (including brackets) with your machine's API key
174175
api_key='<API-KEY>',
@@ -545,7 +546,6 @@ async def close(self):
545546
546547
::
547548
548-
# Cleanly close the underlying connections and stop any periodic tasks.
549549
await robot.close()
550550
"""
551551
LOGGER.debug("Closing RobotClient")
@@ -738,6 +738,10 @@ async def stop_all(self, extra: Dict[ResourceName, Dict[str, Any]] = {}):
738738
# Cancel all current and outstanding operations for the robot and stop all actuators and movement.
739739
await robot.stop_all()
740740
741+
::
742+
743+
await robot.stop_all()
744+
741745
Args:
742746
extra (Dict[viam.proto.common.ResourceName, Dict[str, Any]]): Any extra parameters to pass to the resources' ``stop`` methods,
743747
keyed on the resource's ``ResourceName``

0 commit comments

Comments
 (0)