Get Fault List VI

NI Scan Engine VIs

Get Fault List VI

Owning Palette: Faults VIs

Installed With: RT Module

Returns a list of active faults.

Details  Example

 Place on the block diagram  Find on the Functions palette
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
fault list contains the list of active faults.
code is the fault code.
level is the severity level of the fault.
first reported time returns the time the fault first occurred since it was last cleared.
number reported is the number of times the fault has occurred since it was last cleared.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Get Fault List Details

This VI allocates memory and can affect the determinism of the application. This VI must run on a target with the NI Scan Engine installed.

To obtain the fault list of a remote target from a host computer, you can use the DataSocket Read VI to subscribe to the following URL:

psp:\\<target IP address>\NI_SystemState\ControllerStatus\FaultList

The data type returned by the URL above is identical to that of the fault list output terminal of this VI.

You also can determine whether a fault is present on a remote target from a host computer by using the DataSocket Read VI to subscribe to the following URL:

psp:\\<target IP address>\NI_SystemState\ControllerStatus\FaultPresent

The data type returned by the URL above is Boolean.

Example

Refer to the Scan Engine.lvproj in the labview\examples\scanengine directory for an example of using the Get Fault List VI.

 Open example  Browse related examples