Auto Return¶
Client implementation of the AutoReturn service.
-
exception
bosdyn.client.auto_return.
AutoReturnResponseError
(response, error_message=None)[source]¶ Bases:
bosdyn.client.exceptions.ResponseError
Error in Auto Return RPC
-
exception
bosdyn.client.auto_return.
InvalidParameterError
(response, error_message=None)[source]¶ Bases:
bosdyn.client.auto_return.AutoReturnResponseError
One or more parameters were invalid.
-
class
bosdyn.client.auto_return.
AutoReturnClient
[source]¶ 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)[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) –
- Raises
AutoReturnResponseError – An invalid request was received by the service.
RpcError – Problem communicating with the service.
- Returns
The bosdyn.api.auto_return_pb2.ConfigureResponse.
-
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.
-