The parameters for performance evaluation.
NOTE: The below evaluation parameters support for KINGSTAR 4.4 and later versions.
NOTE: Fore more details about the usage examples of the evaluation parameters, please refer to Example of using the evaluation parameters.
The parameters can be classified into three sets: Process Control, Configuration and Result. Please refer to the following tables.
Process Control parameters:
| Name | Value | Meaning |
|---|---|---|
| evalEcatControl | 0x0 |
A parameter of Control. This parameter is for enabling/disabling the evaluation. After enabling the evaluation, the evaluation process will start checking when the trigger condition is met. Access: Read and write. Default value: 0. 0: Disable. Only allowed when Status is 3 or 4. This will clear the evaluation result and Status will become 0. 1: Enable. Only allowed when Status is 0. 2: Pause (not yet supported in KINGSTAR 4.4). 3: Stop. Only allowed when Status is 2. |
| evalEcatStatus | 0x1 |
A parameter of Status. The status of the evaluation process. Access: Read only. Default value: 0. 0: Idle. 1: Enabled. Waiting for trigger. 2: Running. 3: Finished. 4: Error stop. The ongoing evaluation stops when the master state switches away from Op (Operational). |
| evalEcatErrorCode | 0x2 |
A parameter of Error Code. The error code for the last error. Access: Read only. Default value: 0. 0: No error. -1: Wrong control. |
Configuration parameters:
| Name | Value | Meaning |
|---|---|---|
| evalEcatTriggerMode | 0x100 |
A parameter of Trigger Mode. The trigger condition for the evaluation to start. Access: Read and write. Default value: 0. 0: Starts after master gets to the Op (Operational) state. |
| evalEcatTriggerParam | 0x101 |
A parameter of Trigger Parameter. The trigger parameter for the Trigger Mode. Access: Read and write. Default value: 0. |
| evalEcatTriggerDelay | 0x102 |
A parameter of Trigger Delay. The delay for the evaluation to start when the trigger condition is met. Access: Read and write. Default value: 0. |
| evalEcatMode | 0x103 |
A parameter of Evaluation Mode. The evaluation mode. Access: Read and write. Default value: 0. 0: Time. The evaluation process will finish when the time is up. The unit for the End Parameter of this mode is the number of cycles. |
| evalEcatEndParam | 0x104 |
A parameter of End Parameter. The end parameter for the specified Evaluation Mode. Access: Read and write. Default value: 30,000. |
Result parameters:
| Name | Value | Meaning |
|---|---|---|
| evalEcatProcessingTime | 0x200 |
A parameter of Processing Time. The total time it takes for the master to process data receiving and transmitting as well as the tasks needed to run the fieldbus network. Access: Read only. Supported aggregate values: maximum, average and minimum. |
| evalEcatPacketJitter | 0x201 |
A parameter of Packet Jitter. The jitter of sending out packet from NIC. Access: Read only. Supported aggregate values: maximum, average and minimum. |
| evalEcatRealtimeJitter | 0x300 |
A parameter of Real-time Jitter. The jitter of the master system. Access: Read only. Supported aggregate values: maximum, average and minimum. |
| evalEcatTransmittingLatency | 0x301 |
A parameter of Transmitting Latency. The time it takes for the packet data to be copied to the NIC transmit buffer. Access: Read only. Supported aggregate values: maximum, average and minimum. |
| evalEcatReceiveLatency | 0x302 |
A parameter of Receive Latency. The time for a packet to loop back to the master. Access: Read only. Supported aggregate values: maximum, average and minimum. |
| evalEcatDcDeviation | 0x400 |
A parameter of DC Deviation. The DC (Distributed Clock) synchronization error of the DC-enabled slaves. Access: Read only. Supported aggregate values: maximum, average and minimum. |
| evalEcatDcmDeviation | 0x401 |
A parameter of DCM Deviation. The synchronization error between the master clock and the DC (Distributed Clock) reference clock. Access: Read only. Supported aggregate values: maximum, average and minimum. |