Compensator

This sample application demonstrates how to use the compensator.

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.

Precondition

These helper functions is used in the sample apps below.

  public Axis CreateAndReadyAxis(int AxisNumber)
  {
    Axis axis = controller.AxisGet(AxisNumber); // Initialize Axis Class. (Use RapidSetup Tool to see what is your axis number)
    HelperFunctions.CheckErrors(axis);          // [Helper Function] Check that the axis has been initialize correctly.
    ResetAxis(axis);
    return axis;
  }

  public void ResetAxis(Axis myAxis)
  {
    myAxis.ErrorLimitTriggerValueSet(1000);
    myAxis.UserUnitsSet(Constants.USER_UNITS); // Specify the counts per Unit.
    myAxis.PositionSet(0);                     // Sets the current position as 0 effectively 'homing' it. 
    myAxis.Abort();                            // If there is any motion happening, abort it (creates a fault).
    myAxis.DefaultAccelerationSet(Constants.ACCELERATION);
    myAxis.DefaultDecelerationSet(Constants.ACCELERATION);
    myAxis.DefaultVelocitySet(Constants.VELOCITY);
 
    EnableAmp(myAxis);
  }

  public void EnableAmp(Axis myAxis)
  {
    myAxis.ClearFaults();      // To enable after an abort faults must be cleared.                                 
    myAxis.AmpEnableSet(true); // Enable the motor.
  }      

📜 Compensator 1D
This sample application demonstrates how to use a 1 dimensional compensator.

      // To use a compensator space in memory must be reserved before creating axis objects. For this sample app we will create two overlapping compensation tables. 
      controller.CompensatorCountSet(2);
 
      // To know how much memory will be required for the compensator table you must first know your MIN, MAX, and DELTA. See our compensator topic page for more information. 
      const int MIN    = 0;   // The smallest value in counts on the input axis where a table will be applied to the output axis. 
      const int MAX    = 200; // The largest value in counts on the input axis where a table will be applied to the output axis. 
      const int DELTA  = 10;  // The number of encoder counts on the input axis between values in the table.
      const int POINTS = ((MAX - MIN) / DELTA) + 1; // The space required in memory for the table  to be held. (21)
 
      // Compensator table values use Axis COUNTS NOT user units to be applied to the output axis.
      double[] TABLE0 = new double[POINTS] { 0, 1000, -5000, -10000, 10000, 5000, -5000, 2500, 0, 2500, 5000, 7500, 1000, 1250, 1000, 7500, 5000, 2500, 0, -2500, -1000 };
      double[] TABLE1 = new double[POINTS] { 0, 500, 0, 0, 0, 0, 0, 0, 0, 0, 1000, -5000, -1000, 1000, 5000, -5000, 2500, 0, -1000, 0, 0 };
 
      // Reserve space in memory for the compensator tables.
      controller.CompensatorPointCountSet(Constants.COMP_NUM_ZERO, TABLE0.Length);
      controller.CompensatorPointCountSet(Constants.COMP_NUM_ONE, TABLE1.Length);
 
      controller.AxisCountSet(2);
 
      Axis moving_axis   = CreateAndReadyAxis(Constants.MAIN_AXIS_NUMBER);   // Helper function to setup an axis
      Axis follower_axis = CreateAndReadyAxis(Constants.DRIVEN_AXIS_NUMBER); // Helper function to setup an axis
 
      // NOTE the three following values must be equal before a compensator can be configured. Otherwise an error will be thrown. See topic page for more info. 
      if (controller.CompensatorPointCountGet(Constants.COMP_NUM_ZERO) == TABLE0.Length && POINTS == TABLE0.Length)
      {
        // Initalize the Compensator
        controller.CompensatorConfigSet(Constants.COMP_NUM_ZERO, moving_axis, RSIAxisMasterType.RSIAxisMasterTypeAXIS_ACTUAL_POSITION, MIN, MAX, DELTA, follower_axis, RSICompensatorOutputType.RSICompensatorOutputTypeSINGLE, TABLE0);
 
        // You can also configure multiple overlaping compensation tables. Note the first compensator remains in SINGLE mode but the second is set to ADDITIVE
        controller.CompensatorConfigSet(Constants.COMP_NUM_ONE, moving_axis, RSIAxisMasterType.RSIAxisMasterTypeAXIS_ACTUAL_POSITION, MIN, MAX, DELTA, follower_axis, RSICompensatorOutputType.RSICompensatorOutputTypeADDITIVE, TABLE1);
      }

Learn more in the concept page.

📜 Compensator 2D
This sample application demonstrates how to use a 2 dimensional compensator.

      // Constants
      const int X_MIN   = 0;
      const int X_MAX   = 500;
      const int X_DELTA = 100;
      const int Y_MIN   = 0;
      const int Y_MAX   = 500;
      const int Y_DELTA = 100;
      const int COMPENSATOR_X_POINTS = ((X_MAX - X_MIN) / X_DELTA) + 1;
      const int COMPENSATOR_Y_POINTS = ((Y_MAX - Y_MIN) / Y_DELTA) + 1;
      const int POINTS  = (COMPENSATOR_X_POINTS) * (COMPENSATOR_Y_POINTS);
 
      // Compensator uses Axis COUNTS NOT user units
      double[] TABLE = new double[POINTS] {
                             0,      0,       0,      0,       0,       0,
                           100,    200,    -200,     10,     300,       0,
                           100,    200,    -500,    400,     500,       0,
                             0,      0,       0,      0,       0,       0,
                          -300,    300,    -300,   -300,    -300,       0,
                             0,      0,       0,      0,       0,       0,
      };
 
      // To use a compensator space in memory must be reserved before creating axis objects. For this sample app we will create two overlapping compensation tables. 
      controller.CompensatorCountSet(1);
      controller.CompensatorPointCountSet(Constants.COMP_NUM_ZERO, TABLE.Length);
 
      // Initialize Axes. (Use RapidSetup Tool to see what is your axis number)
      controller.AxisCountSet(3);
      Axis x = CreateAndReadyAxis(Constants.X_AXIS_NUMBER);
      Axis y = CreateAndReadyAxis(Constants.Y_AXIS_NUMBER);
      Axis z = CreateAndReadyAxis(Constants.Z_AXIS_NUMBER);
 
      z.ErrorLimitTriggerValueSet(1); // Specify the position error limit trigger. (Learn more about this on our support page)
 
      // Initalize the Compensator
      controller.CompensatorConfigSet(Constants.COMP_NUM_ZERO, x, RSIAxisMasterType.RSIAxisMasterTypeAXIS_ACTUAL_POSITION, X_MIN, X_MAX, X_DELTA, y, RSIAxisMasterType.RSIAxisMasterTypeAXIS_ACTUAL_POSITION, Y_MIN, Y_MAX, Y_DELTA, z, RSICompensatorOutputType.RSICompensatorOutputTypeSINGLE, TABLE);

Learn more in the concept page.

📜 Compensator Single Axis
This sample application demonstrates how to use a compensator that modifies the motion of itself.

      // Constants
      const int MIN    = 10;
      const int MAX    = 210;
      const int DELTA  = 10;
      const int POINTS = ((MAX - MIN) / DELTA) + 1; //21
 
      // Compensator uses Axis COUNTS NOT user units
      double[] TABLE = new double[POINTS] { 0, 2, -3, -5, -3, 2, -3, 0, 2, -3, -5, -3, 2, -3, 0, 2, -3, -5, -3, 2, -3 };
 
      // Setup memory space for the compensator
      controller.CompensatorCountSet(1);
      controller.CompensatorPointCountSet(Constants.COMP_NUM_ZERO, TABLE.Length);
 
      // Initialize Axes. (Use RapidSetup Tool to see what is your axis number)
      controller.AxisCountSet(1);
      Axis axis = CreateAndReadyAxis(Constants.AXIS_NUMBER);
 
      // NOTE the three following values must be equal before a compensator can be configured. Otherwise an error will be thrown. See topic page for more info. 
      if (controller.CompensatorPointCountGet(Constants.COMP_NUM_ZERO) == TABLE.Length && POINTS == TABLE.Length)
      {
        controller.CompensatorConfigSet(Constants.COMP_NUM_ZERO, axis, RSIAxisMasterType.RSIAxisMasterTypeAXIS_COMMAND_POSITION, MIN, MAX, DELTA, axis, RSICompensatorOutputType.RSICompensatorOutputTypeSINGLE, TABLE);
 
        axis.MoveSCurve(DELTA * 2); // Note multiply by to to get to index because min=delta
        axis.MotionDoneWait();
        controller.SampleWait(Constants.SAMPLES);
      }

Learn more in the concept page.