8 Machine Identification and Nameplate ToC Previous Next

8.2 IMachineryItemVendorNameplateType ToC Previous Next

The IMachineryItemVendorNameplateType is a subtype of the 2:IVendorNameplateType defined in OPC 10000-100. It refines the semantics of the Properties defined in 2:IVendorNameplateType, makes some Properties mandatory and adds additional Properties. It is formally defined in Table 9.

Table 9 – IMachineryItemVendorNameplateType Definition

Attribute Value        
BrowseName IMachineryItemVendorNameplateType        
IsAbstract True        
Description Interface containing identification and nameplate information for a MachineryItem provided by the vendor        
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the 2:IVendorNameplateType defined in OPC 10000-100, i.e. inheriting the InstanceDeclarations of that Node.          
Properties of the 2:IVendorNameplateType          
0:HasProperty Variable 2:Manufacturer 0:LocalizedText 0:PropertyType M, RO
0:HasProperty Variable 2:SerialNumber 0:String 0:PropertyType M, RO
           
0:HasProperty Variable YearOfConstruction 0:UInt16 0:PropertyType O, RO
0:HasProperty Variable MonthOfConstruction 0:Byte 0:PropertyType O, RO
0:HasProperty Variable InitialOperationDate 0:DateTime 0:PropertyType O, RO

The mandatory 2:Manufacturer provides a human-readable, localized name of the manufacturer. It is defined by the 2:IVendorNameplateType. It is recommended to provide a language neutral LocalizedText. Clients shall not assume the uniqueness of the manufacturer based on this information, i.e. potentially several manufacturers use the same name. The value of this Property might change during the life-cycle of a MachineryItem, for example, when the name of the manufacturer changes due to an acquisition. The manufacturer might change this information, for example, within the next firmware update. Examples are “{“”,”TRUMPF”}” “{“”,”KUKA Deutschland GmbH”}”, “{“”, “ENGEL AUSTRIA GMBH”}”.

The mandatory 2:SerialNumber is a string containing a unique production number of the manufacturer of the MachineryItem. It is defined by the 2:IVendorNameplateType. The global uniqueness of the serial number is only given in the context of the manufacturer, and potentially the model. The value of this Property shall not change during the life-cycle of the MachineryItem. If a manufacturer internally does not manage serial numbers, as for example for special purpose machinery manufacturers, they could use for example the order number as serial number. Examples are: “A3231E001”, “643872”, “235223”.

The optional YearOfConstruction provides the year (Gregorian calendar) in which the manufacturing process of the MachineryItem has been completed. It shall be a four-digit number and never change during the life-cycle of a MachineryItem. For example: “2019”, “2020”.

The optional MonthOfConstruction provides the month in which the manufacturing process of the MachineryItem has been completed. It shall be a number between 1 and 12, representing the month from January to December. The MonthOfConstruction shall only be provided, if the YearOfConstruction is provided as well. For example, “1”, “2”, “3”.

The optional InitialOperationDate provides the date, when the MachineryItem was switched on the first time after it has left the manufacturer plant. The value of InitialOperationDate is not meant to provide any information about the state of warranty. If the date is not provided by the MachineryItem, the InitialOperationDate should not be added. For example: “2020-01-29T18:59:59Z”, “2022-11-1712:00:00Z”.

How the InitialOperationDate is set is vendor-specific. This might be done by some manual configuration or can be done automatically. If the InitialOperationDate is set automatically, the vendor needs to ensure, that it uses a coordinated system time.

The optional 2:ProductInstanceUri is a globally unique resource identifier provided by the manufacturer of the MachineryItem. It is defined by the 2:IVendorNameplateType. It is intended to uniquely identify the MachineryItem and shall not change during the life-cycle of the MachineryItem. The length is restricted to 255 characters and it is the responsibility of the manufacturer that the 2:ProductInstanceUri is globally unique. The recommended syntax of the 2:ProductInstanceUri is: <ManufacturerUri>/<any string>. The manufacturer might choose the serial number of the MachineryItem as <any string>, if the serial number is unique within the manufacturer’s scope, or a combination of model and serial number, if the serial number is only unique within a model. Examples are: “http://www.trumpf.com/A3231E001”, “http://www.kuka.com/#KR210R2700_EXTRA_C4_FLR/667659”, “http://www.engelglobal.com/Viper06/235223”.

