Auto Return

Client implementation of the AutoReturn service.

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

Bases: bosdyn.client.exceptions.ResponseError

Error in Auto Return RPC

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

Bases: bosdyn.client.auto_return.AutoReturnResponseError

One or more parameters were invalid.

class bosdyn.client.auto_return.AutoReturnClient

Bases: bosdyn.client.common.BaseClient

A client for configuring automatic AutoReturn behavior.

default_service_name = 'auto-return'

service_type = 'bosdyn.api.auto_return.AutoReturnService'

configure(params, leases, **kwargs)

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) –

Raises

• AutoReturnResponseError – An invalid request was received by the service.

• RpcError – Problem communicating with the service.

Returns

The bosdyn.api.auto_return_pb2.ConfigureResponse.

configure_async(params, leases, **kwargs)

Async version of the configure() RPC.

get_configuration(**kwargs)

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)

Async version of the get_configuration() RPC.

start(**kwargs)

Start AutoReturn now. :raises RpcError: Problem communicating with the service.

Returns

The bosdyn.api.auto_return_pb2.GetConfigurationResponse.

start_async(**kwargs)

Async version of the start() RPC.

bosdyn.client.auto_return.configure_error(response)

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