Class

DoorClient

DoorClient()

Constructor

# new DoorClient()

Client for the door service.

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

Extends

  • BaseClient

Methods

# open_door(request, args) → {Promise.<door_pb.OpenDoorCommandResponse>}

Issue a open door command to the robot.
Parameters:
Name Type Description
request door_pb.OpenDoorCommandRequest The door command.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/door.js, line 43

Problem communicating with the robot.
RpcError
The lease for the request failed.
LeaseUseError
The full OpenDoorCommandResponse message, which includes a command id for feedback.
Promise.<door_pb.OpenDoorCommandResponse>

# open_door_feedback(request, args) → {Promise.<door_pb.OpenDoorFeedbackResponse>}

Get feedback from the robot on a specific door command.
Parameters:
Name Type Description
request door_pb.OpenDoorFeedbackRequest The request for feedback of the door command.
args Object Extra arguments for controlling RPC details.

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

Problem communicating with the robot.
RpcError
The full OpenDoorFeedbackResponse message.
Promise.<door_pb.OpenDoorFeedbackResponse>

# 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/door.js, line 29

void

DoorClient(namenullable)

Constructor

# new DoorClient(namenullable)

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

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

Methods

# open_door(request, args) → {Promise.<door_pb.OpenDoorCommandResponse>}

Issue a open door command to the robot.
Parameters:
Name Type Description
request door_pb.OpenDoorCommandRequest The door command.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/door.js, line 43

Problem communicating with the robot.
RpcError
The lease for the request failed.
LeaseUseError
The full OpenDoorCommandResponse message, which includes a command id for feedback.
Promise.<door_pb.OpenDoorCommandResponse>

# open_door_feedback(request, args) → {Promise.<door_pb.OpenDoorFeedbackResponse>}

Get feedback from the robot on a specific door command.
Parameters:
Name Type Description
request door_pb.OpenDoorFeedbackRequest The request for feedback of the door command.
args Object Extra arguments for controlling RPC details.

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

Problem communicating with the robot.
RpcError
The full OpenDoorFeedbackResponse message.
Promise.<door_pb.OpenDoorFeedbackResponse>

# 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/door.js, line 29

void