This clause describes Interfaces with specific functionality that may be applied to multiple types at arbitrary positions in the type hierarchy.
Interfaces are defined in OPC 10001-7.
Figure 4 shows the Interfaces described in this specification.
Figure 4 – Overview of Interfaces for Devices and Device components
IVendorNameplateType includes Properties that are commonly used to describe a TopologyElement from a manufacturer point of view. They can be used as part of the identification. The Values of these Properties are typically provided by the component vendor.
The VendorNameplate Interface is illustrated in Figure 5 and formally defined in Table 17.
Figure 5 – VendorNameplate Interface
Table 17 – IVendorNameplateType definition
|
Attribute |
Value |
||||
|
BrowseName |
IVendorNameplateType |
||||
|
IsAbstract |
True |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the BaseInterfaceType defined in OPC 10001-7 |
|||||
|
|
|
|
|
|
|
|
Product-specific Properties |
|||||
|
0:HasProperty |
Variable |
Manufacturer |
0:LocalizedText |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
ManufacturerUri |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
Model |
0:LocalizedText |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
ProductCode |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
HardwareRevision |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
SoftwareRevision |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
DeviceRevision |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
DeviceManual |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
DeviceClass |
0:String |
0:PropertyType |
O |
|
Product instance-specific Properties |
|||||
|
0:HasProperty |
Variable |
SerialNumber |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
ProductInstanceUri |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
RevisionCounter |
0:Int32 |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
SoftwareReleaseDate |
0:DateTime |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
PatchIdentifiers |
0:String[] |
0:PropertyType |
O |
|
Conformance Units |
|||||
|
DI Nameplate |
|||||
Product type specific Properties:
Manufacturer provides the name of the company that manufactured the item this Interface is applied to. ManufacturerUri provides a unique identifier for this company. This identifier should be a fully qualified domain name; however, it may be a GUID or similar construct that ensures global uniqueness.
Model provides the name of the product.
ProductCode provides a unique combination of numbers and letters used to identify the product. It may be the order information displayed on type shields or in ERP systems.
HardwareRevision provides the revision level of the hardware. SemanticVersionString (a sub-type of String defined in OPC 10000-5) may be used when using the Semantic Versioning format.
SoftwareRevision provides the version or revision level of the software component, the software/firmware of a hardware component, or the software/firmware of the Device. SemanticVersionString (a sub-type of String defined in OPC 10000-5) may be used when using the Semantic Versioning format.
DeviceRevision provides the overall revision level of a hardware component or the Device. As an example, this Property can be used in ERP systems together with the ProductCode Property. SemanticVersionString (a sub-type of String defined in OPC 10000-5) may be used when using the Semantic Versioning format.
DeviceManual allows specifying an address of the user manual. It may be a pathname in the file system or a URL (Web address).
DeviceClass indicates in which domain or for what purpose a certain item for which the Interface is applied is used. Examples are “ProgrammableController”, “RemoteIO”, and “TemperatureSensor”. This standard does not predefine any DeviceClass names. More specific standards that utilize this Interface will likely introduce such classifications (e.g., IEC 62769, OPC 30000, or OPC 10020).
Product instance specific Properties:
SerialNumber is a unique production number provided by the manufacturer. This is often stamped on the outside of a physical component and may be used for traceability and warranty purposes.
ProductInstanceUri is a globally unique resource identifier provided by the manufacturer. This is often stamped on the outside of a physical component and may be used for traceability and warranty purposes. The maximum length is 255 characters. The recommended syntax of the ProductInstanceUri is: <ManufacturerUri>/<any string> where <any string> is unique among all instances using the same ManufacturerUri.
Examples: “some-company.com/5ff40f78-9210-494f-8206-c2c082f0609c”, “some-company.com/snr-16273849” or “some-company.com/model-xyz/snr-16273849”.
RevisionCounter is an incremental counter indicating the number of times the configuration data has been modified. An example would be a temperature sensor where the change of the unit would increment the RevisionCounter but a change of the measurement value would not affect the RevisionCounter.
SoftwareReleaseDate defines the date when the software is released. If the version information is about patches, this should be the date of the latest patch. It is additional information for the user.
PatchIdentifiers identify the list of patches that are applied to a software version. The format and semantics of the strings are vendor-specific. The order of the strings shall not be relevant.
Companion specifications may specify additional semantics for the contents of these Properties.
Table 18 specifies the mapping of these Properties to the International Registration Data Identifiers (IRDI) defined in ISO/ICE 11179-6. They should be used if a Server wants to expose a dictionary reference as defined in OPC 10001-5.
Table 18 – VendorNameplate Mapping to IRDIs
|
Property |
IRDI |
|
Manufacturer |
|
|
ManufacturerUri |
|
|
Model |
|
|
SerialNumber |
|
|
HardwareRevision |
|
|
SoftwareRevision |
|
|
DeviceRevision |
- |
|
RevisionCounter |
|
|
ProductCode |
|
|
ProductInstanceUri |
|
|
DeviceManual |
- |
|
DeviceClass |
ITagNameplateType includes Properties that are commonly used to describe a TopologyElement from a user point of view.
The TagNameplate Interface is illustrated in Figure 6 and formally defined in Table 19.
Figure 6 – TagNameplate Interface
Table 19 – ITagNameplateType definition
|
Attribute |
Value |
||||
|
BrowseName |
ITagNameplateType |
||||
|
IsAbstract |
True |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the BaseInterfaceType defined in OPC 10001-7 |
|||||
|
|
|
|
|
|
|
|
0:HasProperty |
Variable |
AssetId |
0:String |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
ComponentName |
0:LocalizedText |
0:PropertyType |
O |
|
Conformance Units |
|||||
|
DI TagNameplate |
|||||
AssetId is a user writable alphanumeric character sequence uniquely identifying a component. The ID is provided by the integrator or user of the device. It contains typically an identifier in a branch, use case or user specific naming scheme. This could be for example a reference to an electric scheme.
ComponentName is a user writable name provided by the integrator or user of the component.
Table 20 specifies the mapping of these Properties to the International Registration Data Identifiers (IRDI) defined in ISO/IEC 11179-6. They should be used if a Server wants to expose a dictionary reference as defined in OPC 10001-5.
Table 20 – TagNameplate Mapping to IRDIs
|
Property |
IRDI |
|
AssetId |
|
|
ComponentName |
0112/2///61987#ABA251 - designation of device |
The DeviceHealth Interface includes Properties and Alarms that are commonly used to expose the health status of a Device. It is illustrated in Figure 7 and formally defined in Table 21.
Figure 7 – DeviceHealth Interface
Table 21 – IDeviceHealthType definition
|
Attribute |
Value |
||||
|
BrowseName |
IDeviceHealthType |
||||
|
IsAbstract |
True |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:BaseInterfaceType defined in OPC 10001-7 |
|||||
|
|
|
|
|
||
|
0:HasComponent |
Variable |
DeviceHealth |
DeviceHealthEnumeration |
0:BaseDataVariableType |
O |
|
0:HasComponent |
Object |
DeviceHealthAlarms |
|
0:FolderType |
O |
|
Conformance Units |
|||||
|
DI DeviceHealth |
|||||
DeviceHealth indicates the status as defined by NAMUR Recommendation NE107. Clients can read or monitor this Variable to determine the device condition.
The DeviceHealthEnumeration DataType is an enumeration that defines the device condition. Its values are defined in Table 22. Its representation in the AddressSpace is defined in Table 23.
Table 22 – DeviceHealthEnumeration values
|
Name |
Value |
Description |
|
NORMAL |
0 |
The Device functions normally. |
|
FAILURE |
1 |
Malfunction of the Device or any of its peripherals. Typically caused device-internal or is process related. |
|
CHECK_FUNCTION |
2 |
Functional checks are currently performed. Examples: Change of configuration, local operation, and substitute value entered. |
|
OFF_SPEC |
3 |
"Off-spec" means that the Device is operating outside its specified range (e.g. measuring or temperature range) or that internal diagnoses indicate deviations from measured or set values due to internal problems in the Device or process characteristics. |
|
MAINTENANCE_REQUIRED |
4 |
Although the output signal is valid, the wear reserve is nearly exhausted or a function will soon be restricted due to operational conditions e.g. build-up of deposits. |
Table 23 – DeviceHealthEnumeration definition
|
Attribute |
Value |
|||||
|
BrowseName |
DeviceHealthEnumeration |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
|
Subtype of the 0:Enumeration type defined in OPC 10000-5 |
||||||
|
0:HasProperty |
Variable |
0:EnumStrings |
0:LocalizedText [] |
0:PropertyType |
|
|
|
Conformance Units |
||||||
|
DI DeviceHealth |
||||||
DeviceHealthAlarms shall be used for instances of the DeviceHealth Alarm Types specified in 4.12.
DeviceHealthAlarms may also be used for other Alarm instances that relate to the health condition of the Device.
The IOperationCounterType defines counters for the duration of operation. It is formally defined in Table 24.
Table 24 – IOperationCounterType definition
|
Attribute |
Value |
||||
|
BrowseName |
IOperationCounterType |
||||
|
IsAbstract |
True |
||||
|
Description |
Interface defining counters for the duration of operation |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:BaseInterfaceType |
|||||
|
0:HasProperty |
Variable |
PowerOnDuration |
0:Duration |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
OperationDuration |
0:Duration |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
OperationCycleCounter |
0:UInteger |
0:PropertyType |
O |
|
Conformance Units |
|||||
|
DI OperationCounter Interface |
|||||
PowerOnDuration is the duration the Device has been powered. The main purpose is to determine the time in which degradation of the Device occurred. The details, when the time is counted, is implementation-specific. Companion specifications might define specific rules. Typically, when the Device has supply voltage and the main CPU is running, the time is counted. This may include any kind of sleep mode, but may not include pure Wake on LAN. This value shall only increase during the lifetime of the Device and shall not be reset when the Device is restarted. The PowerOnDuration is provided as Duration, i.e., in milliseconds or even fractions of a millisecond. However, the Server is not expected to update the value in such a high frequency, but maybe once a minute or once an hour, depending on the application.
OperationDuration is the duration the Device has been powered and performing an activity. This counter is intended for Devices where a distinction is made between switched on and in operation. For example, a drive might be powered on but not operating. It is not intended for Devices always performing an activity like sensors always measuring data. This value shall only increase during the lifetime of the Device and shall not be reset when the Device is restarted. The OperationDuration is provided as Duration, i.e., in milliseconds or even fractions of a millisecond. However, the Server is not expected to update the value in such a high frequency, but maybe once a minute or once an hour, depending on the application.
OperationCycleCounter is counting the times the Device switches from not performing an activity to performing an activity. For example, each time a valve starts moving, is counted. This value shall only increase during the lifetime of the Device and shall not be reset when the Device is restarted.
The child Nodes of the IOperationCounterType have additional Attribute values defined in Table 25.
Table 25 – IOperationCounterType Attribute values for child Nodes
|
BrowsePath |
Description Attribute |
|
PowerOnDuration |
PowerOnDuration is the duration the Device has been powered. The main purpose is to determine the time in which degradation of the Device occurred. The details, when the time is counted, is implementation-specific. Companion specifications might define specific rules. Typically, when the Device has supply voltage and the main CPU is running, the time is counted. This may include any kind of sleep mode, but may not include pure Wake on LAN. This value shall only increase during the lifetime of the Device and shall not be reset when the Device is restarted. The PowerOnDuration is provided as Duration, i.e., in milliseconds or even fractions of a millisecond. However, the Server is not expected to update the value in such a high frequency, but maybe once a minute or once an hour, depending on the application. |
|
OperationDuration |
OperationDuration is the duration the Device has been powered and performing an activity. This counter is intended for Devices where a distinction is made between switched on and in operation. For example, a drive might be powered on but not operating. It is not intended for Devices always performing an activity like sensors always measuring data. This value shall only increase during the lifetime of the Device and shall not be reset when the Device is restarted. The OperationDuration is provided as Duration, i.e., in milliseconds or even fractions of a millisecond. However, the Server is not expected to update the value in such a high frequency, but maybe once a minute or once an hour, depending on the application. |
|
OperationCycleCounter |
OperationCycleCounter is counting the times the Device switches from not performing an activity to performing an activity. For example, each time a valve starts moving, is counted. This value shall only increase during the lifetime of the Device and shall not be reset when the Device is restarted. |
The SupportInfo Interface defines a number of additional data that a commonly exposed for Devices and their components. These include mainly images, documents, or protocol-specific data. The various types of information is organized into different folders. Each information element is represented by a readonly Variable. The information can be retrieved by reading the Variable value.
Figure 8 Illustrates the SupportInfo Interface. It is formally defined in Table 26.
Figure 8 – Support information Interface
Table 26 – ISupportInfoType definition
|
Attribute |
Value |
||||
|
BrowseName |
ISupportInfoType |
||||
|
IsAbstract |
True |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the BaseInterfaceType defined in OPC 10001-7 |
|||||
|
|
|
|
|
||
|
0:HasComponent |
Object |
DeviceTypeImage |
|
0:FolderType |
O |
|
0:HasComponent |
Object |
Documentation |
|
0:FolderType |
O |
|
0:HasComponent |
Object |
DocumentationFiles |
|
0:FolderType |
O |
|
0:HasComponent |
Object |
ProtocolSupport |
|
0:FolderType |
O |
|
0:HasComponent |
Object |
ImageSet |
|
0:FolderType |
O |
|
Conformance Units |
|||||
|
DI DeviceSupportInfo |
|||||
Clients need to be aware that the contents that these Variables represent may be large. Reading large values with a single Read operation may not be possible due to configured limits in either the Client or the Server stack. The default maximum size for an array of bytes is 1 megabyte. It is recommended that Clients use the IndexRange in the OPC UA Read Service (see OPC 10000-4) to read these Variables in chunks, for example, one-megabyte chunks. It is up to the Client whether it starts without an index and repeats with an IndexRange only after an error or whether it always uses an IndexRange.
The components of the ISupportInfoType have additional references as defined in Table 27.
Table 27 – ISupportInfoType Additional Subcomponents
|
Source Path |
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
DeviceTypeImage |
0:HasComponent |
Variable |
<ImageIdentifier> |
0:Image |
0:BaseDataVariableType |
MP |
|
Documentation |
0:HasComponent |
Variable |
<DocumentIdentifier> |
0:ByteString |
0:BaseDataVariableType |
MP |
|
DocumentationFiles |
0:HasComponent |
Object |
<DocumentFileId> |
|
0:FileType |
MP |
|
ProtocolSupport |
0:HasComponent |
Variable |
<ProtocolSupportIdentifier> |
0:ByteString |
0:BaseDataVariableType |
MP |
|
ImageSet |
0:HasComponent |
Variable |
<ImageIdentifier> |
0:Image |
0:BaseDataVariableType |
MP |
Pictures can be exposed as Variables organized in the DeviceTypeImage folder. There may be multiple images of different resolutions. Each image is a separate Variable.
All images are transferred as a ByteString. The DataType of the Variable specifies the image format. OPC UA defines BMP, GIF, JPG and PNG (see OPC 10000-3).
Documents in many cases will represent a product manual. They may be exposed as Variables or as FileType instances. Files are useful in particular for large documents.
- Documents as Variables are represented as a ByteString and organized in the Documentation folder. The BrowseName of each Node will consist of the filename including the extension that can be used to identify the document type. Typical extensions are “.pdf” or “.txt”.
- Documents as FileType instances are organized in the DocumentationFiles folder. They are retrieved from the Server by using the FileType Methods. It is recommended to use the MimeType Property to specify the media type of the file based on RFC 2046.
Protocol support files are exposed as Variables organized in the ProtocolSupport folder. They may represent various types of information as defined by a protocol. Examples are a GSD or a CFF file.
All protocol support files are transferred as a ByteString. The BrowseName of each Variable shall consist of the complete filename including the extension that can be used to identify the type of information.
Images that are used within UIElements are exposed as separate Variables rather than embedding them in the element. All image Variables will be aggregated by the ImageSet folder. The UIElement shall specify an image by its name that is also the BrowseName of the image Variable. Clients can cache images so they don't have to be transferred more than once.
The DataType of the Variable specifies the image format. OPC UA defines BMP, GIF, JPG and PNG (see OPC 10000-3).