The Object DocumentationRep is the sole repository for the machine module documentation resources. The DocumentationRep is accessed, for example, by clients and HMIs.

The Property MaterialLoadingPointsidentifies the loading points of the machine module and their capability in terms of what materials can be loaded at a loading point. The Property MaterialLoadingPointsis defined as a list of objects of type LoadUnloadPointType.

The type LoadUnloadPointTypeis defined in Table 21.

Table 21LoadUnloadPointTypeDefinition

Name

Type

Description

LoadUnloadPointType

Structure

Description of a loading/unloading point.

ID

String

Unique identifier for the loading/unloading point.

MES_ID

String

Unique identifier for the loading/unloading point for higher level systems, e.g. MES, ERP.

UserName

String

Name of the loading/unloading point given by the end user.

Description

LocalizedText

Human readable identification of the loading/unloading point.

MaterialCapability

MaterialType[]

List of materials that can be loaded to the machine at this loading point or list of materials that may be unloaded at this unloading point.

The type MaterialTypeis defined in Table 22.

Table 22MaterialTypeDefinition

Name

Type

Description

MaterialType

Structure

Description of a material.

Group

String

Material group of the material.

ID

String

Unique identifier for the material.

BatchID

String

Batch ID for the material. Can be empty (null) when the material is not batch managed.

Description

LocalizedText

Human readable identification of the material.

MES_ID

String

Material ID as stored in the MES/ERP system.

BaseUoM

EUInformation

The material base unit of measure. For each material one single base unit of measure is defined.

The Property MaterialStorageBuffersdescribes the buffers inside the machine module and their current status. The Property MaterialStorageBuffersis a list of objects of type MaterialStorageBufferDataType.

The type MaterialStorageBufferDataTypeis defined in Table 23.

Table 23MaterialStorageBufferDataTypeDefinition

Name

Type

Description

MaterialStorageBufferDataType

Structure

Description of a material storage buffer.

ID

String

Unique identifier for the storage buffer.

MES_ID

String

Unique identifier for the storage buffer for a higher level system, e.g. MES, ERP.

StoredMaterial

MaterialType

The material that is stored in the buffer.

EngineeringUnits

EUInformation

Unit of measure

TotalStorageCapacity

Double

The maximum quantity that can be stored in the buffer in the EngineeringUnits unit of measure.

StorageLogic

StorageLogicEnumeration

The way the storage is loaded/unloaded.

The type MaterialTypeis defined in Table 22. The StorageLogicEnumeration is defined in Table 24.

Table 24StorageLogicEnumerationDefinition

Enumstring

Value

Description

Other

0

None of the below.

FIFO

1

The first product entering the storage buffer is the first to leave the storage buffer.

LIFO

2

The last product entering the storage buffer is the first to leave the storage buffer.

FEFO

3

The first expired material is the first to leave the storage buffer.

The Property TotalRunningHourscounts the number of hours the machine module has been in operation since the last time its configuration was changed. More specifically, time is counted when the machine module state is different from: Stopping, Stopped, Aborting, Aborted, Clearing.

The Value of the Property TotalRunningHoursshall be persisted both in the OPC UA Server and in the underlying system so that if one fails and/or is replaced, the other will allow restoring the Value when the OPC UA Server and underlying system are on separate hardware infrastructure.

The Property ValidSinceis the date since the configuration was last modified.

The Method LoadMachineModuleDocumentationallows to securely load any machine module documentation to the documentation repository DocumentationRepfolder where it can be reached by applications.

Signature

LoadMachineModuleDocumentation(

[in]ByteString DocumentToBeLoaded

[out]MethodExecutionFeedbackType ExecutionFeedback

);

Argument

Description

DocumentToBeLoaded

The document, as a byte string, to be transferred to the DocumentationRep folder.

ExecutionFeedback

The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

The Method SetNewSpecificationsaves its arguments as the new specification for the machine module. Prior to that it saves the previous specification into the PastSpecification RecordsObject of the same machine module.

Signature

SetNewSpecification(

[in]LoadUnloadPointType[] NewMaterialLoadingPoints

[in]MaterialStorageBufferDataType[] NewMaterialStorageBuffers

[out]MethodExecutionFeedbackType ExecutionFeedback

);

ResultCode

Description

BadNodeIdUnknown

See table 173 in OPC 10000-4 for the description of these result codes.

BadTypeMismatch

BadOutOfRange

BadNotWritable

BadNotFound

Argument

Description

NewMaterialLoadingPoints

The information about the material loading points that will be valid after the machine specification is changed.

NewMaterialStorageBuffers

The information about the storage buffers that will be valid after the machine specification is changed.

ExecutionFeedback

The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

Please report errors or issues with the site to webmaster.

Copyright © 2022 - OPC Foundation

ResultCode

Description

BadNodeIdUnknown

See table 173 in OPC 10000-4 for the description of these result codes.

BadTypeMismatch

BadOutOfRange

BadNotWritable

BadNotFound