◆ AmpEnableGet()

virtual bool AmpEnableGet ( )
pure virtual

Get the state of the Amp Enable Output.

ℹ This function is avaliable in RapidCode and RapidSequencer

Part of the Dedicated I/O method group.

Description:
AmpEnableGet returns the state of the Amp Enable Output.
Returns
(int32_t) 0 = amp is disabled, 1 = amp is enabled.
Sample Code:
ConfigAmpFault
//---ARRANGE---
const double AMP_FAULT_DURATION_TIME = 1; //value in seconds
//---ACT---
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.
//---ASSERT---
Assert.That(axis.AmpEnableGet(), Is.EqualTo(false), "The getter function should return a value equal to false");
Assert.That(axis.AmpFaultActionGet(), Is.EqualTo(RSIAction.RSIActionABORT), "The getter function should return a value equal to RSIActionABORT");
Assert.That(axis.AmpFaultTriggerStateGet(), Is.EqualTo(false), "The getter function should return a value equal to false");
Assert.That(axis.AmpFaultDurationGet(), Is.EqualTo(AMP_FAULT_DURATION_TIME), "The getter function should return a value equal to AMP_FAULT_DURATION_TIME");
RapidSetup:
Go to axis screen->Dedicated I/O tab. The High/Low state next to Amp Enable is the result of the AmpEnableGet function.
Note
For the RMP DedicatedIOGet(RSIMotorDedicatedIn::RSIMotorDedicatedInAMP_ACTIVE) is a more accurate state of the physical drive rather than logical axis.
DedicatedIO.jpg
See also
AmpEnableSet, Dedicated I/O