35 DiagnosticsType
A Client can start and stop diagnostics via methods. The single diagnosis steps are vendor specific. After each completed step, the server may generate a DiagnosisStepEndEvent (Table 163).
The event keeps the result of the diagnosis step. After completion of all diagnosis functions, the server shall send a DiagnosisEndEvent (Table 164).
| Attribute | Value | ||||
| BrowseName | DiagnosticsType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of 0:BaseObjectType defined in OPC UA Part 5 | |||||
| 0:HasProperty | Variable | Status | DiagnosticsStatus Enumeration | 0:PropertyType | M, RO |
| 0:HasComponent | Method | RunDiagnostics | M | ||
| 0:HasComponent | Method | StopDiagnostics | M | ||
| 0:GeneratesEvent | ObjectType | DiagnosisStepEndEventType | Defined in 35.4 | ||
| 0:GeneratesEvent | ObjectType | DiagnosisEndEventType | Defined in 35.5 | ||
35.1 Status
The status shows a client whether the diagnostic function is active or finished and if diagnosis detected at least one error.
| Name | Value | Description |
| OFF | 0 | Diagnostics inactive |
| ACTIVE_OK | 1 | Diagnostics active |
| ACTIVE_ERROR_DETECTED | 2 | Diagnostics active, at least one error detected |
| COMPLETE | 3 | Diagnostics completed successfully, result in variable “Result” available |
| COMPLETE_ERROR_DETECTED | 4 | Diagnostics completed detected some error |
35.2 RunDiagnostics
Method to start diagnostics functions from any Status. Status must change to an “active state” or stay in the current “active state” if diagnosis functions already running.
Signature
RunDiagnostics ();The method has no Input- or OutputArguments.
| Attribute | Value | ||||
| BrowseName | RunDiagnostics | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Modelling Rule |
|---|
35.3 StopDiagnostics
Method to stop diagnostics functions from any Status.
If Status is “active”, this method cancels active diagnosis functions. Status should change to “Off” after diagnostics stopped.
When diagnosis functions already done, Status changes immediately to “Off”.
Signature
StopDiagnostics ();The method has no Input- or OutputArguments.
| Attribute | Value | ||||
| BrowseName | StopDiagnostics | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Modelling Rule |
|---|
35.4 DiagnosisStepEndEventType
| Attribute | Value | ||||
| BrowseName | DiagnosisStepEndEventType | ||||
| IsAbstract | True | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of 0:BaseEventType defined in OPC UA Part 5 | |||||
| 0:HasProperty | Variable | Result | 0:Boolean | 0:PropertyType | M, R |
| 0:HasProperty | Variable | InputNode | NodeId | 0:PropertyType | M, R |
35.4.1 Result
The property is true if the device completes a diagnostic step without error detection.
35.4.2 InputNode
In the case of component-related diagnostic steps (e.g. different zones of a hotrunner), this Property holds the NodeID of the corresponding instance. For general information InputNode holds the NodeId of the root node.
The component information and the severity allow the machine to prevent the use of faulty components.
35.4.3 Inherited properties of BaseEventType
| Severity | in accordance with clause 6.4. |
| SourceNode | NodeId of the root Node of the specific interface. |
| Message | keeps the result of diagnostics as a vendor specific localized text. |
Examples:
“Wiring analysis of zone 1 completed successfully.”
“Error detected, current consumption of zone 3 too high! “
35.5 DiagnosisEndEventType
| Attribute | Value | ||||
| BrowseName | DiagnosisEndEventType | ||||
| IsAbstract | True | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of 0:BaseEventType defined in OPC UA Part 5 | |||||
| 0:HasProperty | Variable | Status | DiagnosticsStatusEnumeration | 0:PropertyType | O, R |
35.5.1 Status
Status after completion of the diagnosis.
35.5.2 Inherited properties from BaseEventType
Severity in accordance with clause 6.4.
SourceNode contains the NodeId of the root Node of the specific interface.
Message keeps the result of diagnostics as a vendor specific localized text.
Examples:
“Successfully completed. System configuration is correct!”
“Diagnosis completed, 3 faulty zones detected. “