Log Status

Client for the log-status service.

This allows client code to start, extend or terminate experiment logs and start retro logs.

exception bosdyn.client.log_status.LogStatusResponseError(response, error_message=None)

Bases: ResponseError

Error in Log Status RPC

exception bosdyn.client.log_status.ExperimentAlreadyRunningError(response, error_message=None)

Bases: LogStatusResponseError

The log status request could not be started, an experiment is already running.

exception bosdyn.client.log_status.RequestIdDoesNotExistError(response, error_message=None)

Bases: LogStatusResponseError

The provided request id does not exist or is invalid.

exception bosdyn.client.log_status.InactiveLogError(response, error_message=None)

Bases: LogStatusResponseError

The log has already terminated and cannot be updated.

exception bosdyn.client.log_status.ConcurrencyLimitReachedError(response, error_message=None)

Bases: LogStatusResponseError

The limit of concurrent retro logs has be reached, a new log cannot be started.

class bosdyn.client.log_status.LogStatusClient

Bases: BaseClient

A client for interacting with robot logs.

default_service_name = 'log-status'

service_type = 'bosdyn.api.log_status.LogStatusService'

get_log_status(id, **kwargs)

Synchronously get status of a log.

Parameters:

id (string) – Id of log to retrieve

Raises:

RequestIdDoesNotExistError – Id was not found on robot

get_log_status_async(id, **kwargs)

Asynchronously get status of a log.

get_active_log_statuses(**kwargs)

Synchronously retrieve status of active logs.

get_active_log_statuses_async(**kwargs)

Asynchronously retrieve status of active logs.

start_experiment_log(seconds, **kwargs)

Start an experiment log, to run for a specified duration.

Parameters:

seconds – Number of seconds to gather data for the experiment log

Raises:

ExperimentAlreadyRunningError – Only 1 experiment log can be run at a time

start_experiment_log_async(seconds, **kwargs)

Start an experiment log, to run for a specified duration.

start_retro_log(seconds, **kwargs)

Start a retro log, to run for a specified duration.

Parameters:

seconds – Number of seconds to gather data for the retro log

Raises:

• ExperimentAlreadyRunningError – Retro logs cannot be run while an experiment log is running

• ConcurrencyLimitReachedError – Maximum number of retro logs are already running, another cannot be started

start_retro_log_async(seconds, **kwargs)

Start a retro log, to run for a specified duration.

update_experiment(id, seconds, **kwargs)

Update an experiment log to run for a specified duration.

Parameters:

• id (string) – Id of log to retrieve

• seconds (float) – Number of seconds to gather data for the experiment log

Raises:

• RequestIdDoesNotExistError – Id was not found on robot

• InactiveLogError – Cannot update log, it is already terminated

update_experiment_async(id, seconds, **kwargs)

Update an experiment log to run for a specified duration.

terminate_log(id, **kwargs)

Terminate an experiment log.

Parameters:

id (string) – Id of log to terminate

Raises:

RequestIdDoesNotExistError – Id was not found on robot

terminate_log_async(id, **kwargs)

Terminate an experiment log.

bosdyn.client.log_status.get_log_status_error(response)

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

bosdyn.client.log_status.get_active_log_statuses_error(response)

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

bosdyn.client.log_status.start_experiment_log_error(response)

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

bosdyn.client.log_status.start_retro_log_error(response)

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

bosdyn.client.log_status.update_experiment_log_error(response)

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

bosdyn.client.log_status.terminate_log_error(response)

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