Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add controller nc error codes #9

Merged
merged 5 commits into from
Jul 16, 2024
Merged

Add controller nc error codes #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0840008
add nc controller error codes
Jul 16, 2024
ca7f4c5
add documentation
Jul 16, 2024
060afaf
add unknown error plus test
Jul 16, 2024
e56ae32
add nc error descriptions
Jul 16, 2024
0634402
fix mistake in example
Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 150 additions & 0 deletions TcError/TcError/NC/NcErrorCodeDescription.TcPOU
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
<?xml version="1.0" encoding="utf-8"?>
<TcPlcObject Version="1.1.0.1">
<POU Name="NcErrorCodeDescription" Id="{4a0565f1-16c1-0724-1369-59c0c1905318}" SpecialFunc="None">
<Declaration><![CDATA[(*
Returns an description of the error from the NcErrorCodes datatype.

## Example
```
ncErrorCode := NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_WINDOW_VELOCITY_NOT_ALLOWED;
errorDescription := NcErrorCodeDescription(ncErrorCode); // 'The value for the lag error window (velocity) is not allowed.'
```

## Source
https://infosys.beckhoff.com/content/1033/tc3ncerrcode/1521556875.html?id=2911757239699425890
*)
FUNCTION NcErrorCodeDescription : T_MaxString
VAR_INPUT
ncErrorCode : NcErrorCodes;
END_VAR
]]></Declaration>
<Implementation>
<ST><![CDATA[CASE ncErrorCode OF
NcErrorCodes.CONTROLLER_ERROR_CONTROLLER_ID_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the controller ID is not allowed, e.g. because it has already been assigned, is less than or equal to zero, or is greater than 255.';
NcErrorCodes.CONTROLLER_ERROR_CONTROLLER_TYPE_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the controller type is unacceptable because it is not defined.';
NcErrorCodes.CONTROLLER_ERROR_OPERATION_MODE_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the controller operating mode is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_WEIGHTING_OF_THE_VELOCITY_PRE_CONTROL_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the percentage weighting of the velocity pre-control is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_MONITOR_POSITION_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the activation of the lag error monitor is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LAG_MONITORING_VELOCITY_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the activation of the lag error monitoring (velocity) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_WINDOW_POSITION_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the lag error window (maximum allowable lag error) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_FILTER_TIME_POSITION_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the lag error filter time (position) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_WINDOW_VELOCITY_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the lag error window (velocity) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_FILTER_TIME_VELOCITY_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the lag error filter time (velocity) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_CONTROLLER_OUTPUT_LIMITATION_OUTPUT_LIMITATION_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the output limitation of the controller at the total manipulated variable is invalid.';
NcErrorCodes.CONTROLLER_ERROR_PROPORTIONAL_GAIN_KV_OR_KP_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the proportional gain (Kv factor or Kp factor) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_INTEGRAL_ACTION_TIME_TN_CONTROLLER_NOT_ALLOWED_POSITION:
NcErrorCodeDescription :=
'The value for the integral action time is not allowed (I part of the PID T1 controller).';
NcErrorCodes.CONTROLLER_ERROR_RATE_TIME_TV_CONTROLLER_NOT_ALLOWED_POSITION:
NcErrorCodeDescription := 'The value for the derivative action time is not allowed (D part of the PID T1 controller).';
NcErrorCodes.CONTROLLER_ERROR_DAMPING_TIME_TD_CONTROLLER_NOT_ALLOWED_POSITION:
NcErrorCodeDescription :=
'The value for the damping time is not allowed (D part of the PID T1 controller).';
NcErrorCodes.CONTROLLER_ERROR_ACTIVATION_OF_THE_AUTOMATIC_OFFSET_CALIBRATION_NOT_ALLOWED:
NcErrorCodeDescription := 'Activation of the automatic offset calibration is only possible for certain types of controller (with no I component).';
NcErrorCodes.CONTROLLER_ERROR_ADDITIONAL_PROPORTIONAL_GAIN_KV_OR_KP_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the second term of the proportional gain (Kv factor or Kp factor) is not allowed.';
NcErrorCodes
.CONTROLLER_ERROR_REFERENCE_VELOCITY_FOR_ADDITIONAL_PROP_GAIN_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the reference velocity percentage data entry, to which the additional proportional gain is applied, is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_PROPORTIONAL_GAIN_PA_PROPORTION_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the proportional gain (Pa factor) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_PROPORTIONAL_GAIN_KV_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the proportional gain (Kv factor) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_INTEGRAL_ACTION_TIME_TN_CONTROLLER_NOT_ALLOWED_VELOCITY:
NcErrorCodeDescription :=
'The value for the integral action time is not allowed (I part of the PID T1 controller).';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_FILTER_TIME_NOT_ALLOWED:
NcErrorCodeDescription :=
'The parameter for the velocity filter time in seconds is invalid (P-T1 filter).';
NcErrorCodes.CONTROLLER_ERROR_DEAD_RANGE_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the dead range (neutral zone) of the position error or the velocity error (control deviation) is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_PROPORTIONAL_GAIN_KCP_NOT_ALLOWED:
NcErrorCodeDescription := 'The parameter for the proportional gain Kcp of the slave coupling difference control is invalid.';
NcErrorCodes.CONTROLLER_ERROR_RATE_TIME_TV_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription := 'The value for the derivative action time is not allowed (D part of the PID T1 controller).';
NcErrorCodes.CONTROLLER_ERROR_DAMPING_TIME_TD_CONTROLLER_NOT_ALLOWED:
NcErrorCodeDescription :=
'The value for the damping time is not allowed (D part of the PID T1 controller).';
NcErrorCodes.CONTROLLER_ERROR_LIMITATION_OF_THE_I_PART_NOT_ALLOWED:
NcErrorCodeDescription :=
'The parameter for limiting the I-part of a PI- or PID-controller is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_LIMITATION_OF_THE_D_PART_NOT_ALLOWED:
NcErrorCodeDescription :=
'The parameter for limiting the D-part of a PI- or PID-controller is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_PARAMETER_DEACTIVATION_OF_THE_I_PART_DURING_TRAVEL_NOT_ALLOWED:
NcErrorCodeDescription :=
'The boolean parameter for switching off the I-part during active positioning is invalid.';
NcErrorCodes.CONTROLLER_ERROR_PARAMETER_FILTER_TIME_FOR_P_T2_FILTER_NOT_ALLOWED:
NcErrorCodeDescription := 'The time T0 in seconds is not permissible as a filter time for the P-T2 element of the velocity controller.';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_OBSERVER_PARAMETERIZED_MODE_IS_NOT_ALLOWED:
NcErrorCodeDescription := 'The parameterized mode (0=OFF, 1=LUENBERGER) for the velocity observer of the special NC controller in the torque interface is not permitted.';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_OBSERVER_MOTOR_TORQUE_CONSTANT_KT_OR_KF_IS_NOT_ALLOWED:
NcErrorCodeDescription := 'The parameter for the motor torque constant Kt (rotary motor) or Kf (linear motor) of the velocity observer of the special NC controller in the torque interface is invalid.';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_OBSERVER_MOTOR_MOMENT_OF_INERTIA_JM_IS_NOT_ALLOWED:
NcErrorCodeDescription := 'The parameter for the motor moment of inertia JM of the velocity observer of the special NC controller in the torque interface is invalid.';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_OBSERVER_BANDWIDTH_F0_IS_NOT_ALLOWED:
NcErrorCodeDescription := 'The parameter for the bandwidth f0 of the velocity observer of the special NC controller in the torque interface is invalid.';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_OBSERVER_CORRECTION_FACTOR_KC_IS_NOT_ALLOWED:
NcErrorCodeDescription := 'The parameter for the correction factor kc of the velocity observer of the special NC controller in the torque interface is invalid.';
NcErrorCodes
.CONTROLLER_ERROR_VELOCITY_OBSERVER_TIME_CONSTANT_T_FOR_1ST_ORDER_FILTER_NOT_ALLOWED:
NcErrorCodeDescription := 'The time constant T for the 1st order velocity filter (PID-T2 or "Lead Lag") of the velocity observer of the special NC controller in the torque interface is not allowed.';
NcErrorCodes
.CONTROLLER_ERROR_VELOCITY_OBSERVER_AMPLITUDE_DAMPING_FOR_2ND_ORDER_FILTER_NOT_ALLOWED:
NcErrorCodeDescription := 'The high-pass/low-pass amplitude attenuation dHP or dTP for the 2nd order velocity filter ("bi-quad") of the velocity observer of the special NC controller in the torque interface is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_VELOCITY_OBSERVER_FREQUENCY_FOR_2ND_ORDER_FILTER_NOT_ALLOWED:
NcErrorCodeDescription := 'The high-pass/low-pass frequency fHP or fTP for the 2nd order velocity filter ("bi-quad") of the velocity observer of the special NC controller in the torque interface is not allowed.';
NcErrorCodes.CONTROLLER_ERROR_CONTROLLER_INITIALIZATION:
NcErrorCodeDescription := 'The controller has not been initialized. Although the controller has been created, the rest of the initialization has not been performed (1. Initialization of controller, 2. Reset of controller).';
NcErrorCodes.CONTROLLER_ERROR_AXIS_ADDRESS:
NcErrorCodeDescription :=
'The controller does not know its axis, or the axis address has not been initialized.';
NcErrorCodes.CONTROLLER_ERROR_DRIVE_ADDRESS:
NcErrorCodeDescription :=
'The controller does not know its drive, or the drive address has not been initialized.';
NcErrorCodes.CONTROLLER_ERROR_LAG_ERROR_MONITOR_POSITION:
NcErrorCodeDescription := 'While the lag error monitor was active (position), the lag error was exceeded by an amount greater than the lag error window and which lasting longer than the parameterized lag error filter time.';
NcErrorCodes.CONTROLLER_ERROR_LAG_MONITORING_VELOCITY:
NcErrorCodeDescription := 'With active lag error monitoring (velocity) a velocity lag error exceedance has occurred, whose magnitude is greater than the lag error window, and whose duration is longer than the parameterized lag error filter time.';
NcErrorCodes.CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_AREA_ASIDE:
NcErrorCodeDescription := 'Internal error: CONTROLERR_RANGE_AREA_ASIDE';
NcErrorCodes.CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_AREA_BSIDE:
NcErrorCodeDescription := 'Internal error: CONTROLERR_RANGE_AREA_BSIDE';
NcErrorCodes.CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_QNENN:
NcErrorCodeDescription := 'Internal error: CONTROLERR_RANGE_QNENN';
NcErrorCodes.CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_PNENN:
NcErrorCodeDescription := 'Internal error: CONTROLERR_RANGE_PNENN';
NcErrorCodes.CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_AXISIDPRESP0:
NcErrorCodeDescription := 'Internal error: CONTROLERR_RANGE_AXISIDPRESP0';
NcErrorCodes.ERR_UNKNOWN:
NcErrorCodeDescription := 'Unknown NC error code.';
ELSE
NcErrorCodeDescription := 'Error code not recognized';
END_CASE
]]></ST>
</Implementation>
</POU>
</TcPlcObject>
66 changes: 66 additions & 0 deletions TcError/TcError/NC/NcErrorCodes.TcDUT
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="utf-8"?>
<TcPlcObject Version="1.1.0.1">
<DUT Name="NcErrorCodes" Id="{4a2189ab-d0dd-07c8-117c-3fab1f036fcf}">
<Declaration><![CDATA[{attribute 'qualified_only'}
{attribute 'strict'}
(*
Some NC Error codes

Source: https://infosys.beckhoff.com/content/1033/tc3ncerrcode/1521556875.html?id=2911757239699425890
*)
TYPE NcErrorCodes : (
NO_ERROR := 0,
CONTROLLER_ERROR_CONTROLLER_ID_NOT_ALLOWED := 17664,
CONTROLLER_ERROR_CONTROLLER_TYPE_NOT_ALLOWED := 17665,
CONTROLLER_ERROR_OPERATION_MODE_CONTROLLER_NOT_ALLOWED := 17666,
CONTROLLER_ERROR_WEIGHTING_OF_THE_VELOCITY_PRE_CONTROL_NOT_ALLOWED := 17667,
CONTROLLER_ERROR_LAG_ERROR_MONITOR_POSITION_NOT_ALLOWED := 17668,
CONTROLLER_ERROR_LAG_MONITORING_VELOCITY_NOT_ALLOWED := 17669,
CONTROLLER_ERROR_LAG_ERROR_WINDOW_POSITION_NOT_ALLOWED := 17670,
CONTROLLER_ERROR_LAG_ERROR_FILTER_TIME_POSITION_NOT_ALLOWED := 17671,
CONTROLLER_ERROR_LAG_ERROR_WINDOW_VELOCITY_NOT_ALLOWED := 17672,
CONTROLLER_ERROR_LAG_ERROR_FILTER_TIME_VELOCITY_NOT_ALLOWED := 17673,
CONTROLLER_ERROR_CONTROLLER_OUTPUT_LIMITATION_OUTPUT_LIMITATION_NOT_ALLOWED := 17674,
CONTROLLER_ERROR_PROPORTIONAL_GAIN_KV_OR_KP_CONTROLLER_NOT_ALLOWED := 17680,
CONTROLLER_ERROR_INTEGRAL_ACTION_TIME_TN_CONTROLLER_NOT_ALLOWED_POSITION := 17681,
CONTROLLER_ERROR_RATE_TIME_TV_CONTROLLER_NOT_ALLOWED_POSITION := 17682,
CONTROLLER_ERROR_DAMPING_TIME_TD_CONTROLLER_NOT_ALLOWED_POSITION := 17683,
CONTROLLER_ERROR_ACTIVATION_OF_THE_AUTOMATIC_OFFSET_CALIBRATION_NOT_ALLOWED := 17684,
CONTROLLER_ERROR_ADDITIONAL_PROPORTIONAL_GAIN_KV_OR_KP_CONTROLLER_NOT_ALLOWED := 17685,
CONTROLLER_ERROR_REFERENCE_VELOCITY_FOR_ADDITIONAL_PROP_GAIN_CONTROLLER_NOT_ALLOWED := 17686,
CONTROLLER_ERROR_PROPORTIONAL_GAIN_PA_PROPORTION_NOT_ALLOWED := 17687,
CONTROLLER_ERROR_PROPORTIONAL_GAIN_KV_CONTROLLER_NOT_ALLOWED := 17688,
CONTROLLER_ERROR_INTEGRAL_ACTION_TIME_TN_CONTROLLER_NOT_ALLOWED_VELOCITY := 17689,
CONTROLLER_ERROR_VELOCITY_FILTER_TIME_NOT_ALLOWED := 17692,
CONTROLLER_ERROR_DEAD_RANGE_NOT_ALLOWED := 17693,
CONTROLLER_ERROR_PROPORTIONAL_GAIN_KCP_NOT_ALLOWED := 17695,
CONTROLLER_ERROR_RATE_TIME_TV_CONTROLLER_NOT_ALLOWED := 17696,
CONTROLLER_ERROR_DAMPING_TIME_TD_CONTROLLER_NOT_ALLOWED := 17697,
CONTROLLER_ERROR_LIMITATION_OF_THE_I_PART_NOT_ALLOWED := 17698,
CONTROLLER_ERROR_LIMITATION_OF_THE_D_PART_NOT_ALLOWED := 17699,
CONTROLLER_ERROR_PARAMETER_DEACTIVATION_OF_THE_I_PART_DURING_TRAVEL_NOT_ALLOWED := 17700,
CONTROLLER_ERROR_PARAMETER_FILTER_TIME_FOR_P_T2_FILTER_NOT_ALLOWED := 17701,
CONTROLLER_ERROR_VELOCITY_OBSERVER_PARAMETERIZED_MODE_IS_NOT_ALLOWED := 17702,
CONTROLLER_ERROR_VELOCITY_OBSERVER_MOTOR_TORQUE_CONSTANT_KT_OR_KF_IS_NOT_ALLOWED := 17703,
CONTROLLER_ERROR_VELOCITY_OBSERVER_MOTOR_MOMENT_OF_INERTIA_JM_IS_NOT_ALLOWED := 17704,
CONTROLLER_ERROR_VELOCITY_OBSERVER_BANDWIDTH_F0_IS_NOT_ALLOWED := 17705,
CONTROLLER_ERROR_VELOCITY_OBSERVER_CORRECTION_FACTOR_KC_IS_NOT_ALLOWED := 17706,
CONTROLLER_ERROR_VELOCITY_OBSERVER_TIME_CONSTANT_T_FOR_1ST_ORDER_FILTER_NOT_ALLOWED := 17707,
CONTROLLER_ERROR_VELOCITY_OBSERVER_AMPLITUDE_DAMPING_FOR_2ND_ORDER_FILTER_NOT_ALLOWED := 17708,
CONTROLLER_ERROR_VELOCITY_OBSERVER_FREQUENCY_FOR_2ND_ORDER_FILTER_NOT_ALLOWED := 17709,
CONTROLLER_ERROR_CONTROLLER_INITIALIZATION := 17728,
CONTROLLER_ERROR_AXIS_ADDRESS := 17729,
CONTROLLER_ERROR_DRIVE_ADDRESS := 17730,
CONTROLLER_ERROR_LAG_ERROR_MONITOR_POSITION := 17744,
CONTROLLER_ERROR_LAG_MONITORING_VELOCITY := 17745,
CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_AREA_ASIDE := 17824,
CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_AREA_BSIDE := 17825,
CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_QNENN := 17826,
CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_PNENN := 17827,
CONTROLLER_ERROR_INTERNAL_ERROR_CONTROLERR_RANGE_AXISIDPRESP0 := 17828,
ERR_UNKNOWN := 65535
);
END_TYPE
]]></Declaration>
</DUT>
</TcPlcObject>
Loading