340 pp.
Beckhoff Automation GmbH & Co. KG · 83 pp.
Beckhoff Automation EN Automation Interface User Manual PDF
Related manuals
119 pp.
125 pp.
28 pp.
32 pp.
166 pp.
96 pp.
285 pp.
Contents
Document text
Manual | EN Automation Interface 2023-01-25 | Version: 1.2
Table of contents
Table of contents Table of contents 1 Foreword.................................................................................................................................................... 5 1.1 Notes on the documentation ............................................................................................................. 5 1.2 Safety instructions............................................................................................................................. 6 1.3 Notes on information security............................................................................................................
7 2 Overview .................................................................................................................................................... 8 2.1 Version overview............................................................................................................................... 9 2.2 Frequently Asked Questions ........................................................................................................... 11 3 System requirements..............................................................................................................................
14 4 Installation ............................................................................................................................................... 15 5 Configuration........................................................................................................................................... 17 5.1 Basics.............................................................................................................................................. 17 5.1.1 Accessing TwinCAT configuration ...................................................................................
17 5.1.2 Browsing TwinCAT configuration..................................................................................... 18 5.1.3 Custom TreeItem Parameters.......................................................................................... 20 5.2 Best practice ................................................................................................................................... 23 5.2.1 Building an EtherCAT topology........................................................................................ 23 5.2.2 From offline to online configurations ................................................................................
27 6 API ............................................................................................................................................................ 30 6.1 ITcSysManager ............................................................................................................................... 30 6.1.1 ITcSysManager::NewConfiguration ................................................................................. 31 6.1.2 ITcSysManager::OpenConfiguration................................................................................ 32 6.1.3 ITcSysManager::SaveConfiguration ................................................................................
32 6.1.4 ITcSysManager::ActivateConfiguration............................................................................ 33 6.1.5 ITcSysManager::IsTwinCATStarted................................................................................. 33 6.1.6 ITcSysManager::StartRestartTwinCAT............................................................................ 33 6.1.7 ITcSysManager::LinkVariables ........................................................................................ 33 6.1.8 ITcSysManager::UnlinkVariables.....................................................................................
34 6.1.9 ITcSysManager2::GetTargetNetId ................................................................................... 34 6.1.10 ITcSysManager2::SetTargetNetId.................................................................................... 35 6.1.11 ITcSysManager2::GetLastErrorMessages....................................................................... 35 6.1.12 ITcSysManager::LookupTreeItem.................................................................................... 35 6.1.13 ITcSysManager3::LookupTreeItemById...........................................................................
36 6.1.14 ITcSysManager3::ProduceMappingInfo........................................................................... 36 6.1.15 ITcSysManager3::ConsumeMappingInfo......................................................................... 37 6.2 ITcSmTreeItem................................................................................................................................ 37 6.2.1 ITcSmTreeItem Item Types.............................................................................................. 39 6.2.2 ITcSmTreeItem Item Sub Types ......................................................................................
41 6.2.3 ITcSmTreeItem::ProduceXml........................................................................................... 60 6.2.4 ITcSmTreeItem::ConsumeXml......................................................................................... 61 6.2.5 ITcSmTreeItem::CreateChildITcSmTreeItem................................................................... 62 6.2.6 ITcSmTreeItem::DeleteChild............................................................................................ 63 6.2.7 ITcSmTreeItem::ImportChild............................................................................................
64 6.2.8 ITcSmTreeItem::ExportChild............................................................................................ 64 Automation Interface 3 Version: 1.2
Table of contents
Table of contents 6.2.9 ITcSmTreeItem::LookupChild .......................................................................................... 65 6.2.10 ITcSmTreeItem2::ResourcesCount.................................................................................. 65 6.2.11 ITcSmTreeItem::ChangeChildSubType ........................................................................... 65 6.2.12 ITcSmTreeItem2::ClaimResources.................................................................................. 66 6.2.13 ITcSmTreeItem3::CompareItem.......................................................................................
66 6.2.14 ITcSmTreeItem::GetLastXmlError.................................................................................... 66 7 Samples ................................................................................................................................................... 67 8 How to ...................................................................................................................................................... 69 8.1 How to activate a previously created configuration.........................................................................
69 8.2 How to link variables ....................................................................................................................... 70 8.3 How to unlink variables ................................................................................................................... 70 8.4 How to disable/enable a tree item (e.g. an I/O device) ................................................................... 71 8.5 How to change the path to a plc project and/or rescan the project ................................................. 71 8.6 How to change the fieldbus address (station no.) of a profibus box ...............................................
72 8.7 How to export/import the information of a child of a tree item......................................................... 73 8.8 How to enumerate through the child's of a tree item....................................................................... 74 8.9 How to add child items (devices, boxes, terminals, variables etc.) ................................................. 75 8.10 How to update the address information of I/O devices ................................................................... 75 8.11 How to create/change a linkage of a nc axis, encoder or drive to an I/O device, box or terminal...
76 8.12 How to exchange a fieldbus device and move all childs to the new one ........................................ 77 8.13 How to scan devices and boxes...................................................................................................... 77 8.14 How to add routes to a remote ADS device .................................................................................... 79 8.15 How to execute a broadcast search................................................................................................ 81 Automation Interface 4 Version: 1.2
1.1 Notes on the documentation
Foreword 1 Foreword 1.1 Notes on the documentation This description is only intended for the use of trained specialists in control and automation engineering who are familiar with applicable national standards. It is essential that the documentation and the following notes and explanations are followed when installing and commissioning the components. It is the duty of the technical personnel to use the documentation published at the respective time of each installation and commissioning. The responsible staff must ensure that the application or use of the products described satisfy all the requirements for safety, including all the relevant laws, regulations, guidelines and standards.
Disclaimer The documentation has been prepared with care. The products described are, however, constantly under development. We reserve the right to revise and change the documentation at any time and without prior announcement. No claims for the modification of products that have already been supplied may be made on the basis of the data, diagrams and descriptions in this documentation. Trademarks Beckhoff ® , TwinCAT ® , TwinCAT/BSD ® , TC/BSD ® , EtherCAT ® , EtherCAT G ® , EtherCAT G10 ® , EtherCAT P ® , Safety over EtherCAT ® , TwinSAFE ® , XFC ® , XTS ® and XPlanar ® are registered trademarks of and licensed by Beckhoff Automation GmbH.
Other designations used in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owners. Patent Pending The EtherCAT Technology is covered, including but not limited to the following patent applications and patents: EP1590927, EP1789857, EP1456722, EP2137893, DE102015105702 with corresponding applications or registrations in various other countries. EtherCAT ® is a registered trademark and patented technology, licensed by Beckhoff Automation GmbH, Germany Copyright © Beckhoff Automation GmbH & Co. KG, Germany.
The reproduction, distribution and utilization of this document as well as the communication of its contents to others without express authorization are prohibited. Offenders will be held liable for the payment of damages. All rights reserved in the event of the grant of a patent, utility model or design. Automation Interface 5 Version: 1.2