Non-Boolean Parameters

This table is a list of supported non-Boolean parameters.

These parameters are read and written by the function blocks MC_ReadParam and MC_WriteParam.

1

10

11

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1012

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1028

1029

1030

1031

1032

1034

1035

1036

1037

1500

1501

1502

 

 

 

 

 

 

 

Parameter Details

ID

Parameter

Name

R/W

Update Rate Type

Description

1

MC_AXIS_PARAM_CMD_POS

Command Position

Read-only

Controller

  • Axis command position – includes any command deltas from superimposed axes.
  • User units.
  • If a set position is in process due to homing or registration, there may be a 1 cycle delay.

10

MC_AXIS_PARAM_ACT_VEL

Actual Velocity

Read-only

EtherCAT Cyclic

  • Axis actual velocity
  • User unit/sec

11

MC_AXIS_PARAM_CMD_VEL

Command Velocity

Read-only

Controller

  • Axis command velocity – includes any command deltas from superimposed axes.
  • User unit/sec

1000

MC_AXIS_PARAM_PHASE_SHIFT

Phase Shift

Read-only

Controller

  • The amount of phase shift applied by MC_Phasing.
  • Slave axis' user units

1001

MC_AXIS_PARAM_SUPERIMPOSED_DISTANCE

Superimposed Distance

Read-only

Controller

1002

MC_AXIS_PARAM_MASTER_OFFSET

Master Offset

Read / Write

Controller

  • Write: The amount to increment the master offset for an active master/slave move.
    • User units.
  • Read: The amount of master offset applied.
    • User units.

1003

MC_AXIS_PARAM_SLAVE_OFFSET

Slave Offset

Read / Write

Controller

  • Write: The amount to increment the slave offset for an active master/slave move.
    • User units.
  • Read: The amount of slave offset applied.
    • User units.

1004

MC_AXIS_PARAM_MOVE_TYPE_ACTIVE

Active Move Type

Read-only

Controller

The active move type.

See Move Types.

1005

MC_AXIS_PARAM_MOVE_TYPE_NEXT

Next Move Type

Read-only

Controller

The queued (next) move type.

See Move Types.

1006

MC_AXIS_PARAM_POSITION_ERROR

Position Error

Read-only

EtherCAT Cyclic

Position error in user units.

1007

MC_AXIS_PARAM_FEEDBACK_LAST

Raw Feedback

Read-only

EtherCAT Cyclic

  • Raw Feedback position in user units.
  • Keeps track of the actual position based on the physical feedback device connected to the drive.
  • Not offset as a result of calling MC_SetPos.

1008

MC_AXIS_PARAM_ROLLOVER_POSITION

Rollover

Read / Write

Controller

  • The axis rollover position is in User units.
  • If the axis is a servo axis:
    • This parameter can only be written when there are no moves in the queue. 1
    • When this parameter is changed, the new position is scaled from the old position.

In particular:

{equation}NewPosition = OldPosition * (New Rollover) / (Old Rollover){/equation}. 

1009

MC_AXIS_PARAM_VELCOMP_FACTOR

Velocity Compensation Factor

Read / Write

Controller

  • The factor used to multiply the velocity compensation value to account for the number of updates of delay in transmission of the feedback value from the drive to the control.
  • See Velocity Compensation.

1010

MC_AXIS_PARAM_VELCOMP_FILTER

Velocity Compensation Filter

Read / Write

Controller

1012

MC_AXIS_PARAM_IN_POSITION_BAND

Axis In-Position Bandwidth

Read / Write

Controller

The bandwidth about the command position to determine the state of the in-position flag.

See Note 2.

1014

MC_AXIS_PARAM_DRIVE_STATUS

Drive Status

Read-only

EtherCAT Cyclic

  • Drive Status Word
  • Some status bits are set only at program startup.

1015

MC_AXIS_PARAM_UU_FB_RATIO_NUM

User Unit to feedback unit ratio numerator

Read-only

Static

1016

MC_AXIS_PARAM_TORQUE_ACTUAL

Actual Torque

Read-only

EtherCAT Cyclic

1017

MC_AXIS_PARAM_BUS_ADDRESS

Drive Address

Read-only

Static

  • Drive address value used in EtherCAT fieldbus functions as drive address.
  • Before using in fieldbus functions, this value needs to be converted to an integer by using a convert any_to_dint / any_to_udint function.

1018

MC_AXIS_PARAM_SENSOR_DELAY

Sensor Delay

Read / Write

Controller

Compensation for Physical sensor delay for MC_TouchProbe, in microseconds.

See Note 1.

1019

MC_AXIS_PARAM_INTERP_CMD_POS

Interpolated Command Position

Read-only

Controller

  • Command position solely from this axis’s interpolator (in User units).
  • This value does not include any command deltas from other axes that are currently superimposed upon it.

1020

MC_AXIS_PARAM_INTERP_CMD_VEL

Interpolated Command Velocity

Read-only

Controller

  • Command velocity solely from this axis’s interpolator (in user units).
  • This value does not include any command deltas from other axes that are currently superimposed upon it.

