AmpFaultActionSet()

void AmpFaultActionSet

(

RSIAction

action

)

Description:

AmpFaultActionSet sets the action to be performed when the Amp Fault triggers.

Note:

Available Actions are Abort(), EStop(), Stop(), None, EStopAbort(), and EStopModify()

Parameters

action

Action taken on Amp Fault event. A RSIAction value.

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 image below, AmpFaultActionSet sets the action type shown in the Amp Fault box. It is currently set to ABORT.

See also

AmpFaultActionGet()

Examples

AxisConfig.cs, AxisConfiguration.cpp, PhantomAxis.cpp, and SampleAppsHelper.h.