Fault

For clients to use the fault service.

exception bosdyn.client.fault.FaultResponseError(response, error_message=None)[source]

Bases: bosdyn.client.exceptions.ResponseError

General class of errors for directory registration responses.

exception bosdyn.client.fault.ServiceFaultAlreadyExistsError(response, error_message=None)[source]

Bases: bosdyn.client.fault.FaultResponseError

The specified service fault id already exists as an active fault on the robot.

exception bosdyn.client.fault.ServiceFaultDoesNotExistError(response, error_message=None)[source]

Bases: bosdyn.client.fault.FaultResponseError

The specified service fault id does not match any active service faults on the robot.

class bosdyn.client.fault.FaultClient[source]

Bases: bosdyn.client.common.BaseClient

Client for the Fault service.

default_service_name = 'fault'
service_type = 'bosdyn.api.FaultService'
trigger_service_fault(service_fault, **kwargs)[source]

Broadcast a new service fault through the robot.

Parameters

service_fault (bosdyn.api.ServiceFault) – Populated fault message to broadcast.

Returns

An instance of bosdyn.api.TriggerServiceFaultResponse

Raises
trigger_service_fault_async(service_fault, **kwargs)[source]

Async version of trigger_service_fault()

clear_service_fault(service_fault_id, clear_all_service_faults=False, clear_all_payload_faults=False, **kwargs)[source]

Clear a service fault from the robot state.

Parameters
  • service_fault_id (bosdyn.api.ServiceFaultId) – ServiceFault to clear.

  • clear_all_service_faults (bool) – Clear all faults associated with the service name.

  • clear_all_payload_faults (bool) – Clear all faults associated with the payload guid.

Returns

An instance of bosdyn.api.ClearServiceFaultResponse

Raises
clear_service_fault_async(service_fault_id, clear_all_service_faults=False, clear_all_payload_faults=False, **kwargs)[source]

Async version of clear_service_fault()