Autowalk

For clients to the Autowalk service.

exception bosdyn.client.autowalk.AutowalkResponseError(response, error_message=None)[source]

Bases: ResponseError

General class of errors for autowalk service.

exception bosdyn.client.autowalk.CompilationError(response, error_message=None)[source]

Bases: AutowalkResponseError

Provided Walk could not be compiled because the Walk was malformed.

exception bosdyn.client.autowalk.ValidationError(response, error_message=None)[source]

Bases: AutowalkResponseError

Provided Walk could not be validated because some part of the Walk was unable to initialize.

class bosdyn.client.autowalk.AutowalkClient[source]

Bases: BaseClient

Client for the Autowalk service.

default_service_name = 'autowalk-service'
service_type = 'bosdyn.api.autowalk.AutowalkService'
update_from(other)[source]

Update instance from another object.

Parameters:

other – The object where to copy from.

compile_autowalk(walk, data_chunk_byte_size=1000000, **kwargs)[source]

Send the input walk file to the autowalk service for compilation.

Parameters:

  • walk – a walks_pb2.Walk input to be compiled by the autowalk service

  • data_chunk_byte_size – max size of each streamed message

Raises:
load_autowalk(walk, leases=[], data_chunk_byte_size=1000000, **kwargs)[source]

Send the input walk file to the autowalk service for compilation and load resulting mission to the Mission Service on the robot.

Parameters:

  • walk – a walks_pb2.Walk input to be loaded onto the robot by the autowalk service

  • leases – Leases the autowalk service will need to use. Unlike other clients, these MUST be specified.

  • data_chunk_byte_size – max size of each streamed message

Raises: