APIs, concepts, guides, and more
Motion: Multi-Axis

Learn how to use multi-axis motion in C#.

Warning
This is a sample program to assist in the integration of the RMP motion controller with your application. It may not contain all of the logic and safety features that your application requires. We recommend that you wire an external hardware emergency stop (e-stop) button for safety when using our code sample apps. Doing so will help ensure the safety of you and those around you and will prevent potential injury or damage.

The sample apps assume that the system (network, axes, I/O) are configured prior to running the code featured in the sample app. See the Configuration page for more information.


In this page:


📜 Multi-Axis Velocity Motion

Learn how to update Multi-Axis Velocity 📖 synchronously and on the fly. This sample demonstrates updating multi-axis velocities at a rate of ~2ms. Before running this sample app: 1) Configure your Multi-Axis on RapidSetup, 2) Adjust your Limits and Action for all axes.

/* This sample demonstrates updating a multi-axis velocity synchronously and on the fly.
It can update velocities at a rate of ~2ms.
Before running this sample app:
1. Make sure to configure your Multi-Axis on RapidSetup.
2. Make sure to adjust your Limits and Action for all axes.
*/
using RSI.RapidCode; // RSI.RapidCode.dotNET;
using System.Threading;
Console.WriteLine("📜 MultiAxis Motion: Velocity");
int exitCode = 0;
// set sample config params
const int CYCLES = 3; // how many times to update the velocity
// get rmp objects
try
{
Helpers.CheckErrors(controller);
Helpers.VerifyHardwareUsage(controller);
Helpers.VerifyAxisCount(controller, minRequiredSampleAxisCount: 3, minRequiredSampleMultiAxisCount: 1);
// get axes
int axisCount = controller.AxisCountGet();
Axis axis0 = controller.AxisGet(Constants.AXIS_0_INDEX);
Helpers.CheckErrors(axis0);
Axis axis1 = controller.AxisGet(Constants.AXIS_1_INDEX);
Helpers.CheckErrors(axis1);
Axis axis2 = controller.AxisGet(Constants.AXIS_2_INDEX);
Helpers.CheckErrors(axis2);
// get multiaxis (motion supervisor number is equal to number of axes because indexing starts at 0)
MultiAxis multi = controller.LoadExistingMultiAxis(axisCount);
Helpers.CheckErrors(multi);
// remove any existing axes
multi.AxisRemoveAll();
// add axes to multiaxis
multi.AxisAdd(axis0);
multi.AxisAdd(axis1);
multi.AxisAdd(axis2);
// prepare for motion
multi.Abort();
multi.ClearFaults();
// define motion parameters
double[] accelerations = [20, 20, 20];
double[] velocities = [0, 0, 0];
Random rnd = new Random(); // for generating random velocities
// update velocities on the fly
for (int i = 0; i < CYCLES; i++)
{
// generate random velocities for all axes
velocities[0] = rnd.Next(1, 16);
velocities[1] = rnd.Next(1, 16);
velocities[2] = rnd.Next(1, 16);
Console.WriteLine($"Cycle {i + 1}: Velocities = [{velocities[0]}, {velocities[1]}, {velocities[2]}]");
// move multiaxis (this will also update the move on the fly)
multi.MoveVelocity(velocities, accelerations);
// short delay before next iteration
Thread.Sleep(2000);
}
// clean up
Helpers.AbortMotionObject(multi); // stop motion on all axes
multi.ClearFaults();
multi.AxisRemoveAll();
exitCode = Constants.EXIT_SUCCESS;
}
// handle errors as needed
catch (Exception e)
{
Console.WriteLine($"❌ Error: {e.Message}");
exitCode = Constants.EXIT_FAILURE;
}
finally
{
controller.Delete(); // dispose
}
return exitCode;
Constants used in the C# sample apps.
Definition _constants.cs:3
const int EXIT_FAILURE
Exit code for failed execution.
Definition _constants.cs:69
const int AXIS_0_INDEX
Default: 0.
Definition _constants.cs:20
const int AMP_ENABLE_MS
Default: 750.
Definition _constants.cs:35
const int EXIT_SUCCESS
Exit code for successful execution.
Definition _constants.cs:68
const int AXIS_1_INDEX
Default: 1.
Definition _constants.cs:21
const int AXIS_2_INDEX
Default: 2.
Definition _constants.cs:22
Represents a single axis of motion control. This class provides an interface for commanding motion,...
Definition rsi.h:5921
static MotionController * Get()
Get an already running RMP EtherCAT controller.
Represents the RMP soft motion controller. This class provides an interface to general controller con...
Definition rsi.h:800
void AxisRemoveAll()
Remove all axes from a MultiAxis group.s.
void MoveVelocity(const double *const velocity, const double *const accel)
Velocity move.
void AxisAdd(Axis *axis)
Add an Axis to a MultiAxis group.
Represents multiple axes of motion control, allows you to map two or more Axis objects together for e...
Definition rsi.h:10842
void ClearFaults()
Clear all faults for an Axis or MultiAxis.
void Abort()
Abort an axis.
int32_t AmpEnableSet(bool enable, int32_t ampActiveTimeoutMilliseconds=AmpEnableTimeoutMillisecondsDefault, bool overrideRestrictedState=false)
Enable all amplifiers.
Helpers namespace provides utility functions for common tasks in RMP applications.
Definition helpers.h:21


