7.9 OPC UA Variable Mapping to PtFunctionType Properties
Table 54 lists the OPC UA Variables and the drive properties represented by Variables which are components of ObjectTypes specified above.
The Variables listed are components of a parent folder which belongs to the Object. The parent folder is specified in the row preceding the rows specifying the Variables which belong to this very folder.
The "Modelling Rule" columns have an entry for each ObjectType supporting the Variable listed in the respective row. If an ObjectType does not support the Variable, the respective column is empty. The modelling rules "optional" and "optional placeholder" are not distinguished.
| PtFrequencyDriveAxisType | PtVelocityDriveAxisType | PtPositioningDriveAxisType | PtVelocityServoDriveAxisType | PtPositionServoDriveAxisType | PtTorqueServoDriveAxisType | PtEncoderAxisType | PtGearAxisType | |||
| BrowseName | Modelling Rule | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Monitoring | ||||||||||
| AccelerationActualValue | O | O | O | O | O | O | Current acceleration of motor or axis. | |||
| AccelerationCommandAdditiveValue | O | O | O | O | Additional additive value for AccelerationSetpoint (e.g. precontrol value from motion controller). | |||||
| AccelerationSetpoint | O | O | O | O | O | Acceleration setpoint as input for motor/axis control algorithm. | ||||
| AxisTorqueForce | O | O | O | O | O | O | O | Actual force or torque that is provided at the end of the full drive train. Differentiation via unit e.g. Nm or N. Shall be provided only if it differs from TorqueForceActualValue (e.g. a gear following the motor and the drive control command value refers to the motor and not to the powertrain output). | ||
| AxisOutputVelocity | O | O | O | O | O | O | O | Actual velocity that is provided at the end of the full drive train. Can be interpreted as rotational velocity or linear velocity. Differentiation via unit e.g. rpm or m/s. Shall be provided only if it differs from VelocityActualValue (e.g. a gear following the motor and the velocity or drive control command value refers to the motor and not to the powertrain output). | ||
| AxisState | M | M | M | M | M | M | Actual state of the Powertrain Axis Object' internal state machine, e.g. S2, encoded as 0:MultiStateValueDiscreteType. The content of the EnumStrings lookup table Property is defined in Table 20. | |||
| BrakeState | O | O | O | O | O | O | O | Actual brake status encoded as PtBrakeStateVariableType. The Variable shall not be provided if the Drive Axis has no brake. | ||
| ControlMode | O | O | O | O | O | O | Active control function in the overall control cascade, e.g. SPEED_CONTROL_MODE, encoded as 0:MultiStateValueDiscreteType. The content of the EnumStrings lookup table Property is defined in Table 20. | |||
| ControlPriority | M | M | M | M | M | M | M | O | Leading control context, e.g. Fieldbus or Local, of the Powertrain Axis Object encoded as PtControlPriorityVariableType. | |
| DeviceTemperature | O | O | O | O | O | O | O | O | Actual device temperature. May be used if no separate motor and converter temperature is available. | |
| <EncoderxTemperature> | O | O | O | O | O | O | Actual temperature of encoder feedback sensor. | |||
| FrequencyCommandValue | M | Commanded frequency value, transmitted from the controller to the drive by Fieldbus communication or analogue input clamp. | ||||||||
| FrequencySetpoint | M | O | O | O | O | O | Frequency setpoint as input for motor/axis control algorithm. | |||
| GearInputShaftTurningDirection | O | O | O | O | O | O | O | Turning direction of gear input shaft, encoded as PtShaftTurningDirectionVariableType. | ||
| GearInputTorque | O | O | O | O | O | O | O | Actual torque that is provided/measured to/at the gearbox input shaft. | ||
| GearInputVelocity | O | O | O | O | O | O | O | Actual velocity that is provided/measured to/at the gearbox. Most commonly a rotational velocity. | ||
| GearOutputShaftTurningDirection | O | O | O | O | O | O | O | Turning direction of gear output shaft, encoded as PtShaftTurningDirectionVariableType. | ||
| GearOutputTorque | O | O | O | O | O | O | O | Actual torque that is provided/measured at the end of the gearbox (classical rotational output) | ||
| GearOutputVelocity | O | O | O | O | O | O | O | Actual rotational velocity that is provided/measured at the output shaft of the gearbox. | ||
| GearRatio | O | O | O | O | O | O | M | If gear ratio is adjustable, active ratio should be shown here. Gear factor represented as ratio of input turns / output turns. | ||
| GearState | O | O | O | O | O | O | O | If there are multiple gear stages that can be switched the current "state" should be presented here. It is encoded as PtGearStateVariableType. | ||
| GearTemperature | O | O | O | O | O | O | O | Actual temperature for monitoring the gearbox. E.g. oil sump. | ||
| HomingState | M | O | O | O | Homing state (NOT_REFERENCED, REFERENCED). | |||||
| MotorTemperature | O | O | O | O | O | O | Actual motor temperature. | |||
| Override | O | Active override factor on programmed velocity in percent (100% == programmed velocity). | ||||||||
| PositionActualValue | O | M | O | M | M | M | Current position of motor or axis. | |||
| PositionCommandValue | O | M | Commanded position of the controller. | |||||||
| PositionFollowingError | O | O | Actual difference between PositionSetpoint and PositionActualValue. | |||||||
| PositionSetpoint | O | O | Setpoint as input for motor/axis control algorithm. | |||||||
| ShaftTurningDirection | O | O | O | O | O | O | O | O | Turning direction of the shaft, encoded as PtShaftTurningDirectionVariableType. | |
| TorqueForceActualValue | O | O | O | O | O | O | Actual axis torque. Means torque for a rotatory axis and force for a linear axis. | |||
| TorqueForceCommandAdditiveValue | O | O | O | O | O | Additional value for commanded torque/force of the controller, transmitted by associated signal, or fixed offset value e.g. for compensation of weight or constant process forces. | ||||
| TorqueForceCommandValue | O | O | O | Commanded torque/force value, transmitted from the controller to the drive by Fieldbus communication or analogue input clamp. | ||||||
| CurrentTorqueCommandValue | O | O | O | Commanded torque related current of the controller, transmitted by the associated Telegram Signal. | ||||||
| TorqueForceSetpoint | O | O | O | O | O | Torque/Force setpoint as input for motor/axis control unit. | ||||
| TraversingTask | M | Current active/executed traversing task. May be commanded via fieldbus by PLC or is commanded by drive internal program execution. Details are visible at referenced PtTraversingTaskType Object. | ||||||||
| VelocityActualValue | O | M | M | M | M | O | O | Current velocity of axis. Corresponds to VelocityCommandValue. | ||
| VelocityCommandAdditiveValue | O | O | O | Additional additive value for Velocity Setpoint (e.g. precontrol value from motion controller). | ||||||
| VelocityCommandValue | M | M | O | Commanded velocity value, transmitted from the controller to the drive by Fieldbus communication or analogue input clamp. | ||||||
| VelocityFollowingError | O | O | O | O | Actual difference between VelocitySetpoint and VelocityActualValue. | |||||
| VelocitySetpoint | M | O | O | M | Velocity setpoint as input for motor/axis control algorithm. | |||||
| <VibrationSensor_x> | O | O | O | O | O | O | O | O | PtVibrationSensorType Object representing an attached vibration sensor. | |
| Maintenance | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| GearBacklash | O | O | O | O | O | O | O | Measured value of wear. | ||
| GearMaintenanceStatus | O | O | O | O | O | O | O | O | Status indicator with the values "Green", "Yellow", "Red", encoded as PtMaintenanceStatusVariableType. Provided if no Gear x Object present. | |
| GearOilRemainingUsefulLifetime | O | O | O | O | O | O | O | O | Remaining hours until scheduled maintenance, in hours or percentage. Provided if no Gear x Object present. | |
| <Gear_x> MaintenanceStatus | O | O | O | O | O | O | O | O | Status indicator with the values "Green", "Yellow", "Red", encoded as PtMaintenanceStatusVariableType. | |
| <Gear_x> OilRemainingUsefulLifetime | O | O | O | O | O | O | O | O | Remaining hours until scheduled maintenance, in hours or percentage. | |
| <Motor_x>, <Converter>, <Encoder_x> ,<Brake_x>, <Gear_x> PowerOnDuration | O | O | O | O | O | O | O | O | Actual duration of the power-on-state of motor x in milliseconds. | |
| <Motor_x> , <Converter>, <Encoder_x> ,<Brake_x>, <Gear_x> OperationDuration | O | O | O | O | O | O | O | O | Actual duration of performing effective operation of motor x in milliseconds. | |
| <Motor_x> , <Converter>, <Encoder_x> ,<Brake_x>, <Gear_x> OperationCycleCounter | O | O | O | O | O | O | O | O | Number of switches of motor x between power-on and operation. | |
| <Motor_x>PeakUtilization | O | O | O | O | O | O | O | O | Utilization of motor (converter) capacity, in % of converter load limit (0% - 100%), applies for motor x. Provide if global PeakUtilization Variable is not provided or not adequate. | |
| <Motor_x> RemainingUsefulLifetime | O | O | O | O | O | O | O | O | Remaining hours until scheduled maintenance, in hours or percentage, applies for motor x. Provide if global RemainingUsefulLifetime Variable is not provided or not adequate. | |
| <Motor_x> ThermalCapacityUtilization | O | O | O | O | O | O | O | O | Utilization of motor thermal capacity, in % of motor load limit (0% - 100%), applies for motor x. Provide if global ThermalCapacityUtilization Variable is not provided or not adequate. | |
| OperationCycleCounter | O | O | O | O | O | O | O | O | Number of switches between power-on and operation. | |
| OperationDuration | O | O | O | O | O | O | O | O | Actual duration of performing effective operation of the Powertrain Axis Object (e.g. the Drive's motor "works") in milliseconds. | |
| PeakUtilization | O | O | O | O | O | O | O | O | Utilization of motor (converter) capacity, in % of converter load limit (0% - 100%). | |
| PowerOnDuration | O | O | O | O | O | O | O | O | Actual duration of the power-on-state in milliseconds of the Powertrain Axis Object. | |
| RemainingUsefulLifetime | O | O | O | O | O | O | O | O | Remaining hours until scheduled maintenance, in hours or percentage. | |
| ThermalCapacityUtilization | O | O | O | O | O | O | O | O | Utilization of motor (converter) thermal capacity, in % of converter load limit (0% - 100%). | |
| CharacteristicsMotorAndControl | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FeedbackMode | O | O | O | O | O | O | Sensing device used by closed loop control of the Powertrain Axis Object, e.g. FEEDBACK_SENSOR_1, encoded as 0:MultiStateValueDiscreteType. The content of the EnumStrings lookup table Property is defined in Table 20. | |||
| MotorForceRated | O | O | O | O | O | O | Rated force of a linear moving axis. | |||
| MotorPowerRated | M | M | M | M | M | M | Rated power of the motor. | |||
| MotorSpeedRated | O | O | O | O | O | O | Rated speed of rotatory motor. If the motor of the axis does not work rotatory, the Variable shall not be provided. | |||
| MotorTorqueRated | O | O | O | O | O | O | Rated torque of the motor. | |||
| MotorType | M | M | M | M | M | M | Kind of motor, e.g. STEPPER, INDUCTION_ROTATORY, etc. encoded as 0:MultiStateValueDiscreteType. The content of the EnumStrings lookup table Property is defined in Table 20. | |||
| PositionFollowingErrorLimit | O | O | O | O | O | O | Maximum allowed position deviation in the position closed loop control. Exceeding this limit causes position following error. | |||
| SpeedMaxConfigured | O | O | O | O | O | O | Maximum speed determined by configuration data. | |||
| TimePeriodPositionControl | O | O | Time period for calculation of position control. | |||||||
| TimePeriodTorqueControl | O | O | O | O | O | Time period for calculation of torque control. | ||||
| TimePeriodTrajectoryInterpolation | O | Time period for delivering of new trajectory setpoint. | ||||||||
| TimePeriodVelocityControl | O | O | O | O | O | Time period for calculation of velocity control | ||||
| TorqueMaxConfigured | O | O | O | O | O | O | Maximum torque determined by configuration data. | |||
| TrajectoryInterpolationMode | O | Interpolation mode of trajectory interpolator | ||||||||
| VelocityFollowingErrorLimit | O | O | O | O | O | O | Maximum allowed velocity deviation in the velocity closed loop control. Exceeding this limit causes velocity following error. | |||
| LimitSupervision | O | O | M | O | O | O | ||||
| SoftwarePosLimitHigh | M | O | M | O | Software upper position limit. | |||||
| SoftwarePosLimitLow | M | O | M | O | Software lower position limit. | |||||
| TorqueLimit | O | O | O | O | M | O | Torque limit of the motor. | |||
| TorqueLimitHigh | O | O | O | M | O | O | Upper torque limit of the motor. | |||
| TorqueLimiting | O | O | O | O | Indicates if torque limiting is active. | |||||
| TorqueLimitLow | O | O | O | M | O | O | Lower torque limit of the motor. | |||
| VelocityProfile | M | M | M | M | M | |||||
| JogPosInc1 | O | O | Jogging position increment 1. | |||||||
| JogPosInc2 | O | O | Jogging position increment 2. | |||||||
| JogSpeed1 | O | O | O | O | O | O | Jogging setpoint 1 value (see [PDP], chapter 6.3.3.3.4). | |||
| JogSpeed2 | O | O | O | O | O | O | Jogging setpoint 2 value (see [PDP], chapter 6.3.3.3.4). | |||
| MaximumVelocity | O | O | O | O | O | O | Highest speed of the ramp-function. | |||
| MinimumVelocity | O | O | O | O | O | O | Lowest speed of the ramp-function. | |||
| NominalSpeed | M | M | M | M | M | O | Reference value for ramp up (down) used to calculate ramp acceleration (deceleration) | |||
| QuickStopVelocityRampDeceleration | M | M | M | M | M | O | Quick stop ramp deceleration. | |||
| QuickStopVelocityRampDownTime | M | M | M | M | M | O | Quick stop ramp down time, in seconds. | |||
| VelocityRampAcceleration | M | M | Actual ramp acceleration. | |||||||
| VelocityRampDeceleration | M | M | M | M | M | O | Actual ramp deceleration. | |||
| VelocityRampDownTime | M | M | M | M | M | O | Actual ramp down time of the RFG (see RfgRampUpTime above), in seconds | |||
| VelocityRampUpTime | M | M | Actual ramp up time of the Ramp Function Generator (RFG), see [PDP], chapter 6.3.3, in seconds | |||||||
| CharacteristicsMechanics | O | O | O | O | ||||||
| GearFactorPrecise | O | O | O | O | O | O | O | May be used if GearRatio is not precise enough. Structure representing the Gear factor as ratio of input turns / output turns. Mechanical movement at the input to mechanical movement at the output (transmission factor). | ||
| GearRatio | O | O | O | O | O | O | O | Rotation to rotation transmission factor. Mechanical movement at the input to mechanical movement at the output (transmission factor). Shall be provided if a gear is present in the Powertrain Axis Object. | ||
| SpindlePitch | O | O | O | O | Rotation to linear transmission factor. Mechanical movement at the input to mechanical movement at the output (transmission factor). | |||||
| Homing | M | M | M | M | ||||||
| HomingDirection | O | O | Homing direction (POSITIVE or NEGATIVE) | |||||||
| HomingMode | M | O | M | O | Active homing mode (ABSOLUTE, REF_MARK, DIST_CODE, FLY). | |||||
| HomingPointOffset | O | O | Home position shift for adjustment of axis mechanical zero. | |||||||
| HomingSpeedToCam | O | O | Speed when moving to cam. | |||||||
| HomingSpeedToMark | O | O | Speed when moving to mark. | |||||||
| Diagnosis | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Logbook | M | M | M | M | M | M | O | O | PtLogbookType mapping the content of the Powertrain Axis Object diagnosis system. | |
| LogObject | O | O | O | O | O | O | O | O | 0:LogObjectType (specified in OPC 10000-26) mapping the content of the Powertrain Axis Object diagnosis system. | |