OPC UA for the Powertrain - Part 2: Functional Model
11 OPC UA DataTypes
11.1 PtLogEntryDataType
Table 92 - PtLogEntryDataType Structure
Name
Type
Description
Optional
PtLogEntryDataType
structure
FaultSituationNumber
0:Byte
Identification 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
EventNumber
0:UInt32
Unique number of event. LogEntries with the same EventNumber belong to different fault situations.
False
EventType
PtEventTypeEnumeration
Characterization of the event (fault, warning, etc.), encoded as PtEventTypeEnumeration Must never have the value "UNSPECIFIED".
False
EventClass
PtEventClassEnumeration
Fault-code identifying a fault or warning, encoded as PtEventClassEnumeration. Must never have the value "UNSPECIFIED".
False
VendorEventCode
0:Int32
Optional 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
VendorEventSubcode
0:UInt32
Additional information specifying more detailed information for the VendorEventCode.
True
EventText
0:LocalizedText
Brief description of the fault or warning.
False
EventComing
0:DateTime
Time when the event appears.
False
EventGoing
0:DateTime
Time 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
EventAcknowledged
0:DateTime
Time 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
Attribute
Value
BrowseName
PtLogEntryDataType
IsAbstract
False
References
NodeClass
BrowseName
DataType
TypeDefinition
Other
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:LogObjectTypeObject shall make the same information as the PtLogEntryDataType elements of the LogbookObject'sLogEntries 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 field
PtLogEntryDataType field mapped
Used Value
Time
EventComing, EventGoing, EventAcknowledged
Time when the event appears, disappears or is acknowledged. Each of these generates a new event.
PtLogObjectEventType if a corresponding PtLogObjectEventTypeEvent is generated, otherwise Null NodeId.
SourceNode
-
NodeId of the PtFunctionTypeObject representing the axis/drive affected.
SourceName
-
BrowseName of the SourceNode.
Message
EventText
TraceContext
-
AdditionalData[] {"LogEntry", Value}
Value = PtLogbookEventType.LogEntry
Use LogEntryProperty 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 Value
Mapped Severity ranges
Syslog Names
FAULT
301 - 1000
Alert, Emergency
WARNING
251 - 299
Critical
MAINTENANCE
230 - 250
Error
MAINTENANCE_REQUIRED
201 - 229
Error
MAINTENANCE_DEMANDED
151 - 200
Warning
MAINTENANCE_CALIBRATION
101 - 150
Notice
11.2 PtGearFactorDataType
Table 96 - PtGearFactorDataType Structure
Name
Type
Description
Optional
PtGearFactorDataType
structure
InputTurns
0:Int32
Number of turns at the gear input.
False
OutputTurns
0:Int32
Number of turns at the gear output.
False
Its representation in the AddressSpace is defined in Table 97.
Table 97 - PtGearFactorDataType Definition
Attribute
Value
BrowseName
PtGearFactorDataType
IsAbstract
False
References
NodeClass
BrowseName
DataType
TypeDefinition
Other
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
Name
Value
Description
UNSPECIFIED
0
Unspecified. May be used for the EventType parameter of the PtLogbookType GetFilteredLogbookEntries Method only.
FAULT
1
Severe exception. Axis or function not working as commanded.
WARNING
2
Exception. Critical limit reached. Axis or function still working as commanded.
MAINTENANCE
3
Limit for maintenance reached. Axis or function still working as commanded.
MAINTENANCE_REQUIRED
4
Maintenance is required.
MAINTENANCE_DEMANDED
5
Maintenance is demanded.
MAINTENANCE_CALIBRATION
6
Calibration is due.
Its representation in the AddressSpace is defined in Table 99.
Table 99 - PtEventTypeEnumeration definition
Attribute
Value
BrowseName
PtEventTypeEnumeration
IsAbstract
False
References
NodeClass
BrowseName
DataType
TypeDefinition
Other
Subtype of the 0:Enumeration type defined in OPC 10000-5.
0:HasProperty
Variable
0:EnumValues
0: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
Name
Value
Description
UNSPECIFIED
0
Unspecified. May be used for the EventClass parameter of the PtLogbookType GetFilteredLogbookEntries Method only.
MICROCONTROLLER_HARDWARE_OR_SOFTWARE
1
Comprises exceptions in the main CPU of the drive, memory/checksum errors, over-/underrun in control processes, controller self test failed, etc.
MAINS_SUPPLY
2
Comprises exceptions out of the mains supply like phase error, mains over- /undervoltage, etc.
LOW_VOLTAGE_SUPPLY
3
Comprises exceptions out of the low voltage supply supplied to the drive system (e.g. external 24 V supply).
DC_LINK_OVERVOLTAGE
4
Exception 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_ELECTRONICS
5
Comprises exceptions in the inverter stage of the drive: phase current measurement errors, overcurrent supervision error.
OVERTEMPERATURE_ELECTRONIC_DEVICE
6
Overtemperature because of overload or faulty cooling system.
ISOLATION_FAULT
7
Exception because of over-current resulting from shortage between phase and phase or phase and ground.
MOTOR_OVERLOAD
8
Exception because of over-temperature of the motor. This may be a result from motor overload or a faulty cooling system.
FIELDBUS_SYSTEM
9
Exception 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_CHANNEL
10
Exception because of a fault in the drive safety function (e.g. results from the redundant safety paths don't match).
FEEDBACK
11
Exception because of an exception in the feedback interface or the feedback sensor (e.g. encoder, position or velocity measurement system).
INTERNAL_COMMUNICATION
12
Exception 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.).
INFEED
13
Comprises exceptions out of the infeed unit of the drive: for example missing DC link voltage, etc.
BRAKE_RESISTOR
14
Exception from the dummy load circuit of the drive: Over-temperature brake resistor, brake resistor no current, etc.
LINE_FILTER
15
Exception from the main line filter in front of the infeed unit if the filter is a separate physical entity (e.g. over-temperature, etc.).
EXTERNAL
16
Exception 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.
TECHNOLOGY
17
Exception from a drive internal process supervision task/system. For example, supervision of a torque limit.
ENGINEERING
18
Exception from differences between real and expected configuration information.
OTHER
19
Necessary 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_DEVICE
20
Exception 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
Attribute
Value
BrowseName
PtEventClassEnumeration
IsAbstract
False
References
NodeClass
BrowseName
DataType
TypeDefinition
Other
Subtype of the 0:Enumeration type defined in OPC 10000-5.