APIs, concepts, guides, and more
axis-motion-hold-via-position.cs
/* This sample demonstrates how to hold motion based on another axis reaching a specified position.
Uses one axis to control when another axis's motion is released, useful for synchronized operations.
*/
using RSI.RapidCode; // RSI.RapidCode.dotNET;
Console.WriteLine("📜 Motion Hold: via Position");
// set sample config params
const double TRIGGER_POSITION = 1;
const int MOVING_AXIS_TARGET = 10;
const int HOLDING_AXIS_TARGET = 2;
// get rmp objects
try
{
Helpers.CheckErrors(controller);
// get axes
Axis holdingAxis = controller.AxisGet(Constants.AXIS_0_INDEX);
Helpers.CheckErrors(holdingAxis);
Axis movingAxis = controller.AxisGet(Constants.AXIS_1_INDEX);
Helpers.CheckErrors(movingAxis);
// configure phantom axes
Helpers.PhantomAxisReset(holdingAxis);
holdingAxis.AmpEnableSet(true);
movingAxis.AmpEnableSet(true);
// configure motion hold - holdingAxis will be held until movingAxis reaches trigger position
holdingAxis.MotionHoldTypeSet(RSIMotionHoldType.RSIMotionHoldTypeAXIS_COMMAND_POSITION); // use AXIS_ACTUAL_POSITION for real axes
holdingAxis.MotionHoldAxisNumberSet(movingAxis.NumberGet()); // specify which axis position to monitor
holdingAxis.MotionHoldAxisPositionSet(TRIGGER_POSITION); // position that will release the hold
holdingAxis.MotionHoldAxisLogicSet(RSIUserLimitLogic.RSIUserLimitLogicGE); // release when position >= trigger position
// enable motion hold and command motion
holdingAxis.MotionAttributeMaskOnSet(RSIMotionAttrMask.RSIMotionAttrMaskHOLD);
holdingAxis.MoveRelative(HOLDING_AXIS_TARGET); // this motion will be held
Console.WriteLine($"\tHolding axis commanded to move to {HOLDING_AXIS_TARGET}, but motion is held");
// move the trigger axis to release the hold
movingAxis.MoveRelative(MOVING_AXIS_TARGET);
Console.WriteLine($"\tMoving axis to {MOVING_AXIS_TARGET} to release hold...");
movingAxis.MotionDoneWait();
holdingAxis.MotionDoneWait();
Console.WriteLine($"\tHolding axis final position: {holdingAxis.CommandPositionGet()} (expected: {HOLDING_AXIS_TARGET})");
Console.WriteLine($"\tMoving axis final position: {movingAxis.CommandPositionGet()} (expected: {MOVING_AXIS_TARGET})");
// cleanup
Helpers.AbortMotionObject(holdingAxis);
}
// handle errors as needed
finally
{
controller.Delete(); // dispose
}
static void AbortMotionObject(RapidCodeMotion motionObject)
Aborts motion on the given RapidCodeMotion object (Axis or MultiAxis), waits for motion to stop,...
Definition _helpers.cs:186
static void CheckErrors(RapidCodeObject rsiObject)
Checks for errors in the given RapidCodeObject and throws an exception if any non-warning errors are ...
Definition _helpers.cs:15
static void PhantomAxisReset(Axis phantomAxis)
Configures a phantom axis on the controller.
Definition _helpers.cs:144
Helpers class provides static methods for common tasks in RMP applications.
Definition _helpers.cs:5
void MoveRelative(double relativePosition, double vel, double accel, double decel, double jerkPct)
Command a relative point-to-point S-Curve motion.
Represents a single axis of motion control. This class provides an interface for commanding motion,...
Definition rsi.h:5862
Axis * AxisGet(int32_t axisNumber)
AxisGet returns a pointer to an Axis object and initializes its internals.
static MotionController * Get()
Get an already running RMP EtherCAT controller.
void Delete(void)
Delete the MotionController and all its objects.
Represents the RMP soft motion controller. This class provides an interface to general controller con...
Definition rsi.h:800
void MotionHoldAxisPositionSet(double position)
Sets the Axis position.
int32_t MotionDoneWait()
Waits for a move to complete.
void MotionHoldTypeSet(RSIMotionHoldType type)
Set the motion hold type.
void MotionHoldAxisNumberSet(int32_t number)
Sets the Axis number for Motion Hold.
int32_t AmpEnableSet(bool enable, int32_t ampActiveTimeoutMilliseconds=AmpEnableTimeoutMillisecondsDefault, bool overrideRestrictedState=false)
Enable all amplifiers.
int32_t NumberGet()
Get the axis number.
void MotionAttributeMaskOnSet(RSIMotionAttrMask maskOn)
Turn on a particular motion attribute mask.
void MotionHoldAxisLogicSet(RSIUserLimitLogic logic)
Set the logic when holding for Axis ActualPosition.
RSIUserLimitLogic
Logic options for User Limits.
Definition rsienums.h:646
RSIMotionAttrMask
Attribute masks for motion. You cannot mix RSIMotionAttrMaskDELAY and RSIMotionAttrMaskAPPEND.
Definition rsienums.h:1060
RSIMotionHoldType
Types for MotionHold attribute.
Definition rsienums.h:1095