The RMP Motion Controller APIs

◆ HomeActionGet()

RSIAction HomeActionGet ( )
Description:
HomeActionGet returns the action that will occur when the Home Event triggers.
Returns
(RSIAction) Action taken on Home trigger.
Remarks
This function is also available in RapidSequencer.

Part of the Limits and Action Configuration method group.

Note:
Available Actions are Abort(), EStop(), Stop(), None, EStopAbort(), and EStopModify()
Sample Code:
if (HomeActionGet() == RSIAction.RSIActionSTOP) {
Console.WriteLine("Homing Action is set to STOP.");
}
RapidSetup:
Go to axis screen->Limits & Actions. In image below, HomeActionGet returns the action type shown in the Home Fault box. It is currently set to STOP.
See also
HomeActionSet
RSI::RapidCode::RSIAction
RSIAction
Action to perform on an Axis.
Definition: rsienums.h:1047
RSI::RapidCode::Axis::HomeActionGet
RSIAction HomeActionGet()
Get the action that will occur when the Home LIMIT triggers.