1 Scope
This document provides additional information regarding the Roof Support System within the context of the OPC UA information models for Mining. OPC 40565-2 describes the data exchange for Roof Support System as a part of the Development and Support equipment.
2 Normative references
The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments and errata) applies.
OPC 10000-1, OPC Unified Architecture - Part 1: Overview and Concepts
OPC 10000-1
OPC 10000-2, OPC Unified Architecture - Part 2: Security Model
OPC 10000-2
OPC 10000-3, OPC Unified Architecture - Part 3: Address Space Model
OPC 10000-3
OPC 10000-4, OPC Unified Architecture - Part 4: Services
OPC 10000-4
OPC 10000-5, OPC Unified Architecture - Part 5: Information Model
OPC 10000-5
OPC 10000-6, OPC Unified Architecture - Part 6: Mappings
OPC 10000-6
OPC 10000-7, OPC Unified Architecture - Part 7: Profiles
OPC 10000-7
OPC 10000-100, OPC Unified Architecture - Part 100: Devices
OPC 10000-100
OPC 40001-1, OPC UA for Machinery - Part 1: Basic Building Blocks
http://www.opcfoundation.org/UA/Machinery/
OPC 40560, OPC Unified Architecture for Mining - General
http://opcfoundation.org/UA/Mining/General/
OPC 40565-1, OPC Unified Architecture for Mining – Development and Support Equipment: General
http://opcfoundation.org/UA/Mining/DevelopmentSupport/General/
3 Terms, definitions and conventions
3.1 Overview
It is assumed that basic concepts of OPC UA information modelling OPC 10000-1, OPC 10000-100, and OPC 40001‑1 are understood in this document. This document will use these concepts to describe the OPC 40565-2 Information Model. For the purposes of this document, the terms and definitions given in the documents referenced in the OPC Core documents, OPC 10000-1, OPC 10000-100, OPC 40001-1, OPC 40560 and OPC 40565-1 apply.
Note that OPC UA terms and terms defined in this specification are italicized in the specification.
3.2 Abbreviated terms
| RSS | Roof Support System |
| AFC | Armoured Face Conveyor |
3.3 Conventions used in this document
The conventions and definitions described in the OPC Core documents, OPC 10000-1, OPC 10000-100, OPC 40001-1, OPC 40560, OPC 40569-1 and OPC 40565-1 apply.
4 General information to OPC 40565-2: Roof Support System
4.1 Introduction to the OPC UA Companion Specification Mining
For general information on the OPC UA Companion Specification Mining and OPC UA in general, please refer to OPC 40560.
As explained in OPC 40560, the machine and system category-level documents serve as an abstraction layer for the types of machinery with similar functionalities. Consequently, this machine and system-level document may also rely on models defined in OPC 40565-1.
4.2 Introduction to OPC Unified Architecture
The main components of the roof support system are the different types of shields used in longwall mining operations to guard personnel and machines from a collapsing roof. The combination of Shearer, Armoured Face Conveyor and Roof Support Shields is commonly used in longwall mining operations. The shields close the gap which is generated by the extraction cycles of the Shearer. After the Shearer passes a shield or group of shields, the gap is closed by moving the shields towards the coal face using hydraulic force. It is possible also to move each shield separately. [1, P. 1409]
This document contains OPC UA type definitions for the Roof Support System.
5 Use Cases and Scope of Information Exchange
As outlined in OPC 40560, OPC UA type definitions and data items contained in this OPC UA Companion Specification are based on the Use Cases developed for the Application Case Longwall Operation by a Specialist Working Group. The Use Cases of the RSS, within the context of underground longwall operation, are explained in detail in OPC 40569-1. Please refer to this document to gain an overview of longwall mining Use Cases for this system as well as to study detailed descriptions of the Use Cases.
As a core feature, OPC UA offers the possibility to extend and complement type definitions. Therefore, the type definitions developed for the RSS only contain the minimum amount of data elements, such as variables and methods, necessary for the Use Cases described in OPC 40569-1. Manufacturers and mine operators are advised to extend the type definitions defined in this document, e.g. using inheritance, to adapt the type definitions to their individual requirements. This typically includes adding custom variables or alarms to type definitions derived from the ones specified in this document.
Thus, the scope of this document is to define the basic elements of data that are necessary for operation of the RSS and parameters of the RSS that are required by other longwall components as defined in OPC 40569-1. These include, for example:
Push State of the AFC
Shield Advance State
Shield Width
A precise overview of the data contained in the OPC 40565-2 Information Model is given in Chapter 6.
The following information sources are excluded and may be added by manufacturers or mine operators using custom type definitions derived from the ones presented in this document:
Real-time sensor data (e.g. temperature, pressure, current)
Tele-remote control signals (e.g. start, stop, tram)
Alarms and events (e.g. current tripping alarm, temperature warning)
Custom state machines
6 OPC UA ObjectTypes
6.1 RoofSupportSystemType ObjectType
6.1.1 Overview
The RoofSupportSystemType provides a representation of a roof support system as a sub-type of MiningEquipmentType as shown in Figure 1. Importantly, it is composed of a ParameterSet to monitor all relevant parameters of the equipment.
6.1.2 ObjectType Definition
The RoofSupportSystemType is formally defined in Table 1.
| Attribute | Value | ||||
| BrowseName | RoofSupportSystemType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | Data Type | TypeDefinition | Others |
|---|---|---|---|---|---|
| Subtype of the MiningEquipmentType defined in OPC 40560 | |||||
| 0:HasAddIn | Object | 4:MiningEquipmentIdentification | 4:MiningEquipmentIdentificationType | M | |
| 0:HasComponent | Object | 2:ParameterSet | 0:BaseObjectType | M | |
| Conformance Units | |||||
|---|---|---|---|---|---|
| RSS Functional Variables | |||||
| RSS Methods |
The components of the RoofSupportSystemType have subcomponents which are defined in Table 2.
| BrowsePath | References | NodeClass | BrowseName | DataType | TypeDefinition | Others |
| 2:ParameterSet | 0:HasComponent | Variable | AFCPushState | RSSStateEnum | 0:BaseDataVariableType | M, RO |
| 2:ParameterSet | 0:HasComponent | Variable | ClearanceLeft | 0:Double | 0:AnalogUnitRangeType | M, RO |
| 2:ParameterSet | 0:HasComponent | Variable | ClearanceRight | 0:Double | 0:AnalogUnitRangeType | M, RO |
| 2:ParameterSet | 0:HasComponent | Variable | ShieldAdvanceState | RSSStateEnum | 0:BaseDataVariableType | M, RO |
| 2:ParameterSet | 0:HasComponent | Variable | ShieldWidth | 0:Double | 0:AnalogUnitRangeType | M, RO |
The component Variables of the RoofSupportSystemType have additional Attributes defined in Table 3.
| BrowsePath | Value Attribute | Description Attribute |
NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact UnitId: 5067858 DisplayName: m Description: metre | This is the EngineeringUnit of the left clearance. | |
| High: 500 Low: -10 | This is the EURange of the left clearance. | |
NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact UnitId: 5067858 DisplayName: m Description: metre | This is the EngineeringUnit of the right clearance. | |
| High: 500 Low: -10 | This is the EURange of the right clearance. | |
NamespaceUri: http://www.opcfoundation.org/UA/units/un/cefact UnitId: 5067858 DisplayName: m Description: metre | This is the EngineeringUnit of the shield width. | |
| High: 5 Low: 0.5 | This is the EURange of the shield width. |
6.1.3 ObjectType Description
The AFCPushState Variable describes the status of the AFCPush process determined on the actual shearer position
The ClearanceLeft Variable describes the length of the safe zone on the left side of the shearer. There is no risk of collision between the shearer and the RSS in that zone.
The ClearanceRight Variable describes the length of the safe zone on the right side of the shearer. There is no risk of collision between the shearer and the RSS in that zone
The ShieldAdvanceState Variable describes the status of the ShieldAdvance process determined on the actual shearer position.
The ShieldWidth Variable describes the width of the shields including the gap between the shields.
Please refer to OPC 10000-100, OPC 40001-1, OPC 40560 and OPC 40565-1 for the descriptions of other inherited instance declarations.
7 OPC UA DataTypes
7.1 RSSStateEnum
This enumeration defines the states of the RSS. The enumeration is defined in Table 4.
| Name | Value | Description |
|---|---|---|
| UNDEFINED | 0 | Enum value indicating an undefined RSS push operation stage |
| ONGOING | 1 | Enum value indicating an ongoing RSS push operation |
| ERROR | 2 | Enum value indicating an erroneous RSS push operation |
| FINISHED | 3 | Enum value indicating a finished RSS push operation |
Its representation in the AddressSpace is defined in Table 5.
| Attribute | Value | |||||
| BrowseName | RSSStateEnum | |||||
| IsAbstract | False | |||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | Other | |
|---|---|---|---|---|---|---|
| Subtype of the Enumeration type defined in OPC 10000-5 | ||||||
| 0:HasProperty | Variable | 0:EnumValues | 0:EnumValueType[] | 0:PropertyType | ||
8 Profiles and Conformance Units
This chapter defines the corresponding profiles and conformance units for the OPC UA Information Model for OPC 40565-2. Profiles are named groupings of conformance units. Facets are profiles that will be combined with other Profiles to define the complete functionality of an OPC UA Server or Client. The following tables specify the facets available for Servers that implement the OPC 40565-2 Information Model companion specification.
NOTE: The names of the supported profiles are available in the Server Object under ServerCapabilities.ServerProfileArray.
8.1 Conformance Units
Table 6 defines the corresponding Conformance Units for the OPC UA Information Model for OPC 40565-2: RSS.
| Category | Title | Description |
| Server | RSS Functional Variables | Supports all mandatory variables part of the RoofSupportSystemlType type definition. |
| Client | RSS Client Functional Variables | Supports querying all mandatory variables part of the RoofSupportSystemlType type definition. |
8.2 Profiles
8.2.1 Profile list
Table 7 lists all Profiles defined in this document and defines their URIs.
| Profile | URI |
| RSS Core Server Facet | http://opcfoundation.org/UA-Profile/Mining/DevelopmentSupport/RoofSupportSystem/Server/Core |
| RSS Core Client Facet | http://opcfoundation.org/UA-Profile/Mining/DevelopmentSupport/RoofSupportSystem/Client/Core |
8.2.2 Server Facets
8.2.2.1 Overview
The following sections specify the Facets available for Servers that implement the RSS companion specification. Each section defines and describes a Facet or Profile.
8.2.2.2 RSS Core Server Facet
Table 8 defines a Profile that describes the base characteristics for an OPC UA Server that has implemented the OPC 40565-2 Information Model.
| Group | Conformance Unit / Profile Title | Mandatory / Optional |
| RSS | RSS Functional Variables | M |
8.2.3 Client Facets
8.2.3.1 Overview
The following tables specify the Facets available for Clients that implement the RSS companion specification.
8.2.3.2 RSS Core Client Facet
Table 9 defines a Facet that describes the base characteristics for an OPC UA Client querying an OPC UA Server that has implemented the OPC 40565-2 Information Model.
| Group | Conformance Unit / Profile Title | Mandatory / Optional |
| RSS | RSS Client Functional Variables | M |
9 Namespaces
9.1 Namespace Metadata
Table 10 defines the namespace metadata for this document. The Object is used to provide version information for the namespace and an indication about static Nodes. Static Nodes are identical for all Attributes in all Servers, including the Value Attribute. See OPC 10000-5 for more details.
The information is provided as Object of type NamespaceMetadataType. This Object is a component of the Namespaces Object that is part of the Server Object. The NamespaceMetadataType ObjectType and its Properties are defined in OPC 10000-5.
The version information is also provided as part of the ModelTableEntry in the UANodeSet XML file. The UANodeSet XML schema is defined in OPC 10000-6.
| Attribute | Value | ||
| BrowseName | http://opcfoundation.org/UA/Mining/DevelopmentSupport/RoofSupportSystem/ | ||
| Property | DataType | Value | |
|---|---|---|---|
| NamespaceUri | String | http://opcfoundation.org/UA/Mining/DevelopmentSupport/RoofSupportSystem/ | |
| NamespaceVersion | String | 1.0.0 | |
| NamespacePublicationDate | DateTime | 2022-09-01 | |
| IsNamespaceSubset | Boolean | False | |
| StaticNodeIdTypes | IdType [] | System.Int32[] | |
| StaticNumericNodeIdRange | NumericRange [] | ||
| StaticStringNodeIdPattern | String | ||
Note: The IsNamespaceSubset Property is set to False as the UaNodeSet XML file contains the complete Namespace. Servers only exposing a subset of the Namespace need to change the value to True.
9.2 Handling of OPC UA Namespaces
Namespaces are used by OPC UA to create unique identifiers across different naming authorities. The Attributes NodeId and BrowseName are identifiers. A Node in the UA AddressSpace is unambiguously identified using a NodeId. Unlike NodeIds, the BrowseName cannot be used to unambiguously identify a Node. Different Nodes may have the same BrowseName. They are used to build a browse path between two Nodes or to define a standard Property.
Servers may often choose to use the same namespace for the NodeId and the BrowseName. However, if they want to provide a standard Property, its BrowseName shall have the namespace of the standards body although the namespace of the NodeId reflects something else, for example the EngineeringUnits Property. All NodeIds of Nodes not defined in this document shall not use the standard namespaces.
provides a list of mandatory and optional namespaces used in an 40565-2 OPC UA Server. provides a list of mandatory and optional namespaces used in an 40565-2 OPC UA Server.
| NamespaceURI | Description | Use |
| http://opcfoundation.org/UA/ | Namespace for NodeIds and BrowseNames defined in the OPC UA specification. This namespace shall have namespace index 0. | Mandatory |
| Local Server URI | Namespace for nodes defined in the local server. This namespace shall have namespace index 1. | Mandatory |
| http://opcfoundation.org/UA/DI/ | Namespace for NodeIds and BrowseNames defined in OPC 10000-100. The namespace index is Server specific. | Mandatory |
| http://opcfoundation.org/UAMachinery/ | Namespace for NodeIds and BrowseNames defined in OPC 40001-1. The namespace index is Server specific. | Mandatory |
| http://opcfoundation.org/UA/Mining/General/ | Namespace for NodeIds and BrowseNames defined in OPC 40560. The namespace index is Server specific. | Mandatory |
| http://opcfoundation.org/UA/Mining/DevelopmentSupport/General/ | Namespace for NodeIds and BrowseNames defined in OPC 40565-1. The namespace index is Server specific. | Mandatory |
| http://opcfoundation.org/UA/Mining/DevelopmentSupport/RoofSupportSystem/ | Namespace for NodeIds and BrowseNames defined in this document. The namespace index is Server specific. | Mandatory |
| Vendor specific types | A Server may provide vendor-specific types like types derived from ObjectTypes defined in this document in a vendor-specific namespace. | Optional |
| Vendor specific instances | A Server provides vendor-specific instances of the standard types or vendor-specific instances of vendor-specific types in a vendor-specific namespace. It is recommended to separate vendor specific types and vendor specific instances into two or more namespaces. | Mandatory |
Table 11 provides a list of namespaces and their indices used for BrowseNames in this document. The default namespace of this document is not listed since all BrowseNames without prefix use this default namespace.
| NamespaceURI | Namespace Index | Example |
| http://opcfoundation.org/UA/ | 0 | 0:EngineeringUnits |
| http://opcfoundation.org/UA/DI/ | 2 | 2:DeviceRevision |
| http://opcfoundation.org/UA/Machinery/ | 3 | 3:MachineComponentsType |
| http://opcfoundation.org/UA/Mining/General/ | 4 | 4:MiningEquipmentType |
| http://opcfoundation.org/UA/Mining/DevelopmentSupport/General/ | 5 |
Annex A OPC 40565-2 Namespace and mappings (Normative)
A.1 Namespace and identifiers for OPC 40565-2 Information Model
This appendix defines the numeric identifiers for all of the numeric NodeIds defined in this document. The identifiers are specified in a CSV file with the following syntax:
<SymbolName>, <Identifier>, <NodeClass>Where the SymbolName is either the BrowseName of a Type Node or the BrowsePath for an Instance Node that appears in the specification and the Identifier is the numeric value for the NodeId.
The BrowsePath for an Instance Node is constructed by appending the BrowseName of the instance Node to the BrowseName for the containing instance or type. An underscore character is used to separate each BrowseName in the path. Let’s take for example, the MiningEquipmentType ObjectType Node which has the add-in Identification object. The Name for the Identification InstanceDeclaration within the MiningEquipmentType declaration is: MiningEquipmentType_Identification.
The NamespaceUri for all NodeIds defined here is:
http://opcfoundation.org/UA/Mining/DevelopmentSupport/RoofSupportSystem/
The CSV released with this version of the specification can be found here:
http://opcfoundation.org/UA/schemas/Mining/DevelopmentSupport/RoofSupportSystem/1.0.0/NodeIds.csv
NOTE The latest CSV that is compatible with this version of the specification can be found here:
http://opcfoundation.org/UA/schemas/Mining/DevelopmentSupport/RoofSupportSystem/NodeIds.csv
A computer processible version of the complete Information Model defined in this document is also provided. It follows the XML Information Model schema syntax defined in OPC 10000-6.
The Information Model Schema for this version of the specification (including any revisions, amendments or errata) can be found here:
http://opcfoundation.org/UA/schemas/Mining/DevelopmentSupport/RoofSupportSystem/1.0.0/opc.ua.mining.devlopmentsupport.roofsupportsystem.NodeSet2.xml
NOTE The latest Information Model schema that is compatible with this version of the document can be found here:
http://opcfoundation.org/UA/schemas/Mining/DevelopmentSupport/RoofSupportSystem/opc.ua.mining.developmentsupport.roofsupportsystem.NodeSet2.xml
Annex B Annex B Bibliography (Informative)
[1] DARLING, P., 2011. SME Mining Engineering Handbook [online]. 3rd ed.
___________
Agreement of Use
COPYRIGHT RESTRICTIONS
This document is provided "as is" by the OPC Foundation and VDMA.
Right of use for this specification is restricted to this specification and does not grant rights of use for referred documents.
Right of use for this specification will be granted without cost.
This document may be distributed through computer systems, printed or copied as long as the content remains unchanged and the document is not modified.
OPC Foundation and VDMA do not guarantee usability for any purpose and shall not be made liable for any case using the content of this document.
The user of the document agrees to indemnify OPC Foundation and VDMA and their officers, directors and agents harmless from all demands, claims, actions, losses, damages (including damages from personal injuries), costs and expenses (including attorneys' fees) which are in any way related to activities associated with its use of content from this specification.
The document shall not be used in conjunction with company advertising, shall not be sold or licensed to any party.
The intellectual property and copyright is solely owned by the OPC Foundation and VDMA.
PATENTS
The attention of adopters is directed to the possibility that compliance with or adoption of OPC or VDMA specifications may require use of an invention covered by patent rights. OPC Foundation or VDMA shall not be responsible for identifying patents for which a license may be required by any OPC or VDMA specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. OPC or VDMA specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents.
WARRANTY AND LIABILITY DISCLAIMERS
WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED "AS IS" AND MAY CONTAIN ERRORS OR MISPRINTS. THE OPC FOUDATION NOR VDMA MAKES NO WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, WITH REGARD TO THIS PUBLICATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE. IN NO EVENT SHALL THE OPC FOUNDATION NOR VDMA BE LIABLE FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, RELIANCE OR COVER DAMAGES, INCLUDING LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
The entire risk as to the quality and performance of software developed using this specification is borne by you.
RESTRICTED RIGHTS LEGEND
This Specification is provided with Restricted Rights. Use, duplication or disclosure by the U.S. government is subject to restrictions as set forth in (a) this Agreement pursuant to DFARs 227.7202-3(a); (b) subparagraph (c)(1)(i) of the Rights in Technical Data and Computer Software clause at DFARs 252.227-7013; or (c) the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2), as applicable. Contractor / manufacturer are the OPC Foundation, 16101 N. 82nd Street, Suite 3B, Scottsdale, AZ, 85260-1830
COMPLIANCE
The combination of VDMA and OPC Foundation shall at all times be the sole entities that may authorize developers, suppliers and sellers of hardware and software to use certification marks, trademarks or other special designations to indicate compliance with these materials as specified within this document. Products developed using this specification may claim compliance or conformance with this specification if and only if the software satisfactorily meets the certification requirements set by VDMA or the OPC Foundation. Products that do not meet these requirements may claim only that the product was based on this specification and must not claim compliance or conformance with this specification.
TRADEMARKS
Most computer and software brand names have trademarks or registered trademarks. The individual trademarks have not been listed here.
GENERAL PROVISIONS
Should any provision of this Agreement be held to be void, invalid, unenforceable or illegal by a court, the validity and enforceability of the other provisions shall not be affected thereby.
This Agreement shall be governed by and construed under the laws of Germany.
This Agreement embodies the entire understanding between the parties with respect to, and supersedes any prior understanding or agreement (oral or written) relating to, this specification.