11 OPC UA DataTypes

11.1 PtLogEntryDataType

Table 92 - PtLogEntryDataType Structure
NameTypeDescriptionOptional
PtLogEntryDataTypestructure
FaultSituationNumber0:ByteIdentification of fault situation. 0 means current fault situation. Usually, an operator acknowledge generates a new fault situation if the server maintains different fault situations or snapshots in the diagnosis system.False
EventNumber0:UInt32Unique number of event. LogEntries with the same EventNumber belong to different fault situations.False
EventTypePtEventTypeEnumerationCharacterization of the event (fault, warning, etc.), encoded as PtEventTypeEnumeration Must never have the value "UNSPECIFIED".False
EventClassPtEventClassEnumerationFault-code identifying a fault or warning, encoded as PtEventClassEnumeration. Must never have the value "UNSPECIFIED". False
VendorEventCode0:Int32Optional field containing the vendor specific fault code. Set to -1 if not used. -1 is reserved and may not be used as error code. In case of an existing definition of -1 as error code, it must be mapped to a different value. Clients should not expect this field to be present (backward compatibility).False
VendorEventSubcode0:UInt32Additional information specifying more detailed information for the VendorEventCode.True
EventText0:LocalizedTextBrief description of the fault or warning.False
EventComing0:DateTimeTime when the event appears.False
EventGoing0:DateTimeTime when the event disappears. May not be set when the log entry is created. The field shall be set to "1900-01-01T00:00:00Z" to indicate an "empty" value in this case. Must be set when the event disappears.False
EventAcknowledged0:DateTimeTime when the event is acknowledged. May not be set when the log entry is created. The field shall be set to "1900-01-01T00:00:00Z" to indicate an "empty" value in this case. Must be set when the event is acknowledged.False

Its representation in the AddressSpace is defined in Table 93

Table 93 - PtLogEntryDataType Definition
AttributeValue
BrowseNamePtLogEntryDataType
IsAbstractFalse
ReferencesNodeClassBrowseNameDataTypeTypeDefinitionOther
Subtype of the 0:Structure type defined in OPC 10000-3.
Conformance Units
Powertrain Logbook Readable

Note: EventType refers to the diagnosis of Axis function. In addition to this, asset component related health status is available in the asset model (see [OPC 40400-1]).

If the Server provides the LogObject, the LogRecords provided by this 0:LogObjectType Object shall make the same information as the PtLogEntryDataType elements of the Logbook Object's LogEntries array available for the Client. The necessary mapping of PtLogEntryDataType fields to 0:LogRecord fields is specified in Table 94.

Table 94 - Mapping of PtLogEntryDataTypeFields
LogRecord fieldPtLogEntryDataType field mappedUsed Value
TimeEventComing, EventGoing, EventAcknowledgedTime when the event appears, disappears or is acknowledged. Each of these generates a new event.
SeverityEventTypeSeverity mapped according to Table 95.
EventType-PtLogObjectEventType if a corresponding PtLogObjectEventType Event is generated, otherwise Null NodeId.
SourceNode-NodeId of the PtFunctionType Object representing the axis/drive affected.
SourceName-BrowseName of the SourceNode.
MessageEventText
TraceContext-
AdditionalData[]
{"LogEntry", Value}
Value = PtLogbookEventType.LogEntryUse LogEntry Property of corresponding PtLogObjectEventType. If Events are not supported, use corresponding element of the PtLogbook LogEntries component.

Table 95 maps the EventType fields' enumeration values of the PtLogEntryDataType to severity ranges specified in OPC 10000-26, "Table 9 - LogRecord Severity Mapping".

Table 95 - Mapping of EventType Field Value to Severity ranges
EventType Field ValueMapped Severity rangesSyslog Names
FAULT301 - 1000 Alert, Emergency
WARNING251 - 299Critical
MAINTENANCE230 - 250Error
MAINTENANCE_REQUIRED201 - 229Error
MAINTENANCE_DEMANDED151 - 200Warning
MAINTENANCE_CALIBRATION101 - 150Notice

11.2 PtGearFactorDataType

Table 96 - PtGearFactorDataType Structure
NameTypeDescriptionOptional
PtGearFactorDataTypestructure
InputTurns0:Int32Number of turns at the gear input.False
OutputTurns0:Int32Number of turns at the gear output.False

Its representation in the AddressSpace is defined in Table 97.

Table 97 - PtGearFactorDataType Definition
AttributeValue
BrowseNamePtGearFactorDataType
IsAbstractFalse
ReferencesNodeClassBrowseNameDataTypeTypeDefinitionOther
Subtype of the 0:Structure type defined in OPC 10000-3.
Conformance Units
Powertrain Axis Properties

11.3 PtEventTypeEnumeration

This enumeration is used for the characterization of an event. The values specified for future use may not be used by Servers.

