Local Grid

Client support for the LocalGridService.

class bosdyn.client.local_grid.LocalGridClient

Bases: bosdyn.client.common.BaseClient

Client to access local grid local_grids from the robot.

default_service_name = 'local-grid-service'

service_type = 'bosdyn.api.LocalGridService'

get_local_grid_types(**kwargs)

Get a list of the local_grid types available from the robot.

Returns

A list of the different types (string names) of local grids.

Raises

RpcError – Problem communicating with the robot.

get_local_grid_types_async(**kwargs)

Async version of get_local_grid_types().

get_local_grids(local_grid_type_names, **kwargs)

Get a selection of local_grids of specified types.

Parameters

local_grid_type_names (list of strings) – List of strings specifying types local_grids to request. Available local_grid types may be requested using get_local_grid_types().

Returns

A list of LocalGridResponseProtos, each containing a local_grid or an error status code.

Raises

RpcError – Problem communicating with the robot.

get_local_grids_async(local_grid_type_names, **kwargs)

Async version of get_local_grids().