Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
OPC UA Communication
Title IndraWorks
OPC UA Communication
Table of Contents
Table of Contents
Page
Table of Contents
Page
5.7 Write..................................................................................................................................................... 46
6 Discovery..................................................................................................................... 47
6.1 General information.............................................................................................................................. 47
6.2 Discovery server................................................................................................................................... 47
6.3 OPC UA server of the XLC/MLC and MTX........................................................................................... 47
6.3.1 General information........................................................................................................................... 47
6.3.2 Enabling the discovery mechanisms of the OPC UA server for the MTX.......................................... 48
6.3.3 Enabling the discovery mechanisms of the OPC UA server for XLC/MLC........................................ 49
7 DiagnosisLogbook....................................................................................................... 51
7.1 General information.............................................................................................................................. 51
7.2 Type description................................................................................................................................... 51
7.2.1 Overview............................................................................................................................................ 51
7.2.2 AutomationConditionType................................................................................................................. 52
7.2.3 AutomationWarningType................................................................................................................... 53
7.2.4 AutomationErrorType........................................................................................................................ 53
7.2.5 AutomationDiscreteAlarmType.......................................................................................................... 53
7.2.6 DiscreteAlarmType............................................................................................................................ 54
7.2.7 ConditionType................................................................................................................................... 54
7.2.8 BaseEventType................................................................................................................................. 56
7.3 Object description................................................................................................................................. 57
8 Type plate.................................................................................................................... 59
8.1 General information.............................................................................................................................. 59
8.2 Type description................................................................................................................................... 59
8.2.1 Overview............................................................................................................................................ 59
8.2.2 RexrothDeviceType........................................................................................................................... 60
8.2.3 ComponentType................................................................................................................................ 62
8.2.4 SoftwareComponentType.................................................................................................................. 63
8.2.5 HardwareComponentType................................................................................................................ 63
8.3 Object description................................................................................................................................. 64
8.3.1 General information........................................................................................................................... 64
8.3.2 Example............................................................................................................................................. 64
8.3.3 Example HardwareComponentSet.................................................................................................... 65
8.3.4 Example CML65................................................................................................................................ 65
9 File system................................................................................................................... 67
9.1 General information.............................................................................................................................. 67
9.2 Type description................................................................................................................................... 67
9.2.1 Overview............................................................................................................................................ 67
9.2.2 AutomationFileType........................................................................................................................... 68
9.2.3 FileStatusType................................................................................................................................... 69
9.2.4 FileDirectoryType.............................................................................................................................. 70
9.3 File system in the OPC UA address space........................................................................................... 70
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG III/137
IndraWorks OPC UA Communication
Table of Contents
Page
9.4 Methods of the AutomationFileType..................................................................................................... 71
9.4.1 Open.................................................................................................................................................. 71
9.4.2 Close................................................................................................................................................. 72
9.4.3 Read.................................................................................................................................................. 72
9.4.4 Write.................................................................................................................................................. 72
9.4.5 GetPosition........................................................................................................................................ 72
9.4.6 SetPosition........................................................................................................................................ 73
9.4.7 SetAccessRight................................................................................................................................. 73
9.4.8 SetTime............................................................................................................................................. 73
9.5 Methods of the FileDirectoryType......................................................................................................... 73
9.5.1 CreateDirectory................................................................................................................................. 73
9.5.2 CreateFile.......................................................................................................................................... 74
9.5.3 Delete................................................................................................................................................ 74
9.5.4 MoveOrCopy..................................................................................................................................... 74
9.6 Variables of the AutomationFileType.................................................................................................... 75
9.6.1 Size.................................................................................................................................................... 75
9.6.2 Writable............................................................................................................................................. 75
9.6.3 UserWritable...................................................................................................................................... 75
9.6.4 OpenCount........................................................................................................................................ 75
9.6.5 MimeType.......................................................................................................................................... 75
9.6.6 Status................................................................................................................................................ 75
10 CNC items.................................................................................................................... 77
10.1 General information.............................................................................................................................. 77
10.2 Type description................................................................................................................................... 77
10.2.1 General description of complex types............................................................................................... 77
10.2.2 OptionSetType for bit masks............................................................................................................. 77
10.3 Real-time items..................................................................................................................................... 78
10.3.1 NC.DataRT........................................................................................................................................ 78
10.3.2 NC.AxisPosRT................................................................................................................................... 79
10.3.3 NC.DataRTDiag................................................................................................................................. 80
10.3.4 NC.AxisPosRTDiag........................................................................................................................... 81
10.4 Spindle items........................................................................................................................................ 81
10.4.1 NC.Chan.ActSpindleSpeed............................................................................................................... 81
10.4.2 NC.Chan.ActSpindleOverride............................................................................................................ 81
10.4.3 NC.Chan.ActSpindleSpeedDrv.......................................................................................................... 82
10.4.4 NC.Chan.ActSpindleTorque.............................................................................................................. 82
10.4.5 NC.Chan.ActSpindlePower............................................................................................................... 83
10.4.6 NC.Chan.ProgrammedSpindleSpeed................................................................................................ 83
10.4.7 NC.Chan.ActSpindleMovements....................................................................................................... 84
10.4.8 NC.Chan.ActSpindleGears................................................................................................................ 84
10.4.9 NC.Chan.ActSpindleAutoGears........................................................................................................ 85
10.4.10 NC.Chan.ActSpindleSwitchGears..................................................................................................... 85
10.4.11 NC.Chan.ActSpindlePosition............................................................................................................. 86
10.5 Program-data items.............................................................................................................................. 86
10.5.1 NC.Chan.ProgramLinkInfo................................................................................................................ 86
IV/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
Table of Contents
Page
10.5.2 NC.Chan.ActNcBlock........................................................................................................................ 87
10.5.3 NC.Chan.ProgramPosition................................................................................................................ 87
10.5.4 NC.Chan.WaitingStates..................................................................................................................... 87
10.5.5 NC.Chan.ProgrammedFeedrateIndex............................................................................................... 88
10.5.6 NC.Chan.ChanHidden....................................................................................................................... 88
10.5.7 NC.Chan.AxisRotate......................................................................................................................... 88
10.5.8 NC.Chan.AxisPoleSet....................................................................................................................... 88
10.5.9 NC.Chan.AxisShift............................................................................................................................. 88
10.5.10 NC.Chan.AxisScale........................................................................................................................... 89
10.5.11 NC.Chan.AxisMirror........................................................................................................................... 89
10.5.12 NC.Chan.ActAxisVelocityMax........................................................................................................... 89
10.5.13 NC.Chan.ActAxisVelocityPeak.......................................................................................................... 90
10.5.14 NC.Chan.ActAxisAccelerationPeak................................................................................................... 90
10.5.15 NC.Chan.BalancedConditionState.................................................................................................... 91
10.5.16 NC.Chan.CompTempData................................................................................................................ 91
10.5.17 NC.Chan.CompLeadScrewErrData................................................................................................... 91
10.5.18 NC.Chan.CompCrossData................................................................................................................ 91
10.5.19 NC.Chan.CompOffsetData................................................................................................................ 91
10.6 System data.......................................................................................................................................... 92
10.6.1 NC.SystemData................................................................................................................................. 92
10.6.2 NC.SystemDataXml........................................................................................................................... 92
10.7 CPL data............................................................................................................................................... 93
10.7.1 NC.CplPermVariable......................................................................................................................... 93
10.7.2 NC.CplPermVariable,PermVars........................................................................................................ 93
10.7.3 NC.CplPermVariable,DefPermVars................................................................................................... 94
10.8 Configuration data................................................................................................................................ 94
10.8.1 NC.CfgDataXml................................................................................................................................. 94
10.9 Global NC data..................................................................................................................................... 94
10.9.1 NC.BitInterface.................................................................................................................................. 94
10.9.2 NC.TestMode.................................................................................................................................... 96
10.10 Channel-dependent NC data................................................................................................................ 97
10.10.1 NC.Chan.ChanState.......................................................................................................................... 97
10.10.2 NC.Chan.OperationState................................................................................................................. 100
10.10.3 NC.Chan.ModeOfOperation............................................................................................................ 100
10.10.4 NC.Chan.OperationMode................................................................................................................ 101
10.10.5 NC.Chan.ProgramWindow.............................................................................................................. 101
10.10.6 NC.Chan.ActCallChain.................................................................................................................... 102
10.10.7 NC.Chan.ProgramPosition.............................................................................................................. 103
10.10.8 NC.Chan.ActSubProgram............................................................................................................... 104
10.10.9 NC.Chan.ActSubProgramVersion................................................................................................... 104
10.10.10 NC.Chan.ActMainProgram.............................................................................................................. 105
10.10.11 NC.Chan.AxisPosAcs...................................................................................................................... 105
10.10.12 NC.Chan.AxisPosAcsCoupl............................................................................................................ 107
10.10.13 NC.Chan.AxisPosAcsDrv................................................................................................................ 107
10.10.14 NC.Chan.AxisPosDistAcs................................................................................................................ 107
10.10.15 NC.Chan.AxisPosLag...................................................................................................................... 107
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG V/137
IndraWorks OPC UA Communication
Table of Contents
Page
10.10.16 NC.Chan.AxisPosWcs..................................................................................................................... 107
10.10.17 NC.Chan.AxisPosDistWcs............................................................................................................... 107
10.10.18 NC.Chan.AxisPosEndWcs.............................................................................................................. 107
10.10.19 NC.Chan.AxisPosWcsDrv............................................................................................................... 107
10.10.20 NC.Chan.AxisPosProg.................................................................................................................... 107
10.10.21 NC.Chan.AxisPosMcs..................................................................................................................... 107
10.10.22 NC.Chan.AxisPosDistMcs............................................................................................................... 107
10.10.23 NC.Chan.AxisPosBcs...................................................................................................................... 107
10.10.24 NC.Chan.AxisPosBcsDrv................................................................................................................ 107
10.10.25 NC.Chan.ActZeroOffsetSum........................................................................................................... 108
10.10.26 NC.Chan.ActDCorrectionValues..................................................................................................... 108
10.10.27 NC.Chan.ActOnlineCorrValue......................................................................................................... 109
10.10.28 NC.Chan.ActPlacementBcrCorr...................................................................................................... 109
10.10.29 NC.Chan.ActPlacementData........................................................................................................... 110
10.10.30 NC.Chan.ActPlacementSumData.................................................................................................... 110
10.10.31 NC.Chan.ActToolCorrectionValues................................................................................................. 111
10.10.32 NC.Chan.ActAxisOffsetTable.......................................................................................................... 111
10.10.33 NC.Chan.ActDCorrectionNmb......................................................................................................... 112
10.10.34 NC.Chan.ActDCorrectionTable....................................................................................................... 112
10.10.35 NC.Chan.ActPlacementTable.......................................................................................................... 112
10.10.36 NC.Chan.ActFeedOverride.............................................................................................................. 113
10.10.37 NC.Chan.ActFeedrate..................................................................................................................... 113
10.10.38 NC.Chan.ProgrammedFeedrate...................................................................................................... 114
10.10.39 NC.Chan.TestMode......................................................................................................................... 114
10.10.40 NC.Chan.TestFeed.......................................................................................................................... 115
10.10.41 NC.Chan.TestRapidTraverse.......................................................................................................... 115
10.10.42 NC.Chan.SkipBlock......................................................................................................................... 115
10.10.43 NC.Chan.OptionalStop.................................................................................................................... 116
10.10.44 NC.Chan.ReentryChain (ab 14V22)................................................................................................ 116
10.11 Tables based on databases................................................................................................................ 117
10.11.1 NC.DbTableDataRec....................................................................................................................... 117
10.11.2 NC.DbTableEvent............................................................................................................................ 117
10.11.3 NC.DbTableQuery........................................................................................................................... 118
10.12 File-based tables (from 14V22).......................................................................................................... 119
10.12.1 NC.FileTable variable...................................................................................................................... 119
10.12.2 NC.FileTable object......................................................................................................................... 120
10.12.3 AddSet method................................................................................................................................ 121
10.12.4 Methode DeleteSet.......................................................................................................................... 121
10.12.5 Methode InsertAxis.......................................................................................................................... 121
10.12.6 Methode DeleteAxis........................................................................................................................ 122
10.12.7 Methode SetEventNotifier................................................................................................................ 123
10.12.8 Methode CreateFileTable................................................................................................................ 123
Table of Contents
Page
Index.......................................................................................................................... 135
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 7/137
IndraWorks OPC UA Communication
Product Mounting
Selection Engineering Commissioning Operation Decommissioning
phases (assembly/installation)
Presales Aftersales
Design engineer
Mechanic/
electrician
Programmer Programmer
Technologist Commissioning engineer
Target Process Technologist
groups specialist
Process specialist
Machine
operator
Maintenance Mechanic/
technician electrician
Service Disposal company
Select Unpack Parameterize Optimize Operate Dismount
Prepare Mount Program Test Maintain Dispose
Activities Design Install Configure Remove
faults
Construct Simulate
Create
the NC program
Fig. 1-1: Assigning this documentation to the target groups, product phases
and target group activities
8/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
1.2.3 Visualization
Documentation titles with type codes and part numbers
IndraWorks 14VRS HMI
DOK-IWORKS-HMI*****V14-APRS-EN-P, R911343569
This documentation describes the HMI operating interface IndraWorks Operation, its operation and functions as well as the
configuration in IndraWorks Engineering.
Avoiding danger
Fig. 1-2: Structure of the safety instructions
Explaining signal words and safety alert symbol
The safety instructions in this documentation contain specific signal words
(danger, warning, caution, notice) and, if necessary, a safety alert symbol
(according to ANSI Z535.6-2006).
The signal word draws attention to the safety instruction and indicates the
risk potential.
The safety alert symbol (triangular safety reflector with exclamation marks),
preceding the signal words Danger, Warning, Caution indicates hazards for
persons.
DANGER
In case of non-compliance with this safety instruction, death or serious injury
will occur.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 11/137
IndraWorks OPC UA Communication
WARNING
In case of non-compliance with this safety instruction, death or serious injury
can occur.
CAUTION
In case of non-compliance with this safety instruction, minor or moderate
injury can occur.
NOTICE
In case of non-compliance with this safety instruction, material damage can
occur.
12/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
Symbols used
Pointers are displayed as follows:
This is a note.
This is a tip.
Before using Rexroth products, ensure that all the prerequisites for an inten‐
ded use of the products are met:
● Anybody dealing with our products is obliged to read and consent to the
relevant safety instructions and the intended use.
● The original condition of hardware products may not be altered; in other
words, no structural modifications are permitted. It is not permitted to
decompile software products or alter source codes.
● Do not install damaged or defective products or commission them.
● It has to be ensured that the products have been installed as described
in the relevant documentation.
http://www.opcfoundation.org/developer-tools/
Part 1 OPC UA part 1 - Overview and concepts 1.01 specification specifications-unified-architecture/part-1-over‐
view-and-concepts/
http://www.opcfoundation.org/developer-tools/
Part 2 OPC UA part 2 - Security model 1.01 specification specifications-unified-architecture/part-2-securi‐
ty-model/
http://www.opcfoundation.org/developer-tools/
Part 3 OPC UA part 3 - Address space model 1.01 specification specifications-unified-architecture/part-3-ad‐
dress-space-model/
http://www.opcfoundation.org/developer-tools/
Part 4 OPC UA part 4 - Services 1.01 specification specifications-unified-architecture/part-4-serv‐
ices/
http://www.opcfoundation.org/developer-tools/
Part 5 OPC UA part 5 - Information model 1.01 specification specifications-unified-architecture/part-5-infor‐
mation-model/
http://www.opcfoundation.org/developer-tools/
Part 6 OPC UA part 6 - Mappings 1.00 specification specifications-unified-architecture/part-6-map‐
pings/
http://www.opcfoundation.org/developer-tools/
Part 7 OPC UA part 7 - Profiles 1.00 specification specifications-unified-architecture/part-7-pro‐
files/
http://www.opcfoundation.org/developer-tools/
Part 8 OPC UA part 8 - Data access 1.01 specification specifications-unified-architecture/part-8-data-
access/
http://www.opcfoundation.org/developer-tools/
Part 9 OPC UA part 9 - Alarms and conditions 1.00 specification specifications-unified-architecture/part-9-
alarms-and-conditions/
http://www.opcfoundation.org/developer-tools/
Part 10 OPC UA part 10 - Programs 1.00 specification specifications-unified-architecture/part-10-pro‐
grams/
16/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
Subscription Service Set ● Subscriptions are an efficient method in the OPC UA to receive informa‐
tion on value changes in the OPC UA server from the server. Using the
"Subscription Service Set", clients can create, modify and delete sub‐
scriptions.
EndpointURL The EndpointURL describes the communication protocol used and the safety settings of a server
end point. The URL consists of the communication protocol used and the host address. OPC UA
defines a high-performance binary protocol (opc.tcp://) as communication protocol and an XML-
based protocol (http://).
The Bosch Rexroth OPC UA server supports the binary protocol and uses the port 4840 by de‐
fault.
Structure of the end point URL: opc.tcp://<HostAddress>:4840
MessageSecurityMode The safety level is specified using the "MessageSecurityMode".
Possible values are:
● Sign: This safety level ensures the message integrity. The message can be protected
against third party changes by adding a signature.
● SignAndEncrypt: The message confidentiality is ensured in addition to the "Sign" safety lev‐
el. Messages are encrypted using crypto algorithms. Thus, third parties do not have read ac‐
cess.
● None: The messages are neither signed nor encrypted.
SecurityPolicy The "SecurityPolicy" describes the message encryption type. OPC UA defines the policies
"Basic128Rsa15" and "Basic256".
22/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
PublishingInterval The "PublishingInterval" defines the cycle within which a subscription tries to send a notification to
a client. The "PublishingInterval" value is specified between the client and the server when creat‐
ing a subscription
SamplingInterval The "SamplingInterval" defines the cycle within which the server samples the subordinate data
sources. The "SamplingInterval" value is specified between client and server when creating a
"MonitoredItem". The Bosch Rexroth OPC UA server supports the following SamplingIntervals
[ms]: 1, 2, 5, 10, 50, 100, 500, 1000, 2000, 5000
Max. number of items 13VRS: 1000
per subscription 14VRS: 2000
Max. number of sub‐
20 per session
scriptions
Max. number of ses‐
50
sions
For drive data, the following boundary conditions apply with re‐
gard to the number of items depending on the SamplingInterval:
● 50 ms: maximum 5 items
● 100 ms: maximum 5 items
● 250 ms: maximum 10 items
● 500 ms: maximum 50 items
● 1 s: maximum 100 items
● 2.5 s: maximum 250 items
● 5 s: maximum 500 items
Parameter Description
This parameter is used to enable or disable the OPC UA
server.
TaskRun Valid values:
0: Server is not active
1: Server is active
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 23/137
IndraWorks OPC UA Communication
Parameter Description
The "SamplingInterval" defines the cycle within which the
Sampling Interval
server samples the subordinate data sources.
Describes the interval during which one or multiple value
Publishing Interval changes are transferred to the client for one or multiple
"Monitored Items".
The queue size specifies how many values of the Moni‐
toredItems can be saved in a subscription. The maxi‐
mum value is 1000. Via the parameter “Discard Oldest”,
it is specified how a new value is entered if the queue is
full.
Queue Size/Discard Old‐
est Possible values for Discard Oldest:
● TRUE: The oldest value in the queue is replaced
by the new value
● FALSE: The newest value in the queue is replaced
by the new value
Different filter types can be set.
Possible values are:
● DataChangeFilter
Filters ● EventFilter
● AggregateFilter
For the type descriptions, refer to the client documenta‐
tion or the OPC UA specification.
The “Monitoring” mode specifies whether the values of a
monitored item are entered into the queue and reported.
Possible values are:
● Disabled: The value of the monitored item is not
sampled and it is thus not entered into the queue.
This item does not perform a notification
Monitoring mode
● Sampling: The value of the Monitored Item is not
sampled and thus not entered into the queue. This
item does not perform a notification
● Reporting: The value of the Monitored Item is not
sampled and thus not entered into the queue. This
items performs a notification
This parameter specifies whether subscription data is
Enable Publishing
transmitted to the client
NamespaceIndex NamespaceUri
0 http://opcfoundation.org/UA/
1 IndraLogic::4840/UaServer
2 http://www.boschrexroth.com/IndraLogic
3 http://www.boschrexroth.com/PlcEvents
4 http://opcfoundation.org/UA/DI/
5 http://PLCopen.org/OpcUa/IEC61131-3/
6 http://sercos.org/UA/
7 http://boschrexroth.com/OpcUa/Sercos/Objects/
8 http://boschrexroth.com/OpcUa/BaseTypes/
9 http://boschrexroth.com/OpcUa/Device/Types/
10 http://boschrexroth.com/OpcUa/Device/Objects/
11 http://boschrexroth.com/OpcUa/Motion/Types/
12 http://boschrexroth.com/OpcUa/Motion/Objects/
13 http://boschrexroth.com/OpcUa/Robot/Types/
14 http://boschrexroth.com/OpcUa/Robot/Objects/
15 http://boschrexroth.com/OpcUa/DiagnosisLogbook/Types/
16 http://boschrexroth.com/OpcUa/DiagnosisLogbook/Objects/
17 http://boschrexroth.com/OpcUa/System/Types/
18 http://boschrexroth.com/OpcUa/System/Objects/
19 http://boschrexroth.com/OpcUa/Parameter/Types/
20 http://boschrexroth.com/OpcUa/Parameter/Objects/
21 http://boschrexroth.com/OpcUa/Trace/Types/
22 http://boschrexroth.com/OpcUa/Trace/Objects/
23 http://boschrexroth.com/OpcUa/Debug/Types/
24 http://boschrexroth.com/OpcUa/Debug/Objects/
25 http://boschrexroth.com/OpcUa/Filesystem/Types/
26 http://boschrexroth.com/OpcUa/Filesystem/Objects/
27 http://boschrexroth.com/OpcUa/CNC/Objects/
28 http://boschrexroth.com/OpcUa/CNC/Types/
29 http://boschrexroth.com/OpcUa/CNC/Motion/Types/
30 http://boschrexroth.com/OpcUa/CNC/ToolManagement/Types/
31 http://boschrexroth.com/OpcUa/CNC/SystemData/Types/
32 http://boschrexroth.com/OpcUa/CNC/MachineData/Types/
33 http://boschrexroth.com/OpcUa/CNC/BitInterface/Types/
34 http://boschrexroth.com/OpcUa/CNC/Correction/Types/
From firmware version 14V22, method calls for PLC objects are
supported. Additionally, the option "Calling functions, function
blocks, methods and programs" under the menu item "Settings"
has to be set in the dialog of the symbol configuration object.
Subsequently, enable the addressability of the object in the "Ac‐
cess rights" column, identified by a symbol.
Fig. 4-5: Address space in the XLC/MLC system on the hardware platform
CML45/65
The nodes can be classified in three categories:
1. Standard node of the OPC UA specification
● Root
● Objects
– Server
● Types
– DataTypes
– EventTypes
– ObjectTypes
– ReferenceTypes
– VariableTypes
● Views
2. Node of the OPC UA Companion Standards
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 31/137
IndraWorks OPC UA Communication
● DeviceSet
● DeviceTopology
● Logic
● NetworkSet
3. System-specific XLC/MLC nodes
● Debug
● DiagnosisLogbook
● Motion
● Parameter
● Robot
● Sercos
● System
● Trace
Debug This node is for internal use only.
DeviceSet This node is based on the OPC UA Companion Standard "OPC UA for Devi‐
ces (DI)".
For more information, refer to the respective organizations or the OPC Foun‐
dation, using the keywords Companion Specification OPC UA for Devices
(DI).
The figure exemplarily shows three devices:
The node is the only component containing the "ClearError" method that cor‐
responds to the C-0-1030 command.
Refer to chapter 7 "DiagnosisLogbook" on page 51.
The following figure shows the axis and control objects of a CML65 control:
Fig. 4-11: Parameter sets with five configured axes and two kinematics
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 35/137
IndraWorks OPC UA Communication
5.2 Prerequisites
To simulate the communication example, the UaExpert of the Unified Auto‐
mation GmbH is required. The UaExpert is implemented for the Win32 and
Linux platforms and can be downloaded as freeware via http://www.unified-
automation.com.
This documentation refers to version 1.2.0 132 of the UaExpert.
5.3 UaExpert
The UaExpert is a universal OPC UA test client. It is possible, to analyze the
OPC UA server address space and to conduct simple tests with the OPC UA
server.
The UaExpert supports
● browsing of address spaces
● reading and writing of nodes (value "Attribute")
● monitoring of value changes and events (subscription)
● calling methods
● reading of historic data
The UaExpert is divided into several windows.
5.5 Browsing
The "ServerUrl" is now visible for the parameterized connection in the Project
Window below the "Server" node. A connection to this OPC UA server can
now be established via the context menu of this entry or via the "Server Con‐
nect" menu item.
After the connection has been established successfully, the address space of
the OPC UA server is displayed in the Address Space Window.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 43/137
IndraWorks OPC UA Communication
5.6 Subscribe
The UaExpert supports the mechanism to monitor changes in data (subscrip‐
tion) in the Data View Window. One or multiple of these views can be created
via the menu Document - Add and by selecting "Data Access Classic View"
in the "Add Document" dialog.
"Value" attributes monitored on value changes by the server are named
"Monitored Item". To generate a "Monitored Item", the node in the "Address
Space Window" has to be dragged to the "Data View Window" via
drag&drop.
44/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
5.7 Write
To write a value, select (via double-click) the "Value" column of a "Monitor
Item". The value can now be edited. Click on "Enter", and the new value is
written to the server.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 47/137
IndraWorks OPC UA Communication
Discovery
6 Discovery
6.1 General information
In larger industrial networks, there are usually a multitude of UA servers with
different end points. Each end point can have different settings for communi‐
cation, encoding or safety. In such environments, it can challenging for clients
to find the correct server for the specified task. OPC UA provides the so-
called Discovery service. Using the Discovery Service, clients can query,
save the required settings and re-use them again for later connections.
The client scans the local discovery server for existing servers using "Find‐
Server". The response is a current server description. It contains all currently
registered servers. If the required server is listed in the server description, the
client uses the URL to connect directly to the respective server using "Ge‐
tEndpoints". The response contains the end point description of the relevant
server.
For the Local Discovery Server to always be up-to-date regarding the current‐
ly available OPC UA server, the individual servers have to cyclically register
with the Local Discovery Server using the "RegisterServer" service after the
startup and upon the initial login. If the server does not respond within the
specified minimum time, the Local Discovery Server removes it from its Serv‐
erDescription list. A new login is possible at any time. Thus, clients can also
check whether the relevant server is currently available.
Discovery
● The OPC UA server of the XLC/MLC and the MTX does not
provide an individual discovery server.
● A secure connection is required to register at a Discovery
server. The reliability of the communication partners is en‐
sured by the exchange and the verification of certificates.
There is no check on the control. The discovery server is
deemed reliable. The discovery server has to verify whether
the control certificate is marked as to be imported and thus,
as reliable.
6.3.2 Enabling the discovery mechanisms of the OPC UA server for the
MTX
1. Open IndraWorks Engineering
2. Go online
3. Open the file system of the control
4. Open the "uaconfig.cfg" in the folder "/plc".
Discovery
DiagnosisLogbook
7 DiagnosisLogbook
7.1 General information
The object DiagnosisLogbook provides all diagnostics within the XLC/MLC
and MTX systems (ranging from user messages to system error message) by
using the OPC UA standard mechanism "Alarms & Conditions". This stand‐
ard ensures the efficient exchange of diagnostic data by using events. Using
this standard, clients can listen in diagnostic messages, display the messag‐
es by using specific additional data and process them, if required. Conse‐
quently, the implementation effort is reduced considerably for the client.
DiagnosisLogbook
7.2.2 AutomationConditionType
The AutomationConditionType inherits all properties of the standardized type
"ConditionType". Additionally, the AutomationConditionType has the proper‐
ties "Number", "HelpText", "ReasonText " and "RemedyText".
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 53/137
IndraWorks OPC UA Communication
DiagnosisLogbook
"AutomationConditionType"
Attributes Value
Message number
Number
UInt32 HasProperty Variable PropertyType Mandatory
Language-dependent help text
HelpText
LocalizedText HasProperty Variable PropertyType Optional
Language-dependent text about the cause of error
ReasonText
LocalizedText HasProperty Variable PropertyType Optional
Language-dependent remedy text
RemedyText
LocalizedText HasProperty Variable PropertyType Optional
7.2.3 AutomationWarningType
The "AutomationWarningType" inherits from "AutomationDiscreteAlarm‐
Type".
"AutomationWarningType"
Attributes Value
BrowseName AutomationWarningType
IsAbstract False
Inherits the properties of the "AutomationDiscreteAlarmType" (see tab. "AutomationDiscreteAlarmType" on page 54)
7.2.4 AutomationErrorType
The "AutomationErrorType" inherits from "AutomationDiscreteAlarmType".
"AutomationErrorType"
Attributes Value
BrowseName AutomationErrorType
IsAbstract False
Inherits the properties of the "AutomationDiscreteAlarmType" (see tab. "AutomationDiscreteAlarmType" on page 54)
7.2.5 AutomationDiscreteAlarmType
The "AutomationDiscreteAlarmType" inherits from the standardized type
"DiscreteAlarmType". Additionally, the AutomationDiscreteAlarmType has the
properties "Number", "HelpText", "ReasonText " and "RemedyText".
54/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
DiagnosisLogbook
"AutomationDiscreteAlarmType"
Attributes Value
BrowseName AutomationDiscreteAlarmType
IsAbstract True
Inherits the properties of the "DiscreteAlarmType" (see tab. "DiscreteAlarmType" on page 54)
Message number
Number
UInt32 HasProperty Variable PropertyType Mandatory
Language-dependent help text
HelpText
LocalizedText HasProperty Variable PropertyType Optional
Language-dependent text about the cause of error
ReasonText
LocalizedText HasProperty Variable PropertyType Optional
Language-dependent remedy text
RemedyText
LocalizedText HasProperty Variable PropertyType Optional
7.2.6 DiscreteAlarmType
The "DiscreteAlarmType" inherits from "ConditionType". Additionally, the Dis‐
creteAlarmType has the properties "ActiveState", "AckedSate" and "Input‐
Node".
"DiscreteAlarmType"
Attributes Value
BrowseName DiscreteAlarmType
IsAbstract False
Inherits the properties of the "ConditionType" (see tab. "ConditionType" on page 55)
7.2.7 ConditionType
The type "ConditionType" standardized by OPC UA defines all general char‐
acteristic values of a condition. The type inherits from "BaseEventType". All
other condition types are derived from "ConditionType".
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 55/137
IndraWorks OPC UA Communication
DiagnosisLogbook
"ConditionType"
Attributes Value
BrowseName ConditionType
IsAbstract True
DiagnosisLogbook
7.2.8 BaseEventType
The type definition as well as the semantics of BaseEventType can also be
taken from "OPC Unified Architecture Specification Part 5: Information Mod‐
el".
"BaseEventType"
Attributes Value
BrowseName BaseEventType
IsAbstract False
DiagnosisLogbook
Attributes Value
BrowseName DiagnosisLogbook
AutomationCondi‐
tionType AutomationCondi‐
HasEventType ObjectType EventType -
tionType
AutomationWar‐
ningType AutomationWar‐
HasEventType ObjectType EventType -
ningType
58/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
DiagnosisLogbook
AutomationError‐
Type AutomationError‐
HasEventType ObjectType EventType -
Type
Type plate
8 Type plate
8.1 General information
A type plate is a plate attached to the product by the manufacturer, identifying
and describing the product.
The following specifications should be available:
● Company name
● Type ID
● Serial number
● Manufacturing date
Type plate
8.2.2 RexrothDeviceType
The "RexrothDeviceType" object is an extension for the general model. The
object inherits all attributes of "BaseObjectType", "TopologyElementType"
and "DeviceType". All mandatory attributes are implemented.
In the following table, the mandatory and optional attributes to be implemen‐
ted by the "Rexroth Device Type" have to be described.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 61/137
IndraWorks OPC UA Communication
Type plate
"RexrothDeviceType definition"
Attributes Value
BrowseName RexrothDeviceType
IsAbstract True
The object inherits all attributes of "BaseObjectType", "TopologyElementType" and "DeviceType".
Serial number of the device. In case there is not serial number, an empty string is transmitted
SerialNumber
String HasProperty Variable PropertyType Mandatory
Version counter, "0" for Bosch Rexroth controls
RevisionCounter
Int32 HasProperty Variable PropertyType Mandatory
Vendor
Manufacturer
LocalizedText HasProperty Variable PropertyType Mandatory
Hardware product ID, e.g. "IndraControl CML65"
Model
LocalizedText HasProperty Variable PropertyType Mandatory
Operating instructions, link to Bosch Rexroth URL (http://www.boschrexroth.com) for Bosch
DeviceManual Rexroth controls
String HasProperty Variable PropertyType Mandatory
Device version, empty string for Bosch Rexroth controls
DeviceRevision
String HasProperty Variable PropertyType Mandatory
Description of the basic firmware, version string of the firmware
SoftwareRevision
String HasProperty Variable PropertyType Mandatory
Hardware version of the control
HardwareRevision
String HasProperty Variable PropertyType Mandatory
Properties of "RexrothDeviceType"
BrowseName DataType References NodeClass TypeDefinition ModellingRule
Software Basic object describing one or several software components of the control
ComponentSet - HasComponent ObjectType BaseObjectType Mandatory
Hardware Basic object describing one or several hardware components of the control
ComponentSet - HasComponent ObjectType BaseObjectType Mandatory
Link to Bosch Rexroth URL (http://www.boschrexroth.com)
ProductUri
String HasProperty Variable PropertyType Mandatory
Order number
OrderNumber
String HasProperty Variable PropertyType Optional
Type plate
Properties of "RexrothDeviceType"
BrowseName DataType References NodeClass TypeDefinition ModellingRule
Manufacturing date
ManufacturingDate
DateTime HasProperty Variable PropertyType Optional
8.2.3 ComponentType
Attributes Value
BrowseName ComponentType
IsAbstract True
Inherits the attribute of "BaseObjectType"
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 63/137
IndraWorks OPC UA Communication
Type plate
Definition of "ComponentType"
BrowseName DataType References NodeClass TypeDefinition ModellingRule
Product name
ProductName
String HasProperty Variable PropertyType Mandatory
Vendor
ManufacturerName
String HasProperty Variable PropertyType Mandatory
Link to Bosch Rexroth URL (http://www.boschrexroth.com)
ProductUri
String HasProperty Variable PropertyType Mandatory
Order number
OrderNumber
String HasProperty Variable PropertyType Optional
Additional info
AdditionalInfo
String HasProperty Variable PropertyType Optional
8.2.4 SoftwareComponentType
"SoftwareComponentType"
Attributes Value
BrowseName SoftwareComponentType
IsAbstract False
Inherits the attribute of "ComponentType"
Definition of "SoftwareComponentType"
BrowseName DataType References NodeClass TypeDefinition ModellingRule
Build date
BuildDate
UtcTime HasProperty Variable PropertyType Mandatory
Build number
BuildNumber
String HasProperty Variable PropertyType Mandatory
Software version
SoftwareVersion
String HasProperty Variable PropertyType Mandatory
8.2.5 HardwareComponentType
"HardwareComponentType"
Attributes Value
BrowseName HardwareComponentType
IsAbstract False
Inherits the attribute of "ComponentType"
64/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
Type plate
Definition of "HardwareComponentType"
BrowseName DataType References NodeClass TypeDefinition ModellingRule
Hardware version
HardwareRevision
String HasProperty Variable PropertyType Mandatory
Serial number
SerialNumber
String HasProperty Variable PropertyType Mandatory
Manufacturing date
ManufacturingDate
String HasProperty Variable PropertyType Optional
8.3.2 Example
Type plate
Type plate
File system
9 File system
9.1 General information
The “File system” object is below Root/Objects in the address space of the
OPC UA Server. Under the OPC UA server, the folders and files of the sys‐
tem file system are displayed. The description of the information and func‐
tions available in the file system is based on the OPC UA specification part 5
V1.03. The OPC UA information model is describe for file transfer in annex C.
Therefore, the ObjectType "FileType" and "FileDirectoryType" and their func‐
tions are specified. A file folder is thus of the type "FileDirectoryType" and a
file of the type "FileType". To map the complete file system functionality of
the control, the "FileType" is extended by the "AutomationFileType". With this
standard, clients can access the system-specific file system.
File system
9.2.2 AutomationFileType
In "Filetype", methods and variables required for a file handling are defined.
The functionalities of this type include the opening and closing of the file and
the reading and writing at any position within the file. Furthermore, meta data
of the file can be queried providing for example information such as size and
write-protection of the file to the client.
The "AutomationFileType" extends the "FileType" by additional methods and
variables required to map the control-internal file system. Thus, it has a refer‐
ence to the status of the user rights and the time stamp. The two respective
methods implement the setting of the time stamp and the setting of the user
rights.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 69/137
IndraWorks OPC UA Communication
File system
"AutomationFileType Definition"
Attributes Value
BrowseName AutomationFileType
IsAbstract False
9.2.3 FileStatusType
Variables of the "FileStatusType" include meta data of a file or a folder, such
as the creation data (BuildingDate), the last access date (AccessDate) and
the change date (RevisionDate). Furthermore, the user rights are represen‐
ted in the file system. The user rights are represented with the variables
“User ID”, “Group ID” and a bit mask for access rights.
"FileStatusType Definition"
Attributes Value
BrowseName FileStatusType
IsAbstract False
ValueRank -1 (-1 = Scalar)
DataType FileStatusDataType
70/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
File system
9.2.4 FileDirectoryType
The root directory of a file system or each other subdirectory of a file system
can be used as starting directory. The starting directory is always an instance
of "FileDirectoryType". The included folders are also of "FileDirectoryType".
This type includes methods to create, delete and move files and folders. Ad‐
ditionally, all subfolders or files in the folder can be found via the "Organi‐
zes"references.
"FileDirectoryType Definition"
Attributes Value
BrowseName FileDirectoryType
IsAbstract False
File system
File system
opened for writing, the function returns the error "OpcUa_Bad". It means that
the file cannot be opened. This is also the case if the file is to be opened mul‐
tiple times for writing.
Open(
[in] Byte mode
[out] UInt32 fileHandle
);
Contains the mode whether the file is opened for read and
mode
write operations
Used in other methods to get access and the current file posi‐
fileHandle
tion
9.4.2 Close
“Close” is used to close a file handling for a file represented by an object of
the "FileType". The file handle thus becomes invalid.
Close(
[in] UInt32 fileHandle
);
9.4.3 Read
“Read” is used to retrieve a part of the file starting at the current file position.
The file position is set further by the number of read bytes.
Read(
[in] UInt32 fileHandle
[in] UInt32 length
[out] ByteString data
);
9.4.4 Write
“Write” is used to write data to the file starting at the current file position. The
file position is set further by the number of written bytes.
Write(
[in] UInt32 fileHandle
[in] ByteString data
);
9.4.5 GetPosition
GetPosition is used to return the current position of the fileHandle.
GetPosition(
[in] UInt32 fileHandle
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 73/137
IndraWorks OPC UA Communication
File system
9.4.6 SetPosition
SetPosition is used to set the current position of the fileHandle.
SetPosition(
[in] UInt32 fileHandle
[in] UInt64 position
);
9.4.7 SetAccessRight
SetAccessRight is used to set the user rights.
SetAccessRight(
[in] UInt16 accessRight
);
9.4.8 SetTime
SetTime is used to set the access time and the change time of the file.
SetTime(
[in] UInt16 year
[in] UInt16 month
[in] UInt16 day
[in] UInt16 hours
[in] UInt16 minutes
[in] UInt16 seconds
[in] UInt16 mode
);
File system
9.5.2 CreateFile
In case of the CreateFile method, a file and the object of type "AutomationFi‐
leType" is created. This object is located below the folder (FileDirectorytype
object) in which the method was called.
The created file can have different access rights, depending on the subordi‐
nate file system (local or mount directory). Special access rights can be set
after the file has been created via the SetAccessRight (chapter 9.4.7 "SetAc‐
cessRight" on page 73) method.
CreateFile(
[in] String fileName
[in] Boolean requestFileOpen
[out] NodeId fileNodeId
[out] UInt32 fileHandle
);
9.5.3 Delete
Is used to delete a file or a folder. The file (or the folder) has to be below the
folder (FileDirectoryType object) in which the method was called.
Delete(
[in] NodeId objectToDelete
);
9.5.4 MoveOrCopy
A file or a folder can be moved using the “MoveOrCopy” method. It is also
possible to rename the folder or file.
MoveOrCopy(
[in] NodeId objectToMoveOrCopy
[in] NodeId targetDirectory
[in] Boolean createCopy
[in] String newName
[out] NodeId newNodeId
);
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 75/137
IndraWorks OPC UA Communication
File system
objectToMoveOr‐
NodeId of the folder/file to be moved.
Copy
Target directory where the object (file/folder) is moved to.
targetDirectory When renaming a folder or a file, this NodeId matches the
“Call”
createCopy The flag indicates whether a copy is to be created
newName New name of the object (file/folder) in the target directory
newNodeId NodeId of the new or renamed object (file/folder)
9.6.2 Writable
Indicates whether it can be written on the file. This does not include any user
rights. It does also not include whether the file has already been opened for
writing by another client and thus whether the file is write-protected.
9.6.3 UserWritable
Indicates whether it can be written on the file. Includes whether the user has
access rights (write permission). It does not include whether the file has al‐
ready been opened for writing by another client and thus whether the file is
write-protected.
9.6.4 OpenCount
Number of the currently active and valid fileHandle on the file
9.6.5 MimeType
File type acc. to RFC 2046
9.6.6 Status
Complex variable showing the status of a file. It consists of:
● AccessDate
● AccessRight
● BuildingDate
● GroupId
● OwnerId
● RevisionDate
76/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 77/137
IndraWorks OPC UA Communication
CNC items
10 CNC items
10.1 General information
The “CNC” object is below Root/Objects in the address space of the OPC UA
server. The implemented CNC items are mapped below. The address space
is divided into several points. Thus, it can be browsed through the following
objects:
● AxisList
● ChannelList
● Commands
● Channel-independent items
The following section describes how variables with a complex data type are
created and how they can be interpreted.
CNC items
Values" are provided. The NodeId of these variables are shown in the ex‐
plained example NC.Chan.WaitingStates,01,BitMask and NC.Chan.Waiting‐
States,01,OptionSetValues.
The single variable “BitMask” provides the bit mask in an array of Boolean
values. This allows to check individual entries of the bit mask. The single vari‐
able “OptionSetValues” contains the significance of each entry in the bit
mask. This is exemplarily shown in the figure.
When reading the monitored item for the first time, initial values
are provided for all configured fields.
CNC items
Access:
Read: Does not provide any data
Subscription: Yes
10.3.2 NC.AxisPosRT
Provides a status mask and the command positions of the physical axes.
The position values are recorded in each Ipo cycle.
80/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
If the machining method “Punching” is applied, the status mask provides the
active punching mode as well as information on whether the punching stroke
is executed.
Item syntax:
NC.AxisPosRT[,(1)]
(1) = Recording interval:
● 1 - in each IPO cycle (default)
● n - in every nth IPO cycle
Access:
Read: Does not provide any data
Subscription: Yes
Example:
NC.AxisPosRT
Return:
0 int status mask bit 0x0000-0x000F :Punching mode
Bit 0x0100 : Punching stroke
0 int position value, axis 1
0 int position value, axis 2
0 int position value, axis 3
10.3.3 NC.DataRTDiag
This is a diagnostic item for the item NC.DataRT.
It provides only values if NC.DataRT and NC.AxisPosRT is used.
Item syntax:
NC.DataRTDiag
Access:
Read: Provides diagnostic values
Subscription: Yes
Example:
NC.DataRTDiag
Return:
560000 uint byte size of the IPO ring buffer
2 uint load of the IPO ring buffer in percent
0 uint number of lost entries
123456 uint number since the start of the item “NC.DataRT”
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 81/137
IndraWorks OPC UA Communication
CNC items
10.3.4 NC.AxisPosRTDiag
This is a diagnostic item for the item NC.AxisPosRTDiag.
The item is identical to NC.DataRTDiag.
Only one real-time item (NC.DataRT/NC.AxisPosRT) may be used as moni‐
tored item at the same time.
10.4.2 NC.Chan.ActSpindleOverride
Provides the current value of the spindle override
Item syntax:
82/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
NC.Chan.ActSpindleOverride,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
“SystemNumber“: System number
“ActiveValue”: Active value in %
“MaximumValue“: Maximum value
Without specifying the selector, an array of type SpindleOverrideDataType is
read.
Selector reads an array containing only selected data.
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan. ActSpindleOverride,1
Return: [ .Name = “S1“, .Number = 6, .SystemNumber = 1, . ActiveValue =
40, .MaximumValue = 50 ; … ]
10.4.3 NC.Chan.ActSpindleSpeedDrv
Provides the active actual spindle speed(s)
Item syntax:
Refer to chapter 10.4.1 "NC.Chan.ActSpindleSpeed" on page 81
Access:
Read: yes
Write: yes
Subscription: yes
10.4.4 NC.Chan.ActSpindleTorque
Provides the active and maximum spindle torque in percent
Item syntax:
NC.Chan.ActSpindleTorque,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
SystemNumber“: System number
“ActiveValue”: Active value in %
“MaximumValue“: Maximum value in %
Without specifying the selector, an array of type SpindleTorqueDataType is
read.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 83/137
IndraWorks OPC UA Communication
CNC items
10.4.5 NC.Chan.ActSpindlePower
Provides the active and maximum spindle power in watts
Item syntax:
NC.Chan.ActSpindlePower,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
“SystemNumber“: System number
“ActiveValue”: Active value in watts
“MaximumValue“: Maximum value in watts
Without specifying the selector, an array of type SpindlePowerDataType is
read.
Selector reads an array containing only selected data.
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan. ActSpindlePower,1
Return: [ .Name = “S1“, .Number = 6, .SystemNumber = 1, . ActiveValue =
80, .MaximumValue = 120 ; … ]
10.4.6 NC.Chan.ProgrammedSpindleSpeed
Provides the programmed spindle speed(s)
The spindles indicated in the channel are configured via the MA‐
CODA parameter 6005 0030. This parameter indicates channel-
specifically which spindle is shown at which position in the spindle
display.
Item syntax:
Refer to chapter 10.4.1 "NC.Chan.ActSpindleSpeed" on page 81
Access:
84/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Read: yes
Write: yes
Subscription: yes
10.4.7 NC.Chan.ActSpindleMovements
Returns the motion functions of the spindles
Item syntax:
NC.Chan.ActSpindleMovements,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
“SystemNumber“: System number
“MotionFunction“: Spindle motion function
Without specifying the selector, an array of type SpindleMovementDataType
is read.
Selector reads an array containing only selected data.
The value for "MotionFunction" is of the type “SpindleMovementsEnum” and
can assume the values of the enumeration.
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan. ActSpindleMovements,1
Return: [ .Name = “S1“, .Number = 6, .SystemNumber = 1, .MotionFunction =
5(Stop); … ]
10.4.8 NC.Chan.ActSpindleGears
Provides the active gear step of a spindle
Item syntax:
NC.Chan.ActSpindleGears,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
“SystemNumber“: System number
“GearSelection“: Active spindle gear step
Without specifying the selector, an array of type SpindleGearDataType is
read.
Selector reads an array containing only selected data.
The value for “GearSelection” is of type “SpindleGearEnum” and can assume
the values of the enumeration.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 85/137
IndraWorks OPC UA Communication
CNC items
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan. ActSpindleGears,1
Return: [ .Name = “S1“, .Number = 6, .SystemNumber = 1, . GearSelection =
41(GearRange1); … ]
10.4.9 NC.Chan.ActSpindleAutoGears
Indicates for which spindle an automatic gear selection is active in the selec‐
ted channel
Gear selection state:
0 = Manual gear selection
1 = Automatic gear selection active
Item syntax:
Refer to chapter 10.4.8 "NC.Chan.ActSpindleGears" on page 84
Access:
Read: yes
Write: yes
Subscription: yes
10.4.10 NC.Chan.ActSpindleSwitchGears
Indicates whether gears are currently shifted
Gear step shifting state:
0 = No gear shifting
1 = Gear shifted
Item syntax:
NC.Chan.ActSpindleSwitchGears,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
“SystemNumber“: System number
“GearShifting“: Gear shifting
Without specifying the selector, an array of type SpindleGearSwitchDataType
is read.
Selector reads an array containing only selected data.
Access:
Read: yes
Write: yes
Subscription: yes
86/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Example:
NC.Chan. ActSpindleSwitchGears,1
Return: [ .Name = “S1“, .Number = 6, .SystemNumber = 1, . GearShifting = 0;
…]
10.4.11 NC.Chan.ActSpindlePosition
Provides the active spindle list position in degrees
Item syntax:
NC.Chan.ActSpindlePosition,(1)[,(2)]
1. channel number
2. Selector:
"Name”: Spindle name
“Number”: Axis number
“SystemNumber“: System number
“Value“: Active actual value of the spindle
Without specifying the selector, an array of type SpindlePositionDataType is
read.
Selector reads an array containing only selected data.
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan. ActSpindleSwitchGears,1
Return: [ .Name = “S1“, .Number = 6, .SystemNumber = 1, . Value =
246.3700; … ]
10.5.1 NC.Chan.ProgramLinkInfo
Provides the active program with path names and its selection criteria from
the requested channel.
Selector:
“ActiveProgram“: Active program
“CallStatus“: Call status
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 87/137
IndraWorks OPC UA Communication
CNC items
Example:
NC.Chan. ProgramLinkInfo,1
Return: [ .ActiveProgram = “/mnt/startup-testphase/Ex.npg“, .CallStatus = 65;
…]
The “CallStatus” is provided as a bit mask of an enumeration.
The item can be read with a third parameter.
Item syntax:
NC.Chan.ProgramLinkInfo,(1)[,(2)][,(3)]
Parameter 3:
“BitMask”: Array writing on each bit of the bit mask
“OptionSetValues”: Bit mask
"OptionSetValues" shows a bit-by-bit representation for each bit of the mask
set to TRUE. The order of the bits of the bit mask point to a position of the
array, i.e. the first bit (lowest significance) points to the first entry in the array,
etc.
10.5.2 NC.Chan.ActNcBlock
Provides the name of the current block
Example:
NC.Chan.ActNcBlock
Return: “N150“
10.5.3 NC.Chan.ProgramPosition
Provides the current file position in the respective main program or subrou‐
tine
This item is not suitable for the cyclic query within a group, as it is communi‐
cated with the NC during each read access.
Selector:
“FileName“: File name incl. path
“FilePosition“: File position
Example:
NC.Chan.ProgramPosition,1
Return: [ .FileName = “/usr/user/sect.cnc“, .FilePosition = 34; … ]
10.5.4 NC.Chan.WaitingStates
Provides the active waiting states of a channel and the name of the current
block.
CNC items
10.5.5 NC.Chan.ProgrammedFeedrateIndex
Provides the information which programmed feed - F1 or F2 - is currently ac‐
tive.
Example:
NC.Chan.ProgrammedFeedrateIndex
Return: 2
10.5.6 NC.Chan.ChanHidden
Specifies whether the channel is hidden in the display. It is set using the MA‐
CODA number 600500010.
Example:
NC.Chan.ChanHidden
Return: true
10.5.7 NC.Chan.AxisRotate
The item provides the angle by which a programmed contour was rotated in
the active plane.
Example:
NC.Chan.AxisRotate
Return: 5.0
10.5.8 NC.Chan.AxisPoleSet
This function specifies the absolute position of the pole for the input tools
“Mirroring”, “Scaling” and “Rotating”. Apart from the rotation point of the mir‐
ror, the item provides another seven additional values shown in the columns
0 - 6.
Selector:
Refer to chapter 10.10.11 "NC.Chan.AxisPosAcs" on page 105
Example:
NC.Chan.AxisPoleSet,1
Return: [ .Position = 12, .Name = “X“, .Number = 2, .Unit = 1(Metric), .Chan‐
nel = 1, .InPosition = true, .KnowReferencePoint = true, .DiameterProgActive
= false; … ]
10.5.9 NC.Chan.AxisShift
The item reads the values containing the offset of a programmed contour par‐
allely displaced to the axes of the program coordinate system.
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 89/137
IndraWorks OPC UA Communication
CNC items
Selector:
“Value”
“Name”
“Number”
“Unit”
“Channel”
“InPosition”
“KnowReferencePoint”
“DiameterProgActive”
Example:
NC.Chan.AxisShift,1
Return: [ .Value = , .Name = “Y“, .Number = 2, .Unit = 1(Metric), .Channel =
1, .InPosition = true, .KnowReferencePoint = true, .DiameterProgActive =
false; … ]
10.5.10 NC.Chan.AxisScale
This item can be used to read scaling values specified for a programmed
contour. Apart from the scaling values, item provides another additional val‐
ues shown in the columns 0 - 6.
Selector:
Refer to chapter 10.5.9 "NC.Chan.AxisShift" on page 88
10.5.11 NC.Chan.AxisMirror
This item can be used to determine the current state of the mirroring. If mir‐
roring is activated for an axis within the channel, the item returns the value 1
for this axis. If the mirroring is switched off, 0 is returned. Apart from the mir‐
ror states, the item provides another seven additional values shown in the
columns 0 - 6.
Selector:
Refer to chapter 10.5.9 "NC.Chan.AxisShift" on page 88
10.5.12 NC.Chan.ActAxisVelocityMax
Provides the maximum velocity in the axis coordinate system
90/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Only values for the asynchronous axes and axes in the jog mode
are provided. Otherwise, this value is 0.
Additional information is provided for each axis in the first seven
columns.
The eighth column contains the respective velocity value of the
axis.
Selector:
Refer to chapter 10.5.9 "NC.Chan.AxisShift" on page 88
10.5.13 NC.Chan.ActAxisVelocityPeak
Provides the peak value, the maximum value and the nominal value of the
current axis velocity
Selector:
“NominalValue”
“PeakValue”
“MaxValue”
“Name”
“Number”
“Unit”
“Channel”
“InPosition”
“KnowReferencePoint”
“DiameterProgActive”
Example:
NC.Chan.AxisShift,1
Return: [ .NominalValue = 10000, .PeakValue = 10500, .MaxValue =
12000, .Name = “Z“, .Number = 2, .Unit = 1(Metric), .Channel = 1, .InPosition
= true, .KnowReferencePoint = true, .DiameterProgActive = false; … ]
10.5.14 NC.Chan.ActAxisAccelerationPeak
Provides the peak value, the maximum value and the nominal value of the
current axis acceleration
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 91/137
IndraWorks OPC UA Communication
CNC items
Selector:
Refer to chapter 10.5.9 "NC.Chan.AxisShift" on page 88
10.5.15 NC.Chan.BalancedConditionState
Informs whether axes or spindles are adjusted
10.5.16 NC.Chan.CompTempData
Provides the active temperature-dependent compensation values (WCS) for
all axes of the channel
10.5.17 NC.Chan.CompLeadScrewErrData
Provides the active screw (spindle) lead error compensation for all axes of
the channel
10.5.18 NC.Chan.CompCrossData
Provides the active cross compensation values (WCS) for all axes of the
channel
10.5.19 NC.Chan.CompOffsetData
Provides the sum value of all axis compensations for all axes of the channel
92/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Item syntax:
NC.SystemData,(1)
1. Element path (in Xpath syntax)
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.SystemData,/SysToolInsert/Hd/SKQ
Return
NC.SystemData,/SysToolInsert/Hd/IKQ1
Return
10.6.2 NC.SystemDataXml
Access to system data in xml format
To read or write an XML stream without outer start tag and end
tag, the parameter mode has to be linked logically to 1024 an via
"OR" operation. This is only recommend when accessing individu‐
al elements of a system date.
CNC items
Example:
NC.SystemDataXml,/SysToolInsert/Hd/IKQ1
Return
10.7.1 NC.CplPermVariable
Item syntax:
NC.CplPermVariable,(1)[,(2)] [,(3)]
1. Variable name
2. Index1 (optional)
3. Index2 (optional)
Access:
Read: yes
Write: yes
Subscription: yes
With field variables, the two optional indices can be used to ac‐
cess individual elements. In case of missing indices, all elements
are accessed.
In case of two-dimensional CPL variables and the missing Index2,
the complete line of the elements specified under Index1 is ac‐
cessed.
Examples:
Reading one element of a one-dimensional array
NC.CplPermVariable,@_R,4
Return
10.7.2 NC.CplPermVariable,PermVars
The "Organizes references" provided upon browsing this node includes all
fixed permanent CPL variables (@1 - @100).
94/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
10.7.3 NC.CplPermVariable,DefPermVars
The "Organizes references" provided upon browsing this node includes all
definable permanent CPL variables.
10.8.1 NC.CfgDataXml
Item syntax:
NC.CfgDataXml,(1)[,(2)]
1. Element path (in Xpath syntax) of configuration data
2. Mode, controls the item response's behavior
Access:
Read: yes (data size 16kByte max.)
Write: yes
Subscription: no
To read or write an XML stream without outer start tag and end
tag, the parameter mode has to be linked logically to "1024" via
an "OR" operation. This is only recommended when accessing in‐
dividual elements of a configuration date.
Examples:
Reading an individual date
NC.CfgDataXml,/AX/Dr[1]/Vel/MaxVel
Return:
<MaxVel>15000.00000</MaxVel> Data of the configuration date [string]
Reading a single date without xml tags
NC.CfgDataXml,/AX/Dr[1]/Vel/MaxVel,1024
Return:
15000.00000 data of the configuration date [string]
Reading a substructure
NC.CfgDataXml,/AX/Dr[1]/Vel
Return:
<Vel><MaxVel>15000.00000</MaxVel><FeedCalc>0</FeedCalc></Vel> Da‐
ta of the configuration date [string]
CNC items
tion and index to be provided (channel number, axis number, spindle num‐
ber).
The bit descriptions are provided in the set language. They are
only available if the respective text files are available in the con‐
trol.
Item syntax:
NC.BitInterface,(1),(2),[(3)]
1. interface type
2. Selector
Access:
96/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Read: yes
Write: no
Subscription: yes (only for the state of the bits)
Examples:
Reading the complete channel interface of channel 3:
NC.BitInterface,Channel,Data,3
Return:
Structured type "BitInterfaceDataType" with two ByteStrings
PlcToCnc: Length=14, Content=050000000000983a000000000000
CncToPlc: Length=14, Content=0500010001000000000008000000
10.9.2 NC.TestMode
Provides the current setting of total inhibit or changes the total inhibit setting
False = “Total inhibit” inactive
True = “Total inhibit” active
Item syntax:
NC.TestMode
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.TestMod
Return:
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 97/137
IndraWorks OPC UA Communication
CNC items
Apart from the channel state, the states of the block processing
and of the interpolator are reported.
Channel states
CNC items
Channel states
CNC items
CNC items
Return
10.10.2 NC.Chan.OperationState
Provides the ChanState as structured variable
10.10.3 NC.Chan.ModeOfOperation
It provides the operation mode of a channel
CNC items
10.10.4 NC.Chan.OperationMode
Provides the ModeOfOperation as structured variable
Item syntax:
NC.Chan.OperationMode,(1),Mode
1. channel number
Access:
Read: Provides the (main) operation mode in the channel
Write: Operation mode switching in the channel
10.10.5 NC.Chan.ProgramWindow
Provides a section from the current main program or the subroutine
Item syntax:
102/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
NC.Chan.ProgramWindow,(1),(2),(3)
1. channel number
2. Window size (number of blocks in the result, 200 max.)
3. Desired number of preceding blocks (10 max.)
Access:
Read: yes (from 14V20)
Subscription: yes
Example:
NC.Chan.ProgramWindow,1,10,2
Provides 10 lines max. The two preceding lines are empty line if they are not
available.
Return
10.10.6 NC.Chan.ActCallChain
Provides the current subroutine nesting
Program name with path, file position and block number are provi‐
ded each. The subroutine nesting is provided relatively to the ac‐
tive block.
Item syntax:
NC.Chan.ActCallChain,(1)[,(2)]
1. channel number
2. Selector: 1: Block number; 2: Program name with path; 3: File position
Without specifying the selector, an array of type CallChainDataType is read.
Selector reads an array containing only selected data (e.g. block numbers).
Access:
Read: yes (from 14V20)
Subscription: yes
Example:
NC.Chan.ActCallChain,1
The following data structure is provided for each level of the call chain of the
channel:
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 103/137
IndraWorks OPC UA Communication
CNC items
10.10.7 NC.Chan.ProgramPosition
Provides the current program position
Included are program name with path, file position and block number.
Item syntax:
NC.Chan.ProgramPosition,(1)[,(2)]
1. channel number
2. Selector:
“BlockNo“: Block number
“ProgramName“: Program name with path
“FilePosition“: File position
Without specifying the selector, a structure of type CallChainDataType is
read.
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ProgramPosition,1
104/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Return
NC.Chan.ActCallChain,1,BlockNo
Return
10.10.8 NC.Chan.ActSubProgram
Provides the name of the current subroutine
The result comprises the name and the path of the subroutine.
With read-protected subroutines and cycles, the name of the call‐
ing program is provided.
Item syntax:
NC.Chan.ActSubProgram,(1)
1. channel number
Access:
Read: yes (from 14V20)
Subscription: yes
Example:
NC.Chan.ActSubProgram,1
Return
10.10.9 NC.Chan.ActSubProgramVersion
Provides a version number used to detect changes in the current subroutine
Item syntax:
NC.Chan.ActSubProgramVersion,(1)
1. channel number
Access:
Read: yes (from 14V20)
Subscription: yes
Example:
NC.Chan.ActSubProgramVersion,1
Return
CNC items
10.10.10 NC.Chan.ActMainProgram
Provides the name and the path of the main program
Item syntax:
NC.Chan.ActMainProgram,(1)
1 channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActMainProgram,1
Return
10.10.11 NC.Chan.AxisPosAcs
Provides the current axis positions with regard to the axis coordinate system
Item syntax:
NC.Chan.AxisPosAcs,(1)[,(2)]
1. channel number
2. Selector:
1: Position
2: Name
3: Number
4: Unit
5: Channel
6: InPosition
7: KnowReferencePoint
8: DiameterProgActive
Without specifying the selector, an array of type AxisPositionDataType is
read.
Selector reads an array containing only selected data (e.g. position values).
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.AxisPosAcs,1
The following data structure is provided for each axis and coordinate:
106/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Data axis/coordinate 1
CNC items
10.10.12 NC.Chan.AxisPosAcsCoupl
Provides the current axis positions with respect to the axis coordinate system
at system axis coupling
10.10.13 NC.Chan.AxisPosAcsDrv
Provides the current actual axis positions with respect to the axis coordinate
system
The positions are directly provided from the drive data.
10.10.14 NC.Chan.AxisPosDistAcs
NC.Chan.AxisPosDistAcs provides the distance to go with respect to the axis
coordinate system
10.10.15 NC.Chan.AxisPosLag
Provides the lag of axes
10.10.16 NC.Chan.AxisPosWcs
Provides the current axis positions with respect to the workpiece coordinate
system of the axes
10.10.17 NC.Chan.AxisPosDistWcs
Provides the distance to go with respect to the workpiece coordinate system
10.10.18 NC.Chan.AxisPosEndWcs
Provides the axis end positions with respect to the workpiece coordinate sys‐
tem
The positions comprise corrections active to the programmed end value.
10.10.19 NC.Chan.AxisPosWcsDrv
Provides the actual Cartesian axis positions with respect to the workpiece co‐
ordinate system of the axes
10.10.20 NC.Chan.AxisPosProg
Provides the programmed axis positions.
10.10.21 NC.Chan.AxisPosMcs
Provides the current axis positions with respect to the machine coordinate
system of the axes
10.10.22 NC.Chan.AxisPosDistMcs
Provides the distance to go with respect to the machine coordinate system
10.10.23 NC.Chan.AxisPosBcs
Provides the current axis positions with respect to the basic coordinate sys‐
tem
10.10.24 NC.Chan.AxisPosBcsDrv
Provides the current actual axis positions with respect to the basic coordinate
system
The positions are directly provided from the drive data.
108/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
10.10.25 NC.Chan.ActZeroOffsetSum
Provides the sum of the active zero offset values of all ZO groups for all axes
in the channel
Item syntax:
NC.Chan.ActZeroOffsetSum,(1)[,(2)]
1. channel number
2. Selector:
1: Sum of the offset values
2: Name
3: Number
4: Unit
5: Channel
6: InPosition
7: KnowReferencePoint
8: DiameterProgActive
Without specifying the selector, an array of type AxisPositionDataType is
read.
Selector reads an array containing only selected data (e.g. offset values).
Access:
Read: yes
Subscription: yes
10.10.26 NC.Chan.ActDCorrectionValues
Provides the active D-correction values, i.e. the active values for length and
radius correction, as well as the edge position (orientation)
Item syntax:
NC.Chan.ActDCorrectionValues,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActDCorrectionValues,1
Return
CNC items
10.10.27 NC.Chan.ActOnlineCorrValue
Provides the active online correction values (WCS) for all axes of the chan‐
nel.
Item syntax:
NC.Chan.ActOnlineCorrValue,,(1)[,(2)]
1. channel number
2. Selector:
“Value” active online correction value
“Name”
“Number”
“Unit”
“Channel”
“InPosition”
“KnowReferencePoint”
“DiameterProgActive”
Without specifying a selector, an array of type CncValueDataType is read.
The selector reads an array containing only selected data (e.g. active online
correction values).
Access:
Read: yes
Subscription: yes
10.10.28 NC.Chan.ActPlacementBcrCorr
Provides the active D-correction values, i.e. the active values for length and
radius correction, as well as the edge position (orientation)
Item syntax:
NC.Chan.ActPlacementBcrCorr,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan. ActPlacementBcrCorr,1
Return
40 double X-offset
70.6 double Y-offset
-5.1 double Z-offset
75 double Phi angle
110/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
10.10.29 NC.Chan.ActPlacementData
Provides the active placement data of five banks with the related three coor‐
dinate values and three angle values
Item syntax:
NC.Chan.ActPlacementData,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan. ActPlacementData,1
Data is only displayed here for one bank.
Return
4 double X-coordinate
0.6 double Y-coordinate
1 double Z-coordinate
75 double Phi angle
45 double Theta angle
35 double Psi angle
10.10.30 NC.Chan.ActPlacementSumData
Provides the active sum values of the placements and the workpiece position
correction
Item syntax:
NC.Chan.ActPlacementSumData,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActPlacementSumData,1
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 111/137
IndraWorks OPC UA Communication
CNC items
Return
25 double X-sum
10.6 double Y-sum
0.0 double Z-sum
45 double Phi angle sum
12 double Theta angle sum
135 double Psi angle sum
10.10.31 NC.Chan.ActToolCorrectionValues
Provides the active tool correction values
The values for length correction and radius correction are provi‐
ded as well as edge position, Euler angle (orientation in space)
and edge number.
Item syntax:
NC.Chan.ActToolCorrectionValues,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActToolCorrectionValues,1
Return
10.10.32 NC.Chan.ActAxisOffsetTable
Provides the name and the path of the active axis offset table
Item syntax:
NC.Chan.ActAxisOffsetTable,(1)
1. channel number
Access:
Read: yes
112/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
Subscription: yes
Example:
NC.Chan.ActAxisOffsetTable,1
Return
10.10.33 NC.Chan.ActDCorrectionNmb
Provides the active D-correction number
Item syntax:
NC.Chan.ActDCorrectionNmb,(1)
Return
10.10.34 NC.Chan.ActDCorrectionTable
Provides the name and path of the active D-correction table
Item syntax:
NC.Chan.ActDCorrectionTable,(1)
1. channel number
Access:
Read: yes
Subscription:
Example:
NC.Chan.ActDCorrectionTable,1
Return
10.10.35 NC.Chan.ActPlacementTable
Provides name and path of the active placement table
Item syntax:
NC.Chan.ActPlacementTable,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActPlacementTable,1
Return
CNC items
10.10.36 NC.Chan.ActFeedOverride
Provides the current value of the feed override in percent
Item syntax:
NC.Chan.ActFeedOverride,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActFeedOverride,1
Return
10.10.37 NC.Chan.ActFeedrate
Provides the current feed value as three path feed values
For each feed value, the respectively active override is considered:
1. External command interpolator velocity:
This is specified for the interpolator (programmed feed)
2. Actual interpolator velocity:
Current path velocity
3. Internal command interpolator velocity:
This can be changed - compared to path feed 1 - by an application
(such as the FeedAdapt function). During feed programming in mm/rev
(G95), it provides the path feed in mm/min for example.
Item syntax:
NC.Chan.ActFeedrate,(1)
1. channel number
Access:
Read: yes
Velocity is specified in mm/min.
Subscription: yes
Example:
NC.Chan.ActFeedrate,1
Return
CNC items
10.10.38 NC.Chan.ProgrammedFeedrate
Provides the programmed feed values F1 and F2
Item syntax:
NC.Chan.ProgrammedFeedrate,(1)
1. channel number
Access:
Read: yes
Subscription: yes
Example:
NC.Chan.ActFeedrate,1
Return
10.10.39 NC.Chan.TestMode
Provides the current setting of channel inhibit or changes the total channel in‐
hibit
False = “Channel inhibit” inactive
True = “Channel inhibit” active
Item syntax:
NC.Chan.TestMode,(1)
1. channel number
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan.TestMode,1
Return
CNC items
10.10.40 NC.Chan.TestFeed
Provides the current setting of the test feed or changes this setting for the re‐
spective channel
False = “Test feed” inactive
TRUE = “Test feed” active
Item syntax:
NC.Chan.TestFeed,(1)
1. channel number
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan.TestFeed,1
Return
10.10.41 NC.Chan.TestRapidTraverse
Provides the current setting of the test rapid traverse or changes this setting
for the respective channel
False = “Test rapid traverse” inactive
True = “Test rapid” traverse active
Item syntax:
NC.Chan.TestRapidTraverse,(1)
1. channel number
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan.TestRapidTraverse,1
Return
10.10.42 NC.Chan.SkipBlock
Provides the current setting of "Skip block" or changes this setting for the re‐
spective channel
False = “Skip block” inactive
True = “Skip block” active
Item syntax:
116/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
NC.Chan.SkipBlock,(1)
1. channel number
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan.SkipBlock,1
Return
10.10.43 NC.Chan.OptionalStop
Provides the current setting of "Optional stop" or changes this setting for the
respective channel
False = “Optional stop” inactive
True = “Optional stop” active
Item syntax:
NC.Chan.OptionalStop,(1)
1. channel number
Access:
Read: yes
Write: yes
Subscription: yes
Example:
NC.Chan.OptionalStop,1
Return
CNC items
Example:
NC.Chan. ReentryChain,1
Return
Item syntax:
NC.DbTableDataRec,(1),(2),(3)
1. Element path (in Xpath syntax)
2. Key1 (e.g. sector)
3. Key2 (e.g. place)
Access:
Read: yes
Write: yes
Subscription: no
Example:
NC.DbTableDataRec,/DBT1/Rec/Hd/SKQ,1,1
Return
NC.DbTableDataRec,/DBT1/Rec/Hd/IKQ1,1,1
Return
10.11.2 NC.DbTableEvent
Reports write access to a DB table, to a substructure or to a data block of the
table
CNC items
numbers are consecutive, reporting is continuous. Otherwise, not all write ac‐
cesses are recorded and the DB table has to be read again.
Item syntax:
NC.DbTableEvent,(1),(2),(3)
1. Element path (in Xpath syntax)
2. Key1 (optional)
3. Key2 (optional)
Access:
Read: no
Write: no
Subscription: Only suitable for (data) subscription
Example:
NC.DbTableEvent,/DBT1
Return
10.11.3 NC.DbTableQuery
Searching for data blocks according to a preset search criterion. The search
criterion is indicated via parameters upon item instancing.
Search condition as list: Refer to the manual "IndraMotion MTX 14VRS OPC
Communication".
Item syntax:
NC.DbTableQuery,(1),…(n)
1. Root tag
2… n. Search condition as list
Access:
Read: Provides a list of all data blocks meeting the search condition.
For each data block, the string identifier of the NodeId is provided.
The namespace index of the node ID is 27.
Subscription: no
Example:
Search all data blocks with (K1=1) and (IKQ2=3)
NC.DbTableQuery,/DBT1,K1=1,IKQ2=3
Return
NC.DbTableDataRec,/
String 1. Found data set
DBT1/Rec,1,1
NC.DbTableDataRec,/
String 2. Found data set
DBT1/Rec,1,2
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 119/137
IndraWorks OPC UA Communication
CNC items
NamespaceIndex 29
IdentifierType Numeric
Identifier 70935
NamespaceIndex 29
IdentifierType Numeric
Identifier: 70942
NamespaceIndex 29
IdentifierType Numeric
Identifier 70944
NamespaceIndex 29
IdentifierType Numeric
Identifier 70948
CNC items
10 double Value of L1
NamespaceIndex: 29
IdentifierType: Numeric
Identifier: 70960
AffectedNode
EventField:
NodeId of the changed node of FileTable
AutomationDeviceFailureEventType
Provides error for event handling
NamespaceIndex: 29
IdentifierType: Numeric
Identifier: 70970
NamespaceUri - Error class
EventField:
SymbolicId - Error number
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 121/137
IndraWorks OPC UA Communication
CNC items
NamespaceIndex: 27
IdentifierType: String
Syntax: NC.FileTable,(1)
Identifier: 1. Table name (complete path, file name)
Example: NC.FileTable,/database/DC1.dct
NodeId of method
NamespaceIndex: 29
IdentifierType: String
Identifier: NC.FileTable.AddSet
Syntax:
AddSet (
);
NamespaceIndex: 27
IdentifierType: String
Identifier: Syntax: NC.FileTable,(1)
1. Table name (complete path, file name)
Example: NC.FileTable,/database/DC1.dct
NodeId of method
NamespaceIndex: 29
IdentifierType: String
Identifier: NC.FileTable.DeleteSet
Syntax:
DeleteSet (
);
NamespaceIndex: 27
IdentifierType: String
122/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
NodeId of method
NamespaceIndex: 29
IdentifierType: String
Identifier: NC.FileTable.InsertAxis
Syntax
InsertAxis (
[in] UInt32 Index
[in] UInt32 Chan
[in] String Name
[in] String Type
);
Index:
Position in the table at which the axis is to be inserted (the first axis has index
1).
If the index is larger than the current number of axes in the table, the axis is
added at the end.
Chan:
Channel assignment of axis (0 means no channel assignment)
Name:
Identifier of the axis
Type:
Type of axis (Lin: Linear axis; red: Rotary axis)
NamespaceIndex: 27
IdentifierType: String
Identifier: Syntax: NC.FileTable,(1)
1. Table name (complete path, file name)
Example: NC.FileTable,/database/ZO1.zot
NodeId of method
NamespaceIndex: 29
IdentifierType: String
Identifier: NC.FileTable.DeleteAxis
Syntax
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 123/137
IndraWorks OPC UA Communication
CNC items
DeleteAxis (
[in] UInt32 Index
);
Index:
Position in the table at which the axis is to be deleted (the first axis has index
1).
NamespaceIndex: 27
IdentifierType: String
Identifier: Syntax: NC.FileTable,(1)
1. Table name (complete path, file name)
Example: NC.FileTable,/database/ZO1.zot
NodeId of method
NamespaceIndex: 29
IdentifierType: String
Identifier: NC.FileTable.SetEventNotifier
Syntax
SetEventNotifier (
[in] Byte EventNotifier
);
EventNotifier
0: None
1: SubscibeToEvents
NamespaceIndex: 26
IdentifierType: String
Identifier: DirectoryPath (e.g. "/database")
124/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
CNC items
NodeId of method
NamespaceIndex: 29
IdentifierType: String
Identifier: NC.FileTable.Create
Syntax
CreateFileTable (
[in] NodeId TypeDefNodeId
[in] String Name
[in] String Template
[in] Int32 Channel
[out] NodeId FileTableNodeId
);
TypeDefNodeId:
NodeId of the table type
DctFileTableType: Type D-correction table
NamespaceIndex: 29
IdentifierType: Numeric
Identifier: 70942
NamespaceIndex: 29
IdentifierType: Numeric
Identifier: 70944
NamespaceIndex: 29
IdentifierType: Numeric
Identifier: 70948
Name:
File name of the new table (without path)
If no file extension is specified, it is added according to the table type.
Template:
Template for the table incl. path (optional)
Empty string: do not use template
Channel:
Channel number (optional)
Only for zero offset table
Specifies which axes are to be created:
>=1: all channel axes of the channel
-1: All system axes (default)
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 125/137
IndraWorks OPC UA Communication
CNC items
FileTableNodeId:
This output parameter returns the NodeID of the newly created table.
126/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 127/137
IndraWorks OPC UA Communication
Drive data
13 Drive data
13.1 General information
The “Sercos” object contains all Sercos devices connected in the systems
XLC/MLC and MTX. These are connected to the “Sercos” object via “Has‐
Component” references. The Sercos profiles and parameters of the respec‐
tive Sercos device are mapped below the Sercos devices according to the
"OPC Unified Architecture for Sercos Devices Companion Specification". All
instances of the mapped objects and variables are located in the namespace
"http://boschrexroth.com/OpcUa/Sercos/Objects/". The following figure shows
an exemplary OPC UA address space with drive data. The right section of
the figure shows the information read on the Sercos parameter S-0-0138.
13.2 Application
The Sercos parameters allow read access (read service) and write access
(write service). Additionally, they can be added to a subscription as monitored
item. A limited number of parameters is specified. This limitation depends on
the sampling interval used. This relation is shown in the following table. It
shows for example that five parameters are used as monitored items in a
sampling interval of 50 ms for a subscription. At the same time, five more pa‐
rameters can be added in a sampling interval of 100 ms. This also applies to
the other sampling intervals shown in the table.
Index
Index
A Helpdesk........................................................... 133
About this documentation..................................... 7 Hotline............................................................... 133
Information representation............................. 10
Validity of the documentation........................... 7 I
ANSI Z535.6-2006.............................................. 10 Important instructions on use.............................. 13
AutomationConditionType................................... 52 Intended use.................................................. 13
AutomationDiscreteAlarmType........................... 53 Intended use
AutomationErrorType.......................................... 53 Areas of use and application.......................... 13
AutomationWarningType.................................... 53 Introduction.................................................... 13
Introducing the OPC Unified Architecture
B General information....................................... 15
BaseEventType................................................... 56 OPC UA information model............................ 16
Overview on specifications............................ 15
C Service-oriented architecture......................... 16
CML65................................................................ 65
CNC items O
General information....................................... 77 Object description......................................... 57, 64
Type description............................................. 77 Example CML65............................................ 65
Complaints.......................................................... 12 Example HardwareComponentSet................ 65
ComponentType................................................. 62 Example SoftwareComponentSet.................. 64
ConditionType..................................................... 54 General information....................................... 64
Configuration by the client.................................. 25 OPC UA
Configuration of the OPC UA server of the Introduction in the OPC Unified Architec‐
MTX..................................................................... 22 ture................................................................. 15
Configuration of the OPC UA server of the OPC UA communication example................. 39
XLC/MLC............................................................ 23 Properties of the OPC UA server................... 21
Criticism.............................................................. 12 Server of XLC/MLC and MTX........................ 47
Customer Feedback............................................ 12 The Bosch Rexroth OPC UA server.............. 21
OPC UA communication example
D Establish a connection................................... 40
DiagnosisLogbook.............................................. 51 Introduction.................................................... 39
General information....................................... 51 Subscribe....................................................... 43
Type description............................................. 51 UaExpert........................................................ 39
Discovery............................................................ 47 Write............................................................... 46
General information....................................... 47 OPC UA communication sample
Discovery server................................................. 47 Prerequisites.................................................. 39
DiscreteAlarmType............................................. 54 OPC UA Communication sample
Documentation: Browse........................................................... 42
Record of revision............................................ 7 OPC UA server of XLC/MLC and MTX............... 47
E R
Example CML65................................................. 65 RexrothDeviceType............................................ 60
Example HardwareComponentSet..................... 65 RIL_OpcUaClient.library........................... 127, 129
Example SoftwareComponentSet....................... 64 RIL_OpcUaServer.library.................................. 129
F S
Feedback............................................................ 12 Safety instructions............................................... 10
File system Security configuration......................................... 24
General information....................................... 67 Server address spaces
Available namespaces................................... 26
H Available test nodes....................................... 38
General information....................................... 26
HardwareComponentSet.................................... 65
Server address space.................................... 28
HardwareComponentType.................................. 63
The address space in the XLC/MLC sys‐
Hazard warnings................................................. 10
tem................................................................. 29
136/137 Bosch Rexroth AG DOK-IWORKS-OPC*UA*****-AP04-EN-P
IndraWorks OPC UA Communication
Index
T
The Bosch Rexroth OPC UA server
Configuration by the client............................. 25
Configuration of the OPC UA server of
the MTX......................................................... 22
Configuration of the OPC UA server of
the XLC/MLC................................................. 23
General information....................................... 21
Properties of the Bosch Rexroth OPC UA
server............................................................. 21
Security configuration.................................... 24
Server address spaces.................................. 26
Tool description
Overview.................................................. 51, 59
Type description............................................ 51, 59
AutomationConditionType.............................. 52
AutomationDiscreteAlarmType...................... 53
AutomationErrorType..................................... 53
AutomationWarningType............................... 53
BaseEventType.............................................. 56
ComponentType............................................ 62
ConditionType................................................ 54
DiscreteAlarmType........................................ 54
HardwareComponentType............................. 63
RexrothDeviceType....................................... 60
SoftwareComponentType.............................. 63
Type plate........................................................... 59
General information....................................... 59
Typeplate
Type description............................................. 59
U
Unintended use
Consequences, non-liability........................... 13
Introduction.................................................... 13
W
Warnings............................................................. 10
DOK-IWORKS-OPC*UA*****-AP04-EN-P Bosch Rexroth AG 137/137
IndraWorks OPC UA Communication
Notes
Bosch Rexroth AG
Electric Drives and Controls
P.O. Box 13 57
97803 Lohr, Germany
Bgm.-Dr.-Nebel-Str. 2
97816 Lohr, Germany
Phone +49 9352 18 0
Fax +49 9352 18 8400
www.boschrexroth.com/electrics
*R911379309*
R911379309
DOK-IWORKS-OPC*UA*****-AP04-EN-P