Table 98 - PtEventTypeEnumeration Items
NameValueDescription
UNSPECIFIED0Unspecified. May be used for the EventType parameter of the PtLogbookType GetFilteredLogbookEntries Method only.
FAULT1Severe exception. Axis or function not working as commanded.
WARNING2Exception. Critical limit reached. Axis or function still working as commanded.
MAINTENANCE3Limit for maintenance reached. Axis or function still working as commanded.
MAINTENANCE_REQUIRED4Maintenance is required.
MAINTENANCE_DEMANDED5Maintenance is demanded.
MAINTENANCE_CALIBRATION6Calibration is due.

Its representation in the AddressSpace is defined in Table 99.

Table 99 - PtEventTypeEnumeration definition
AttributeValue
BrowseNamePtEventTypeEnumeration
IsAbstractFalse
ReferencesNodeClassBrowseNameDataTypeTypeDefinitionOther
Subtype of the 0:Enumeration type defined in OPC 10000-5.
0:HasPropertyVariable0:EnumValues0:EnumValueType []0:PropertyType
Conformance Units
Powertrain Actual and Command Values

11.4 PtEventClassEnumeration

This enumeration contains detailed information for a fault or warning. The values specified for future use may not be used by Servers.

Table 100 - PtEventClassEnumeration Items
NameValueDescription
UNSPECIFIED0Unspecified. May be used for the EventClass parameter of the PtLogbookType GetFilteredLogbookEntries Method only.
MICROCONTROLLER_HARDWARE_OR_SOFTWARE1Comprises exceptions in the main CPU of the drive, memory/checksum errors, over-/underrun in control processes, controller self test failed, etc.
MAINS_SUPPLY2Comprises exceptions out of the mains supply like phase error, mains over- /undervoltage, etc.
LOW_VOLTAGE_SUPPLY3Comprises exceptions out of the low voltage supply supplied to the drive system (e.g. external 24 V supply).
DC_LINK_OVERVOLTAGE4Exception because of overvoltage of the DC link, which typically is a result of excessive energy feedback from the motor/process or a faulty dummy load.
POWER_ELECTRONICS5Comprises exceptions in the inverter stage of the drive: phase current measurement errors, overcurrent supervision error.
OVERTEMPERATURE_ELECTRONIC_DEVICE6Overtemperature because of overload or faulty cooling system.
ISOLATION_FAULT7Exception because of over-current resulting from shortage between phase and phase or phase and ground.
MOTOR_OVERLOAD8Exception because of over-temperature of the motor. This may be a result from motor overload or a faulty cooling system.
FIELDBUS_SYSTEM9Exception from the Communication System between the drive (DU) and the controller. For example, this may be temporary communication frame errors or exceptions in the isochronous operation.
SAFETY_CHANNEL10Exception because of a fault in the drive safety function (e.g. results from the redundant safety paths don't match).
FEEDBACK11Exception because of an exception in the feedback interface or the feedback sensor (e.g. encoder, position or velocity measurement system).
INTERNAL_COMMUNICATION12Exception from the drive internal Communication System if there is a separate physical entity related to the internal Communication System (e.g. communication backplane, bus cable, etc.).
INFEED13Comprises exceptions out of the infeed unit of the drive: for example missing DC link voltage, etc.
BRAKE_RESISTOR14Exception from the dummy load circuit of the drive: Over-temperature brake resistor, brake resistor no current, etc.
LINE_FILTER15Exception from the main line filter in front of the infeed unit if the filter is a separate physical entity (e.g. over-temperature, etc.).
EXTERNAL16Exception posted by additional input channels to the drive. For example, a separate custom specific temperature sensor connected to the drive system by an digital input.
TECHNOLOGY17Exception from a drive internal process supervision task/system. For example, supervision of a torque limit.
ENGINEERING18Exception from differences between real and expected configuration information.
OTHER19Necessary because every entry in the actual fault situation of the diagnosis system and the warning mechanism shall result in an exception in one of the PROFIdrive fault classes because of consistency. Therefore, if a drive exception does not match with one of the defined fault classes it shall be mapped with the fault class (Other).
AUXILIARY_DEVICE20Exception because of a fault in an auxiliary device of the drive which cannot be mapped to another fault class (e.g. special cooling devices often used for large drives).

Its representation in the AddressSpace is defined in Table 101.

Table 101 - PtEventClassEnumeration definition
AttributeValue
BrowseNamePtEventClassEnumeration
IsAbstractFalse
ReferencesNodeClassBrowseNameDataTypeTypeDefinitionOther
Subtype of the 0:Enumeration type defined in OPC 10000-5.
0:HasPropertyVariable0:EnumValues0:EnumValueType []0:PropertyType
Conformance Units
Powertrain Actual and Command Values