📜 Multi-Axis Point-to-Point Motion

Learn how to perform S-Curve Motion 📖 for multiple axes simultaneously. Demonstrates both trapezoidal and S-curve motion profiles using the MultiAxis object.

/* This sample demonstrates both trapezoidal and S-curve point-to-point motion profiles for multi-axis motion.
The MultiAxis object coordinates the motion of multiple axes simultaneously.
*/
using RSI.RapidCode; // RSI.RapidCode.dotNET;
Console.WriteLine("📜 MultiAxis Motion: Point to Point");
int exitCode = 0;
// get rmp objects
Console.WriteLine($"Axis Count: {controller.AxisCountGet()}");
try
{
Helpers.CheckErrors(controller);
Helpers.VerifyHardwareUsage(controller);
Helpers.VerifyAxisCount(controller, minRequiredSampleAxisCount: 2, minRequiredSampleMultiAxisCount: 1);
// get axes
int axisCount = controller.AxisCountGet();
Axis axis0 = controller.AxisGet(Constants.AXIS_0_INDEX);
Helpers.CheckErrors(axis0);
Axis axis1 = controller.AxisGet(Constants.AXIS_1_INDEX);
Helpers.CheckErrors(axis1);
{
Helpers.PhantomAxisReset(axis0);
Helpers.PhantomAxisReset(axis1);
}
// get multiaxis (indexed by motion supervisor number, indexing starts at 0)
MultiAxis multi = controller.LoadExistingMultiAxis(axisCount);
Helpers.CheckErrors(multi);
// remove any existing axes
multi.AxisRemoveAll();
// add axes to multiaxis
multi.AxisAdd(axis0);
multi.AxisAdd(axis1);
// Use MotionAttributeMaskOnSet and MotionAttributeMaskOffSet to enable/disable synchronization features
// Both SYNC_START and SYNC_END are enabled by default
// See our Motion: Point-to-Point documentation for more details
// multi.MotionAttributeMaskOffSet(RSIMotionAttrMask.RSIMotionAttrMaskSYNC_START);
// multi.MotionAttributeMaskOffSet(RSIMotionAttrMask.RSIMotionAttrMaskSYNC_END);
// prepare for motion
multi.Abort(); // stop any existing motion
multi.ClearFaults();
// Reset axes and position
axis0.PositionSet(0);
axis1.PositionSet(0);
// define motion parameters
double[] positions1 = [ 5, 10 ]; // first set of positions
double[] positions2 = [ 15, 15 ]; // second set of positions
double[] velocities1 = [ 10, 10 ]; // velocities for first move
double[] velocities2 = [ 10, 10 ]; // velocities for second move
double[] accelerations = [ 20, 20 ]; // accelerations for both axes
double[] decelerations = [ 20, 20 ]; // decelerations for both axes
double[] jerkPercent = [ 50, 50 ]; // jerk percent for s-curve motion
// move using s-curve motion profile
Console.WriteLine($"\nMove 1 (S-Curve): Positions = [{positions1[0]}, {positions1[1]}]");
multi.MoveSCurve(positions1, velocities1, accelerations, decelerations, jerkPercent);
multi.MotionDoneWait(); // wait for motion to complete
Console.WriteLine($"Axis 0 CommandPosition: {axis0.CommandPositionGet()} (expected: {positions1[0]})");
Console.WriteLine($"Axis 1 CommandPosition: {axis1.CommandPositionGet()} (expected: {positions1[1]})");
// move using trapezoidal motion profile
Console.WriteLine($"\nMove 2 (Trapezoidal): Positions = [{positions2[0]}, {positions2[1]}]");
multi.MoveTrapezoidal(positions2, velocities2, accelerations, decelerations);
multi.MotionDoneWait(); // wait for motion to complete
Console.WriteLine($"Axis 0 CommandPosition: {axis0.CommandPositionGet()} (expected: {positions2[0]})");
Console.WriteLine($"Axis 1 CommandPosition: {axis1.CommandPositionGet()} (expected: {positions2[1]})");
// cleanup
Helpers.AbortMotionObject(multi);
multi.ClearFaults();
multi.AxisRemoveAll();
Console.WriteLine("\nMulti-axis point-to-point motion complete.");
exitCode = Constants.EXIT_SUCCESS;
}
// handle errors as needed
catch (Exception e)
{
Console.WriteLine($"❌ Error: {e.Message}");
exitCode = Constants.EXIT_FAILURE;
}
finally
{
controller.Delete(); // dispose
}
return exitCode;
const bool USE_HARDWARE
Default: false.
Definition _constants.cs:10
void PositionSet(double position)
Set the Command and Actual positions.
void MoveTrapezoidal(const double *const position, const double *const vel, const double *const accel, const double *const decel)
Point-to-point trapezoidal move.
void MoveSCurve(const double *const position, const double *const vel, const double *const accel, const double *const decel, const double *const jerkPct)
Point-to-point S-Curve Move.
int32_t MotionDoneWait(int32_t waitTimeoutMilliseconds=WaitForever)
Waits for a move to complete.