APIs, concepts, guides, and more

◆ AmpFaultActionGet()

RSIAction AmpFaultActionGet ( )
Description:
AmpFaultActionGet returns the action which will occur when an Amp Fault is triggered.
Returns
(::RSIAction) Action taken on Amp Fault event.

Part of the Limits and Action Configuration method group.

Note:
Available Actions are Abort(), EStop(), Stop(), None, EStopAbort(), and EStopModify()
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 image below, AmpFaultActionGet returns the action type shown in the Amp Fault box. It is currently set to ABORT.
See also
AmpFaultActionSet
Examples
axis-config-ampfault.cs, and axis-configuration.cpp.