Package com.viam.service.motion.v1
Interface MotionServiceGrpc.AsyncService
- All Known Implementing Classes:
MotionServiceGrpc.MotionServiceImplBase
- Enclosing class:
- MotionServiceGrpc
public static interface MotionServiceGrpc.AsyncService
A MotionService declares the gRPC contract for a motion service
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
doCommand
(Common.DoCommandRequest request, io.grpc.stub.StreamObserver<Common.DoCommandResponse> responseObserver) DoCommand sends/receives arbitrary commandsdefault void
getPlan
(Motion.GetPlanRequest request, io.grpc.stub.StreamObserver<Motion.GetPlanResponse> responseObserver) Returns the plan(s) & state history of the most recent execution to move a component.default void
getPose
(Motion.GetPoseRequest request, io.grpc.stub.StreamObserver<Motion.GetPoseResponse> responseObserver) default void
listPlanStatuses
(Motion.ListPlanStatusesRequest request, io.grpc.stub.StreamObserver<Motion.ListPlanStatusesResponse> responseObserver) Returns the status of plans created by requests to move components that are executing OR are part of an execution which changed it state within the a 24HR TTL OR until the robot reinitializes.default void
move
(Motion.MoveRequest request, io.grpc.stub.StreamObserver<Motion.MoveResponse> responseObserver) default void
moveOnGlobe
(Motion.MoveOnGlobeRequest request, io.grpc.stub.StreamObserver<Motion.MoveOnGlobeResponse> responseObserver) Generate and begin executing an execution to move a component to a specific GPS coordinate.default void
moveOnMap
(Motion.MoveOnMapRequest request, io.grpc.stub.StreamObserver<Motion.MoveOnMapResponse> responseObserver) Generate a plan and move a component to a specific pose with respect to the SLAM map's origin.default void
stopPlan
(Motion.StopPlanRequest request, io.grpc.stub.StreamObserver<Motion.StopPlanResponse> responseObserver) Stops a Plan
-
Method Details
-
move
default void move(Motion.MoveRequest request, io.grpc.stub.StreamObserver<Motion.MoveResponse> responseObserver) -
moveOnMap
default void moveOnMap(Motion.MoveOnMapRequest request, io.grpc.stub.StreamObserver<Motion.MoveOnMapResponse> responseObserver) Generate a plan and move a component to a specific pose with respect to the SLAM map's origin. May replan to avoid obstacles
-
moveOnGlobe
default void moveOnGlobe(Motion.MoveOnGlobeRequest request, io.grpc.stub.StreamObserver<Motion.MoveOnGlobeResponse> responseObserver) Generate and begin executing an execution to move a component to a specific GPS coordinate. May replan to avoid obstacles & account for location drift. Creates a new plan upon replanning.
-
getPose
default void getPose(Motion.GetPoseRequest request, io.grpc.stub.StreamObserver<Motion.GetPoseResponse> responseObserver) -
stopPlan
default void stopPlan(Motion.StopPlanRequest request, io.grpc.stub.StreamObserver<Motion.StopPlanResponse> responseObserver) Stops a Plan
-
listPlanStatuses
default void listPlanStatuses(Motion.ListPlanStatusesRequest request, io.grpc.stub.StreamObserver<Motion.ListPlanStatusesResponse> responseObserver) Returns the status of plans created by requests to move components that are executing OR are part of an execution which changed it state within the a 24HR TTL OR until the robot reinitializes. This currently only returns plans for MoveOnGlobe and MoveOnMap.
-
getPlan
default void getPlan(Motion.GetPlanRequest request, io.grpc.stub.StreamObserver<Motion.GetPlanResponse> responseObserver) Returns the plan(s) & state history of the most recent execution to move a component. Returns a result if the last execution is still executing OR changed state within the last 24 hours AND the robot has not reinitialized. Plans are never mutated. Replans always create new plans. Replans share the execution_id of the previously executing plan. This currently only returns plans for MoveOnGlobe and MoveOnMap.
-
doCommand
default void doCommand(Common.DoCommandRequest request, io.grpc.stub.StreamObserver<Common.DoCommandResponse> responseObserver) DoCommand sends/receives arbitrary commands
-