Constructor
# new LocalGridClient(nameopt)
Create an instance of LocalGridClient's class.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name |
string
|
<optional> |
null | Name of the Class. |
Extends
- BaseClient
Methods
# get_local_grid_types(args) → {Promise.<Array.<local_grid_pb.LocalGridType>>}
Get a list of the local_grid types available from the robot.
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
A list of the different types of local grids.
Promise.<Array.<local_grid_pb.LocalGridType>>
# get_local_grids(local_grid_type_names, args) → {Promise.<Array.<local_grid_pb.LocalGridResponse>>}
Get a selection of local_grids of specified types.
Parameters:
| Name | Type | Description |
|---|---|---|
local_grid_type_names |
Array.<string>
|
List of strings specifying types local_grids to request. Available local_grid types may be requested using get_local_grid_types(). |
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
A list of LocalGridResponseProtos,
each containing a local_grid or an error status code.
Promise.<Array.<local_grid_pb.LocalGridResponse>>