Auto Return

Client implementation of the AutoReturn service.

exception bosdyn.client.auto_return.AutoReturnResponseError(response, error_message=None)[source]

Bases: ResponseError

Error in Auto Return RPC

exception bosdyn.client.auto_return.InvalidParameterError(response, error_message=None)[source]

Bases: AutoReturnResponseError

One or more parameters were invalid.

class bosdyn.client.auto_return.AutoReturnClient[source]

Bases: BaseClient

A client for configuring automatic AutoReturn behavior.

default_service_name = 'auto-return'
service_type = 'bosdyn.api.auto_return.AutoReturnService'
configure(params, leases, clear_buffer=False, **kwargs)[source]

Set the configuration of the AutoReturn system.

Parameters:

  • params (bosdyn.api.auto_return.auto_return_pb2.Params) – Parameters to use.

  • leases (list of bosdyn.client.Lease) –

  • clear_buffer (bool) – Set True to forget any currently buffered locations.

Raises:
Returns:

The bosdyn.api.auto_return_pb2.ConfigureResponse.

configure_async(params, leases, clear_buffer=False, **kwargs)[source]

Async version of the configure() RPC.

get_configuration(**kwargs)[source]

Get the configuration of the AutoReturn system.

Raises:

RpcError – Problem communicating with the service.

Returns:

The bosdyn.api.auto_return_pb2.GetConfigurationResponse.

get_configuration_async(**kwargs)[source]

Async version of the get_configuration() RPC.

start(params=None, leases=[], **kwargs)[source]

Start AutoReturn now. :raises InvalidParameterError: An invalid request was received by the service. :raises RpcError: Problem communicating with the service.

Returns:

The bosdyn.api.auto_return_pb2.StartResponse.

start_async(params=None, leases=[], **kwargs)[source]

Async version of the start() RPC.

bosdyn.client.auto_return.configure_error(response)[source]

Return a custom exception based on the Configure response, None if no error.

bosdyn.client.auto_return.start_error(response)[source]

Return a custom exception based on the Start response, None if no error.