Documentation Github spot-sdk-js Github spot-server-js

Class

ManipulationApiClient

ManipulationApiClient()

Constructor

# new ManipulationApiClient()

Client for the ManipulationAPI service.

View Source bosdyn-client/manipulation_api_client.js, line 7

Extends

  • BaseClient

Methods

# manipulation_api_command(manipulation_api_request, args) → {Promise.<manipulation_api_pb.ManipulationApiResponse>}

Issue a manipulation api command to the robot.
Parameters:
Name Type Description
manipulation_api_request manipulation_api_pb.ManipulationApiRequest The command request for a manipulation task.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/manipulation_api_client.js, line 42

The full ManipulationApiResponse message, which includes a command id for feedback.
Promise.<manipulation_api_pb.ManipulationApiResponse>

# manipulation_api_feedback_command(manipulation_api_feedback_request, args) → {Promise.<manipulation_api_pb.ManipulationApiFeedbackResponse>}

Issue a manipulation api feedback request to the robot.
Parameters:
Name Type Description
manipulation_api_feedback_request manipulation_api_pb.ManipulationApiFeedbackRequest The request for feedback for a specific manipulation command.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/manipulation_api_client.js, line 54

The full ManipulationApiFeedbackResponse message.
Promise.<manipulation_api_pb.ManipulationApiFeedbackResponse>

# update_from(other) → {void}

Update instance from another object.
Parameters:
Name Type Description
other Object The object where to copy from.

View Source bosdyn-client/manipulation_api_client.js, line 29

void

ManipulationApiClient(nameopt)

Constructor

# new ManipulationApiClient(nameopt)

Create an instance of ManipulationApiClient's class.
Parameters:
Name Type Attributes Default Description
name string <optional>
 null Name of the Class.

View Source bosdyn-client/manipulation_api_client.js, line 20

Methods

# manipulation_api_command(manipulation_api_request, args) → {Promise.<manipulation_api_pb.ManipulationApiResponse>}

Issue a manipulation api command to the robot.
Parameters:
Name Type Description
manipulation_api_request manipulation_api_pb.ManipulationApiRequest The command request for a manipulation task.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/manipulation_api_client.js, line 42

The full ManipulationApiResponse message, which includes a command id for feedback.
Promise.<manipulation_api_pb.ManipulationApiResponse>

# manipulation_api_feedback_command(manipulation_api_feedback_request, args) → {Promise.<manipulation_api_pb.ManipulationApiFeedbackResponse>}

Issue a manipulation api feedback request to the robot.
Parameters:
Name Type Description
manipulation_api_feedback_request manipulation_api_pb.ManipulationApiFeedbackRequest The request for feedback for a specific manipulation command.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/manipulation_api_client.js, line 54

The full ManipulationApiFeedbackResponse message.
Promise.<manipulation_api_pb.ManipulationApiFeedbackResponse>

# update_from(other) → {void}

Update instance from another object.
Parameters:
Name Type Description
other Object The object where to copy from.

View Source bosdyn-client/manipulation_api_client.js, line 29

void