Skip to content

Commit ea155e8

Browse files
author
William Spies
authored
DATA-354 Update docstring for motion service (#144)
* DATA-354 Update docstring for motion service * DATA-354 Incorporates feedback from njooma
1 parent f53bc0f commit ea155e8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/viam/services/motion.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ async def move(
3838
) -> bool:
3939
"""Plan and execute a movement to move the component specified to its goal destination.
4040
41+
Note: Frames designated with respect to components can also be used as the `component_name` when calling for a move. This
42+
technique allows for planning and moving the frame itself to the `destination`. To do so, simply override the `name` attribute
43+
for a given resource with the originating ReferenceFrame. Then pass in the updated resource into the `component_name`. Ex:
44+
resource = Arm.get_resource_name("arm")
45+
resource.name = "externalFrame"
46+
success = await MotionServiceClient.move(resource, ...)
4147
4248
Args:
4349
component_name (ResourceName): Name of a component on a given robot.

0 commit comments

Comments
 (0)