Extends
- BaseClient
Methods
# async get_hardware_config_with_link_info() → {robot_state_pb.HardwareConfiguration}
Convenience function which first requests a robots hardware configuration followed by
requests to get link models for all robot links.
robot_state_pb.HardwareConfiguration with
all link models filled out.
robot_state_pb.HardwareConfiguration
# get_robot_hardware_configuration(args) → {Promise.<robot_state_pb.RobotHardwareConfigurationResponse>}
Obtain current hardware configuration of robot.
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The hardware configuration,
which includes the link names.
Promise.<robot_state_pb.RobotHardwareConfigurationResponse>
# get_robot_link_model(link_name, args) → {Promise.<robot_state_pb.Skeleton.Link.ObjModel>}
Obtain link model OBJ for a specific link.
Parameters:
| Name | Type | Description |
|---|---|---|
link_name |
string
|
Name of the link to get the model. |
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The bosdyn.api.Skeleton.Link.ObjModel for
the specified link.
Promise.<robot_state_pb.Skeleton.Link.ObjModel>
# get_robot_metrics(args) → {Promise.<robot_state_pb.RobotMetricsResponse>}
Obtain robot metrics, such as distance traveled or time powered on.
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
All of the current robot metrics.
Promise.<robot_state_pb.RobotMetricsResponse>
# get_robot_state(args) → {Promise.<robot_state_pb.RobotStateResponse>}
Obtain current state of the robot.
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The current robot state.
Promise.<robot_state_pb.RobotStateResponse>