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

    // 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(1);                        // set the duration (seconds) required before the Amp Fault event triggers.
 
    // get
    bool isEnabled = axis.AmpEnableGet();
    RSIAction faultAction = axis.AmpFaultActionGet();
    bool faultTriggerState = axis.AmpFaultTriggerStateGet();
    double 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

AxisConfiguration.cpp, and axis-config-ampfault.cs.