AmpFaultTriggerStateGet()

bool AmpFaultTriggerStateGet

(

)

Description:

AmpFaultTriggerStateGet returns the trigger state.

Returns

(int32_t) 1 = triggers on active high signal, 0 = triggers on active low signal.

Part of the Limits and Action Configuration method group.

Sample Code:

Axis: Configuration

    const double AMP_FAULT_DURATION_TIME = 1; //value in seconds
 
    // SET
    axis.AmpEnableSet(false);                          // Disable the amp
    axis.AmpFaultActionSet(RSIAction.RSIActionABORT);  // Set the action that will occur when there is an amp fault.
    axis.AmpFaultTriggerStateSet(false);               //Set the state of the amp fault.
    axis.AmpFaultDurationSet(AMP_FAULT_DURATION_TIME); //Set the duration required before the Amp Fault event triggers.
 
    // GET
    var isEnabled         = axis.AmpEnableGet();
    var faultAction       = axis.AmpFaultActionGet();
    var faultTriggerState = axis.AmpFaultTriggerStateGet();
    var faultDuration     = axis.AmpFaultDurationGet();

RapidSetup:

Go to axis screen->Limits & Actions. In the image below, AmpFaultTriggerStateGet returns the trigger state shown in the Amp Fault box. It currently triggers on a HIGH because the "High" checkbox is checked.

See also

AmpFaultTriggerStateSet

Examples

AxisConfig.cs, and AxisConfiguration.cpp.