Extends
- BaseClient
Members
TimeSyncEndpoint
# readonly timesync_endpoint
Accessor for timesync-endpoint that was grabbed via 'update_from()'.
Methods
# clear_behavior_fault(behavior_fault_id, leaseopt, args) → {Promise.<boolean>}
Clear a behavior fault on the robot.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
behavior_fault_id |
string
|
ID of the behavior fault. | ||
lease |
Lease
|
<optional> |
null | Lease information to use in the message. |
args |
Object
|
Options to provide for gRPC request. |
Boolean whether response status is STATUS_CLEARED.
Promise.<boolean>
# robot_command(command, end_time_secsopt, timesync_endpointopt, leaseopt, args) → {Promise.<string>}
Issue a command to the robot asynchronously.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
command |
RobotCommandBuilder
|
Command to issue. | ||
end_time_secs |
number
|
<optional> |
null | End time for the command in seconds. |
timesync_endpoint |
TimeSyncEndpoint
|
<optional> |
null | Timesync endpoint. |
lease |
Lease
|
<optional> |
null | Lease object to use for the command. |
args |
Object
|
Options to provide for gRPC request. |
Problem communicating with the robot.
RpcError
Invalid request received by the robot.
InvalidRequestError
The API supports this request, but the system does not support this request.
UnsupportedError
Client has not done timesync with robot.
NoTimeSyncError
The command was received after its max_duration had already passed.
ExpiredError
The command end time was too far in the future.
TooDistantError
The robot must be powered on to accept a command.
NotPoweredOnError
The robot is faulted and the fault must be cleared first.
BehaviorFaultError
The command cannot be executed while the robot is docked.
DockedError
Robot does not know how to handle supplied frame.
UnknownFrameError
Return the id of the command's callback.
Promise.<string>
# robot_command_feedback(robot_command_id, args) → {Promise.<robot_command_pb.RobotCommandFeedbackResponse>}
Get feedback from a previously issued command.
Parameters:
| Name | Type | Description |
|---|---|---|
robot_command_id |
string
|
ID of the robot command to get feedback on. |
args |
Object
|
Options to provide for gRPC request. |
Problem communicating with the robot.
RpcError
Promise.<robot_command_pb.RobotCommandFeedbackResponse>
# async update_from(other) → {void}
Update instance from another object.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
Object
|
The object where to copy from. |
void