Constructor
# new FaultClient(nameopt, nullable)
Create an instance of FaultClient's class.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name |
string
|
<optional> <nullable> |
null | The class name. |
Extends
- BaseClient
Methods
# clear_service_fault(service_fault_id, clear_all_service_faultsopt, clear_all_payload_faultsopt, args) → {Promise.<service_fault_pb.ClearServiceFaultResponse>}
Clear a service fault from the robot state.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
service_fault_id |
service_fault_pb.ServiceFaultId
|
ServiceFault to clear. | ||
clear_all_service_faults |
boolean
|
<optional> |
false | Clear all faults associated with the service name. |
clear_all_payload_faults |
boolean
|
<optional> |
false | Clear all faults associated with the payload guid. |
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The service fault does not exist in active service faults.
ServiceFaultDoesNotExistError
Something went wrong during the fault clear.
FaultResponseError
An instance of bosdyn.api.ClearServiceFaultResponse
Promise.<service_fault_pb.ClearServiceFaultResponse>
# trigger_service_fault(service_fault, args) → {Promise.<service_fault_pb.TriggerServiceFaultResponse>}
Broadcast a new service fault through the robot.
Parameters:
| Name | Type | Description |
|---|---|---|
service_fault |
service_fault_pb.ServiceFault
|
Populated fault message to broadcast. |
args |
Object
|
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The service fault already exists.
ServiceFaultAlreadyExistsError
Something went wrong during the fault trigger.
FaultResponseError
An instance of
bosdyn.api.TriggerServiceFaultResponse
Promise.<service_fault_pb.TriggerServiceFaultResponse>