The optional 2:ManufacturerUri is a globally unique identifier of the manufacturer of the MachineryItem. It is defined by the 2:IVendorNameplateType. It is intended to uniquely identify the manufacturer. It is the manufacturers responsibility to use the same identifier across its products. If the 2:ManufacturerUri is provided, it is recommended to be used as Prefix in the 2:ProductInstanceUri. As 2:ManufacturerUri is recommended to be used inside the 2:ProductInstanceUri, it shall not change during the life-cycle of the MachineryItem, even if the manufacturer changes its name, e.g. due to an acquisition. Examples are: “http://www.trumpf.com”, “http://www.kuka.com”, “http://www.engelglobal.com”.

The optional 2:Model provides a human-readable, localized name of the model of the MachineryItem. It is defined by the 2:IVendorNameplateInterfaceType. If there is no specific model, this Property should not be provided. If the physical nameplate on the MachineryItem provides a model, the Property shall be provided. It is recommended to provide a language neutral LocalizedText. Examples are “{“”,“TruLaser 5030 (L76)”}”, “{“”,“VC 200/50”}”, “{“”,”KR210R2700EXTRAC4FLR”}”, “{“”,”Viper 6”}”.

The optional 2:ProductCode provides a machine-readable string of the model of the MachineryItem, that might include options like the hardware configuration of the model. This information might be provided by the ERP system of the vendor. For example, it can be used as order information. It is defined by the 2:IVendorNameplateType. If no specific information is available, the Property should not be provided. The value of this Property shall not change during the life-cycle of the MachineryItem. Examples are “11182372”, “2377636”.

The optional 2:HardwareRevision provides a string representation of the revision level of the hardware of a MachineryItem. Hardware is physical equipment, as opposed to programs, procedures, rules and associated documentation (see IEC 61499-1, [2]). The Property is defined by the 2:IVendorNameplateType. Many Machines will not provide such information due to the modular and configurable nature of the Machine. The value of this Property might change during the life-cycle of a MachineryItem. Examples are: “01.33”, “A2”, “014/15120129-2018”.

The optional 2:SoftwareRevision provides a string representation of the revision level of a MachineryItem. It is defined by the 2:IVendorNameplateType. In most cases, MachineryItems consist of several software components. In that case, information about the software components might be provided as additional information in the AddressSpace, including individual revision information. The 2:SoftwareRevision is either not provided or provides an overall software revision level. The value of this Property might change during the life-cycle of a MachineryItem. Examples are: “PLL01 1.10.0.3” “V05.01.01.15”, “3.1 R1293”, “70.0.1”, “4.60.03”.

The optional Properties 2:DeviceRevision, 2:RevisionCounter and 2:DeviceManual defined by the 2:IVendorNameplateType are not further defined in this Interface.

The optional 2:DeviceClass, defined by the 2:IVendorNameplateType, should only be used, when a companion specification defines concrete values for specific MachineryItem classes. This specification does not define any values for this Property. Examples are: “Injection Moulding Machine”, “Drilling Machine”.

The InstanceDeclarations of the IMachineryItemVendorNameplateType have additional Attribute values defined in Table 10.

Table 10 – IMachineryItemVendorNameplateType Attribute values for child Nodes

Source Path Value Description
2:Manufacturer - A human-readable, localized name of the manufacturer of the MachineryItem.
2:SerialNumber - A string containing a unique production number of the manufacturer of the MachineryItem. The global uniqueness of the serial number is only given in the context of the manufacturer, and potentially the model. The value shall not change during the life-cycle of the MachineryItem.
YearOfConstruction - The year (Gregorian calendar) in which the manufacturing process of the MachineryItem has been completed. It shall be a four-digit number and never change during the life-cycle of a MachineryItem.
MonthOfConstruction - The month in which the manufacturing process of the MachineryItem has been completed. It shall be a number between 1 and 12, representing the month from January to December.
InitialOperationDate - The date, when the MachineryItem was switched on the first time after it has left the manufacturer plant.

Previous Next