1021

MC_AXIS_PARAM_REGIST_COMP

Registration Compensation

Read-only

Controller

  • The latest calculated registration compensation value.
  • This value is updated each time a good registration mark is encountered.
  • This value is in User units.

1022

MC_AXIS_PARAM_REGIST_DIST

Distance Between the Last Two Good Registration Marks

Read-only

EtherCAT Non-Cyclic

  • The distance between the last two good registration marks.
  • This value is in User units.

1023

MC_AXIS_PARAM_REGIST_GOOD_CNT

Number of Consecutive Good Registration Marks

Read / Write

EtherCAT Non-Cyclic

  • Number of consecutive good registration marks.
  • This value is incremented each time a good registration mark is encountered.
    • It is automatically zeroed when a bad registration mark is encountered.
  • The ability to write this parameter is provided to allow the application to zero this value.

1024

MC_AXIS_PARAM_REGIST_BAD_CNT

Number of Consecutive Bad Registration Marks

Read / Write

EtherCAT Non-Cyclic

  • Number of consecutive bad registration marks.
  • This value is incremented each time a bad registration mark is encountered.
    • It is automatically zeroed when a good registration mark is encountered.
  • The ability to write this parameter is provided to allow the application to zero this value.

1028

MC_AXIS_PARAM_UU_FB_RATIO_DEN

User units to feedback unit ratio denominator

Read-only

Static

1029

MC_AXIS_PARAM_CM_ACT_CMD_POS

Coordinated Motion Applied Command Position

Read-only

Controller

Amount of motion actually applied to the PLCopen axis drive by Coordinated Motion commands.

1030

MC_AXIS_PARAM_CM_CMD_POS

Coordinated Motion Command Position

Read-only

Controller

Amount of motion requested of a PLCopen axis by the Coordinated Motion commands.

1031

MC_AXIS_PARAM_INGEAR_BANDWIDTH

In Gear bandwidth

Read / Write

Controller

  • The bandwidth about the target slave velocity where the slave axis locks onto the master axis and the InGear output turns on for the MC_GearIn function block.
  • User unit/sec
  • Default value = 0.1.

1032

MC_AXIS_PARAM_DRIVE_AXIS_NUMBER

Drive Axis Number

Read-only

Static

One-based number that specifies the axis on the drive.

1034

MC_AXIS_PARAM_UU_FB_RATIO

User units to feedback unit ratio

Read-only

Controller

1035

MC_AXIS_PARAM_BUS_INTERFACE_TYPE

Bus Interface Type

Read-only

Static

The parameter value is:

  • DRIVE_BUS_INTERFACE_ECAT when the axis is associated with an EtherCAT device.
  • DRIVE_BUS_INTERFACE_SIMULATOR when the axis is simulated.

1036

MC_AXIS_PARAM_SIM_CLOSING

Simulator

Distance

Closing

Fraction

Write-only

Controller

This setting affects how responsive a simulated axis to changing command positions.

  • The valid range of this parameter is (0.0, 1.5].
  • The default value is 0.7.

Values are broken down into these ranges:

  • (0.0, 1.0): Simulate following error.
    • A value of 0.1 generates a large following error.
    • A value of 0.9 generates a small following error.
  • 1.0: No following error.
  • (1.0,1.5]: Simulate leading error.

  • A value of 1.0 is recommended when using an axis as a virtual master to command motion through camming and/or gearing.

1037

MC_AXIS_PARAM_UU_REV_RATIO

User units revolution ratio

Read / Write

Controller


  • Do NOT change the user units per revolution ratio when the axis is enabled, geared, or cammed to another axis.
    Undefined behavior may result.

1500

MC_AXIS_PARAM_BUS_POSITION_DEMAND

Position demand value

Read-only

EtherCAT Cyclic

Drive Position Demand Value 32-bits.


  • There may be a 1 cycle delay.

1501

MC_AXIS_PARAM_BUS_STATUS_WORD

Drive Status Word

Read-only

EtherCAT Cyclic

Drive Axis Status Word 16-bits.


  • There may be a 1 cycle delay.

1502

MC_AXIS_PARAM_BUS_CONTROL_WORD

Drive Control Word

Read-only

EtherCAT Cyclic

Drive Axis Control Word 16-bits.


  • There may be a 1 cycle delay.

Notes

See Tuning Controller Performance for EtherCAT Communication Latency.

  1. This is a configuration parameter.
  2. There is some delay in acquiring fast input information from drives and calculating the registration marks.
    While the information is evaluated cyclically, there may be a few cycles between when the fast input occurs and the system records the registration marks.
  3. There is some delay in acquiring fast input information from drives and calculating the fast input position.
    While the information is evaluated cyclically, there may be a few cycles between when the fast input occurs and the system records the fast input data.
  4. There is some delay in acquiring the actual position values.
    While the information is evaluated cyclically, there may be a few cycles between when the actual position is updated in the drive and the system records the fast input data.

See Also