SoMachine EIO0000000067 04/2012

SoMachine
Programming Guide
04/2012

EIO0000000067.07

www.schneider-electric.com

The information provided in this documentation contains general descriptions and/or technical characteristics of the performance of the products contained herein. This documentation is not intended as a substitute for and is not to be used for determining suitability or reliability of these products for specific user applications. It is the duty of any such user or integrator to perform the appropriate and complete risk analysis, evaluation and testing of the products with respect to the relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein. If you have any suggestions for improvements or amendments or have found errors in this publication, please notify us. No part of this document may be reproduced in any form or by any means, electronic or mechanical, including photocopying, without express written permission of Schneider Electric. All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer should perform repairs to components. When devices are used for applications with technical safety requirements, the relevant instructions must be followed. Failure to use Schneider Electric software or approved software with our hardware products may result in injury, harm, or improper operating results. Failure to observe this information can result in injury or equipment damage. 2012 Schneider Electric. All rights reserved.

EIO0000000067 04/2012

Table of Contents

Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

7 9

Part I Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Introduction to Programming . . . . . . . . . . . . . . . . . . . . .
Programming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13
15
15

Chapter 2 Managing Projects with SoMachine . . . . . . . . . . . . . . . .

Main Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17
17

Part II Managing Your Project . . . . . . . . . . . . . . . . . . . . . . .

Chapter 3 Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.1 General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Description of the Main Selection Screen . . . . . . . . . . . . . . . . . . Accessing General Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2 Show Existing Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Show Existing Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3 Create New Machine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create New Machine Sub-Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start with Standard Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start with Empty Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start with TVD Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start with Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start with Existing Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4 Machine Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Machine Workflow Sub-Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Commission Machine - Start with Project . . . . . . . . . . . . . . . . . . . . . . . . . Commission Machine - Upload Project from Device . . . . . . . . . . . . . . . . . Update Firmware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5 Learning Center. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Learning Center. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19
21
22 23 26 28 28 32 33 34 36 37 40 42 43 44 45 47 50 52 52

Chapter 4 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Overview of the Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . Description of the General Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Description of the Description Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Description of the Custom Information Task . . . . . . . . . . . . . . . . . . . . . . .
EIO0000000067 04/2012

55
56 58 59 61
3

Chapter 5 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Description of the Configuration Tab . . . . . . . . . . . . . . . . . . . . . 5.2 Graphical Configuration Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Deleting Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Detecting Configuration Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing Programming and Application Functions with the Graphical Configuration Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Network Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63
64 64 68 69 71 73 81 83 85

Chapter 6 Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Description of the Program Tab . . . . . . . . . . . . . . . . . . . . . . . . . 6.2 Managing the Application Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Declaring POUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Declaring Remanent Variables . . . . . . . . . . . . . . . . . . . . . . . Adding a Symbol Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Other Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction to Data Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction to Network Variables List (NVL) . . . . . . . . . . . . . . . . . . . . . . 6.3 Adding Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Expansion Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Communication Managers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Devices to a Communication Manager . . . . . . . . . . . . . . . . . . . . Adding Devices from Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.4 Managing the Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generalities About Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Library Management in SoMachine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Schneider Electric Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Other Libraries Used in SoMachine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Your Own Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.5 Managing the Communication Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Ethernet Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the CANopen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Serial Line Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Profibus DP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the AS-Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.6 SoMachine Commands Simplifying Programming. . . . . . . . . . . . . . . . . . Function and Function Block Finder . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing a Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

89
90 90 93 94 95 97 100 102 103 104 106 109 110 111 113 115 118 119 120 123 127 135 138 139 140 143 149 152 155 161 162 166

EIO0000000067 04/2012

6.7 SoMachine Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SoMachine Commands Providing Single Access to Your Machine . . . . . Description of the Build All Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . Description of the Create Boot Application Command . . . . . . . . . . . . . . . Description of the USB Mass Storage Command . . . . . . . . . . . . . . . . . . . Description of the Remote Connection Command . . . . . . . . . . . . . . . . . . Description of the Import / Export Vijeo-Designer Project Commands . . . 6.8 SoMachine Controller-HMI Data Exchange . . . . . . . . . . . . . . . . . . . . . . . SoMachine Single Variable Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing Variables in the Controller Part . . . . . . . . . . . . . . . . . . . . . . . . Selecting Variables in the HMI Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing Variables in the HMI Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Parametrization of the Physical Media . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.9 SoMachine Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Information about SoMachine Templates . . . . . . . . . . . . . . . . . . Supported Fieldbusses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting SoMachine Templates for Your Project. . . . . . . . . . . . . . . . . . . Administration of SoMachine Templates. . . . . . . . . . . . . . . . . . . . . . . . . . 6.10 Managing Device Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Facts of Device Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Devices from Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Device Template on the Basis of Field Devices . . . . . . . . . . . Visualizations Suitable for Creating Device Templates. . . . . . . . . . . . . . . Further Information on Integrating Control Logic into Device Templates . Steps to Create a Device Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.11 Managing Function Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Facts of Function Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Functions From Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Functions as Basis for Function Templates . . . . . . . . . . . . . . Steps to Create a Function Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.12 Downloading and Running Applications . . . . . . . . . . . . . . . . . . . . . . . . . . Downloading Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Running Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6.13 Check for the Latest Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check for the Latest Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

170 171 172 173 174 176 181 182 183 187 188 189 191 192 193 195 196 198 204 205 206 208 209 210 213 217 218 219 222 224 226 227 230 231 231

Chapter 7 Commissioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Description of the Commissioning Tab . . . . . . . . . . . . . . . . . . . . Description of the Login/Logout Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . Description of the Multiple Download Task . . . . . . . . . . . . . . . . . . . . . . . . Description of the Source Download Task . . . . . . . . . . . . . . . . . . . . . . . . Description of the Save Data / Restore Data Tasks . . . . . . . . . . . . . . . . .

235
236 239 244 246 247

Chapter 8 Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

251
251

EIO0000000067 04/2012

Part III Troubleshooting and FAQ . . . . . . . . . . . . . . . . . . . .

Chapter 9 Generic - Troubleshooting and FAQ . . . . . . . . . . . . . . . .
9.1 Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shortcuts and Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling and Configuring Analog Inputs on CANopen . . . . . . . . . . . . . . Startup Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

257
259
259 260 262 264

Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A Usage of the OPC Server 3 . . . . . . . . . . . . . . . . . . . . . . . .
General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Declaring a Variable to be Used With OPC . . . . . . . . . . . . . . . . . . . . . . . OPC Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Usage of the CoDeSys OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . .

265
267
268 270 273 280

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

281 313

EIO0000000067 04/2012

Safety Information

Important Information
NOTICE Read these instructions carefully, and look at the equipment to become familiar with the device before trying to install, operate, or maintain it. The following special messages may appear throughout this documentation or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure.

EIO0000000067 04/2012

PLEASE NOTE Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this material. A qualified person is one who has skills and knowledge related to the construction and operation of electrical equipment and its installation, and has received safety training to recognize and avoid the hazards involved.

EIO0000000067 04/2012

About the Book

At a Glance
Document Scope This document describes the graphical user interface of the SoMachine software and the functions it provides. For further information, refer to the separate documents provided in the SoMachine online help. Validity Note This document has been updated with the release of SoMachine V3.1. Related Documents
Title of Documentation ATV IMC Drive Controller Programming Guide Reference Number EIO0000000390 (ENG); EIO0000000391 (FRE); EIO0000000392 (GER); EIO0000000393 (SPA); EIO0000000394 (ITA); EIO0000000395 (CHS) EIO0000000632 (ENG); EIO0000000633 (FRE); EIO0000000634 (GER); EIO0000000635 (SPA); EIO0000000636 (ITA); EIO0000000637 (CHS) EIO0000000638 (ENG); EIO0000000639 (FRE); EIO0000000640 (GER); EIO0000000641 (SPA); EIO0000000642 (ITA); EIO0000000643 (CHS)

Magelis XBTGC HMI Controller Programming Guide

Magelis XBTGT, XBTGK HMI Controller Programming Guide

EIO0000000067 04/2012

Modicon M238 Logic Controller Programming Guide

EIO0000000384 (ENG); EIO0000000385 (FRE); EIO0000000386 (GER); EIO0000000388 (SPA); EIO0000000387 (ITA); EIO0000000389 (CHS) EIO0000000374 (ENG); EIO0000000737 (FRE); EIO0000000738 (GER); EIO0000000739 (SPA); EIO0000000740 (ITA); EIO0000000741 (CHS) EIO0000000402 (ENG); EIO0000000403 (FRE); EIO0000000404 (GER); EIO0000000405 (SPA); EIO0000000406 (ITA); EIO0000000407 (CHS) EIO0000000408 (ENG); EIO0000000409 (FRE); EIO0000000410 (GER); EIO0000000411 (SPA); EIO0000000412 (ITA); EIO0000000413 (CHS) EIO0000000673 (ENG); EIO0000000674 (FRE); EIO0000000675 (GER); EIO0000000676 (SPA); EIO0000000677 (ITA); EIO0000000678 (CHS)

M238 ExecLoader User Guide

Modicon M258 Logic Controller Programming Guide

Modicon LMC058 Logic Controller Programming Guide

SoMachine DTM Programming Guide

You can download these technical publications and other technical information from our website at www.schneider-electric.com.

10

EIO0000000067 04/2012

Product Related Information

WARNING
LOSS OF CONTROL
z

z z

z z

The designer of any control scheme must consider the potential failure modes of control paths and, for certain critical control functions, provide a means to achieve a safe state during and after a path failure. Examples of critical control functions are emergency stop and overtravel stop, power outage and restart. Separate or redundant control paths must be provided for critical control functions. System control paths may include communication links. Consideration must be given to the implications of unanticipated transmission delays or failures of the link. Observe all accident prevention regulations and local safety guidelines.1 Each implementation of this equipment must be individually and thoroughly tested for proper operation before being placed into service.

Failure to follow these instructions can result in death, serious injury, or equipment damage. For additional information, refer to NEMA ICS 1.1 (latest edition), "Safety Guidelines for the Application, Installation, and Maintenance of Solid State Control" and to NEMA ICS 7.1 (latest edition), "Safety Standards for Construction and Guide for Selection, Installation and Operation of Adjustable-Speed Drive Systems" or their equivalent governing your particular location.
1

WARNING
UNINTENDED EQUIPMENT OPERATION
z z

Only use software approved by Schneider Electric for use with this equipment. Update your application program every time you change the physical hardware configuration.

Failure to follow these instructions can result in death, serious injury, or equipment damage. User Comments We welcome your comments about this document. You can reach us by e-mail at [email protected].

EIO0000000067 04/2012

11

12

EIO0000000067 04/2012

SoMachine Introduction EIO0000000067 04/2012

Introduction

I
Whats in this Part? This part contains the following chapters:
Chapter 1 2 Chapter Name Introduction to Programming Managing Projects with SoMachine Page 15 17

EIO0000000067 04/2012

13

Introduction

14

EIO0000000067 04/2012

SoMachine Introduction to Programming EIO0000000067 04/2012

Introduction to Programming

1
Programming
Overview SoMachine allows you to configure, program and commission entire machines in a single software environment. It consists of 2 parts dedicated to specific programming tasks: z SoMachine part for controller programming z Vijeo-Designer part for HMI programming User Documentation This programming manual describes the SoMachine user interface and functions. It is part of the SoMachine online help. To start the SoMachine online help, click the ? button in the SoMachine screen or select the Help command from the General Functions Menu (see page 26). To start the online help from the Program screen of SoMachine, use the Help menu or press the F1 key. To start the Vijeo-Designer online help, select a suitable command from the Help menu or press the F1 key when you are in the Vijeo-Designer application. For general information on SoMachine, like for example system requirements, installation and supported devices, refer to section Introduction of the SoMachine online help. For detailed information on the controllers and integrated HMIs supported by SoMachine, refer to section Hardware User Guides of the SoMachine online help. For detailed information on SoMachine libraries, refer to section Functions & Libraries User Manuals of the SoMachine online help.

EIO0000000067 04/2012

15

Introduction to Programming

16

EIO0000000067 04/2012

SoMachine Managing Projects with SoMachine EIO0000000067 04/2012

Managing Projects with SoMachine

Main Tasks
Overview SoMachine provides a graphical user interface based on the 3 main tasks that it has been designed for: z configuring projects z programming projects z commissioning machines Configuring Projects SoMachine provides tools that are intended to assist you in creating new projects quickly and easily. It provides for project start-up a variety of tested validated documented architectures (a dedicated TVDA Finder tool assists you in selecting the architecture that most appropriately suits your individual project), z a variety of application projects for conveying, hoisting, and packaging that provide basic configurations for these applications, z some examples that provide basic projects for making yourself familiar with SoMachine.
z

Once the project is created, SoMachine provides extensive possibilities to add textual and graphical information to each project file. This additional information enables you to distinguish projects avoiding the need to open them when you have to select the suitable project out of those that are available on your computer. For easy configuration of your project, SoMachine provides a graphical configuration editor that allows to add and configure devices in an intuitive way. Programming Projects For programming projects, the conventional CoDeSys graphical user interface is integrated into SoMachine. It provides the general programming and controller configuration functions. For configuring HMI controllers, Vijeo-Designer is used.
EIO0000000067 04/2012

17

Managing Projects with SoMachine

Commissioning Machines SoMachine provides components that are especially dedicated to machine commissioning. These components provide only those functions that are required for this task, like login into the devices, configuring last parameters and up- or downloading software and/or sourcecode.

18

EIO0000000067 04/2012

SoMachine Managing Your Project EIO0000000067 04/2012

Managing Your Project

II
Whats in this Part? This part contains the following chapters:
Chapter 3 4 5 6 7 8 Home Properties Configuration Program Commissioning Report Chapter Name Page 21 55 63 89 235 251

EIO0000000067 04/2012

19

Managing Your Project

20

EIO0000000067 04/2012

SoMachine Home EIO0000000067 04/2012

Home

3
Whats in this Chapter? This chapter contains the following sections:
Section 3.1 3.2 3.3 3.4 3.5 General Information Show Existing Machine Create New Machine Machine Workflow Learning Center Topic Page 22 28 32 43 52

EIO0000000067 04/2012

21

Home

3.1

General Information

Whats in this Section? This section contains the following topics:

Topic General Description of the Main Selection Screen Accessing General Functions Page 23 26

22

EIO0000000067 04/2012

Home

General Description of the Main Selection Screen

Starting up SoMachine Start SoMachine by using the Start Programs Schneider Electric SoMachine menu or double-click the SoMachine icon on your desktop or doubleclick an already existing SoMachine project file in Windows Explorer. NOTE: If you start SoMachine via the Start menu or by double-clicking the SoMachine icon, the main selection screen will be displayed as described below. If you start SoMachine by double-clicking an already existing SoMachine project file, SoMachine will start with the Program tab (see page 90). A splash screen will be displayed indicating that the program is being started.

EIO0000000067 04/2012

23

Home

Elements of the Main Selection Screen After successful startup SoMachine displays the main selection screen (the Home tab), which provides access to the available functions. The following window will be displayed after SoMachine startup:

1 2 3 4

This SoMachine icon provides access to the general functions menu. The task selection pane on the left-hand side shows the tasks that are provided by the Home screen, you can hide this pane by clicking the handle (position 7 in the figure). The work area in the middle is intended to always be visible. It provides access to the most recently opened projects. The Files of type list allows you to display All files or to display only Project files or Library files or CoDeSys project files (before V3.0) or CoDeSys library files (before V3.0) in this work area. The View list allows you to change from the thumbnails view of the projects to a more detailed List view.

24

EIO0000000067 04/2012

Home 6 The information pane on the right-hand side shows further information on the project that is currently selected in the work area. It contains the Open button to open the selected project. You can hide this pane by clicking the handle. Handles to hide or display the task selection pane on the right-hand side, the information pane on the left-hand side and the message pane at the bottom of the window is not visible by default in the startup screen. The Language list allows you to change the language of the SoMachine user interface, after you have changed the language you must restart SoMachine for the changes to become valid. The ? icon provides quick access to the SoMachine online help.

Tasks of the Home Tab The task selection pane on the left-hand side of the main selection screen groups the SoMachine functions in folders according to the tasks you can perform with them.
Tasks of the Home Screen Show existing machine Sub-Tasks This folder provides sub-tasks for opening an already existing SoMachine project, and for opening a project archive file (refer to the Show Existing Machine (see page 28) chapter for details). This folder provides sub-tasks for creating a new SoMachine project file or library file either from scratch or by using a template. Refer to the Create New Machine (see page 32) chapter for details. This folder provides sub-tasks that are especially dedicated to commissioning a machine. Further commands that are beyond commissioning tasks are not available from this folder. Refer to the Machine Workflow (see page 43) chapter for details. This folder provides further information on SoMachine. Refer to the Learning Center (see page 52) chapter for details.

Create new machine

Machine workflow

Learning Center

Closing SoMachine Projects The Home tab also serves for closing your SoMachine project. Just click the Home tab when you are inside a project, and the project will be closed, returning you to the main selection screen as indicated in the above figure.

EIO0000000067 04/2012

25

Home

Accessing General Functions

The General Functions Menu Click the SoMachine icon that is visible in the upper left corner of the SoMachine window to access the general functions menu.

The general functions menu provides the following commands:

Command Home Description Execute this command to return to the Home tab (closing your currently open project), that is the main selection screen (see page 24) of SoMachine. Execute this command to save the changes to your currently open project. Execute this command to save your currently open project / library to a different location or under a different name. A standard Windows Save Project dialog box is displayed that allows you to browse to the new folder and / or enter the new file name.

Save Save As

26

EIO0000000067 04/2012

Home

Command Save/Send archive

Description Execute this command to create an archive file of the SoMachine project that is currently open and: z to save the archive file to a connected drive by using the Save button of the Project Archive dialog box or z to create a temporary archive file that is attached to an empty email by using the Send button of the Project Archive dialog box. This e-mail is automatically created by SoMachine if the Messaging Application Programming Interface (MAPI) is correctly installed. See your local administrator for more information. Execute this command to configure: z the Preferred Path where to open and save SoMachine projects. z the Online Polling Interval (ms) that is the time span that has to elapse between 2 attempts to poll the connected devices. z the Routing Step Width that defines the grid size of the graphical configuration editor (see page 68). Select a value between 15 (wide grid) and 50 (small grid), bearing in mind that a smaller grid (a higher value) leads to longer times for refreshing the graphical representation of your configuration. z the Timeout for routing that defines the time the graphical configuration editor (see page 68) is allowed to (re)route the graphical representation of your configuration in order to create right-angled connecting lines. If this timeout elapses before the routing process is finished, the remaining lines will be displayed without right-angles. z the Stop Gateway on Exit check box defines the behavior of the gateway after closing the last instance of SoMachine: z check box checked (default) The gateway is automatically stopped when you exit the last SoMachine instance. If other instances of SoMachine are still running, using the gateway, it will not be stopped. z check box unchecked The gateway will not be stopped automatically when you exit the last SoMachine instance.
z general settings by clicking the Options button.

Preferences

Help About

Execute this command to open the SoMachine online help. Execute this command to open the About dialog box that provides information about the currently installed SoMachine version as well as license and technical information. Execute this command to close SoMachine.

Exit

EIO0000000067 04/2012

27

Home

3.2

Show Existing Machine

Show Existing Machine

Sub-Tasks With the Show existing machine task you can open an already existing project. It includes the following sub-tasks: Browse for existing project to open an existing SoMachine project z Extract archive to open an existing SoMachine project archive file
z

Opening a Most Recent Project The work area provides quick access to the SoMachine projects you had opened before. You can define the number of projects that will be displayed here in the Options dialog box that is accessible via the general functions menu (see page 26) Preferences Options Load and Save Display [1-16] items in most recently used list.

28

EIO0000000067 04/2012

Home

1 2

3 4

The most recently opened projects will be displayed in the SoMachine work area. The Files of type list allows you to display All files or to display only Project files or Library files or CoDeSys project files (before V3.0) or CoDeSys library files (before V3.0) in this work area. The View list allows you to change from the thumbnails view of the projects to a more detailed List view. The information pane displays Project Information related to the project that is selected in the work area. To open the selected project, click the Open button.

Double-click its icon in the work area or select the project in the work area and click the Open button in the information pane to open the project in SoMachine. SoMachine will select the Properties tab (see page 56) for assigning further information.

EIO0000000067 04/2012

29

Home

Browsing for Existing Project The sub-task Browse for existing project allows you to browse for existing projects on the local drives or on connected network drives.

1 2 3

4 5

The task selection pane shows the connected drives similar to a Windows Explorer. The work area displays the SoMachine projects that are available in the folder you have selected in the selection pane. The Files of type list allows you to display All files or to display only Project files or Library files or CoDeSys project files (before V3.0) or CoDeSys library files (before V3.0) in this work area. The View list allows you to change from the thumbnail view of the projects to a more detailed List view. The information pane displays Project Information related to the project that is selected in the work area. To open the selected project, click the Open button.

30

EIO0000000067 04/2012

Home

In the task selection pane browse to the folder that contains the SoMachine project you want to open. Double-click its icon in the work area or select the project in the work area and click the Open button in the information pane to open the project in SoMachine. SoMachine will select the Properties tab (see page 56) for assigning further information. To access network drives that are not mapped on your PC, proceed as follows:
Step 1 2 3 Action Click the Remote drive task in the task selection pane. Enter the server name and the subfolder name(s) according to the following syntax in the text box: \\servername\foldername Click the Open button. Result: The content of the server / subfolder will be displayed in the task selection pane similar to a Windows Explorer.

Opening a Project Archive The sub-task Extract Archive allows you to open existing SoMachine project archive files. To open an existing SoMachine project archive file proceed as follows:
Step 1 2 3 4 Action Select the Extract Archive sub-task from the task selection pane. Result: The Extract Archive dialog box will be displayed. Browse to the folder that contains the project archive file you want to open. Select the project archive file and click the Open button. Result: The Project Archive dialog box opens. In the Project Archive dialog box select the Referenced devices and Referenced libraries you want to extract from the archive file and click the Extract button. Result: SoMachine extracts the selected items from the archive file and automatically opens the project.

EIO0000000067 04/2012

31

Home

3.3

Create New Machine

Whats in this Section? This section contains the following topics:

Topic Create New Machine Sub-Tasks Start with Standard Project Start with Empty Project Start with TVD Architecture Start with Application Start with Existing Project Page 33 34 36 37 40 42

32

EIO0000000067 04/2012

Home

Create New Machine Sub-Tasks

Sub-Tasks With the Create new machine task you can create a new project either from scratch or by using a project template. It includes the following sub-tasks: z Start with standard project z Start with empty project z Start with TVD architecture z Start with application z Start with existing project

EIO0000000067 04/2012

33

Home

Start with Standard Project

Function of the Sub-Task The Start with standard project sub-task allows you to create a new project for a controller or HMI of your choice. In one single step you can enter a name for the Program Organization Unit (POU) (for controllers and HMIs with controller), and select the programming language for this POU. SoMachine creates a project with the name you entered, including the selected device, the programming language as well as the POU, that is automatically associated to a master (MAST) task.

34

EIO0000000067 04/2012

Home

Creating a new Standard Project To create a new standard project, proceed as follows:
Step 1 2 Action In the Home tab select Create new machine Start with standard project. From the Device list select the controller or HMI you want to create a new project for. Comment If you select a device for which SoMachine provides template projects (for example ATV IMC) an additional text box is displayed below the Project Initialization Settings. It indicates that template projects are available for this device and provides a link to the Start with Application screen. You can follow this link to select one of the provided project templates as basis for your project. The Device Name must not contain any spaces. Names of HMI devices must not exceed a length of 32 characters. The POU Name text box will only be available for edit if you select a controller or an HMI with controller in the Device list. If you select an HMI without controller, this text box will be unavailable. The POU Name text box must not contain any spaces.

In the Device Name text box enter a name for the selected controller or HMI. If you are about to create a standard project for a controller or HMI with controller, enter a name for the Program Organization Unit (POU) in the POU Name text box.

If you are about to create a standard project for a controller or HMI with controller, select a programming language from the Implementation Language list. Click the Create Project button. Result: A Save Project As dialog box opens that allows you to browse to the destination folder and to assign a name to the new project. Click Save to save your project to the selected folder. Result: SoMachine opens the project and selects the Program tab (see page 90).

In the Program tab you will see that the new project already contains the following items: z a device of the selected type, named as specified z a POU of the selected language, named as specified z a MAST task which calls the POU

EIO0000000067 04/2012

35

Home

Start with Empty Project

Function of the Sub-Task The Start with empty project sub-task allows you to create a new project from scratch without any preconfigured devices or settings. It opens a Save Project As dialog box where you can browse to the destination folder and assign a name to the new project. Click Save to save your project to the selected folder. SoMachine opens the project and selects the Properties tab (see page 56) for assigning further information.

36

EIO0000000067 04/2012

Home

Start with TVD Architecture

Function of the Sub-Task The Start with TVD Architecture sub-task allows you to create a new project on the basis of a Tested, Validated and Documented Architecture (TVDA). SoMachine provides a variety of TVDA projects with ready-to-use configuration you can adapt to your individual requirements. You can either select the suitable tested validated documented architecture directly or you can use the TVD Architecture Finder function to find the TVD architecture that best suits your individual requirements. NOTE: The TVD Architectures specified have been tested under actual service conditions. Of course, your specific application requirements may be different from those assumed for these projects. In that case, you will have to adapt the project to your particular needs. To do so, you will need to consult the specific product documentation of the hardware, software components and controller logic that you may find necessary to modify or adapt. Pay particular attention and conform to any safety information, different electrical requirements and normative standards that would apply to your modifications and/or adaptations. Some or all of the TVD Architectures may contain recommendations of products that are not available in your country or locality, or may imply or recommend wiring, products, procedures or controller logic and/or functions that are in conflict with your local, regional or national electrical or safety codes and/or normative standards.

WARNING
REGULATORY INCOMPATIBILITY Be sure that all equipment applied and systems designed comply with and conform to all applicable local, regional and national regulations and standards. Failure to follow these instructions can result in death, serious injury, or equipment damage. The use and application of the TVD Architectures require expertise in the design and programming of automated control systems. Only you, the designer or integrator, can be aware of all the conditions and factors present during installation and setup, operation, and maintenance of the machine or process, and can therefore determine the automation and associated equipment, the control logic and functions, the related safety provisions and interlocks which can be effectively and properly used. When selecting automation and control equipment, and any other related equipment or software for a particular application, you must also consider any applicable local, regional or national standards and/or regulations.

EIO0000000067 04/2012

37

Home

1 2

The TVD Architecture Finder in the selection pane assists you in finding the suitable tested validated documented architecture by answering the questions. The work area provides a list of the tested validated documented architectures available and highlights the project that best suits your requirements after you have answered the questions in the TVD Architecture Finder. The information pane provides further information related to the tested, validated and documented architecture that is selected in the work area. It contains the Open button to open the selected project.

38

EIO0000000067 04/2012

Home

Creating a New Project on the Basis of a TVD Architecture To create a new project on the basis of a TVD architecture, proceed as follows:
Step 1 2 Action In the Home tab, select Create new machine Start with TVD architecture. Answer the questions in the selection pane and click the Recommended Project button. Result: The TVD architecture that best suits your requirements will be highlighted in green in the work area. Double-click the TVD architecture you want to use as template for your new project in the work area or select it in the work area and click the Open button in the information pane. Result: A Save Project As dialog box will be displayed where you can browse to the destination folder and assign a name to the new project. Click Save to save your project to the selected folder. SoMachine opens the project and selects the Properties tab (see page 56) for assigning further information.

EIO0000000067 04/2012

39

Home

Start with Application

Function of the Sub-Task The Start with application sub-task allows you to create a new project on the basis of sample projects for dedicated applications. SoMachine provides a variety of application project examples, that are project shells dedicated to the following applications, including controller, HMI, field devices and application functions: z Controller Templates z Conveying z Hoisting z Packaging

1 2 3

The selection pane lists those Applications SoMachine provides application projects for. The work area shows those application projects that are available for the application selected in the selection pane. The information pane provides further information related to the application project that is selected in the work area. It contains the Open button to open the selected project.

40

EIO0000000067 04/2012

Home

Creating a new Project on the Basis of an Application Project To create a new project on the basis of an application project, proceed as follows:
Step 1 2 Action In the Home tab select Create new machine Start with application. From the Applications list select the suitable application type for your machine. Result: The application projects available for the selected application will be displayed in the work area. Double-click the application project you want to use as template for your new project in the work area or select it in the work area and click the Open button in the information pane. Result: A Save Project As dialog box will be displayed that allows you to browse to the destination folder and assign a name to the new project. Click Save to save your project to the selected folder. SoMachine opens the project and selects the Properties tab (see page 56) for assigning further information.

EIO0000000067 04/2012

41

Home

Start with Existing Project

Function of the Sub-Task The Start with existing project sub-task allows you to create a new project that is based on an already existing project. Browse for existing project and / or library files on the local drives or on connected network drives. To prevent the existing project / library from being overwritten, a Save as dialog box is automatically displayed when you save the new project / library. Enter a new name to create a new project / library file. This sub-task is identical to the sub-task Browse for existing project in the Show existing machine task. For further information refer to the description of this subtask (see page 30).

42

EIO0000000067 04/2012

Home

3.4

Machine Workflow

Whats in this Section? This section contains the following topics:

Topic Machine Workflow Sub-Tasks Commission Machine - Start with Project Commission Machine - Upload Project from Device Update Firmware Page 44 45 47 50

EIO0000000067 04/2012

43

Home

Machine Workflow Sub-Tasks

Sub-Tasks of the Machine Workflow Task The Machine Workflow task provides sub-tasks that are especially dedicated to commissioning a machine. Further tasks that are beyond commissioning tasks are not available from this folder. It is, for example, not possible to modify the SoMachine project. The Machine Workflow task includes the following sub-tasks: Commission machine - start with project z Commission machine - upload project from device z Update firmware
z

44

EIO0000000067 04/2012

Home

Commission Machine - Start with Project

Function of the Sub-Task The sub-task Commission machine - start with project allows the machine commissioner to browse for already available SoMachine projects on the local drives or on connected network drives.

1 2 3

4 5

The task selection pane shows the connected drives similar to a Windows Explorer. The work area displays the SoMachine projects that are available in the folder you have selected in the selection pane. The Files of type list allows you to display All files or to display only Project files or Library files or CoDeSys project files (before V3.0) or CoDeSys library files (before V3.0) in this work area. The View list allows you to change from the thumbnail view of the projects to a more detailed List view. The information pane displays Project Information related to the project that is selected in the work area. To open the selected project, click the Open button. 45

EIO0000000067 04/2012

Home

Opening a Project for Machine Commissioning To open a project for commissioning a machine proceed as follows:
Step 1 Action In the Home tab select Machine workflow Commission machine - start with project. Result: The connected drives are shown in its task selection pane, similar to a Windows Explorer, allowing to browse for the project file. Browse to the folder that contains the project file for the new machine. Open the project by double-clicking its icon in the work area or by selecting it in the work area and clicking the Open button in the information pane. Result: SoMachine opens the project showing only the Commissioning Machine tab (see page 236) with commands restricted to perform commissioning tasks.

2 3

46

EIO0000000067 04/2012

Home

Commission Machine - Upload Project from Device

Function of the Sub-Task The sub-task Commission machine - upload project from device allows the machine commissioner to upload a SoMachine project from a connected device to the PC running SoMachine. NOTE: This function is only available for the following controllers that are equipped with additional memory: z ATV IMC z M258 Furthermore it is available for those XBTGC types that can use a USB flash drive as secondary storage and for XBTGT/GK controllers that can use the Compact Flash (CF) card as secondary storage.

EIO0000000067 04/2012

47

Home

Uploading a Project for Machine Commissioning To upload a project from a connected device for machine commissioning, proceed as follows:
Step 1 Action In the Home tab select Machine workflow Commission machine - upload project from device. Result: A Select Device dialog box opens. In the Select Device dialog box select the device you want to upload the project from. If the device is not displayed, click the Scan network button to search for all available devices. Click the OK button. Result: The Project Archive dialog box opens:

In the Project Archive dialog box click the ... button to browse to the folder on your SoMachine PC where the uploaded project will be saved.

48

EIO0000000067 04/2012

Home

Step 5

Action In the Archive contents section select those contents of the project archive that will be uploaded to the selected folder. To achieve this, select the check boxes for each item you want to upload. Click Extract to upload the selected contents of the project archive to the selected folder. During the upload process you will be prompted to confirm any overwriting of files already available in the specified folder. Confirm the message prompting you to open the uploaded project. Result: The Commissioning tab opens, displaying the project configuration in the work area.

6 7 8

For more information on the sub-tasks available in the Commissioning tab refer to the Commissioning chapter (see page 235).

EIO0000000067 04/2012

49

Home

Update Firmware
Function of the Sub-Task The sub-task Update firmware allows the machine commissioner to update the firmware of this controller. Performing a firmware update will delete the current application program in the device, including the Boot Application in Flash memory.

CAUTION
LOSS OF APPLICATION DATA
z z

Perform a backup of the application program to the hard disk of the PC before attempting a firmware update. Restore the application program to the device after a successful firmware update.

Failure to follow these instructions can result in injury or equipment damage.

50

EIO0000000067 04/2012

Home

The following screenshot shows the sub-task function with the Modicon M238 Logic Controller:

To update the firmware, click the corresponding firmware download icon for USB or for serial line connections. Result: The proper Exec Loader wizard is started. Follow the instructions on the screen that guide you through the update process. For further information refer to the M238 ExecLoader User Guide that is provided with the SoMachine installation. You can access it via the Start menu as follows: Start Programs Schneider Electric SoMachine Tools ExecLoader User Guide. NOTE: Please note that the Adobe ReaderTM is required to open this PDF document. This reader is not part of the SoMachine installation but can be downloaded from http://www.adobe.com/go/getreader. The information pane provides a link to a download area where the latest firmware updates are available.
EIO0000000067 04/2012

51

Home

3.5
Learning Center
Sub-Tasks

Learning Center

The Learning Center task provides additional information for quickly making yourself familiar with SoMachine. It includes the following sub-tasks: Quick overview z Training Manual z E-Learning z Examples
z

52

EIO0000000067 04/2012

Home

Quick Overview The Quick overview sub-task provides a short film that introduces the SoMachine user interface as well as its main functions in about 2 minutes time. To run this film, no additional software is required on your PC. Training Manual The Training Manual sub-task provides a training PDF file that includes presentations and step-by-step exercises to help you to become familiar with the main features of SoMachine. To open the PDF file, the Adobe ReaderTM is required, see the Note below. E-Learning The E-Learning sub-task provides an interactive training that shows you how to use SoMachine. To run this training, no additional software is required on your PC. Examples The Examples sub-task provides sample projects together with PDF files documenting these SoMachine projects. NOTE: Please note that the Adobe ReaderTM is required to open the PDF documents provided in the Examples and the Training Manual sub-tasks. This reader is not part of the SoMachine installation but can be downloaded from http://www.adobe.com/go/EN_US-H-GET-READER.

EIO0000000067 04/2012

53

Home

54

EIO0000000067 04/2012

SoMachine Properties EIO0000000067 04/2012

Properties

4
Whats in this Chapter? This chapter contains the following topics:
Topic General Overview of the Properties Tab Description of the General Task Description of the Description Task Description of the Custom Information Task Page 56 58 59 61

EIO0000000067 04/2012

55

Properties

General Overview of the Properties Tab

The Properties Tab The Properties tab allows you to enter additional project information. The textual and graphical information entered here are optional. As this information is always displayed in the information pane for the project selected in the work area, it helps to later identify the individual projects, avoiding the need to open them. This tab is only displayed after you have opened a project. The Properties tab provides the following tasks: General z Description z Custom Information
z

56

EIO0000000067 04/2012

Properties

Elements of the Properties Tab

1 2 3

The task selection pane shows the tasks of the Properties tab. The work area provides entry fields for file information and author information. The information pane displays information entered in the work area and allows you to save and archive your project by using the command buttons (Save, Save as, Save/Send archive).

EIO0000000067 04/2012

57

Properties

Description of the General Task

The General Task The General task allows you to save or archive your project and provides the option to add author information. It provides the following sections: z File Information z Author Information z Project Information with Save, Save as and Save/Send archive button File Information The section File Information displays the name of your project file and the folder it is saved in. Author Information The section Author Information provides entry fields for optional information you consider relevant. Your entries are displayed in the section Project Information on the right side. Note: The following characters are not allowed in the Title and Author text boxes: ( (left parenthesis) z ) (right parenthesis) z , (comma)
z

To save the information entered in the Properties tab, click the Save button in the Project Information pane. Changing the Project Name or Project Location To save your project to a different location or under a different name, click the Save as button in the Project Information pane, navigate to the preferred folder and save your project file. Archiving Projects To create an archive file of your project click the Save/Send archive button in the Project Information pane. The Project Archive dialog box opens with the following selections: Save the archive file to a connected drive by using the Save button. z Create a temporary archive file that is attached to an empty e-mail by using the Send button. This e-mail is automatically created by SoMachine if the Messaging Application Programming Interface (MAPI) is correctly installed. See your local administrator for more information.
z

58

EIO0000000067 04/2012

Properties

Description of the Description Task

The Description Task The Description task allows you to add an image to your project. This optional customer image helps you to identify your project.

The work area provides the button Add to add a preferred Customer Image to your SoMachine project and shows the Configuration View corresponding to your settings in the Configuration tab.

EIO0000000067 04/2012

59

Properties

Priority of Images Displayed for the Project SoMachine checks the availability of images for each project and displays them in the following order of priority:
Priority Level high medium low Project Image customer image configuration view standard SoMachine icon

Customer Image The section Customer Image allows you to add an image to your SoMachine project. Adding a Customer Image To add a new image to your project, proceed as follows:
Step 1 2 Action Click the Add button. Result: The dialog box Add customer image to project opens. Browse to your destination folder, select a preferred image, and click Open. Result: The customer image is displayed in the work area and in the information pane.

NOTE: SoMachine supports JPG graphics. The size of the graphic should not exceed 1 MB, otherwise it will be saved with reduced size. Changing or Removing a Customer Image To replace the customer image for the project, click the Change button and browse to the location of the new image. Click the Remove button to remove your image. Configuration View The Configuration View section shows an overview of your project configuration corresponding to your settings in the Configuration tab (see page 64).

60

EIO0000000067 04/2012

Properties

Description of the Custom Information Task

The Custom Information Task The Custom Information task allows you to customize project information you may consider relevant. The work area provides entry fields for custom information as well as the possibility to add attachments to your project.

EIO0000000067 04/2012

61

Properties

Custom Information Fields The Custom Information Fields are text boxes for any optional information you might want to give to personalize your project. The fields and their values you define here can be displayed in the information pane on the right-hand side if you activate the respective Info check box. In the Custom Field text boxes enter a name for a new field you want to create. Enter the content that should appear in this field in the Value text boxes. For every line of information you want to be displayed as Project Information in the information pane on the right-hand side, select the check box in the Info column. Attached Documents Click the Add Attachment button to attach 1 or more documents to your project file. A dialog box will be displayed, where you can browse to the destination folder. After you have attached a file to your project, the section Add Attachment displays a check box for Important Information as well as the icons for: z View attachment, which opens the attached file. z Save attachment as file, which opens a Save as dialog box. z Remove attachment from project, which deletes the link between the project and the attached file.

Important Information The section Attached Documents provides the check box Important Information for each of the attached documents. For each document you consider as important to read, select the check box. The task menu will then show a small SoMachine icon next to the task Custom Information to indicate that it includes important information.

62

EIO0000000067 04/2012

SoMachine Configuration EIO0000000067 04/2012

Configuration

5
Whats in this Chapter? This chapter contains the following sections:
Section 5.1 5.2 General Information Graphical Configuration Editor Topic Page 64 68

EIO0000000067 04/2012

63

Configuration

5.1

General Information

General Description of the Configuration Tab

Overview The Configuration tab is only displayed after you have opened a SoMachine project. It consists of a graphical configuration editor that provides necessary functions to perform the entire hardware and network configuration of your machine. The configuration settings performed here will also be available in the CoDeSys and Vijeo-Designer Program tab.

64

EIO0000000067 04/2012

Configuration

Elements of the Configuration Tab The following graphic displays the Configuration tab with a sample configuration:

2 3

The task selection pane shows the list of controllers, HMIs, and miscellaneous devices you can drag into the graphical configuration editor as well as a Search function to search for the required device. The work area includes the graphical configuration editor with its display manager at the bottom. The information pane provides further information on the element selected in the task selection pane or in the work area (devices, connections, communication managers).

Adding Devices The task selection pane of the Configuration tab lists the devices you can add to the configuration in the graphical configuration editor grouped by type. To add a device, click the entry of the suitable group, select the device from the list and drag it to the work area.
EIO0000000067 04/2012

65

Configuration

Displaying all Versions of Devices By activating the checkbox Display all versions (for experts only) all available versions of the particular devices will additionally be displayed. NOTE: This function is for experts only because using previous versions of devices might force you to manually manage libraries versions to achieve consistency.

CAUTION
DEVICE INCOMPATIBILITY Be sure that any alternative version of a device you select is fully compatible with any controller instructions and/or functions used to control and interface with that device. Failure to follow these instructions can result in injury or equipment damage. Displaying Devices of all Vendors By default, only Schneider Electric devices are displayed in the task selection pane. To expand the list of devices by devices from further manufacturers, select the Display all vendors checkbox.

CAUTION
DEVICE INCOMPATIBILITY
z

Be sure that any non-Schneider Electric device you select is fully compatible with any controller instructions and/or functions used to control and interface with that device. Contact your local Schneider Electric support center for additional information on device compatibility.

Failure to follow these instructions can result in injury or equipment damage.

66

EIO0000000067 04/2012

Configuration

Search Function To ease finding the intended device, SoMachine additionally provides a search function. Open it by clicking the Search item in the task selection pane.

You can choose between the following 2 search functions: z search based on simple wildcards z search based on regular expressions To search for a device by using simple wildcards, select the item Use simple wildcards from the list below the textbox. Enter the product reference of the device you are searching in the text box. As wildcards you can use a question mark (?), which replaces exactly one character, or an asterisk (*), which can be used as a wildcard for none or several characters. Click the Search button to start the search. To search for a device by using regular expressions, select the item Use regular expressions from the list. Enter the name of the device you are searching in the text box and use the regular expressions that suit your requirements. Click the Search button to start the search. For further information on regular expressions refer to the documentation in the CoDeSys online help. In both cases SoMachine will return a list of devices meeting the search phrase you entered or will display a message indicating that no devices were found.

EIO0000000067 04/2012

67

Configuration

5.2

Graphical Configuration Editor

Whats in this Section? This section contains the following topics:

Topic General Description Adding and Deleting Devices Configuring Devices Detecting Configuration Errors Accessing Programming and Application Functions with the Graphical Configuration Editor Creating Network Connections Page 69 71 73 81 83 85

68

EIO0000000067 04/2012

Configuration

General Description
Overview The graphical configuration editor provides necessary functions to perform the entire hardware and network configuration of your machine in a graphical way. The configuration settings performed here will also be available in the Program tab as well as in Vijeo-Designer.

1 2

The graphical configuration editor in the work area displays your machine configuration in a graphical way. The display manager simplifies the use of the graphical configuration editor.

When you start creating a new project from scratch, the graphical configuration editor will be empty. It will then prompt you to drag a device from the list on the lefthand side into this empty area.

EIO0000000067 04/2012

69

Configuration

Display Manager To simplify its use, the graphical configuration editor contains a display manager at the bottom of the pane. The display manager contains the following functions:
Display Manager Item Zoom Description The Zoom slider controls the magnification of the graphical configuration editor. Click the 100% button to display the elements in the graphical configuration editor without magnification in their original size. Click the Show All button to display the elements available in the graphical configuration editor. Click the Reroute button to redraw the connecting lines between the items. Activate this function to redraw the connecting lines between the items with every new device you drag into the graphical configuration editor. Activate this function to allow the graphical configuration editor to draw 1 line if several connecting lines are in parrallel instead of drawing each line separately. This setting speeds up the drawing time. Click the Collapse All button to collapse the subdevices, that are expansion modules. Click the Expand Last button to expand the subdevices (expansion modules) of the last device you selected. Click the Expand All button to expand the subdevices, that are expansion modules.

100%

Show All

Reroute Reroute On Drop

Allow overlapping lines

Collapse All

Expand Last

Expand All

70

EIO0000000067 04/2012

Configuration

Adding and Deleting Devices

Overview The Configuration tab includes the graphical configuration editor that allows to perform machine configuration in a graphical way. When adding or deleting devices in the controller configuration, SoMachine automatically adjusts the memory allocations for the devices. If you are adding or deleting devices to or from an existing program, you must take into account any adjustments made to I/O memory within your program.

WARNING
UNINTENDED EQUIPMENT OPERATION Inspect and modify as necessary any immediate addresses used in the program after modifying the configuration. Failure to follow these instructions can result in death, serious injury, or equipment damage. NOTE: Schneider Electric highly recommends the use of symbolic addressing instead of immediate addressing. This may help to avoid extensive program modifications and to limit the possibility of incorrect programming instructions once a program configuration is modified by adding or deleting I/O or other devices. Adding Devices To add a device, proceed as follows:
Step 1 Action Select the device you want to add to your machine configuration from the catalog list on the left-hand side of the Configuration tab. Further information concerning the selected device will be displayed in the information pane on the right-hand side. Drag the device icon to the graphical configuration editor in the middle of the Configuration tab. Result: The device is added to the machine configuration and can be moved freely with the left mouse button. You can now configure the device.

NOTE: If you add an HMI device to your graphical configuration editor, VijeoDesigner will automatically be started.

EIO0000000067 04/2012

71

Configuration

Assigning a Name to the Device To assign a name to your device in the graphical configuration editor, right-click the device and select Rename device from the context menu, or select the device and click the default name below the device a second time to edit the text field. Result: You can now edit the default name below the device icon (for example MyController), and enter a name of your choice. Deleting Devices To delete a device from the graphical configuration editor, right-click it and select Delete device from the context menu, or select the device in the editor and press the delete key on your keyboard. If you confirm this action, the device as well as the network lines to which the device is connected will be deleted from the graphical configuration editor.

72

EIO0000000067 04/2012

Configuration

Configuring Devices
Overview The graphical configuration editor provides access to configuration dialog boxes of the devices. Configuring Device Parameters To configure the device you added to the graphical configuration editor, you can either double-click the device or right-click the device and select Edit device parameters from the context menu. SoMachine will then open the Parameters configuration dialog box for your device. The tasks displayed on the left-hand side in the task selection pane vary depending on the selected device. The following graphic shows a sample Configuration Parameters screen for an M238 logic controller.

Configure your device as described in the Configuration section of the respective user manual.

EIO0000000067 04/2012

73

Configuration

To close the configuration dialog box and to return to the graphical configuration editor, click the Back button or double-click the Configuration Overview graphic in the task selection pane on the left-hand side. NOTE: When you add an HMI device into the project, the HMI must be linked to the Controller on which the HMI is required.The path between the HMI and controller must be activated using the Set active path function. Configuring Embedded Functions To configure embedded functions of your device, like mapping inputs and outputs as well as configuring high speed counters, pulse train output or pulse width modulation, select in the device configuration screen the entry Embedded Functions. Select the suitable sub entry from this list and configure the parameters as described in the Input / Output Configuration (HSC, PTO, PWM) sections of the respective hardware Programming Guide. NOTE: Schneider Electric highly recommends the use of symbolic addressing instead of immediate addressing while programming. This may help to avoid extensive program modifications and to limit the possibility of incorrect programming instructions once a programs configuration is being modified by adding or deleting I/O or other devices.

WARNING
UNINTENDED EQUIPMENT OPERATION Inspect and modify as necessary any immediate addresses used in the program after modifying the configuration. Failure to follow these instructions can result in death, serious injury, or equipment damage.

74

EIO0000000067 04/2012

Configuration

Configuring Communication Settings To configure the communication ports of your device, select in the device configuration the entry Communication. Select the suitable sub entry (Serial Line, Ethernet, CANopen etc.) from this list and configure the Physical Settings as well as Protocol Settings of the port as described in the respective hardware user guide. In the Protocol Settings screen SoMachine provides a Remove/Change Protocol button that opens the following dialog box to change or remove the configured protocol. You can also open this dialog box by clicking the port of an already available device in the graphical configuration editor. But please note that this leads to a new configuration of the port and removes the already available configured communication settings.

Select the suitable protocol manager from the list and click the Add and close button. Result: The configuration dialog box for the selected protocol will be displayed on the right-hand side of the SoMachine screen.

EIO0000000067 04/2012

75

Configuration

Configuring Empty Interfaces To configure empty interfaces of your device, proceed as follows:
Step 1 Action Click the empty rectangle, representing an empty port, of your device graphic.

Result: The Add device dialog box will be displayed. Its contents, that is the available fieldbusses and / or communication managers, depends on the selected device and the specific port. 2 From the Add device dialog box select the item you want to define for the selected port (in the example below a CANopen Optimized manager).

Click the Add and close button. Result: The selected fieldbus or communication manager is now added to the port and the configuration dialog box for the selected protocol will be displayed on the right-hand side of the SoMachine screen.

76

EIO0000000067 04/2012

Configuration

Adding Slave Devices to a Fieldbus Manager To add a slave device to a fieldbus manager, proceed as described in the following (using a CANopen device as an example):
Step 1 Action Click on a free port of the fieldbus manager in your graphical configuration editor.

Result: The Add device dialog box will be displayed.

EIO0000000067 04/2012

77

Configuration

Step 2

Action Select a suitable device from the list and click the Add or Add and close button. Result: The icon of the selected device will be displayed in the graphical configuration editor, connected to the CANopen_Optimized manager.

To delete a slave device, select it in the graphical configuration editor and hit the DELETE key or right-click the slave device and select Remove from the context menu.

78

EIO0000000067 04/2012

Configuration

Adding Expansion Modules To add expansion modules to your device, proceed as follows:
Step 1 Action Click in the graphical configuration editor on the area Add Expa... of the device.

Result: The Add device dialog box opens, displaying only those expansion modules that can be connected to the selected device like in the graphic below for an M238 logic controller.

EIO0000000067 04/2012

79

Configuration

Step 2

Action Select the expansion module you want to add to the device from the list on the left-hand side and click the Add or Add and close button. Result: The expansion module will be displayed in the graphical configuration editor on the right-hand side of the device.

The expansion modules added to a device are displayed on the right side of the device icon. You can hide or display them by clicking the small arrow above the Add Expa... button. To configure them, double-click their icons. NOTE: When you add a TWDNOI10M3 object (AS-Interface Master Module) the corresponding Virtual AS interface bus fieldbus manager will automatically be inserted. To add AS-Interface slave modules, proceed as described in the Adding Slave Devices to a Fieldbus Manager paragraph (see page 77). Closing the Configuration Dialog Boxes To close the configuration dialog boxes and to return to the graphical configuration editor, click the Back button or double-click the Configuration Overview graphic in the task selection pane on the left-hand side.

80

EIO0000000067 04/2012

Configuration

Detecting Configuration Errors

Indication of Detected Configuration Errors The graphical configuration editor indicates errors detected in the configuration by displaying the respective icons in red. The graphic below provides an example of a detected CANopen configuration error with 2 devices being assigned the same Node ID:

EIO0000000067 04/2012

81

Configuration

Correcting Detected Configuration Errors SoMachine assists you in correcting detected configuration errors. You can solve a detected configuration error concerning the multiple use of node IDs (shown in the above example) as follows:
Step 1 2 Action Click the red icon (in the above example the CANopen Manager) to display further information on the specific detected configuration error in the information pane on the right-hand side. To solve this issue, click the Modify address configuration button. Result: An Address settings dialog box will be displayed.

In the Address settings dialog box you can check the addresses and correct them manually by changing the Node ID of 1 device or you can click the Fix address conflicts button to have the address conflict automatically corrected by SoMachine.

NOTE: Be sure that any and all physical address setting mechanisms on the devices, if any, conform to the address settings in the software configuration.

82

EIO0000000067 04/2012

Configuration

Accessing Programming and Application Functions with the Graphical Configuration Editor
Overview The graphical configuration editor provides direct access to the CoDeSys programming environment. Programming Logic To program logic for a device in the graphical configuration editor, right-click the device and select Open program Application from the context menu. Result: The SoMachine Program tab opens, providing access to the CoDeSys programming interface. Selecting the Active Application In case there are several applications in your machine configuration, the graphical configuration editor allows you to define which one should be the active application. To define 1 application as active application, right-click a device in the graphical configuration editor and select from the list Set application active the application you want to be the active application. Result: A green circle is displayed in the graphical configuration editor to indicate the active application. Adding an Application If your device does not yet have an application, you can create a new application as follows: Right-click the device in the graphical configuration editor and select the command Add application from the context menu. In the Add application dialog box enter a name for your new application and click Open.

EIO0000000067 04/2012

83

Configuration

Updating Firmware To update the firmware, right-click the device in the graphical configuration editor and select the command Update firmware from the context menu. The proper Exec Loader wizard will be started, guiding you through the update process. Performing a firmware update will delete the current application program in the device, including the Boot Application in Flash memory.

CAUTION
LOSS OF APPLICATION DATA
z z

Perform a backup of the application program to the hard disk of the PC before attempting a firmware update. Restore the application program to the device after a successful firmware update.

Failure to follow these instructions can result in injury or equipment damage. Updating the Version of the Device The command Update Device Version allows you to update each device individually to the latest installed version that is available. It is not possible to upgrade a device to a specific version. This command can, for example, be used if a device is marked in the graphical configuration editor by a red circle in the upper right corner of the device icon. This indicates that the version that is used in the project is not installed. Executing the Update Device Version command from the context menu replaces the used version in the project by the most recent version installed in the system. The red circle disappears. For further information on manually updating each device individually or updating several devices simultaneously, refer to the Updating Devices to their Latest Version chapter in the SoMachine Introduction_Compatibility and Migration.pdf document (see Windows Start menu Schneider Electric SoMachine Documentation). Changing a Device SoMachine 3.0 and later versions allow you to change a device, that is configured in your project, to a different, but compatible device of the same controller family. For further information on this Change Device command, refer to the chapter Changing a Device (see page 166).

84

EIO0000000067 04/2012

Configuration

Creating Network Connections

Overview The graphical configuration editor provides easy connection of communication ports by simply drawing lines between them. It automatically checks the compatibility of the ports to be connected and issues error detection messages as tooltips if it detects any incompatibility. Creating Network Connections To create network connections with the graphical configuration editor, proceed as follows:
Step 1 Action Move the cursor on the communication port of the device you want to connect. Result: The cursor will change to a crosshair cursor. The type of the communication port will be indicated in a tooltip. Click on the communication port you want to connect and keep the left mouse button pressed. Result: The cursor converts into a pencil and draws a line when being moved. Drag the pencil cursor to the communication port of the device or module you want to connect your device to. Result: The pencil cursor draws a line between the 2 ports. Release the left mouse button when the pencil cursor is over the communication port of the second device. Result: The pencil is converted into a normal cursor and the line between the devices will be displayed in the color that corresponds to the connection type (for color definitions see below).

2 3

EIO0000000067 04/2012

85

Configuration

Step 5

Action A context menu will be displayed providing the following possibilities to configure the communication parameters of the 2 devices: z Copy parameters from start to end device z Copy parameters of end device to start device z Setup communication parameters of both devices If you select the command Setup communication parameters of both devices, the configuration dialog box for this communication type will be displayed where you can enter the suitable settings manually. This dialog box will also be displayed by double-clicking a network connection line or rightclicking it and selecting Edit parameters from the context menu.

To save your settings, select the Save command from the General Functions Menu (see page 26). To return to the graphical configuration editor, click the Back button on the left-hand side of the screen or double-click the Configuration Overview graphic. To leave the settings on both sides unchanged, click anywhere else in the graphical configuration editor. The context menu will be closed.

Color Definitions The type of network connection is indicated by the color of the connection lines:
Network Connection Line Color black blue purple gray Network Connection Type Modbus Ethernet CANopen connection to a generic port (no compatibility check performed by SoMachine)

86

EIO0000000067 04/2012

Configuration

Deleting Network Connections To delete a network connection from the graphical configuration editor, right-click it and select Delete from the context menu, or select the network connection line in the editor and press the DELETE key on your keyboard. If you confirm this action, the network connection will be deleted from the graphical configuration editor, but the configuration parameters of the connected devices will not be changed. Consistency Checks SoMachine automatically checks the consistency when creating new network connections. It issues error detection messages as tooltips if it detects any incompatibility. You can disable this function for individual connections. To achieve this, right-click the network connection line and select the command Disable consistency checks from the context menu. The network connection line will be displayed with a redstriped background to indicate that the consistency check is disabled. To re-enable the consistency check for a connection line, right-click it and select once again the command Disable consistency checks from the context menu.

EIO0000000067 04/2012

87

Configuration

88

EIO0000000067 04/2012

SoMachine Program EIO0000000067 04/2012

Program

6
Whats in this Chapter? This chapter contains the following sections:
Section 6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 6.11 6.12 6.13 General Information Managing the Application Objects Adding Devices Managing the Libraries Managing the Communication Ports SoMachine Commands Simplifying Programming SoMachine Commands SoMachine Controller-HMI Data Exchange SoMachine Templates Managing Device Templates Managing Function Templates Downloading and Running Applications Check for the Latest Firmware Topic Page 90 93 109 119 139 161 170 182 192 204 217 226 231

EIO0000000067 04/2012

89

Program

6.1

General Information

General Description of the Program Tab

Overview The Program tab is only displayed after you have opened a SoMachine project. It provides access to the CoDeSys programming environment. Any configuration settings that were already performed in the Configuration tab are displayed in the Devices view and can be modified, deleted and / or added here. Any changes performed in this view will also be available in the Configuration tab.

90

EIO0000000067 04/2012

Program

Elements of the Program Tab The following graphic shows the Program tab with a sample configuration:

1 2

menu bar toolbar 91

EIO0000000067 04/2012

Program 3 4 5 6 7 editor multi-tabbed view Messages pane information and status line status bar Devices pane

This user interface provides several dockable panes you can open via the View menu. You can arrange the different panes within the SoMachine window according to your individual preferences.

92

EIO0000000067 04/2012

Program

6.2

Managing the Application Objects

Whats in this Section? This section contains the following topics:

Topic Adding Tasks Adding and Declaring POUs Adding Libraries Adding and Declaring Remanent Variables Adding a Symbol Configuration Adding Other Objects Introduction to Data Logging Introduction to Network Variables List (NVL) Page 94 95 97 100 102 103 104 106

EIO0000000067 04/2012

93

Program

Adding Tasks
Introduction The Devices window allows you to add tasks to your application. Procedure
Step Action

1 Right-click the Task Configuration node and select Add Object Task... from the context menu. 2 In the Add Task dialog box, enter a name in the Name: text box. Note: The name must neither contain any space nor exceed a length of 32 characters. 3 Click Open.

94

EIO0000000067 04/2012

Program

Adding and Declaring POUs

Introduction The Devices window allows you to add Program Organization Units (POUs) to your application. The different types of POU are: z Program: It returns one or several values during operation. All values are retained from the last time the program was run until the next. It can be called by another POU. z Function Block: It provides one or more values during the processing of a program. As opposed to a function, the values of the output variables and the necessary internal variables shall persist from one execution of the function block to the next. So invocation of a function block with the same arguments (input parameters) need not always yield the same output values. z Function: It yields exactly one data element (which can consist of several elements, such as fields or structures) when it is processed. The call in textual languages can occur as an operator in expressions. NOTE: Refer to CoDeSys online help: z For more information on POUs. z If you want to add POUs for implicit Check to your application. Adding POUs To add a POU to the application of the controller, proceed as follows:
Step Action 1 In the Devices view right-click the Application node of the controller and choose Add Object POU. 2 In the Add POU dialog box assign a name to your POU by typing a name in the text field Name. Note: The name must not contain any space characters. If you do not enter a name, a name is given by default. Tip: Assigning an individual name to a POU may ease the organization of your project.

EIO0000000067 04/2012

95

Program

Step Action 3 Select the type of POU you want: z Program z Function Block: a. Select Extends and click on the browser to select the block function you want in the Input Assistant. b. Click the OK button. c. Select Implements and click on the browser to select the interface you want in the Input Assistant. d. Click the OK button. e. In the list box Method implementation language, select the programming language you want for editing the function block.
z Function:

a. Click the browse button to select the Return type you want in the Input Assistant. b. Click the OK button. 4 From the list box Implementation Language, select the programming language you want for editing your program. 5 Click the Open button.

Declaring POUs At least 1 POU has to be declared in the task. To declare a POU in a task, proceed as follows:
Step Action 1 Under the node Task Configuration of the controller, double-click on the task you want to declare your POU. 2 In the POUs section of the configuration tab, click Add POU. 3 In the section Categories of the Input Assistant dialog box, select Programs (Project). 4 Click to clear the check box Structured view. 5 In the Items panel, select the POU you want. 6 Click the OK button.

96

EIO0000000067 04/2012

Program

Adding Libraries
Introduction The Devices window allows you to add libraries to your application by using the Library Manager node. For adding standard SoMachine libraries, use the placeholder concept. For adding libraries you created yourself, the placeholder concept is not applicable. Placeholder Concept for Standard SoMachine Libraries If you add standard libraries that are in the SoMachine scope of delivery, use the placeholder concept to control the compatibility between libraries and devices with different SoMachine versions. The placeholder concept allows you to add a library without explicitly defining its version. The version that will actually be used depends on the device that uses this library. It stores this information in its device description file. Whenever you update your SoMachine software, verify the SoMachine libraries you are using in your project. Those SoMachine libraries that were added using the placeholder concept will not be updated with a SoMachine software update but only when updating the respective device.

WARNING
UNINTENDED EQUIPMENT OPERATION
z z

Verify that the SoMachine Libraries contained in your program are the correct version after updating SoMachine software. Verify that the library versions updated are consistent with your application specifications.

Failure to follow these instructions can result in death, serious injury, or equipment damage. For more information about using the placeholder concept, refer to Placeholder (see page 124).

EIO0000000067 04/2012

97

Program

Procedure of Adding Standard SoMachine Libraries To add a standard library that is included in the SoMachine scope of delivery, use the placeholder concept as described in the following:
Step 1 Action Double-click the Library Manager node in the Devices window. Result: The Library Manager editor opens, showing the libraries that are by default inserted with the selected device. In the editor click the Add library... link. Result: The Add Library dialog box opens. In the Add Library dialog box select the Placeholder tab.

2 3

98

EIO0000000067 04/2012

Program

Step 4

Action In the Placeholder tab configure the following: z Select the Placeholder name from the list. The placeholder names are identical to the library names, except of Schneider Electric libraries that are extended by the prefix SE_). z Define the Default library by selecting the suitable library from the list. This setting only defines the library type that will be inserted. The library version that will actually be used is defined by the device. Click OK. Result: The library will be added to the Library Manager, like for example SE_Standard = Standard, 33.3.1.10 (System).

EIO0000000067 04/2012

99

Program

Adding and Declaring Remanent Variables

Introduction This section describes the different types of remanent variables and their characteristics. It also shows you how to add and declare remanent variables in your application. Types and Characteristics When you want to create an application and add variables, you can declare some of the variables as remanent variables. Remanent variables can retain their values in the event of power outages, reboots, resets, and application program downloads. There are multiple types of remanent variables, declared individually as retain or persistent, or in combination as retain-persistent. NOTE: For more information on remanent variables, refer to the CoDeSys online help as well as the programming guide of your controller platform. Memory Mapping The following table gives more information on memory for:
Device Modicon M238 Logic Controller Modicon M258 Logic Controller Refer to Memory mapping (see Modicon M238 Logic Controller, Programming Guide) Memory mapping (see Modicon M258 Logic Controller, Programming Guide)

Modicon LMC058 Motion Controller Memory mapping (see Modicon LMC058 Motion Controller, Programming Guide) Modicon ATV IMC Drive Controller XBTGC HMI Controller Memory mapping (see ATV IMC Drive Controller, Programming Guide) Memory mapping (see Magelis XBTGC HMI Controller, Programming Guide)

100

EIO0000000067 04/2012

Program

Adding a Persistent Variables List Persistent variables are declared in a global variables list called Persistent Variables. To add this list in an application, do the following:
Step Action 1 Right-click the Application node of the controller, or the Application node of the HMI, and choose Add Object Persistent Variables.... 2 In the Add Persistent Variables dialog box type a name for this list in the Name text box. 3 Click Open. Example:

Result: A persistent variable node is created in the Devices view. Note: The variables list is edited in the editing area whereby VAR_GLOBAL PERSISTENT RETAIN already is preset in the first line. Example:

Declaring Persistent and Retain Variables Refer to the CoDeSys part of the online help.

EIO0000000067 04/2012

101

Program

Adding a Symbol Configuration

Prerequisites Variables that will be exchanged between the controller and (multiple) HMI devices using the transparent SoMachine protocol (see SoMachine, Introduction) must be published in the controller by means of the Symbol configuration. They will then be available as SoMachine variables in Vijeo-Designer. Opening the Symbol Configuration To open the Symbol configuration proceed as follows:
Step 1 Action Right-click the Application node of the controller and select Add Object Symbol configuration.... Result: The Add Symbol configuration dialog box will be displayed. In the Add Symbol configuration dialog box the name Symbol configuration will be displayed in the Name text box. Click Open. Result: A Symbol configuration item is created under the Application node in the Devices window. The Symbols configuration editor will be displayed on the right-hand side.

NOTE: Only 1 symbol configuration node can be created per device. For details on the variables interchange between the controller and HMI part refer to the chapter SoMachine Controller-HMI Data Exchange (see page 182).

102

EIO0000000067 04/2012

Program

Adding Other Objects

Available Objects The devices view also allows you to add the following objects to your application, depending on the controller: z CAM table is only available for SoftMotion devices for motion control in tabular or textual form. z Data Server establishes a point-to-point connection between the local application and a remote data source (i.e. an OPC server). z DataLogManager is used to create customer-specific log files on process or machine status information. z DUT (Data Unit Type) is used to create your own data type. z Global Variable List is used to declare global variables which will be available to the entire application. z Image Pool is the images repository for the project. z Interface is used to organize methods which are used by function blocks. An interface is a POU describing a collection of method-prototypes. z POUs for implicit checks provide check functionality for array and range boundaries, divisions by zero and pointers during runtime z Relocation Table is an editor that allows you to work with the relocation table of the system variables. z Text List is used for multi-language support or dynamic text. z Trace is used to configure and to display a sampling of the values of variables, i.e., the online progression of the values read from the controller over a certain time. z Visualization allows you to create graphical representation of your system for monitoring. z Visualization Manager is used to handle some common settings for all visualizations assigned to the current application For more information concerning these objects, refer to the CoDeSys part of the online help. Adding Objects To add objects to the application of the controller, or to the application of the HMI, do the following.
Step 1 2 Action Right-click the Application node of the controller, and choose the Add Object. command, followed by the command for the object you want to add. In the Add dialog box for the object of your choice click Open.

EIO0000000067 04/2012

103

Program

Introduction to Data Logging

Overview You can monitor and analyze application data by examining the data log file (.log).

Controllers application
LogFile New Data log

File upload from SoMachine, Controllers Web Server or FTP client request

Controllers memory Buffer of LogFile

Data log x Data log y Data log z

FB LogRecord

LogFile.log
Data log 1 Data log 2 Data log 3 Data log 4 Data log 5 Data log 6

Automatic dumping

LogFile Dumping command

FB Dump

Force buffer dumping

The figure shows an application that includes the 2 function blocks, LogRecord and Dump. The LogRecord function block writes data to the buffer, which empties into the data log file (.log) located into the controllers memory. The buffer dumping is automatic when 80% full or it can be forced by the Dump function. As a standard FTP client, a PC can access this data log file when the controller acts as an FTP server. It is also possible to upload the file with SoMachine or by the controllers web server. NOTE: Only controllers with file management functionality can support data logging. Refer to your controllers programming manual to see if it supports file management. The software itself does not evaluate your controller for compatibility with data logging activities.

104

EIO0000000067 04/2012

Program

Sample Data Log File (.log) Entries in File: 8; Last Entry: 8; 18/06/2009;14:12:33;cycle: 1182; 18/06/2009;14:12:35;cycle: 1292; 18/06/2009;14:12:38;cycle: 1450; 18/06/2009;14:12:40;cycle: 1514; 18/06/2009;14:12:41;cycle: 1585; 18/06/2009;14:12:43;cycle: 1656; 18/06/2009;14:14:20;cycle: 6346; 18/06/2009;14:14:26;cycle: 6636; Implementation Procedure You must first declare and configure the data log files in your application before starting to write your program.

EIO0000000067 04/2012

105

Program

Introduction to Network Variables List (NVL)

Overview The Network Variables List (NVL) feature consists of a fixed list of variables that can be sent or received through a communication network. This enables data exchange within a network via network variables, if supported by the controller (target system). The list must be defined in the sender and in the receiver controllers (and can be handled in a single or in multiple projects). Their values are transmitted via broadcasting through User Datagram Protocol (UDP) datagrams. UDP is a connectionless Internet communications protocol defined by IETF RFC 768. This protocol facilitates the direct transmission of datagrams on Internet Protocol (IP) networks. UDP/IP messages do not expect a response, and are therefore ideal for applications in which dropped packets do not require retransmission (such as streaming video and networks that demand real-time performance). The NVL functionality is a powerful feature of SoMachine. It allows you to share and monitor data between controllers and their applications. However, there are no restrictions as to the purpose of the data exchanged between controllers, including, but not limited to, attempting machine or process interlocking or even controller state changes. Only you, the application designer and/or programmer, can be aware of all the conditions and factors present during operation of the machine or process and, therefore, only you can determine the proper communication strategies, interlocks and related safeties necessary for your purposes in exchanging data between controllers using this feature. Strict care must be taken to monitor this type of communication feature, and to be sure that the design of the machine or process will not present safety risks to people or property.

106

EIO0000000067 04/2012

Program

WARNING
UNINTENDED MACHINE OPERATION DUE TO INCORRECT MACHINE COMMUNICATION
z

z z z z

You must consider the potential failure modes of control paths and, for certain critical control functions, provide a means to achieve a safe state during and after a path failure, including power outages and system restarts. Separate or redundant control paths must be provided for critical control functions. You must give consideration to the implications of unanticipated transmission delays or failures of the link. Observe all accident prevention regulations and local safety regulations. Each implementation of equipment using this feature must be individually and thoroughly tested for proper operation before being placed into service.

Failure to follow these instructions can result in death, serious injury, or equipment damage. Be sure to use the Diagnosis and Error Management function blocks as well as network properties parameters to monitor the health, status and integrity of communications using this feature. This feature was designed for data sharing and monitoring and should not be used for most critical control functions. Network Variables List (NVL) The network variables to be exchanged are defined in the following 2 types of lists: z Global Variables Lists (GVL) in a sending controller (sender) z Global Network Variables List (GNVL) in a receiving controller (receiver) The corresponding GVL and GNVL contain the same variable declarations. You can view their contents in the respective editor that opens after double-clicking the GVL or GNVL node in the Devices pane. A GVL contains the network variables of a sender. In the Network properties of the sender, protocol and transmission parameters are defined. According to these settings, the variable values are broadcasted within the network. They can be received by all controllers that have a corresponding GNVL. NOTE: For network variables exchange, the respective network libraries must be installed. This is done automatically for the standard network type UDP as soon as the network properties for a GVL are set. Network variables are broadcasted from the GVL (sender) to one or more GNVL (receivers). For each controller you can define GVLs as well as GNVLs. Thus each controller can act as sender as well as receiver.

EIO0000000067 04/2012

107

Program

A sender GVL can be provided by the same or by another project. So, when creating a GNVL, the sender GVL can either be chosen from a selection list of all available GVLs within the network, or it can be read from an export file, which previously has been generated (for example, by using the Link to File dialog box) from the GVL. NOTE: An export file is needed if the sender GVL to be used is defined within another project. NVL Considerations The following table shows the list of controllers that support the network variables list (NVL) functionality:
Function Name M238 M258 LMC058 Yes XBTGC XBT GK XBT GT Yes ATV IMC

Network Variables List

No

Yes*

*ATV IMC supports NVL only in freewheeling tasks.

The figure shows a network consisting of 1 sender and the recommended maximum of 7 receivers:

Controller Sender A: Sender with the global variables list (GVL) and receiver controller with global network variables lists (GNVLs) Controller Receiver 1...7: Receivers (with GNVL) from A and sender controller (GVL) only for A

108

EIO0000000067 04/2012

Program

6.3

Adding Devices

Whats in this Section? This section contains the following topics:

Topic Adding Controller Adding Expansion Modules Adding Communication Managers Adding Devices to a Communication Manager Adding Devices from Template Page 110 111 113 115 118

EIO0000000067 04/2012

109

Program

Adding Controller
Introduction When you add a controller to your project, several nodes are automatically added to the Devices view. These subnodes are controller-specific, depending on the functions the controller provides. The following paragraph describes the general procedure of adding a controller. For details on a specific controller, refer to the programming manual for your particular controller. Procedure To add a device to your SoMachine project in the Program tab, proceed as follows:
Step Action 1 Right-click on the project node and select the Add Device... command from the context menu. 2 In the Add Device dialog box select Schneider Electric in the list box Vendor. 3 Choose the controller you want to insert into the project. 4 Rename your device by typing a name in the text box Name. Note: The name must neither contain any space, nor exceed a length of 32 characters. If you do not rename the device, a name is given by default. Tip: Naming the device meaningfully may ease the organization of your project. 5 Click the Add Device button. Result: The device selected is added to the project and appears as a new node in the Devices view. The Add Device window remains open. You can then: z add another controller by going back to step 3, or z click the Close button to return to the Program tab.

110

EIO0000000067 04/2012

Program

Adding Expansion Modules

Introduction In your project, you can add the following expansion modules to a controller:
Expansion Module TM2 Digital I/O TM2 Analog I/O TM2 High-Speed Counting I/O AS-Interface TM5 Digital I/O TM5 Analog I/O TM5 Expert I/O TM5 Bus and Power Distribution Controller M238 Logic Controller, XBTGC HMI Controller M238 Logic Controller, XBTGC HMI Controller M238 Logic Controller M238 Logic Controller M258 Logic Controller, LMC058 Motion Controller M258 Logic Controller, LMC058 Motion Controller M258 Logic Controller, LMC058 Motion Controller M258 Logic Controller, LMC058 Motion Controller

CANopen (XBT ZGCCAN, XBT ZGCCANS0) XBTGC HMI Controller TM7 Digital I/O Block TM7 Analog I/O Block M258 Logic Controller, LMC058 Motion Controller M258 Logic Controller, LMC058 Motion Controller

WARNING
UNINTENDED EQUIPMENT OPERATION
z z

Only use software approved by Schneider Electric for use with this equipment. Update your application program every time you change the physical hardware configuration.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000000067 04/2012

111

Program

Procedure of Adding Expansion Modules To add expansion modules to your device, proceed as follows:
Step 1 2 3 4 Action Right-click the controller node and select the Add Device... command from the context menu. In the Add Device dialog box, select Schneider Electric from the Vendor list. Choose the expansion module you want to add to your controller from the Device list below. Rename your expansion module by typing a name in the text box Name. NOTE: The name must not contain any space character. If you do not rename the expansion module, a name is given by default. Tip: Naming the expansion module meaningfully may ease the organization of your project. 5 6 In the Action section do not change the default setting Append device because for expansion modules the actions Insert device and Plug device are not available. Click the Add Device button. Result: The selected expansion module is added to the project and is displayed in the Devices tree as a new subnode of your controller. The Add Device dialog box remains open. You can now do the following: z You can add another expansion module by going back to step 3 of this description. z Or you can click the Close button.

NOTE: When you add a TWDNOI10M3 object (AS-Interface Master Module), the corresponding Virtual AS interface bus fieldbus manager will automatically be inserted. To add AS-Interface slave modules, proceed as described in the Adding Slave Devices to a Fieldbus Manager paragraph (see page 77). Expansion Module Configuration For more information about modules configuration refer to the following Programming Guides of the expansion modules corresponding to your hardware platform: z TM2 Expansion Modules Configuration - Programming Guide z TM5 Expansion Modules Configuration - Programming Guide z TM5 PCI Modules Configuration - Programming Guide z Modicon TM7 Expansion Blocks Configuration - Programming Guide (see Modicon TM7, Expansion Blocks Configuration, Programming Guide)

112

EIO0000000067 04/2012

Program

Adding Communication Managers

Overview Communication managers are mandatory to activate and configure any hardware bus interface, for example CANbus or Serial line. 2 types of communication managers exist: z Fieldbus Managers which allow to configure fieldbus devices (for example CANopen slaves or Modbus slaves) z general communication managers Communication managers available in SoMachine are listed below:
Name ASCII Manager Interface Type Serial line Description Used to transmit and / or receive data with a simple device. Must be used if you want to connect an XBTGT, XBTGK or XBTGH HMI through SoMachine protocol offering transparent exchange of data and multiple download capability (download of controller and HMI applications through 1 unique connection PC-controller or PC-HMI). Modbus RTU or ASCII protocol manager used to define implicit exchanges (I/O scanning) with Modbus slave devices. Used for Modbus RTU or ASCII protocol in master or slave mode. CANopen manager for optimized controllers (M238, XBTGC, XBTGT, XBTGK, ATV IMC) CANopen manager for performance controllers (M258 and LMC058) CANmotion manager for LMC058 Motion Controller CAN1 port only. Modbus TCP manager for controllers with Ethernet port. EtherNet/IP manager for controllers with Ethernet port (M258 and LMC058).

SoMachine-Network Manager Serial line

Modbus IOScanner

Serial line

Modbus Manager CANopen Optimized

Serial line CANbus

CANopen Performance CANmotion Modbus TCP Slave Device EtherNet/IP

CANbus CANbus Ethernet Ethernet

EIO0000000067 04/2012

113

Program

Adding the Communication Manager Proceed as follows to configure the communication manager:
Step 1 Action In the Devices window right-click the bus interface (Serial Line or CANbus) and select Add Device... from the context menu. Result: The Add Device dialog box will be displayed. In the Add Device dialog box select <All vendors> from the list box Vendor. Note: You can sort the devices by brand by clicking on the list box Vendor. Select the Communication manager from the list below. Rename your device by typing a name in the Name textbox. Note: The name must not contain any spaces. If you do not rename the device, a name is given by default. Click the Add Device button. Configure the Communication manager.

2 3 4

5 6

114

EIO0000000067 04/2012

Program

Adding Devices to a Communication Manager

Overview You can add Modbus and CANopen field devices to the communication manager by executing the Add Device command. As a prerequisite the device must be available in the Device Repository (see the CoDeSys online help for details on how to import device descriptions, for example importing CANopen EDS files into SoMachine). Adding Devices
Step 1 Action Right-click the field device manager item (CANopen or Modbus manager) in the Devices window and select Add Device... from the context menu. Result: The Add Device dialog box will be displayed. In the Add Device dialog box select <All vendors> from the list box Vendor. Note: You can sort the devices by brand by clicking on the list box Vendor. Select the device of your choice from the list below. Rename your device by typing a name in the Name textbox. Note: The name must not contain any space. If you do not rename the device, a name is given by default. Tip: Naming the device meaningfully may ease the organization of your project. Click the Add Device button. Result: The field device is added to the field device manager. NOTE: The Add Device dialog box remains open. You can now:
z add another device by going back to step 2 z click the Close button

2 3 4

Access to Diagnostic Information To get diagnostic information of devices on CANopen use the CiA 405 library (see SoMachine, CANopen Management Functions, CAA CiA 405 Library Guide).

EIO0000000067 04/2012

115

Program

Access to Configuration Diagnostic (for Advanced Users) You can use the options Abort if error and Jump to line if error in the Service Data Object tab of the CANopen configurator to deal with potential configuration errors. For further information on these options refer to the Service Data Object chapter in the CoDeSys online help. To optimize the CAN master performance, CAN diagnostics are external from the CAN master in the controller. The CAN diagnostic structure is defined in the CanConfig Extern library available in the Library Manager. The structure g_aNetDiagnosis contains the most recent diagnostic information from the slaves. The structure is updated every time a slave is configured, for whatever reasons. This structure can be used within the program to do the following: z Monitoring the response of the slave(s) configured via SDO messages. z Monitoring the master for any abort messages from the slaves before allowing a machine / application start-up. This structure must be in place and active within the user application during testing, debugging and commissioning of the application. When the machine and its controlling application has been commissioned and is stable, then it would be possible to disable this code from execution. However, if during the lifecycle of an application and the machine or process that it controls, slaves are added or replaced in the operational system, then the diagnostic structure should continue to remain active in the application.

WARNING
UNINTENDED EQUIPMENT OPERATION
z z

Use the g_aNetDiagnosis data structure within the application to monitor CAN slave responses to configuration commands. Verify that the application does not start-up or put the machine or process in an operational state in the event of receiving SDO abort message(s) from any of the CAN slaves.

Failure to follow these instructions can result in death, serious injury, or equipment damage. After adding the CanConfig Extern library to your application, use the Net Diagnostic definition within your application to test for SDO abort messages from the CAN slaves.

116

EIO0000000067 04/2012

Program

To help you better understand the use of the CAN diagnostic data structure, the following code example is provided: IF g_aNetDiagnosis[CAN_Net_Number].ctSDOErrorCounter = 0 THEN (* No error is detected in the configuration*) ELSE (* An error has been detected during configuration. Get the latest error information.*) // node ID of the slave which sent the abort code ReadLastErrorNodeID := g_aNetDiagnosis[CAN_Net_Number].usiNodeID; // index used in the aborted SDO ReadLastErrorIndex := g_aNetDiagnosis[CAN_Net_Number].wIndex; // subIndex used in the aborted SDO ReadLastErrorSubIndex := g_aNetDiagnosis[CAN_Net_Number].bySubIndex; //SDO abort code ReadLastErrorSdoAbortCode := g_aNetDiagnosis [CAN_Net_Number].udiAbortCode; (* Do not allow the start-up or other operation of the machine or process *) END_IF NOTE: In this example, the CAN_Net_Number would be 0 for the CAN0 port, and if the controller is so equipped, 1 for the CAN1port.

EIO0000000067 04/2012

117

Program

Adding Devices from Template

Overview It is also possible to add a new device using a device template. For a description of this procedure refer to the Managing Device Templates section (see page 206).

118

EIO0000000067 04/2012

Program

6.4

Managing the Libraries

Whats in this Section? This section contains the following topics:

Topic Generalities About Libraries Library Management in SoMachine Schneider Electric Libraries Other Libraries Used in SoMachine Creating Your Own Libraries Page 120 123 127 135 138

EIO0000000067 04/2012

119

Program

Generalities About Libraries

Content of Libraries Libraries provide the following items that are executed in the runtime system of your controller: z functions and function blocks z data type definitions z global variables z system variables z visualization objects The management of the libraries in a project is done by using Library Managers for the whole project or controller-specific. The installation of libraries on the system (PC) is done in the Library Repository dialog. Library Main Information In the Library Manager and Library Repository, you will find the following information to the libraries:
Information Name Version Company Namespace Category Description name of the library version of the library library belongs to this company short name which can be used in the application libraries are grouped by categories Example M238 PLCSystem 1.0.1.8 Schneider Electric SEC Controller M238

Library Repository The Library Repository is the editor that manages libraries installed in SoMachine. The Library Repository allows you to install or remove libraries. A library can be used in a SoMachine project only if it is installed in the Library Repository. With the installation of SoMachine, a set of libraries is installed by default. You can install new libraries or new versions of existing libraries.

120

EIO0000000067 04/2012

Program

Managing Libraries by Using Library Managers Libraries declared in a project are managed in the Library Manager editor. Within a SoMachine project, 2 different Library Managers are available at 2 different locations for different use cases of libraries:
Use Case libraries available for the whole project libraries available for a specific controller Location of the Library Manager in the POUs window in the Devices window for each controller, where it is a subnode of the Application node

EIO0000000067 04/2012

121

Program

The figure below shows the Library Manager in the POUs window and the Library Manager in the Devices window on the left-hand side of the SoMachine Program tab:

For more information about library management, refer to CoDeSys online help: Concepts and Base Components / Library Management. For more information about Library Repository, refer to CoDeSys online help: Menu Commands / Installation / Library Repository. For more information about Library Manager, refer to CoDeSys online help: Editors / Library Manager Editor. In SoMachine, features embedded in libraries might be used for the automation as well as for the system (internal). In both cases, libraries are managed with the Library Manager of SoMachine.
122
EIO0000000067 04/2012

Program

Library Management in SoMachine

Organization of the Libraries in the Repository 2 types of libraries exist: Automation libraries: their functions can be used by users in the automation applications (program) System libraries: SoMachine internal libraries, not related to the automation applications (program) SoMachine default Company names: z 3S - Smart Software Solution GmbH z CAA Technical Workgroup z Schneider Electric z System The libraries are grouped in the following categories to provide a better overview: z (Miscellaneous): libraries not categorized z Application: libraries used in the automation applications z Communication: libraries used for specific communication features z Controller: libraries dedicated to SoMachine controllers z Devices: libraries dedicated to distributed devices management (TeSys, Altivar, Lexium) z Intern: system libraries for SoMachine internal usage and controller runtime z Solution: libraries dedicated to applications solutions (Packaging, Hoisting, Conveying, etc.) z System: system libraries for SoMachine internal usage and controller runtime z Target: platform-specific libraries z Use Cases: libraries a user can select to insert all libraries that belong to one use case z Util: libraries providing additional utility functions

EIO0000000067 04/2012

123

Program

Namespace A library namespace is a symbol that allows the unique access to the attached library components (functions, function blocks, variables). The use of namespaces is optional, but necessary if 2 components of 2 different libraries used in the same project have the same name. The full name <namespace>.<component> will then allow a unique access to the correct component.
Case 1 Description There is a function block GEN in the library Util. The namespace of the library Util is Util. An instance of the function block GEN can be declared with or without the library namespace if the name GEN is unique within the project: MyGenerator: Util.GEN; or MyGenerator: GEN; A function block GEN has been created within the project. The use of the library Util namespace will allow the system to access the function block GEN of the library Util. Without namespace, the project function block GEN will be accessed: MyGenerator_Util: Util.GEN; MyGenerator_Project: GEN; Another library, also containing a function block called GEN, is declared in the project with namespace NewLib. The use of the namespace becomes mandatory to identify the correct function block GEN to be accessed: MyGenerator_Util: Util.GEN; MyGenerato_NewLib: NewLib.GEN;

A default namespace is defined for each library. Schneider Electric libraries default namespaces start with the prefix SE. Default namespace of a library declared in a project can be customized in the library Properties editor called from the Library Manager (In the Library Manager of a project, right click on the library then select the Properties field). Placeholder Placeholder is a mechanism used to manage the compatibility between versions of devices and versions of libraries. When SoMachine or existing devices are upgraded or when new devices are integrated, attached Device Description Files are installed. The Device Description File contains the placeholders that define versions of libraries compatible with the device version.

124

EIO0000000067 04/2012

Program

When manually adding a library to a device, use the placeholder to help maintain compatibility between the device version and the library version independent of the version of SoMachine. NOTE: The placeholders are defined in the Device Description Files. When the user creates a new library, there is no placeholder defined in the Device Description Files for this new library. The placeholder mechanism cannot be used when adding this custom library to the device library manager. In a project created with a previous version of SoMachine software, the versions of the libraries declared in the project will be either: z kept unchanged for libraries declared with a specified version, z automatically updated with the latest versions for libraries declared using the latest version concept (version identified with * in the Library Manager), z automatically updated with the versions defined in the controller Device Description File after a controller device update command for libraries declared using the placeholder concept.

WARNING
UNINTENDED EQUIPMENT OPERATION
z z

Verify the SoMachine libraries contained in your program are the correct version after updating SoMachine software. Verify that the library versions updated are consistent with your application specifications.

Failure to follow these instructions can result in death, serious injury, or equipment damage. Different ways to Declare a Library in a Project There are different ways to declare a library in a project. The libraries are automatically declared when adding: z a controller: z IEC 61131 basic libraries: Standard and Util libraries z Controller PLCSystem library z Other libraries to manage embedded controller features (for example: M238 High Speed Counting)
z z z

specific controller features (for example: DataLogManager, Visualization) a fieldbus manager (for example: CANopen or CANmotion manager) a fieldbus device (for example: TeSys, Altivar, Lexium)

Some libraries must be added manually (for example: Toolbox and Solution libraries).

EIO0000000067 04/2012

125

Program

NOTE: You should use only functions and function blocks documented in the online help or function or function blocks that you have thorougly tested with your application.

126

EIO0000000067 04/2012

Program

Schneider Electric Libraries

Introduction All libraries from Schneider Electric are listed below. NOTE: USER column: z YES: Functions and Function Blocks of the library can be used in the users applications (program). z NO: Intended only for specific system or administrative functions. Typically, these functions and function blocks have no user documentation. Category: (Miscellaneous) The following table describes the library available in the (Miscellaneous) category:
Name FeatureNotSupported Namespace none Description USER

Virtual empty library used by the NO system

Category: Application The following table describes the library available in the Application category:
Name SE_LMC_Utility Namespace SE_LMC_Utility Description Utility functions used by the Profibus-DP slave library USER NO

NOTE: For the other library descriptions see the categories Communication, Solution and Util.

EIO0000000067 04/2012

127

Program

Category: Communication The following table describes the libraries available in the Communication category:
Name IoDrvASI refer to AS-Interface (see Modicon M238 Logic Controller, Programming Guide) IoDrvDistributedIo IoDrvModbusSerial Namespace SEN_ASI Description AS-Interface bus management functions bus management functions for distributed I/O on CANopen USER YES

SEN_DIO SEN_MODBUS

NO

NO Modbus devices I/O scanning management for Modbus_IOScanner manager (for further information about Modbus Manager configuration, please refer to online help CoDeSys Programming System Help / Editors / Device Editors / Modbus Configuration Editor / Modbus Device Editor) Profibus-DP slave library Serial Line port configuration getting and setting on M238, M258 and LMC058 controllers Modem configuration on M238, M258 and LMC058 controllers NO YES

IoDrvTM5PCDPS M2xx Communication refer to Functions to Get/Set Serial Line Configuration (see Modicon M238 Logic Controller, Programming Guide) Modem refer to Modem Library (see SoMachine, Modem Functions, Modem Library Guide)

SEN_PROFIBUS SEN_COM

SEN_MOD

YES

SEN PLCCommunication refer to PLCCommunication Library (see SoMachine, Modbus and ASCII Read/Write Functions, PLCCommunication Library Guide) SE_NetVarUdp refer to SE_NetVarUdp Library

YES Management of explicit data exchanges between controller and devices through Modbus or ASCII protocols NOTE: This library is not supported by the ATV IMC Drive Controller. Data exchange between controllers YES within a network via network variables.

128

EIO0000000067 04/2012

Program

Category: Controller The following table describes the libraries available in the Controller category:
Name DataLogging refer to DataLogging Library (see SoMachine, Data Logging Functions, DataLogging Library Guide) Namespace SEDL Description Data logging management of controllers that support file management operations USER YES

The following table describes the libraries available in the Controller ATV IMC category:
Name ATV IMC HSC refer to High Speed Counting (see ATV IMC Drive Controller, High Speed Counting, ATV IMC HSC Library Guide) ATV IMC PLCSystem refer to PLCSystem Library (see ATV IMC Drive Controller, System Functions and Variables, ATV-IMC PLCSystem Library Guide) ATV IMC SysLib V2.3 Namespace SEC_HSC Description ATV IMC High Speed Counting management USER YES

SEC

ATV IMC System Functions and Variables

YES

SEC_SL23

Functions and Function Blocks for compatibility with Controller Inside applications (CoDeSys v2.3) ATV IMC - ATV71 host interface management

YES

ATV IMC UserLib refer to ATV IMC - UserLib Library Guide (see ATV IMC Controller, ATV IMC UserLib Library Guide)

SEC_USER

YES

The following table describes the libraries available in the Controller LMC058 category:
Name IoDrvTM5SEAISG Namespace SEC_TM5SEAISG Description TM5SEAISG device library provides calibration, tarring and calibrated measure services LMC058 Expert I/O management USER YES

LMC058 Expert IO z refer to High Speed Counting (see Modicon LMC058 Motion Controller, High Speed Counting, LMC058 Expert I/O Library Guide) z refer to Pulse Width Modulation (see Modicon LMC058 Motion Controller, Pulse Width Modulation, LMC058 Expert I/O Library Guide)
EIO0000000067 04/2012

SEC_EXP

YES

129

Program

Name

Namespace

Description Functions used to get immediate motion axis value and to reset the detected error.

USER YES

SEC_MC LMC058 Motion refer to High Speed Counting (see Modicon LMC058 Motion Controller, High Speed Counting, LMC058 Expert I/O Library Guide) LMC058 PLCSystem refer to PLCSystem Library (see Modicon LMC058 Motion Controller, System Functions and Variables, LMC058 PLCSystem Library Guide) LMC058 Relocation Table SEC

LMC058 System Functions and Variables

YES

SEC_RELOC

System library for Relocation Table NO (see Modicon LMC058 Motion Controller, Programming Guide) management.

The following table describes the libraries available in the Controller M238 category:
Name M238 ASi Interface Namespace SEC_ASIITF Description USER

System library for AS-Interface bus NO management M238 High Speed Counting management YES

SEC_HSC M238 HSC refer to High Speed Counting (see Modicon M238 Logic Controller, High Speed Counting, M238 HSC Library Guide) M238 PLCSystem refer to PLCSystem Library (see Modicon M238 Logic Controller, System Functions and Variables, M238 PLCSystem Library Guide) SEC

M238 System Functions and Variables

YES

SEC_PTOPWM M238 PTOPWM refer to Pulse Train Output / Pulse Width Modulation (see Modicon M238 Logic Controller, Pulse Train Output, Pulse Width Modulation, M238 PTOPWM Library Guide) M238 Relocation Table SEC_RELOC

M238 PTO and PWM management YES

System library for Relocation Table NO (see Modicon M238 Logic Controller, Programming Guide) management.

130

EIO0000000067 04/2012

Program

The following table describes the libraries available in the Controller M258 category:
Name IoDrvTM5SEAISG Namespace SEC_TM5SEAISG Description TM5SEAISG device library provides calibration, tarring and calibrated measure services M258 Expert I/O management USER YES

M258 Expert IO z refer to High Speed Counting (see Modicon M258 Logic Controller, High Speed Counting, M258 Expert I/O Library Guide) z refer to Pulse Width Modulation (see Modicon M258 Logic Controller, Pulse Width Modulation, M258 Expert I/O Library Guide) M258 PLCSystem refer to PLCSystem Library (see Modicon M258 Logic Controller, System Functions and Variables, Modicon M258 PLCSystem Library Guide) M258 Relocation Table

SEC_EXP

YES

SEC

M258 System Functions and Variables

YES

SEC_RELOC

System library for Relocation Table NO (see Modicon M258 Logic Controller, Programming Guide) management.

The following table describes the libraries available in the Controller XBTGC category:
Name XBT PLCSystem Namespace SEC Description XBT System Functions and Variables XBTGC High Speed Counting management USER YES YES

SEC_HSC XBTGC HSC refer to High Speed Counting (see Magelis XBT GC HMI Controller, High Speed Counting, XBT GC HSC Library Guide) XBTGC PLCSystem refer to PLCSystem Library (see Magelis XBTGC, XBTGT, XBTGK HMI Controller, System Functions and Variables, XBT PLCSystem Library Guide) XBTGC PTOPWM refer to Pulse Train Output / Pulse Width Modulation (see Magelis XBTGC HMI Controller , Pulse Train Output, Pulse Width Modulation, XBTGC Library Guide)
EIO0000000067 04/2012

SEC

XBTGC System Functions and Variables

YES

SEC_PTOPWM

XBTGC PTO and PWM management

YES

131

Program

Category: Devices The following table describes the libraries available in the Devices category:
Name Altivar Library refer to Altivar Library Guide CANmotion Lexium Library refer to CANmotion Lexium Library Guide Namespace SE_ATV Description IEC 61131-3 standard compliant function blocks for the control of ATV variable speed drives Functions SM_Servo_Startup and SM_Stepper_Startup and associated Visualization components to ease motion drives and steppers commissioning. IEC 61131-3 standard compliant function blocks for the control of Lexium Integrated Drives IEC 61131-3 standard compliant function blocks for the control of Lexium 32, Lexium 05 and Lexium SD3 drives on CANopen fieldbus IEC 61131-3 standard compliant function blocks for the control of Lexium 23 drives on CANopen fieldbus Control of TeSys U motor startercontroller and TeSys T motor management system. The library also offers function blocks for generic control of 1 or 2 directions / 1 or 2 speed motors. USER YES

SEM_LXM_SM

YES

Integrated Lexium Library refer to Integrated Lexium Library Guide Lexium Library refer to Lexium Library Guide

SE_ILX

YES

SE_LXM

YES

Lexium 23 Library refer to Lexium 23 Library Guide NOTE: This library is only available after installing a Patch. TeSys Library refer to TeSys Library (see SoMachine, TeSys Motor Starters Functions, TeSys Library Guide)

SE_LXM23

YES

SE_TESYS

YES

Category: Intern The following table describes the libraries available in the Intern IoDrivers category:
Name IoDrvPROFIBUSDPV1Slave IoDrvSlave Namespace IoDrvPROFIBUSDPV1 Slave IoDrvSlave Description Profibus-DP slave library used to manage the TM5PCDPS module Slave device library extended by IoDrvPROFIBUSDPV1Slave USER NO NO

132

EIO0000000067 04/2012

Program

Category: Solution The following table describes the libraries available in the Solution category:
Name Namespace Description
z Conveying Device Templates z Conveying Function Templates

USER YES

Conveying_Templates Conveying Templates refer to Developing Conveying applications by using Template Libraries.pdf in the Windows Start menu Schneider Electric SoMachine Documentation. Conveying refer to SoMachine Conveying Application Functions Conveying Library Guide Hoisting refer to SoMachine Hoisting Application Functions Hoisting Library Guide Packaging refer to SoMachine Packaging Application Functions Packaging Library Guide SE_CONV

Conveying applications function blocks Hoisting applications function blocks Packaging applications function blocks

YES

SE_HOIST

YES

SE_PACK

YES

NOTE: The Solution libraries have to be installed from the SoMachine Solution Extension DVD. Category: System The following table describes the libraries available in the System category:
Name SystemConfigurationItf Namespace SystemConfigurationItf Description System configuration interface library used by the IoDrvTM5PCDPS library System library used by the IoDrvTM5PCDPS library USER NO

SystemInterface

SystemInterface

NO

EIO0000000067 04/2012

133

Program

Category: Util The following table describes the libraries available in the Util category:
Name EnergyEfficiencyToolbox refer to the Energy Efficiency Toolbox Library Guide in the Schneider Electric Libraries Solution Libraries part of the SoMachine online help ModbusEnergyEfficiencyToolbox refer to the Modbus Energy Efficiency Toolbox Library Guide in the Schneider Electric Libraries Solution Libraries part of the SoMachine online help MachineEnergyDashboard refer to the Machine Energy Dashboard Library Guide (see SoMachine, Machine Energy Dashboard Library Guide) Namespace EET Description Function Blocks to collect energy data from individual devices or equipment and to summarize energy usage for the entire machine. Function Blocks to collect energy data from individual Modbus devices or equipment and to summarize energy usage for the entire machine. USER YES

MEET

YES

MED

MED information, based on the data YES provided by the EnergyEfficiencyToolbox library, dedicated to providing meaningful metrics concerning the energy efficiency of a machine. Set of utility Functions and Function YES Blocks complementary to the automatically declared Standard and Util libraries Functions used to get and set the interval of a Cyclic Task. YES

Toolbox refer to Toolbox (see SoMachine, Miscellaneous Functions, Toolbox Library Guide) Toolbox_Advance refer to Toolbox_Advance (see SoMachine, Manage a Cyclic Task Interval, Toolbox_Advance Library Guide)

SE_TBX

SE_TBXADV

134

EIO0000000067 04/2012

Program

Other Libraries Used in SoMachine

Introduction Libraries from companies other than Schneider Electric that are useful are listed below. NOTE: USER column: z YES: Functions and Function Blocks of the library can be used in the users applications (program). z NO: Libraries intended for specific system or administrative functions. Typically, these functions and function blocks have no user documentation. 3S - Smart Software Solution GmbH Libraries Libraries contained in Intern and System are for internal system use and not available for user applications. Libraries are indicated as such in the column USER of the following tables by the word NO. Those that are intended for user applications are indicated as such by the word YES. Libraries available in Use Cases category: container libraries that gather CAA libraries about a common topic (for further information about CAA functions, please refer to CoDeSys Programming System Help / Libraries / System Libraries / CAA Libraries). The following table describes the libraries available in the Intern SoftMotion category:
Name SM3_Basic Namespace SM3_Basic Description USER

YES Functions for SoftMotion basic management (for further information about basic management, please refer to CoDeSys Programming System Help / Libraries / SoftMotion Libraries / SM3_Basic Library) NOTE: This library is only supported on Modicon LMC058 Motion Controller. Functions for SoftMotion CNC management (for further information about CNC management, please refer to CoDeSys Programming System Help / Libraries / SoftMotion Libraries / SM3_CNC Library) NOTE: This library is only supported on Modicon LMC058 Motion Controller. YES

SM3_CNC

SM3_CNC

SM3_Drive_

SoftMotion system management libraries NO

EIO0000000067 04/2012

135

Program

System Libraries The following table describes the library available in the (Miscellaneous) category:
Name CmpEventMgr Namespace Description Event system management library USER NO

The following table describes the libraries available in the Application Common category:
Name Standard64 Standard Namespace Standard64 Standard Description Functions for wide characters strings management and long timers IEC programming standard functions and function blocks (for further information about standard functions, please refer to CoDeSys Programming System Help / Libraries / Standard Library). Programming additional functions and function blocks (for further information about additional functions, please refer to CoDeSys Programming System Help / Libraries / Util Library) USER YES YES

Util

Util

YES

Libraries available in Intern category: some of these libraries are for internal system use only. The following table describes the libraries available in the System SysLibs category:
Name Cmp Sys ISys Namespace Description System management libraries USER NO

SysTime SysTime refer to Real Time Clock management (see SoMachine, Getting & Setting Real Time Clock, SysTime Library Guide)

Controller Real Time Clock management

YES

136

EIO0000000067 04/2012

Program

The following table describes the library available in the System SysLibs23 category:
Name Sys23 Namespace Description System management libraries for CoDeSys v2.3 projects migration USER NO

CAA Technical Workgroup Libraries The following table describes the libraries available in the Application CAA category:
Name CAA Namespace Description Libraries from CoDeSys Automation Alliance workgroup (for further information about CAA functions, please refer to CoDeSys Programming System Help / Libraries / System Libraries / CAA Libraries). Functions blocks for CANopen fieldbus management from application USER NO

CAA CiA 405 refer to CAA CiA 405 Library (see SoMachine, CANopen Management Functions, CAA CiA 405 Library Guide)

CIA405

YES

The following table describes the library available in the Intern CAA category:
Name CAA Namespace Description USER

NO Libraries from CoDeSys Automation Alliance workgroup (for further information about CAA functions, please refer to CoDeSys Programming System Help / Libraries / System Libraries / CAA Libraries).

EIO0000000067 04/2012

137

Program

Creating Your Own Libraries

Overview SoMachine allows you to save a SoMachine project file (<projectname>.project) as a library file (<projectname>.library) and vice-versa. The library file only includes the objects managed in the POUs window. Procedure To create your own library project via the Program tab, proceed as follows:
Step 1 Action The SoMachine Program tab provides 2 different ways to create a new library project: z Either by using the File New menu and selecting the Empty Library project template from the Categories Basic Controllers. z Or by using the File Save project as... menu and selecting from the Save as type list box the Library file type. Fill in the mandatory fields in the File Project Project information. In your library project create your: z functions and function blocks z datatype definitions z global variables z visualization objects z libraries NOTE: Only the objects managed in the POUs window will be considered for a library project. NOTE: If you add standard SoMachine libraries to your own library, always use placeholders to reference them. For details on referencing libraries by placeholders refer to the Adding Libraries chapter (see page 97). 4 Execute the command File Save project and install library into library repository. Result: Your library is now installed on your PC and can be added to any project on your PC using the Library manager.

2 3

NOTE: For more detailed information refer to the CoDeSys online help. To check the syntax and find your potential errors, use the command Check all Pool objects in the menu build, before using Save the project as a compiled library or Save project and install library into library repository. It is best to first code your logic in a regular project application and use the tools available to debug your logic, such as breakpoints and inspection of data values. Once a library is compiled, the logic can not be viewed or modified.

138

EIO0000000067 04/2012

Program

6.5

Managing the Communication Ports

Whats in this Section? This section contains the following topics:

Topic Configuring the Ethernet Interface Configuring the CANopen Interface Configuring the Serial Line Interfaces Configuring the Profibus DP Interface Configuring the AS-Interface Page 140 143 149 152 155

EIO0000000067 04/2012

139

Program

Configuring the Ethernet Interface

Overview Ethernet communications are possible via EtherNet/IP and Modbus TCP slave devices. Before you can establish an Ethernet connection you must physically connect your controller. For detailed information on this hardware connection, refer to the respective hardware manual. Creating an EtherNet/IP or Modbus TCP Slave Device To create an EtherNet/IP or Modbus TCP slave device, proceed as described in the following example for M258 controllers:
Step 1 Action In the Devices window right-click the node Ethernet (Ethernet) that is provided as a sub node of your M258 Logic Controller if it supports Ethernet communications and select the command Add Device... from the context menu. Result: The Add Device dialog box opens.

140

EIO0000000067 04/2012

Program

Step 2

Action In the Add Device dialog box select EthernetIP node to create an EtherNet/IP slave device. Or select the ModbusTCP Slave Device to create a Modbus TCP slave device. Enter a Name and click the Add Device button.

EIO0000000067 04/2012

141

Program

Step 3

Action Add another device or click the Close button to close the dialog box. Result: The Ethernet node in the Devices window now contains a sub node for EtherNet/IP and/or Modbus TCP with the name you entered. Double-click the sub node and configure your Ethernet device in the editor on the right-hand side. The figure below shows the configuration of a ModbusTCP slave device as an example:

For further information on the individual settings refer to the CoDeSys online help.

142

EIO0000000067 04/2012

Program

Configuring the CANopen Interface

Overview For CANopen communications you must first define the transmission rate and configure a CANopen master. The following paragraphs describe how to define the transmission rate in the CANopen configuration dialog box and to create and configure the CANopen Manager that serves as CANopen master using an M238 Logic Controller as an example. Before you can establish a CANopen connection you must physically connect your CANopen devices to your controller. For detailed information on this hardware connection, refer to the hardware manual of your controller. Configuring the Transmission Rate To configure the transmission rate for CANopen communications, proceed as follows:
Step 1 Action In the Devices window double-click the entry CAN that is provided as a subitem of your M238 Logic Controller if it is equipped with a CANopen interface.

Result: The tabbed configuration dialog box for CANopen communications will be displayed on the righthand side.

EIO0000000067 04/2012

143

Program

Step 2

Action In the CANbus tab configure the transmission rate:

From the Baudrate list select the transmission rate of your CANopen connection, by default 250,000 bit/s. To inhibit access to the NMT commands and Service data object (SDO) parameters, that are provided in the Status tab of each device when you are logged in, while the controller is in RUN mode, select the Online Bus Access check box.

144

EIO0000000067 04/2012

Program

Creating and Configuring the CANopen Manager To create and configure the CANopen Manager, that serves as CANopen master and that is required for CANopen communications, proceed as follows:
Step 1 Action In the Devices window right-click the node CAN that is provided as a sub node of your M238 Logic Controller and select the command Add Device... from the context menu:

Result: The Add Device dialog box opens.

EIO0000000067 04/2012

145

Program

Step 2

Action In the Add Device dialog box select the CANopen_Manager. Adapt the default Name, if required, and click the Add Device button:

146

EIO0000000067 04/2012

Program

Step 3

Action The Add Device dialog box remains open. Click the Close button to close the dialog box. Result: The CAN node in the Devices window now contains a CANopen Manager sub node.

To configure your CANopen device, double-click its entry in the Devices window. Result: The configuration dialog box for CANopen devices, the so-called CANopen_Manager, will be displayed on the right-hand side. When configuring the CANopen_Manager and the CANopen devices, consider the hints on nodeguarding and heartbeat settings in the following paragraphs.

For further information on CANopen configurations, refer to the CoDeSys online help. For adding a CANopen device, refer to the Adding Devices chapter (see page 109). Nodeguarding Settings The node Life time (Life time = Guard time x Life time factor) must be greater than twice the task cycle time: z Guard time > task cycle time z Life time factor >= 2 Schneider Electric recommends the following settings:
Parameter Guard time Life time factor Value 200 ms 2 (1 is not allowed)

EIO0000000067 04/2012

147

Program

Heartbeat Settings The CANopen_Manager heartbeat producer time must be equal to or greater than the task cycle. To avoid jitter, choose a producer time that is a multiple of the task cycle: z CANopen_Manager Producer time >= Task cycle time The Node heartbeat consumer time must be greater than twice the CANopen_Manager heartbeat producer time: z Node Consumer time >= 2.5 x CANopen_Manager Producer time The Node heartbeat producer time must be equal to or greater than the task cycle: z Node Producer time >= Task cycle time Schneider Electric recommends the following settings:
Parameter CANopen_Manager Producer time Node Consumer time Node Producer time Value 200 ms 500 ms 200 ms

NOTE: Nodeguarding can be activated (configuration in slaves) only if heartbeat producer AND consumer are de-activated.

148

EIO0000000067 04/2012

Program

Configuring the Serial Line Interfaces

Overview You must first define the communication settings and configure a Protocol Manager before you can add devices. Before you can establish a connection you must physically connect your devices to your controller. For detailed information on this hardware connection, refer to the hardware manuals of your controller and connected devices. Configuring Communication Settings To configure communication settings for serial line interfaces, proceed as follows:
Step 1 Action In the Devices window double-click the desired Serial Line subnode of your controller. Result: The tabbed configuration dialog box for serial line communications will be displayed on the righthand side. Configure the communication settings in the Configuration tab:

Note: The communication settings must be identical for each device connected.

EIO0000000067 04/2012

149

Program

Protocol Managers For each serial line interface, one of the following Protocol Managers is required:
Protocol Manager ASCII Manager Modbus Manager Modbus IOScanner Description Used to transmit and / or receive data with a simple device. Used for Modbus RTU or ASCII protocol in master or slave mode. Modbus RTU or ASCII protocol manager used to define implicite exchanges (I/O scanning) with Modbus slave devices. Must be used if you want to connect an XBTGT, XBTGK or XBTGH HMI through SoMachine protocol offering transparent exchange of data and multiple download capability (download of controller and HMI applications through 1 unique connection PC-controller or PC-HMI).

SoMachine Network Manager

There is one Protocol Manager preconfigured for each serial line interface, but it can be removed and configured according to your individual requirements.

150

EIO0000000067 04/2012

Program

Adding a Protocol Manager To add a Protocol Manager to a serial line interface, proceed as follows:
Step 1 Action In the Devices window right-click the Serial Line nubnode and select the command Add Device from the context menu. Result: The Add Device dialog box will be displayed.

From the Add Device dialog box select the Protocol Manager that suits your requirements, adapt the Name and click the Add Device button. Result: The selected manager will now be displayed in the Devices window as a subnode of the Serial Line node. 3 To configure the Protocol Manager, double-click its entry in the Devices window. Result: The tabbed configuration dialog box for the selected Protocol Manager will be displayed on the right-hand side. For further information on configuring the individual Protocol Managers, refer to the Programming Guide of your controller or to the CoDeSys part of the online help.

You can now add your devices as described in the Adding Devices to a Communication Manager chapter (see page 115).
EIO0000000067 04/2012

151

Program

Configuring the Profibus DP Interface

Overview Before you can establish a Profibus DP connection, you must physically connect to the Profibus DP slave module of your controller. For detailed information on this hardware connection, refer to the respective hardware manual. The following Modicon M258 Logic Controller types support Profibus DP connections: z TM258LD42DT4L z TM258LF42DR z TM258LF42DRS0 z TM258LF42DT4L z TM258LF42DT4LS0 z TM258LF66DT4L The following Modicon LMC058 Motion Controller types support Profibus DP connections: z LMC058LF424 z LMC058LF424S0

152

EIO0000000067 04/2012

Program

Adding a Profibus DP Slave PCI Expansion Module To add a Profibus DP Slave PCI expansion module to your M258 / LMC058 controller, proceed as follows:
Step 1 Action In the Devices window right-click the node Empty (Empty) that is provided as a sub node of the node PCI Slots of your M258 / LMC058 controller and select the command Plug Device... from the context menu: Result: The Plug Device dialog box opens. In the Plug Device dialog box select the entry TM5PCDPS from the list of PCI Communication Modules. Adapt the default Name if required, and click the Plug Device button:

EIO0000000067 04/2012

153

Program

Step 3

Action The Plug Device dialog box remains opens. Plug another device or click the Close button to close the dialog box. Result: The PCI Slots node in the Devices window now contains a Profibus DP sub node with the name you entered or with the default name TM5PCDPS (TM5PCDPS). To configure your Profibus DP Slave PCI expansion module, double-click its entry in the Devices window. Result: The configuration dialog box for the Profibus DP Slave PCI expansion module is displayed on the right-hand side.

For further information, refer to the Profibus DP Slave PCI Expansion Module Configuration chapter in the Modicon TM5 PCI Modules Configuration Programming Guide (see Modicon TM5, PCI Modules Configuration, Programming Guide).

154

EIO0000000067 04/2012

Program

Configuring the AS-Interface

Overview AS-Interface communications are only supported by M238 controllers. To establish AS-Interface communications, you first have to add an AS-Interface Master Module. Then you can add AS-Interface slave modules. Adding and Configuring the AS-Interface Master Module To add the AS-Interface Master Module TWDNOI10M3, proceed as follows:
Step 1 Action In the Devices window right-click the node of your M238 controller (for example TM238LFDC24DT) and select the command Add Device from the context menu. Result: The Add Device dialog box will be displayed.

EIO0000000067 04/2012

155

Program

Step 2

Action In the Add Device dialog box expand the Communication Expansion Modules item and select the entry TWDNOI10M3.

Adapt the default Name, if required, and click the Add Device button. Result: The node of your controller now contains the AS-Interface Master Module as sub node TWDNOI10M3 (TWDNOI10M3) ASi_Master (ASi Master) in the Devices window.

156

EIO0000000067 04/2012

Program

Step 2

Action In the Add Device dialog box expand the Communication Expansion Modules item and select the entry TWDNOI10M3.

Adapt the default Name, if required, and click the Add Device button. Result: The node of your controller now contains the AS-Interface Master Module as sub node TWDNOI10M3 (TWDNOI10M3) ASi_Master (ASi Master) in the Devices window.

EIO0000000067 04/2012

157

Program

Step 3

Action To configure your AS-Interface Master Module, double-click its entry in the Devices window. Configure your AS-Interface Master Module in the editor on the right-hand side.

For further information on configuring AS-Interface Master Modules, refer to the CoDeSys online help. Creating and Configuring an AS-Interface Slave Module To create an AS-Interface slave module, proceed as follows:
Step 1 Action Right-click the TWDNOI10M3 (TWDNOI10M3) ASi_Master (ASi Master) node in the Devices window and select the Add Device command from the context menu. Result: The Add Device dialog box will be displayed.

158

EIO0000000067 04/2012

Program

Step 2

Action Select an AS-Interface slave device from the list, adapt the default Name, if required, and click the Add Device button.

EIO0000000067 04/2012

159

Program

Step 3

Action The Add Device dialog box remains open. Add another AS-Interface slave device, or click the Close button to close the dialog box. Result: The node of your controller now contains the AS-Interface slave device as a new sub node of TWDNOI10M3 (TWDNOI10M3) ASi_Master (ASi Master) in the Devices window. To configure your AS-Interface slave device, double-click its entry in the Devices window. Configure your AS-Interface slave device in the editor on the right-hand side.

For further information on configuring AS-Interface slave modules, refer to the CoDeSys part of the online help.

160

EIO0000000067 04/2012

Program

6.6

SoMachine Commands Simplifying Programming

Whats in this Section? This section contains the following topics:

Topic Function and Function Block Finder Changing a Device Page 162 166

EIO0000000067 04/2012

161

Program

Function and Function Block Finder

Overview SoMachine provides the FFB (function and function block) finder that assists you in finding a specific function or function block even if you do not know its exact name. You can use the function and function block finder in the following programming languages that allow to insert function blocks: z CFC z LD z IL z FBD z ST How to Find a Function or Function Block with the FFB Finder When you are about to create programming code in the editor of the Program tab, go to the place where you want to insert the function block and open the FFB finder as follows: z select the menu Edit FFB Finder or z right-click at the respective place in the editor and select the command FFB Finder... from the context menu

162

EIO0000000067 04/2012

Program

The FFB Finder dialog box opens:

EIO0000000067 04/2012

163

Program

The FFB Finder dialog box contains the following elements for finding a function or function block:
Element Find what Description In the Find what textbox enter the name of the function or function block you want to insert into your programming code. As wildcards you can use a question mark (?), which replaces exactly one character, or an asterisk (*), which can replace several characters or no character at all. If you know the company that created the library which includes the function block you are searching for, you can select the following companies from the Company list: z 3S - Smart Software Solutions GmbH z CAA Technical Workgroup z Schneider Electric z System This parameter is by default set to All companies. Match case Include comments in search Check the Match case check box to perform a case sensitive search. By default, this check box is not selected. Check the Include comments in search check box to search for the entered string not only in the names of functions and function blocks but also in the comments that are saved with them. By default, this check box is not selected. Check the Search in project libraries only check box to limit the search to those libraries that are used in the current application. By default, this check box is not selected and the find operation includes all libraries that are installed on the SoMachine PC. Click the Find button or press the ENTER key to start searching for the function or function block.

Company

Search in project Libraries only

Find

Results Returned by the FFB Finder Any function or function block that matches the entered search criteria will be listed in the Results list with the Name of the function or function block as well as the Library it is saved in, its Version, and the Company that created it. A comment, if available, will be displayed in the column on the right side. The column Loaded on the left side indicates whether the library, the function or function block is saved in, is already used in the current project. To display further information on one of the functions or function blocks, select it from the list. In the field below, a graphic of the function / function block with its inputs and outputs will be displayed, as well as a description or any further information, if available.

164

EIO0000000067 04/2012

Program

Integrating a Function / Function Block into the Programming Code To integrate a function / function block that was found by the FFB Finder in your programming code, select it in the Results list, and z either double-click the selected entry in the Results list, z or click the OK button. The selected function / function block will be inserted at the place where your cursor is positioned in your programming code and the respective library will be loaded automatically. Repeat this operation whenever you need assistance in finding a specific function / function block.

EIO0000000067 04/2012

165

Program

Changing a Device
Overview SoMachine 3.0 and later versions allow you to change a device that is configured in your project to a different, but compatible device of the same controller family. SoMachine automatically converts the currently configured device into the selected device and displays the changes that are made in the Messages pane. The Change Device command may automatically add or remove modules. These hardware changes also have influences on the addressing and the libraries. To help to avoid unintended behavior after a device was changed, take the following precautions: z Make sure that the new device supports all functions and communication ports that are required in your project. z Try to avoid using direct addresses in your application. z Perform a backup of the project to the hard disk of the PC before changing a device.

WARNING
UNINTENDED EQUIPMENT OPERATION
z z

Validate that any direct addresses used in your application (for example, %IB5) have been converted correctly after changing the device. After you have changed the device, verify that the modified project still contains the intended configurations and provides the intended functions.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

CAUTION
LOSS OF DATA
z z

Perform a backup of the project to the hard disk of the PC before changing a device. If you change an S-Type controller into a G-Type controller, the corresponding solution libraries are removed from the controller.

Failure to follow these instructions can result in injury or equipment damage.

166

EIO0000000067 04/2012

Program

Changing a Device To change a device to a compatible device, proceed as follows:

Step 1 2 3 Action Perform a backup of the project to the hard disk of the PC by executing the File Save Project As... command before changing a device. Right-click the device you want to change in the graphical editor of the Configuration tab or in the Devices pane of the Program tab. Select the Change Device command from the context menu. Result: The Change Device dialog box is displayed. It lists those devices that are compatible to the device you selected and provides further information on the selected device:

EIO0000000067 04/2012

167

Program

Step 4 5 6

Action Select the device from the list in which you want to convert your currently configured device. Click the Change Device button. Result: A message box is displayed, notifying you of potential data loss (see safety message above). If you want to continue, click OK. If you have not yet performed a backup of your project, click Cancel to stop without changes and perform a backup before you start the procedure once again. Result after clicking OK: The currently configured device is converted into the device you selected from the list. The information you entered is conserved if the related modules are still available. Any modifications are listed in the Messages pane. Check whether the changed project still contains the intended configurations and provides the intended functions. If this is not the case, adapt the configuration or restore the backup of the unchanged project file.

Special Case: Changing an HMI Device to Another HMI Device with Higher Screen Resolution Just like the other devices you can also change an HMI device to another HMI device of the same family. In this case the Change Device dialog box includes an additional option for HMI devices that allows automatic adaptation to a higher screen resolution.

168

EIO0000000067 04/2012

Program

Change Device dialog box for HMI devices

If the new HMI device has a bigger screen and thus a higher screen resolution, the option Adapt to increased screen resolution is by default enabled. It automatically adapts the contents of the HMI panels and the popup windows as well as the fonts of the HMI panels to the increased screen resolution of the new HMI device. NOTE: This process cannot be undone automatically. You must verify and, if necessary, manually adapt the contents of the panels after the conversion.
EIO0000000067 04/2012

169

Program

6.7

SoMachine Commands

Whats in this Section? This section contains the following topics:

Topic SoMachine Commands Providing Single Access to Your Machine Description of the Build All Command Description of the Create Boot Application Command Description of the USB Mass Storage Command Description of the Remote Connection Command Description of the Import / Export Vijeo-Designer Project Commands Page 171 172 173 174 176 181

170

EIO0000000067 04/2012

Program

SoMachine Commands Providing Single Access to Your Machine

Overview The following specific SoMachine commands provide the possibility to manage the controller as well as the HMI applications of a SoMachine project by a single mouse click.
Command Export Vijeo-Designer project Import Vijeo-Designer project USB Mass Storage Menu File File Project Action Extracts the Vijeo-Designer project from the SoMachine project. Imports a separate Vijeo-Designer project into the SoMachine project. The USB Mass Storage command allows you to save the file system image together with a file management script on a USB mass storage device. The Build all command performs the compilation of all the project applications (controller and HMI). The Create boot application command allows you to create a controller application that is automatically started after it has been downloaded from the SoMachine PC to the controller. The Remote connection command allows you to establish a remote connection between SoMachine 3.1 and a controller via Ethernet. The Multiple Download command launches the transfer of the applications to selected physical targets (controller and HMI). The Save Data to File command allows you to save data from an application of the controller to the PC running SoMachine to be able to restore data later with the Restore Data from File command.

Build all

Build

Create boot application

Online

Remote connection

Online

Multiple Download

Online

Save Data to File / Restore Data Online from File

NOTE: See the Programming Guide for your controller for important safety-related information concerning SoMachine commands.

EIO0000000067 04/2012

171

Program

Description of the Build All Command

Overview The Build all command performs 2 operations: It compiles those controller applications that are located under the item PLC Logic in the Devices tree. z It builds all HMI target applications.
z

Procedure Execute the Build all command as follows:

Step 1 Action From the Build menu select the command Build all. Result: The applications are compiled and the HMI target applications are built. This is indicated in the Messages window of SoMachine. In the Messages window of SoMachine select Build from the list in the upper left side of the window to see the results of the individual compile processes. To display a summary of the messages that occurred during the execution of the Build all command, select Vijeo-Designer from the list in the upper left side of the window. To verify the messages you can start Vijeo-Designer directly by double-clicking the Vijeo-Designer message in the Messages window.

2 3

172

EIO0000000067 04/2012

Program

Description of the Create Boot Application Command

Overview The Create boot application command in the Online menu allows you to create a controller application that is automatically started after it has been downloaded from the SoMachine PC to the controller. NOTE: This function is restricted to controller applications. HMI applications do not support this feature. Procedure To create a boot application for your application, proceed as follows:
Step 1 2 Action In the Devices view select the Application node of the application you want to create a boot application for. From the Online menu select the command Create boot application. Result: SoMachine will automatically build the application. If errors are detected during the build process, they will be issued in the Messages pane. If the build process is executed successfully, a Save as dialog box will be displayed. In the Save as dialog box navigate to the folder where you want to save the boot application and click the Save button. Result: A message box will be displayed asking you whether you want to overwrite the reference context of the last download. Click Yes and the following files will be saved to the specified folder:
z Myapplication.App z Myapplication.crc

EIO0000000067 04/2012

173

Program

Description of the USB Mass Storage Command

Overview The USB Mass Storage... command in the Project menu allows you to save the file system image together with a file management script on a USB mass storage device. This function is only available for M258 Logic Controllers. Saving SoMachine Data on a USB Mass Storage Device To save your SoMachine project to a USB Mass Storage device, proceed as follows:
Step 1 2 Action Plug the USB mass storage device into a USB port of your PC running SoMachine. From the Project menu select the command USB Mass Storage.... Result: SoMachine will automatically build the application. If errors are detected during the build process, an error detection message will be issued and the process will be cancelled. If the build process is executed successfully, the USB Mass Storage dialog box will be displayed.

3 4 5 6 7

In the USB Mass Storage dialog box click the plus sign to create a new row for a new command. Select the commands for the script that will be executed on the controller from the Command list box or select already available macros from the Macros list. Select the source for the commands from the Source list box or click the ... button to navigate to the folder that contains the source. To change the Destination subfolder on the USB mass storage device, open the Destination list and select the suitable folder. To create the script, click the Generate button at the bottom or the gearwheel icon from the toolbar at the top of the dialog box. Result: A Browse For Folder dialog box opens. Browse to the root directory of your USB mass storage device (do not open a subfolder) and click Open. Result: The SoMachine project and the file management script are saved to the USB mass storage device.

174

EIO0000000067 04/2012

Program

Installing the SoMachine Project on a Controller To install the SoMachine project on a controller, merely plug the USB mass storage device into a USB port of the controller. The script on the USB device will be executed automatically which is indicated by the LEDs of the controller as follows:
Action Performed LED Indication Comment The red LED is on until the communication to the USB mass storage has been established. Do not remove the USB mass storage device while the script file is executing. You can remove the USB mass storage device. See the log file on the USB mass storage device for reasons why the script file could not be executed successfully.

USB mass storage device red LED is on is plugged into the controller. Script file is executed. Script file execution has been completed successfully. green LED is flashing green LED is on

The script file could not be red LED is on executed successfully.

Log File A log file is automatically saved in the folder of the script file. It records every execution of the script file with header information (date, time, and machine information) and the result (successful, or not successful like: source file not available, incorrect destination, incorrect command, destination full). Any new information is added to the file, information will not be overwritten.

EIO0000000067 04/2012

175

Program

Description of the Remote Connection Command

Overview The Remote connection command in the Online menu opens the Remote connection dialog box that provides a way to establish a connection between SoMachine 3.1 and a controller via Ethernet. The Remote connection command is a powerful feature of SoMachine. It allows you not only to remotely monitor a controller and its application, but also to upload and download applications, perform various maintenance activities, and change the state of the controller. Strict care must be taken to be sure that the immediate physical environment of the machine and process is in a state that will not present safety risks to people or property before exercising control remotely. For more detailed information of the availability, operation and functionality of this feature, along with important safety and security information, see the programming and hardware guides for your specific controller platform.

WARNING
UNINTENDED EQUIPMENT OPERATION
z

z z z

Configure and install the RUN/STOP input for the application, if available for your particular controller, so that local control over the starting or stopping of the controller can be maintained regardless of the remote commands sent to the controller. Be sure to define a secure password for the Remote connection command, and do not allow unauthorized or unqualified personnel to use this feature. Be sure that there is a local, competent observer present when operating on the controller from a remotely. Be sure that there is a local backup of the application to restore the application in the case that, for whatever reason, an application download is unsuccessful or communication to the controller is lost. You must have a complete understanding of the application before attempting to adjust data, download an application, stopping an application that is operating, or starting the controller remotely. Take the precautions necessary to assure that you are operating on the intended controller by having clear, identifying documentation within the controller application and its remote connection.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

176

EIO0000000067 04/2012

Program

NOTE: The Remote connection command must only be used by authorized and qualified personnel. A qualified person is one who has the skills and knowledge related to the construction and operation of machine and the process controlled by the application and its installation, and has received safety training to recognize and avoid the hazards involved. No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this feature. Functional Description After you have created some remote connections, the discovery frames of the Scan Network operation are not only sent on the local subnet, but also on the remote connections you created. The remote connections are regular TCP/IP connections that are established to remote port 1105 (default port) of the controller. If you execute a Scan Network command without creating a remote connection beforehand, only those controllers will be detected that are located on the local network or on the USB port. To access a remote controller that is located on another IP subnet, you must know its IP address. You can then create a remote connection between SoMachine and this controller. After you have established this connection, the Scan Network operation will automatically detect this controller and other controllers that are locally connected to it, if any. You can create several remote connections to the same IP address. This may be useful in specific configurations. This function provides access to controllers via Ethernet in the following cases: z the SoMachine PC and the controller are located in separate subnets z the SoMachine PC and the controller are located in separate domains linked by the internet z the controller is located in a subnet behind an ADSL connection NOTE: The remote connection will only be established successfully if TCP/IP data traffic to port 1105 is not blocked by any firewall.

EIO0000000067 04/2012

177

Program

Network Scenarios Allowing to Access Remote Controllers The following network scenarios allow access to remote controllers by using the Remote connection command. Scenario 1: SoMachine PC and remote controller are located in separate subnets:

Scenario 2: SoMachine PC and remote controller are located in separate domains that are linked by the internet:

178

EIO0000000067 04/2012

Program

Scenario 3: SoMachine PC and remote controller are located in separate subnets behind an ADSL connection:

Specifying Controllers for Remote Connection To specify controllers located in other TCP/IP subnets than the SoMachine PC, proceed as follows:
Step 1 2 Action Open the Remote connection... dialog box from the Online Remote connection... menu. Comment The default destination port number is 1105. To access the remote controller on a different port, enter the port number after the IP number, separated by a colon according to the following syntax: a.b.c.d:<port number> for example: 111.111.111.111:1106 NOTE: It can be useful to specify the port number when you are trying to access different controllers located behind a router with a NAT (network access table).

In the Remote IP address text field enter the correct IP address of the controller you want to establish a remote connection to.
EIO0000000067 04/2012

179

Program

Step 3

Action Click the Add connection button. Result: The new connection will be listed in the list box below with the connection number because you can establish more than one remote connection to the same controller node.

Comment

Whenever a Scan network command is executed, SoMachine will search not only for locally attached controllers but also for those remote controllers that are listed in the Remote connection list, and the controllers behind them. Removing Connections / Controllers from the Remote Connection list To decrease the number of opened connections to a controller by one, select the respective line of the relevant controller in the Remote connection list, and click the Release Connection button. If the number of opened connections for a controller is 0, the line of this controller will be removed from the list.

180

EIO0000000067 04/2012

Program

Description of the Import / Export Vijeo-Designer Project Commands

Overview The Import Vijeo-Designer project command allows you to import an already existing Vijeo-Designer project into an existing SoMachine project. The Export Vijeo-Designer project command allows you to export the VijeoDesigner project (that is the HMI applications) from an existing SoMachine project. NOTE: The imported Vijeo-Designer project will replace the existing HMI applications of the SoMachine project, if any exist. Importing a Vijeo-Designer Project into SoMachine To import an already existing Vijeo-Designer project into an existing SoMachine project, proceed as follows:
Step 1 Action In SoMachine open the File menu and select the Import Vijeo-Designer project... command. Result: A browse dialog box will be displayed. Browse to the folder that includes the Vijeo-Designer project you want to import, select the VDZ file and click Open. Result: The selected Vijeo-Designer project is merged with the already existing SoMachine project.

Exporting a Vijeo-Designer Project from SoMachine To export the Vijeo-Designer project from an existing SoMachine project in order to create a single VDZ file, proceed as follows:
Step 1 Action In SoMachine open the File menu and select the Export Vijeo-Designer project... command. Result: A browse dialog box will be displayed. Browse to the folder where you want to save the exported VDZ file and click Save. Result: The extracted Vijeo-Designer project is saved as VDZ file and can be opened with Vijeo-Designer.

EIO0000000067 04/2012

181

Program

6.8

SoMachine Controller-HMI Data Exchange

Whats in this Section? This section contains the following topics:

Topic SoMachine Single Variable Definition Publishing Variables in the Controller Part Selecting Variables in the HMI Part Publishing Variables in the HMI Part Parametrization of the Physical Media Page 183 187 188 189 191

182

EIO0000000067 04/2012

Program

SoMachine Single Variable Definition

Overview Sharing variables between a controller and the HMI is very simple in SoMachine. By publishing the variable(s) in SoMachine they will automatically be available for use in the Vijeo-Designer HMI application. For variable exchange with the SoMachine protocol, perform the following steps: z Create variables in the controller part. z Publish the variables by defining them as Symbols in the controller part. They are now available in the HMI part as SoMachine variables. z Configure the physical connection (automatically setup by SoMachine). NOTE: The last step is not necessary for XBTGC controllers because they may communicate with their own control variables. Disabling Automatic Symbol Export to Vijeo-Designer By default, SoMachine automatically exports those variables defined as Symbols to the Vijeo-Designer HMI application. Once symbols have been transferred to Vijeo-Designer, it is usually not necessary to make the transfer every time you call Vijeo-Designer. If you later add or modify symbols in your SoMachine application after having initially transferred the symbols, you can transfer symbols to Vijeo-Designer manually at will. To save time when you open Vijeo-Designer, you can disable the automatic transfer of symbols as follows:
Step 1 Action In the general functions menu (see page 26) select Preferences and click the Options button. Result: The Options dialog box will be displayed. Select the entry Vijeo-Designer from the list on the left-hand side.

EIO0000000067 04/2012

183

Program

Step 3

Action On the right-hand side, enable the check box Disable automatic symbol export.

Click OK to close the dialog box.

NOTE: Activating the Disable automatic symbol export function inhibits the automatic export of SoMachine variables defined as Symbols to Vijeo-Designer. In order to perform this transfer manually, right-click the Symbol configuration node in the Devices window and execute the Export Symbols to Vijeo-Designer command. If you do not perform this manual transfer, Vijeo-Designer may not show the correct symbols which, in turn, may lead to errors in the project.

184

EIO0000000067 04/2012

Program

WARNING
UNINTENDED EQUIPMENT OPERATION Before you start working in Vijeo-Designer and if you have activated the Disable automatic symbol export, execute the Export Symbols to Vijeo-Designer command. Failure to follow these instructions can result in death, serious injury, or equipment damage. Variable Types for SoMachine - HMI Data Exchange The following table lists the variable types for SoMachine - HMI data exchange:
Variable Type in SoMachine Variable Type in VijeoDesigner BOOL BYTE WORD DWORD SINT INT DINT USINT UINT UDINT REAL STRING WSTRING BOOL Integer UINT UDINT Integer INT DINT Integer UINT UDINT REAL STRING STRING Comment ------------WSTRING is supported in Vijeo-Designer as a general STRING type. This means that you can either exchange only STRINGS or only WSTRINGS with the HMI. A mixture of these 2 variable types is not allowed. If you use WSTRINGs, all your strings must be WSTRINGs. Indicate to the Vijeo-Designer driver that all strings should be managed as UNICODE WSTRINGs as follows: Select the node SoMachineNetwork or SoMachineCombo in the Navigator tree of VijeoDesigner and set the parameter String Encoding to the value Unicode.

EIO0000000067 04/2012

185

Program

Variable Type in SoMachine Variable Type in VijeoDesigner Array

Comment In Vijeo-Designer you can only reference the elements of an array, not the whole array. Example: Your array consists of SINTs called myValues. In Vijeo-Designer you can reference myValues[0] or myValues[5] and put this into a variable on the HMI controller. Arrays must not contain more than 2,048 elements. If you try to use arrays with more than 2,048 elements in Vijeo-Designer, an error message will be issued. In Vijeo-Designer you can only reference the elements of a DUT, not the whole DUT. This behavior is similar to the behavior of arrays.

DUT

Unsupported Variable Types The following variable types are not supported for SoMachine - HMI data exchange: all 64-bit integer formats z LREAL z all time and date formats z non-zero based arrays: You cannot import an array that is defined like myArray[1..100].
z

For further information on variable types for SoMachine - HMI data exchange see the Vijeo-Designer online help. Identifier Length In Vijeo-Designer the maximum length of the Symbol name is limited to 32 characters.

186

EIO0000000067 04/2012

Program

Publishing Variables in the Controller Part

Procedure Publish variables in the controller part of the SoMachine application within the Symbol configuration editor and define specific access rights (read/write, read, write):
Step 1 2 Action Create a Symbol Configuration item under the Application node in the Devices window as described in the Adding a Symbol Configuration chapter (see page 102). In the Symbol configuration editor select those elementary variables that you wish to publish for communication with 1 or several HMI terminal(s):

The left part of the editor window shows the variables that are currently available in the application. To see all variables, open the subitems by clicking the plus signs. To provide variables to HMI terminals, select individual variables or even complete nodes in the list on the left-hand side and click the arrow button in the middle to copy them to the right side, that is to provide them to HMI terminals. You can also assign read/write access rights to each variable individually in the Access Rights column. Note: Only variables on elementary data types are available for interchange with HMI terminals. 3 For your settings to become valid click the Download link in the Symbol configuration editor.

NOTE: The publishing mechanism consumes an overhead of about 50 kbyte in the controller. Each published variable consumes 11 bytes within the controller application.

EIO0000000067 04/2012

187

Program

Selecting Variables in the HMI Part

Selecting Variables Those variables that have been published in the controller part are directly available in the HMI part. In the Expression Editor Pad of Vijeo-Designer select the SoMachine tab to have direct access to the variables published in SoMachine.

For further information refer to the Vijeo-Designer online help.

188

EIO0000000067 04/2012

Program

Publishing Variables in the HMI Part

Supported Variable Types The following variable types can be published in Vijeo-Designer to make them available for the entire SoMachine project: z BOOL z DINT z INT z UINT z UDINT z Integer z REAL z STRING Procedure To publish the above mentioned variable types proceed as follows:
Step 1 2 Action In the Vijeo-Designer Variable Editor select those variables you want to publish. Right-click the selected variable(s) and execute the command Move to SoMachine from the context menu.

Result: The Move to SoMachine dialog box will be displayed. 3 In the Move to SoMachine dialog box open the subfolders of the devices defined in SoMachine to see the levels where variables are defined (POU or GVL).

EIO0000000067 04/2012

189

Program

Step 4

Action Select the POU or GVL to which you want to add the selected Vijeo-Designer variable(s) and click OK.

Result: The selected variable(s) has / have been moved to the selected SoMachine POU or GVL and is / are available throughout the SoMachine project.

190

EIO0000000067 04/2012

Program

Parametrization of the Physical Media

Overview The runtime data exchange between the controller and the HMI is executed on different media, depending on the selected hardware. Configuration Example The default settings below are valid for communications between M238 and an HMI panel via serial line RS485 using an XBTZ9008 cable (serial line SubD-RJ45). Configuration of M238 with HMI panel: M238 controller serial line configuration
Parameter Physical Medium Baud rate Parity Data bits Stop bits Value RS485 115200 none 8 1

HMI panel IO-Manager configuration using a driver: SoMachine - network with at least 1 Scan-Group (for further information refer to the Vijeo-Designer online help).
Parameter Physical Medium Baud rate Parity Data bits Stop bits Equipment Name Value RS485 115200 none 8 1 controller device name (available in the communication settings dialog)

Configuration of XBTGC:
Device XBTGC controller HMI panel Driver Configuration no configuration required IO-Manager SoMachine - Combo with at least 1 Scan-Group

EIO0000000067 04/2012

191

Program

6.9

SoMachine Templates

Whats in this Section? This section contains the following topics:

Topic General Information about SoMachine Templates Supported Fieldbusses Selecting SoMachine Templates for Your Project Administration of SoMachine Templates Page 193 195 196 198

192

EIO0000000067 04/2012

Program

General Information about SoMachine Templates

Overview SoMachine provides templates in order to make dedicated control and visualization functionality that has been developed in one SoMachine project easily available to other SoMachine projects. They help to standardize the usage of field devices and applications throughout different SoMachine projects. The following types of templates are available: z device templates that are associated with a single field device z function templates that are associated with a high-level application function SoMachine provides various templates, but you can also create your own templates for any functionality you want to make available to other projects. Using Already Installed SoMachine Templates To use those templates that are provided by SoMachine, you merely have to make them available for your project as described in the chapter Selecting SoMachine Templates for Your Project (see page 196). Creating Your Own Templates The following steps are required for all SoMachine templates:
Step 1 2 3 Action Create your functionality within a SoMachine project and test it with the appropriate hardware or in the simulation. Save the functionality in a template library. Open another SoMachine project and select the template from the template library in order to make the functionality available to this project.

EIO0000000067 04/2012

193

Program

General Notes When using SoMachine templates, note the following: Templates are not controller-specific and can therefore be made available for any controller. Make sure that the controller to which you add the template is capable of executing the functionality contained in the template. z After the template has been installed, you can freely adapt the created objects to your individual requirements. z The templates function does not support Vijeo-Designer applications; HMI applications are not included in the SoMachine templates. z It is possible to install one template several times on the same controller device. In order to avoid naming conflicts when creating the same objects several times, they are renamed automatically during installation. For further information refer to the Naming of Objects section of the Adding Devices from Template chapter (see page 207). z User-defined data types (DUT) or function blocks must be defined in a function block library if they should be used in templates. z Templates do not support the use of direct representations of variables (for example %IX2.0) in templates. But you can, on the other hand, use direct representations with an incomplete address specification (for example %I*) in a template. For further information refer to the Variables configuration - VAR_CONFIG section of the CoDeSys online help.
z

NOTE: Although this form of placeholder for direct addresses is available, it is highly advised to avoid direct addressing in your programs, and to use symbolic addressing wherever and whenever possible.

194

EIO0000000067 04/2012

Program

Supported Fieldbusses
List of Supported Fieldbusses SoMachine templates can include definitions of field devices. Those devices that are linked to the following fieldbusses can be included in SoMachine templates:
Fieldbus CANopen Fieldbus Configuration Information
z z z z

CANopen slave: definition of send PDOs and receive PDOs COB-IDs assigned to the PDOs sequence of SDOs for slave initialization further DTM-specific data, if applicable

Modbus Serial Line (Modbus IOScanner)

Modbus serial slave: z definition of slave channels for defining data being cyclically exchanged between controller and slave device z sequence of Modbus write services for initialization (configuration) of the Modbus slave device EtherNet/IP slave:
z definition of connections that define data being cyclically exchanged

EtherNet/IP

between controller and slave device

z sequence of user parameters for initialization (configuration) of the

EtherNet/IP slave SoftMotion General Drive Pool (LMC058) unassigned SoftMotion devices: z SoftMotion basics like information on axis type and limits z the conversion between the position values received from the device and the units being used in the IEC program (scaling) z parameters related to the position control loop AS-Interface slave: z slave configuration CANmotion slave: z definition of send PDOs and receive PDOs z COB-IDs assigned to the PDOs z sequence of SDOs for slave initialization z SoftMotion basics like information on axis type and limits z the conversion between the position values received from the device and the units being used in the IEC program (scaling) z parameters related to the position control loop

AS-Interface CANmotion

EIO0000000067 04/2012

195

Program

Selecting SoMachine Templates for Your Project

Overview SoMachine templates are stored in template libraries. Each template library contains the definition for several device or function templates that have a common base (for example are all related to motor control). The following paragraphs describe the process of selecting those template libraries that should be available in your project. Procedure To select the SoMachine templates that should be available for a specific project, proceed as follows:
Step 1 2 Action From the Project menu select the command Project Settings. Result: The Project Settings dialog box will be displayed. In the Project Settings dialog box select the option Template Libraries from the list on the left-hand side. Result: The Template Libraries view will be displayed on the right-hand side:

196

EIO0000000067 04/2012

Program

Step 3

Action The Template Libraries view provides the following options: z You can either activate all available template libraries for your project by activating the checkbox Use All Installed Template Libraries. This is the default setting for any new projects. z Or you can select specific template libraries, that is the device or function templates they include, from the Selected Template Libraries list. NOTE: With the latter option it is neither possible to save new device or function templates into those template libraries that are not selected nor to use device templates or function templates from not selected template libraries for creating new field devices. Click OK to activate the selected template libraries for your project.

EIO0000000067 04/2012

197

Program

Administration of SoMachine Templates

Overview The following paragraphs provide an overview of how to create new or change existing device or function templates and to save them as file for transferring them to other PCs. Template Libraries Template libraries contain the definition of several device or function templates. Write Protection The following template libraries are write-protected, which means that they cannot be deleted or renamed: z the standard template libraries that are included in the SoMachine scope of delivery z template libraries that are installed in the Template Repository NOTE: You cannot change write-protected libraries (uninstalling individual templates or changing names), but you can completely uninstall them.

198

EIO0000000067 04/2012

Program

Template Administration For administration of the available device and function templates in SoMachine, select Tools Template Repository. The Template Repository dialog box opens:

The path to the directory where the template libraries are stored is displayed below the Location field. The Installed Templates box lists the installed templates in 2 groups: Device Templates and Function Templates. Each template library can either contain device templates or function templates.

EIO0000000067 04/2012

199

Program

Installing Additional Template Libraries To add additional template libraries to this list, proceed as follows:
Step 1 2 3 Action Click the Install button in the Template Repository dialog box. Result: A File open dialog box opens. Browse to the folder where the template library file you want to install is saved. Select the library file you want to install and click OK. Result: The selected template library will be installed and will be indicated in the Template Repository dialog box, including the device or function templates it contains.

Removing Template Libraries (Device or Function Templates) To remove a template library (device or a function template), proceed as follows:
Step 1 2 Action In the Installed Templates list of the Template Repository dialog box, select the template library (device or function template) you want to remove. To remove the selected template library (device or function template), click the Uninstall button. Result: The selected template library (device or function template) will be removed from the installation.

Renaming Template Libraries (Device or Function Templates) To rename a template library (device or function template), proceed as follows:
Step 1 2 3 Action In the Installed Templates list of the Template Repository dialog box, select the template library (device or function template) you want to rename. Click on the name you want to change. Result: A text box opens. Enter the new name in the text box and press Enter or leave the text box. Result: The template library (device or function template) is now assigned the new name.

200

EIO0000000067 04/2012

Program

Creating a new Template Library To create a new template library, proceed as follows:
Step 1 Action To create a new template library for device templates, select the Device Templates node in the Installed Templates list and click the Create Library button of the Template Repository dialog box. Result: A new template library with a default name is added at the bottom of the Device Templates section of the Installed Templates list. To create a new template library for function templates, select the Function Templates node in the Installed Templates list and click the Create Library button of the Template Repository dialog box. Result: A new template library with a default name is added at the bottom of the Function Templates section of the Installed Templates list. Rename the new template library as stated above and fill it with device or function templates by using for example the copy and paste operations described below.

Saving Template Libraries as File The template libraries that contain device or function templates are SoMachinespecific XML files. To provide them for use on other PCs, proceed as follows:
Step 1 2 3 4 Action Select the template library you want to export in the Installed Templates list. Click the Save As File... button. In the Save File dialog box navigate to the folder where you want to save the template library file. Transfer the template library file to the other PC and install it by using the Template Repository.

EIO0000000067 04/2012

201

Program

Copy and Paste Operations for Template Libraries The Template Repository dialog box also supports the copy and paste operation for template libraries. To copy a template library with the device or function template it contains, select the respective item in the Installed Templates list and click the Copy button. Now click the Paste button to insert a copy of this template library with a default name in the Installed Templates list. This new template library will automatically be inserted below the correct node. This means that template libraries that include device templates will automatically be inserted below the Device Templates node while template libraries including function templates will automatically be inserted below the Function Templates node. Replace the default name by a name of your choice. Copy and Paste Operations for Templates The Template Repository dialog box supports the copy and paste operation for device or function templates. To copy a device or function template, select the respective item from below a template librarys node in the Installed Templates list and click the Copy button. You can now paste a device template underneath a template library below the Device Templates node. A library can only be pasted into a library of the same kind. Replace the default name by a name of your choice. Adding Further Information for Templates or Template Libraries The Template Repository dialog box enables you to enter further information for templates or template libraries. To add further information, select a library or template library in the Installed Templates list and click the Properties button.

202

EIO0000000067 04/2012

Program

The Properties dialog box for the selected library or template library will be displayed.

The Properties dialog box contains the following parameters you can edit:
Parameter Template Name / Library Name Description This text box indicates the name of the library or template library these properties apply to. To change the name, click in this text box and adapt the name according to your requirements. Enter a short text (for example to provide an overview of the contents and purpose of the selected library or template library) because this text will be indicated as tool tip when you select template libraries in SoMachine. Enter a long text (for example to provide a detailed description of the contents and purpose of the selected library or template library.

Comment

Description

The parameters Device Type and Fieldbus Type are only available for device templates. They indicate the device and the fieldbus type and cannot be edited. The checkbox Read-Only is only available for template libraries to indicate whether the selected template library is in read-only status. It is not possible to change the status of the template library here.

EIO0000000067 04/2012

203

Program

6.10

Managing Device Templates

Whats in this Section? This section contains the following topics:

Topic Facts of Device Templates Adding Devices from Template Creating a Device Template on the Basis of Field Devices Visualizations Suitable for Creating Device Templates Further Information on Integrating Control Logic into Device Templates Steps to Create a Device Template Page 205 206 208 209 210 213

204

EIO0000000067 04/2012

Program

Facts of Device Templates

Content of Device Templates Device templates are related to a specific field device. They contain the following information: z fieldbus configuration z control logic (controller programming) (optional) z visualization elements (visualization programming) (optional) Using Device Templates Already available device templates are saved in template libraries. Each template library contains the definition for several device templates that have a common base (are related to motor control, for example). You can easily select them and adapt them to the requirements of your individual SoMachine projects in order to create new preconfigured and ready to use field devices. Creating New Device Templates To make your already configured field devices reusable for any SoMachine project, you can save them as device templates. This also includes the controller programming and visualization linked to this field device.

EIO0000000067 04/2012

205

Program

Adding Devices from Template

Overview Device templates are always related to a specific fieldbus device. They contain the following information: z fieldbus device configuration z control logic (controller programming) (optional) z visualization elements (visualization programming) (optional) The device templates you want to use must be available and enabled in the Template Repository of SoMachine. For details refer to the Administration of SoMachine Templates chapter (see page 198). You can create your own device templates from your project. For details refer to the Steps to Create a Device Template chapter (see page 213). Add Device from Template Create a device using a device template as follows:
Step 1 Action In the Devices window right-click the field device manager and select Add Device from Template from the context menu. Result: The Add Device From Template dialog box will be displayed:

In the Add Device From Template dialog box select the Device Template to be used, and set the Device Name as well as the Device Address if the fieldbus requires numerical addresses. In case the device templates includes control logic, select the program (POU) in which the control logic will be inserted. Click the OK button. Result: The device will be created and parametrized according to the selected device template including the optional visualization screen(s) and control logic.

NOTE: The undo / redo function is not available for the process of creating field devices.
206
EIO0000000067 04/2012

Program

Naming of Objects In order to avoid naming conflicts if the same device template is used as a basis for creating different field devices, the following naming conventions are applied to the field devices and the associated objects (FB, visualization and variables):
If the name of the original object... Case 1: contains the name of the original field device Example: the device template for the field device ATV1 contains a variable Var_ATV1_Input for a new device Axis1 being created with this device template, the new variable is correspondingly named Var_Axis1_Input. the name of the new device plus an underscore are inserted in the original name to form a unique new name. for a new device Axis1 being created with this device template, the new variable is correspondingly named Axis1_Var_Input1. this part of the object is replaced by the name of the new field device that is created. Then ...

Case 2: does not contain the name of the original device Example: the device template for the field device ATV1 contains a variable Var_Input1

EIO0000000067 04/2012

207

Program

Creating a Device Template on the Basis of Field Devices

Overview The following paragraphs list the criteria that must be fulfilled in order to save a field device, including logic and visualization, as device template z the information that is saved in the device template
z

Prerequisites for Devices The field devices must meet the following criteria in order to be saved as device templates: z field devices must be linked to the fieldbusses listed in the Supported Fieldbusses chapter (see page 195). z The device type must be installed in the Device Repository. Prerequisites for the Application You can only create templates from correct applications, which means that no errors are detected during the Build process. Prerequisites for Including Control Logic into a Template In order to include control logic into a template, it is required that the control logic contains one or more code sections that exchange data with this field device. This control logic must be executed (added to a task or called by another program). Otherwise, it will not be considered when executing the Build command. Device Information Saved in Device Templates The following information of field devices is saved in device templates: z fieldbus configuration z I/O mapping of the field device z visualizations that are suitable for the field device z control logic exchanging data with the field device

208

EIO0000000067 04/2012

Program

Visualizations Suitable for Creating Device Templates

Overview Each device template can be associated with 1 or more CoDeSys visualizations. The supported types of visualizations are described as follows. Supported Visualizations SoMachine supports both types of visualizations: z plain visualizations z modular visualizations using frames Visualizations using frames are recommended due to their flexibility and modularity. Plain Visualizations Visualizations without frames are based on a single visualization object, created for the I/O device. SoMachine references the data of the I/O device within the properties of the visual elements. When you create a new device based on this device template, SoMachine directly replaces the variables in the properties of the visual elements. Visualizations Using Frames A visualization using frames is built from a main screen that can be embedded with other vizualisations, using a number of smaller visualizations to be combined like modules in predefined areas of the main screen (frames). In the main screen, a frame-object is placed like a rectangular object as the container. You can assign another vizualization to such a container. The embedded visualization can then be used with an interface to access visual elements internally. Please refer to the CoDeSys online help for further information of this concept. To use embedded visualizations for device templates, you must define an interface that includes definitions of all variables related to the connection to the I/O device or function block for each visualization module. When you create a new device based on this device template, SoMachine adapts all placeholders of the embedded visualizations according to the created I/O device name. NOTE: All the visualizations using frames and the function blocks linked to the specific I/O device must be defined in a library so that SoMachine can find them.

EIO0000000067 04/2012

209

Program

Further Information on Integrating Control Logic into Device Templates

Overview You can include control logic into a device template if the logic contains one or more code sections that exchange data with this field device in one of the following ways: A code section uses a new variable that is defined in the I/O mapping of the field device. z A code section and the I/O mapping of the field device use a common variable that is defined in a GVL or a controller program contained by the application to which the code section belongs. NOTE: If you use structures or arrays, make sure that they are only related to a single field device.
z z

A code section and the field device use a fix device-specific variable (for example the axis-ref variables used with the Altivar or Lexium drives).

Interconnected Calls of Code Sections Code sections consist of a sequence of interconnected calls of function blocks, functions, and operators. If one of the following relationships exists between the individual calls, they are considered as being connected: z a graphical connection exists between the individual calls in CFC, FBD and LD z a variable is connected to the output of the one call and the input of the other call z one call uses the parameter of the other call Individually Selecting Function Blocks You can individually select the function blocks that are included in those code sections that exchange data with the field device to be included in the device template This allows you to create different device templates providing different functions for the same field device. NOTE: The function block type must be defined in a library. Including Expressions into Device Templates The expressions, as well as the variables used in these expressions, that are connected to the parameters of a function block, function or operator are automatically saved in the device template.

210

EIO0000000067 04/2012

Program

General Recommendations for the Creation of Control Logic Only include simple control logic in a device template. This helps to ensure that the code sections work identically even if they are created in different IEC languages. NOTE: For complex control logic you should rather create a function template. Recommendations for the Creation of Control Logic in FBD / LD Avoid edge detection elements because they do not exist in other IEC languages. If possible, use R_TRIG or F_TRIG function blocks instead. Recommendations for the Creation of Control Logic in CFC Use the command Execution Order Order By Data Flow to order the CFC elements belonging to the same code section according to their position in the data flow. This provides a better compatibility with other IEC languages. Provide space (in horizontal direction) between the individual CFC elements, because due to renaming the names of variables will be extended when a new device is created from a template. Control Logic Example The following figure shows a typical example of a code section for an Advantys OTB Distributed I/O device in a conveying application:

EIO0000000067 04/2012

211

Program

The code section consists of the following function blocks:

Name InOTB_Conv20 Conv20 OutOTB_Conv20 Type input block control block output block Function converting data coming from the OTB into the format required by the control block processing data converting data coming from the control block into the format required by the OTB

The variables InByte1_Conv20, InByte2_Conv20 and OutByte_Conv20 are defined in the I/O mapping of the OTB. This means that the code section exchanges data with the OTB device. It can thus become part of the device template.

212

EIO0000000067 04/2012

Program

Steps to Create a Device Template

Overview The following paragraphs list the steps that have to be performed in order to save field devices meeting the criteria stated in Creating a Device Template on the Basis of Field Devices (see page 208). Steps for Saving a Field Device as Template To save an already existing field device as device template, proceed as follows:
Step 1 2 Action Right-click the field device you want to save as device template in the Devices view of SoMachine. Select the command Save As Template from the context menu. Result: SoMachine automatically builds the application. After the built process has been successfully completed, the Save as Template dialog box will be displayed. Define the new device template in the Save as Template dialog box as stated below. Click OK to close the Save as Template dialog box and to create your new device template.

3 4

EIO0000000067 04/2012

213

Program

The Save As Template Dialog Box The Save as Template dialog box contains the following parameters:

1 2 3 4 5 6

indicates the type of the field device on which the device template is based indicates the fieldbus type of the field device the name of the device template that will be created (initially the name of the original field device) select the template library the device template will be added to add further infomation to the device template select function blocks and visualizations that should be saved with the device template

214

EIO0000000067 04/2012

Program

Defining a Name for the New Device Template Use the text box Template Name to define a name for your device template. By default, this text box includes the name of the selected field device. You can either type the name of your choice directly into this text box, or you can click the ... button to select an existing device template from the lists if you want to overwrite this device template. Selecting the Template Library To select one of the previously installed or created template libraries in which the device template should be stored, proceed as follows:
Step 1 Action In the Save as Template dialog box click the ... button right to the Template Library text box. Result: The Select Template Library dialog box will be displayed. The Select Template Library dialog box displays all template libraries that have been installed for the current project or have been created. Write-protected template libraries are not displayed. To add the new device template to 1 of these template libraries, select the suitable entry and click OK.

Adding Further Information to the New Device Template The Save as Template dialog box enables you to enter further information for the device template. You can enter 2 different types of information: z In the Comment text box enter a short text (for example, to provide an overview of the contents and purpose of the device template) because this text will be indicated as tool tip when you select device templates in SoMachine. z In the Description text box enter a long text (for example, to provide a detailed description of the contents and purpose of the device template).

EIO0000000067 04/2012

215

Program

Selecting the Function Blocks To select the function block instances to be included into the device template, proceed as follows:
Step 1 Action In the Save as Template dialog box click the ... button to the right of the Function Blocks text box. Result: The Select Function Block dialog box will be displayed. The Select Function Block dialog box displays all function block instances contained by the control logic of the field device (see page 210). Select an individual function block and click the > button to select it for the device template, that is, to copy it to the Selected Items list on the right-hand side. Or click the >> button to select the entire list of function blocks for the device template, that is, to copy it to the Selected Items list on the right-hand side. Click the OK button.

Selecting the Visualizations To select the visualizations to be included into the field device, proceed as follows:
Step 1 Action In the Save as Template dialog box click the ... button to the right of the Visualizations text box. Result: The Select Visualizations dialog box will be displayed. The Select Visualizations dialog box displays those visualizations that are linked with the field device or with one of the selected function blocks. Select an individual visualization and click the > button to select it for the device template, that is, to copy it to the Selected Items list on the right-hand side. Or click the >> button to select the entire list of visualizations for the device template, that is, to copy it to the Selected Items list on the right-hand side. Click the OK button.

216

EIO0000000067 04/2012

Program

6.11

Managing Function Templates

Whats in this Section? This section contains the following topics:

Topic Facts of Function Templates Adding Functions From Template Application Functions as Basis for Function Templates Steps to Create a Function Template Page 218 219 222 224

EIO0000000067 04/2012

217

Program

Facts of Function Templates

Content of Function Templates Function templates represent dedicated control and visualization functionality that are associated with an application function. A function template may include the following elements: IEC program(s) z field device(s) that is / are being used by the application function z CoDeSys visualization(s) that is / are being used to visualize the application function z global variable list(s) z global variable(s) that may be shared with other application functions z traces z CAM tables
z

NOTE: HMI elements related to CoDeSys are not supported by this function. Using Function Templates Already available function templates are saved in template libraries. Each template library contains the definition for several function templates that have a common base (for example, all are related to packaging applications). You can easily select them and adapt them to the requirements of your individual SoMachine projects in order to create new ready to use application functions. Creating New Function Templates To make your already created application function reusable for any SoMachine project, you can save it as function template. When you save the function template you must decide in which template library it should be stored.

218

EIO0000000067 04/2012

Program

Adding Functions From Template

Procedure To add an application function from a function template to your project, proceed as follows:
Step 1 Action Right-click the Application node in the Devices view and select the command Add Function From Template from the context menu. Result: The Add Function From Template dialog box will be displayed. Enter a Function Name that will be used for the new folder of this application and for the naming of the elements it contains. Click the ... button and select a function template from the Select Function Template dialog box. If the function template contains field devices, the I/O Devices list contains the following information: z Device Name: This cell contains the name of the future field device. You cannot change this name. z Device Type: This cell indicates the type of the field device. You cannot edit this cell. z Fieldbus Type: This cell indicates the fieldbus type of the field device. You cannot edit this cell. z Master: This cell contains the fieldbus master to which the field device is connected. If there are several masters, you can select the master of your choice from the list. z Address: This cell is initially empty. For field devices on fieldbusses that require numerical addresses (Modbus serial line and CANopen) click the ... button right to the field and assign the address of your choice. Confirm your settings by clicking the OK button. Result: SoMachine verifies whether the settings are correct and inserts the new application function as separate folder in the Devices view or displays an error detection message.

2 3 4

Objects Created The function template creates the following objects in your project:
Object root folder field devices Description A new folder is created under the Application node in the Devices view that is named as defined in the Function Name text box. The field devices that are included in the function template are created using names that apply to the naming rules and are connected to the fieldbus master. The I/O mapping is automatically adjusted, if necessary.

EIO0000000067 04/2012

219

Program

Object visualizations

Description The visualizations that are included in the function template are created below the root folder using names that apply to the naming rules. The properties of the visualization are automatically adjusted. The programs that are included in the function template are created below the root folder using names that apply to the naming rules. The names of those objects in the program that are part of the function template will be adjusted automatically. The traces that are included in the function template are created below the root folder using names that apply to the naming rules and can be used to trace variables belonging to the application function. The CAM tables that are included in the function template are created below the root folder using names that apply to the naming rules. They are only required if the application function includes SoftMotion devices. The task configuration is adjusted as required by the function template.

programs

traces

CAM tables

task configuration

global variable lists The global variable lists that are included in the function template are created below the root folder using names that apply to the naming rules. external variables Global variables whose global variable lists do not belong to the function template are restored in their original global variable list as follows: z If a global variable list with the original name does not already exist below the application it will be created automatically. z If a global variable with the original name does not already exist in this global variable list, it will be created automatically. If the type of global variable is not correct, SoMachine will issue an error detection message. persistent variables Persistent variables are restored in the respective variable list of the application as follows: z If a persistent variable list does not already exist below the application it will be created automatically with its original name. z If a variable with the original name does not already exist in the persistent variable list, it will be created automatically. If the type of persistent variable is not correct, SoMachine will issue an error detection message.

Any objects that are created with the instantiation of the function template are listed in the Messages pane.

220

EIO0000000067 04/2012

Program

Naming of Objects In order to avoid naming conflicts if you instantiate the same function template several times on the same controller device, the following naming conventions are applied to the application functions and the associated objects:
If the name of the original object... Case 1: contains the name of the application function this part of the object is replaced by the name of the new application function that is created. Example: the template original application function Axis contains a program Axis_Init Case 2: does not contain the name of the application function Example: the original application function Axis contains a program InitProg for a new application function Axis1 being created with this function template, the new program is correspondingly named Axis1_InitProg. the name of the new application function plus an underscore are inserted in the original name to form a unique new name. for a new application function Axis1 being created with this template, the new program is correspondingly named Axis1_Init. Then ...

NOTE: Use rather short names for your application functions so that they are completely displayed.

EIO0000000067 04/2012

221

Program

Application Functions as Basis for Function Templates

Overview The following paragraphs list the criteria that must be fulfilled in order to save an application function with its associated field devices and visualizations as function template z the information that is saved in the function template
z

Prerequisites for Application Functions In order to save application functions as function templates, it is required that all objects that belong to the application function are grouped under a separate folder in the Devices view. NOTE: This folder cannot contain the field devices associated with the application function. Prerequisites for the Application You can only create templates from correct applications, which means that no errors are detected during the build process. Prerequisites for Saving an Application Function as Function Template In order to save an application function as function template, it is required that all programs of the application function are executed. This means they must meet one of the following criteria: z They must be added to a task. z They must be called by another program. Otherwise they will not be considered when executing the Build command.

222

EIO0000000067 04/2012

Program

Objects Saved in Function Templates The following objects are saved in function templates: z all programs that are located directly in the application function folder as well as their sub-objects z all global variable lists that are located directly in the application function folder z all visualizations that are located directly in the application function folder z all CAM tables that are located directly in the application function folder z all traces that are located directly in the application function folder z all field devices that are used by any program or visualization that is included in the function template z all global variables whose variable lists are not part of the function template but which are used by any program or visualization that is part of the function template z all persistent variables that are used by any program or visualization that is part of the function template NOTE: Any other object types are not saved in the function template (even if they are saved in the application function folder). Only use function blocks and data types that are stored in a library.

EIO0000000067 04/2012

223

Program

Steps to Create a Function Template

Overview The following paragraphs list the steps that have to be performed in order to save already available application functions that meet the criteria stated in Application Functions as Basis for Function Templates (see page 222) as function templates. Procedure To save an already available application function as function template, proceed as follows:
Step 1 2 Action Right-click the folder that contains your application function in the Devices view. Select the command Save As Function Template from the context menu. Result: The Save as Function Template dialog box will be displayed:

3 4

Assign a Template Name and a Template Library as stated below. Click OK to close the Save as Function Template dialog box and to create your new function template. Result: SoMachine verifies that the function template can be created and displays a message that the function template has been created successfully or issues messages indicating the detected errors.

224

EIO0000000067 04/2012

Program

Assigning a Template Name In the Template Name text box of the Save as Function Template dialog box you define the name under which the function template is stored in the template library. By default, this text box contains the name of the folder that contains your application function in the Devices view but you can adapt the name to your individual requirements. Selecting a Template Library To select one of the previously installed or created template libraries in which your new function template should be stored, proceed as follows:
Step 1 Action In the Save as Function Template dialog box click on the ... button next to the Template Library text box. Result: The Select Template Library dialog box will be displayed. The Select Template Library dialog box displays all template libraries that have been installed for the current project or have been created. Write-protected libraries are not displayed. To add your new function template to one of these template libraries, select the suitable entry and click OK.

Adding Further Information to the New Function Template The Save as Template dialog box enables you to enter further information for the function template. You can enter 2 different types of information: z In the Comment text box enter a short text (for example, to provide an overview of the contents and purpose of the function template) because this text will be indicated as tool tip when you select function templates in SoMachine. z In the Description text box enter a long text (for example, to provide a detailed description of the contents and purpose of the function template). Overwriting an Existing Function Template To overwrite an existing function template with the selected application function, proceed as follows:
Step 1 2 3 Action In the Save as Function Template dialog box click the ... button right to the Template Name text box. Browse to the already available function template you want to replace. Select the function template you want to replace. Result: The name of this function template will be inserted in the Template Name text box and the name of the template library where it is stored in is inserted in the Template Library text box. Click OK to close the Save as Function Template dialog box and to replace the selected Function Template with the new application function. 225

EIO0000000067 04/2012

Program

6.12

Downloading and Running Applications

Whats in this Section? This section contains the following topics:

Topic Downloading Applications Running Applications Page 227 230

226

EIO0000000067 04/2012

Program

Downloading Applications
Introduction To run an application, you must first connect the PC to the controller, then download the application to the controller. Downloading a project allows you to copy the current project from SoMachine to the controller memory. NOTE: Due to memory size limitation, some controllers are not able to store the application source but only a built application that is executed. This means that you are not able to upload the application source from the controller to a PC.

WARNING
UNINTENDED EQUIPMENT OPERATION Whenever you login to your controller, ensure the following: z The software application being downloaded must be installed on the intended device. Confirm that you have entered the correct device designation or device address in the Communication Settings dialog. z Confirm that machine guards and tags are in place such that any potential unintended machine operation will not result in personal injury or equipment damage. z Read and understand all user documentation of the software and related devices, as well as the documentation concerning equipment or machine operation. Failure to follow these instructions can result in death, serious injury, or equipment damage. Preconditions Your application must fulfill the following conditions before downloading it to the controller: z the active path must be set for the controller, z the application you want to download must be active, z the application must be of from compilation errors. Boot Application The Boot Application is the application that will be launched on controller start. This application is stored in the controller memory. To configure the download of the boot application, right-click the Application node in the Devices view and select the Properties command. At the end of a successful download of a new application, a message is displayed asking you if you want to create the boot application.
EIO0000000067 04/2012

227

Program

You can manually create a boot application in the following ways: z In offline mode: Click Online Create boot application to save the boot application to a file. z In online mode, with the application being in STOP mode: Click Online Create boot application to download the boot application to the controller. Operating Modes The download method differs depending on the relationship between the loaded application and the application you want to download. The 3 cases are: z Case 1: The application in the controller is the same as the one you want to load. In this case, no download occurs, you just connect SoMachine to the controller z Case 2: You made modifications of the application that is loaded in the controller. In this case you can specify if you want to download all or parts of the modified application or keep the application in the controller as it is. z Case 3: The controller application is different to the one you want to load. In this case, you must specify if you want to connect the loaded application or if you want to load the new one. Downloading your Application to the Controller: Case 1
Step 1 2 Action To connect to the controller, select Online Login to Application[YourApplicationName; Plc Logic]. You are connected to the controller.

Downloading your Application to the Controller: Case 2

Step 1 Action To connect to the controller, select Online Login to Application[YourApplicationName; Plc Logic].

228

EIO0000000067 04/2012

Program

Step 2

Action In case you modified your application and you want to reload it into the controller, the following message appears:

Login with online change only the modified parts of an already running project will be re-loaded to the controller. Login with download the whole modified application will be re-loaded to the controller. Login without any change the modifications are not loaded. Select what you want to do, click OK.

NOTE: See the Programming Guide for your controller for important safety-related information concerning the downloading of applications. Downloading your Application to the Controller: Case 3
Step 1 2 Action To connect to the controller, select Online Login to Application[YourApplicationName; Plc Logic]. In case you want to load a different application than the one currently in the controller, the following message appears:

To download the new application to the controller, click OK otherwise, click Cancel.

NOTE: See the Programming Guide for your controller for important safety-related information concerning the downloading of applications.
EIO0000000067 04/2012

229

Program

Running Applications
Introduction This part shows how to start/stop an application. RUN/STOP with SoMachine The controller can be started and stopped using SoMachine run on a PC connected to the controller. Click Online Start Application [ApplicationName: Plc logic] or CTRL+F5 or the Start Application [ApplicationName: Plc logic] button in the menu bar to start the application. Click Online Stop Application [ApplicationName: Plc logic] or CTRL+SHIFT+F5 or the Stop Application [ApplicationName: Plc logic] button in the menu bar to stop the application. RUN/STOP Input for Controllers Some controllers allow you to configure a Run/Stop input (for example %IX0.0...%IX1.5) to control application start/stop.
Status 0 Rising Edge 1 Description Stop the application. RUN command in SoMachine is not possible. Start the application. The application runs. RUN/STOP command in SoMachine is possible.

Refer to the manual of your controller to find out whether it supports this function. It is highly recommended that if you are going use remote commands to start and stop the controller that you configure and install the RUN/STOP input. It is the best method to help ensure local control over the running of the controller and to help prevent the inadvertent start of the controller from a remote location. For more information, see the description of the Remote connection command (see page 176).

230

EIO0000000067 04/2012

Program

6.13

Check for the Latest Firmware

Check for the Latest Firmware

Overview SoMachine allows you to perform an automatic check for the latest firmware version that is available on your computer whenever you make a connection to most controllers. You can enable or disable this function in the Project Settings dialog box for each project individually as described in the following paragraphs. If the function is activated, the check is performed automatically each time you intend to login to a supported controller. If a more recent firmware version is detected on your computer, this is indicated by a message in the Messages pane of the SoMachine window or additionally by a separate message window that is displayed. NOTE: The Firmware Update function searches the directory structure that was created during the installation of SoMachine to find the various firmware versions available. If you download a new firmware and do not store it in the correct directory, the Firmware Update function will not be aware that another version exists elsewhere on your machine. Supported Controllers The automatic search for the latest firmware version is available for the following controllers:
Controller Check for latest firmware version available M238 yes M258 / LMC058 yes ATV IMC yes XBT Controllers no

Activating / Deactivating the Check for the Latest Firmware To activate / deactivate the automatic check for a more recent firmware of the supported controllers, proceed as follows:
Step 1 2 3 Action Open the SoMachine project for which you want to activate / deactivate the check. Open the Program tab. Select the menu Project Project Settings....

EIO0000000067 04/2012

231

Program

Step 4

Action In the Project Settings dialog box select the option Firmware Update from the list on the left-hand side. Result: The Firmware Update configuration dialog box is displayed:

Configure the firmware update function as follows: z To activate the automatic check for a more recent firmware of the supported controllers in this project, select the option Check if new Firmware is available. z To deactivate the automatic check, select the option Do not check if new Firmware is available. z To prevent the software from opening a separate message box indicating that a more recent firmware has been found, select the option Do not show any pop-messages. In this case the more recent firmware version is only indicated in the Messages pane of the SoMachine window.

232

EIO0000000067 04/2012

Program

Messages Indicating that a More Recent Firmware is Available If the checking function is enabled and a more recent firmware version is detected by SoMachine, this is indicated in 2 different ways: z A message in the Messages pane of the SoMachine window lists the most recent firmware version that has been detected and the path where it is saved on your computer. z A separate message box is opened that indicates the currently installed firmware version and the more recent version that has been detected and the path where it is saved on your computer. It also provides a link to the programming guide of the respective controller where you can find further information. The separate message box is optional. You can prevent it from being created in the Project Settings dialog box via the Do not show any pop-messages option or by activating the Do not show this message again option in the message box itself.

EIO0000000067 04/2012

233

Program

234

EIO0000000067 04/2012

SoMachine Commissioning EIO0000000067 04/2012

Commissioning

7
Whats in this Chapter? This chapter contains the following topics:
Topic General Description of the Commissioning Tab Description of the Login/Logout Task Description of the Multiple Download Task Description of the Source Download Task Description of the Save Data / Restore Data Tasks Page 236 239 244 246 247

EIO0000000067 04/2012

235

Commissioning

General Description of the Commissioning Tab

Overview The Commissioning tab is only displayed after you have opened a SoMachine project. It consists of a graphical configuration editor, like the Configuration tab (see page 64), but it only provides functions that are required for commissioning a machine: z entering last parameters z viewing online status z logging into the machine z downloading to and from the devices z saving controller data to a CSV file z restoring data in a controller from a CSV file

236

EIO0000000067 04/2012

Commissioning

Elements of the Commissioning Tab The following figure shows the Commissioning tab with a sample configuration:

1 2 3

The task selection pane lists the available tasks. The work area includes the graphical configuration editor with functions restricted to commissioning tasks. The information pane provides further information on the element selected in the work area as well as the online status of this device.

EIO0000000067 04/2012

237

Commissioning

Online Status Information The online status is indicated in the graphical configuration editor for each device individually in different colors:
Online Status Not logged in Running Stopped Color yellow green red

The online status information is displayed in the information pane for the device selected in the graphical configuration editor. Editing Device and Communication Parameters To edit device parameters for commissioning the machine double-click the device icon in the graphical configuration editor or z right-click the device icon and select Edit parameters from the context menu.
z

Result: The Parameters configuration screen will be displayed for the selected device (see page 73). To edit communication parameters for commissioning the machine z double-click the network connection line in the graphical configuration editor or z right-click the network connection line and select Edit parameters from the context menu. Result: The network configuration screen will be displayed for the selected network connection (see page 85). NOTE: See the Programming Guide for your controller for important safety-related information concerning the editing of device and communication parameters.

238

EIO0000000067 04/2012

Commissioning

Description of the Login/Logout Task

Overview The Login/Logout task allows you to establish a connection between your PC running SoMachine and a connected device for uploading / downloading software. Before you can establish this connection you must physically connect your device to your PC. For detailed information on this hardware connection, refer to the hardware manual of your device.

WARNING
UNINTENDED EQUIPMENT OPERATION Whenever you login to your controller, ensure the following: z Confirm that you have entered the correct device designation or device address in the Communication Settings dialog. z Confirm that machine guards and tags are in place such that any potential unintended machine operation will not result in personal injury or equipment damage. z Read and understand all user documentation of the software and related devices, as well as the documentation concerning equipment or machine operation. Failure to follow these instructions can result in death, serious injury, or equipment damage. The login procedure differs depending on whether your project consists of only 1 or of several applications.

EIO0000000067 04/2012

239

Commissioning

Login Procedure with Project Consisting of 1 Controller with 1 Application For login to a connected device, proceed as follows:
Step 1 Action In the Commissioning tab click the Login/Logout button from the task selection pane. Result: After successful login, the information line at the bottom of each device icon will indicate the status of the device using different colors (for example, Stop is indicated in red).

If the active path was not previously set in the Communication Settings dialog then the following process starts after launching the login operation.
Phase 1 2a If... the active path was not previously set, no matching controller or several matching controllers are found, exactly 1 matching controller is found, Then ... SoMachine starts a scan to search for available controllers. a message appears and the Communication Settings dialog of the configured controller opens to select a controller on the network and set the active path. an advisory message appears to inform you of potential hazards. Press ALT+F if you agree to the instructions of the message, and the active path is set automatically.

2b

To log out, click the Login/Logout button in the task selection pane once again. Result: After successful logout, the information line at the bottom of each device icon will get the status not logged in or N/A with color yellow. NOTE: The login procedure explained above also applies when selecting the following menu items and icon in the Program tab: z Login icon in the toolbar z Login item of the Online menu z Login item from the context menu of one selected Application in the Devices tree.

240

EIO0000000067 04/2012

Commissioning

Login Procedure with Project Consisting of Several Controllers, Each with 1 Application For login to a connected device, proceed as follows:
Step 1 Action In the Commissioning tab click the Login/Logout button from the task selection pane. Result: The Login/Logout Applications dialog box will be displayed.

In the Login/Logout Applications dialog box select the application you want to login and click the OK button. Result: After successful login, the information line at the bottom of each device icon will indicate the status of the device using different colors (for example, Stop is indicated in red).

EIO0000000067 04/2012

241

Commissioning

If the active path was not previously set in the Communication Settings dialog then the following process starts after launching the login operation.
Phase 1 2 If... the active path was not previously set, at least for 1 device no matching controller or several matching controllers have been found, Then ... SoMachine starts a scan to search for available controllers. the following dialog opens:

Press OK to continue the login operation as selected in the Action column. Press Cancel to abort the login operation completely. For more detailed information about the selections in the Action column, see the following description: z open communication settings - This is the default action for devices that do not have an active path and no matching controller or several matching controllers are found. By pressing OK the Communication Settings dialog opens to set the active path manually for the device. z login - This is the default action for devices that already have an active path. By pressing OK the login is running for the device. z set active path and login - This is the default action for devices that do not have an active path and exactly 1 matching controller is found. By pressing OK a warning occurs for the device. Press ALT+F to confirm setting the active path and login to the matching controller. z none - This is an alternative action which can be choosen for every device. This action cancels the login for the device.

242

EIO0000000067 04/2012

Commissioning

To log out, click the Login/Logout button in the task selection pane once again, deselect the selected applications, and click the Close button. Result: After successful logout, the information line at the bottom of each device icon will get the status not logged in or N/A with color yellow. NOTE: The login procedure explained above also applies when selecting the following menu item in the Program tab: z Login item from the context menu of several selected Applications in the Devices tree.

EIO0000000067 04/2012

243

Commissioning

Description of the Multiple Download Task

Overview For the Multiple Download operation you must specify 2 settings: Select the applications of the project to be downloaded. z Specify online change options and additional settings.
z

NOTE: All physical targets (selected applications associated controllers and HMIs) must be connected to the PC. Procedure Execute the Multiple Download task as follows:
Step 1 Action In the Commissioning tab click the Multiple download button from the task selection pane. Result: The Multiple Download dialog box will be displayed.

In the Please select the applications for download section check each application you want to download the new source project to.

244

EIO0000000067 04/2012

Commissioning

Step 3 4 5

Action Select the Online change options that suit your application. For further details refer to the CoDeSys part of the online help. Select the Additional operations options that suit your application. For further details refer to the CoDeSys part of the online help. Click the OK button to start the download process. Result: A Multiple Download - Result message box will be displayed indicating for each application if the download process has been successfully completed.

NOTE: See the Programming Guide for your controller for important safety-related information concerning the Multiple Download feature.

EIO0000000067 04/2012

245

Commissioning

Description of the Source Download Task

Overview The Source Download task allows you to download an archived version of a SoMachine project from your PC to a connected controller. NOTE: Please note that an additional memory extension must be available on the controller to use this function. It is thus only available for ATV IMC and M258 controllers as well as for those XBTGC types that can use a USB flash drive as secondary storage. XBTGT/GK controllers can use the CF card as secondary storage for source download with SoMachine 2.0. Procedure To download a SoMachine project to your controller, proceed as follows:
Step 1 2 Action Login to the controller you want to download the SoMachine project to, as described in the Description of the Login / Logout Task chapter (see page 239). Click the Source Download button from the task selection pane. Result: A project archive of the currently open project is automatically created and downloaded to the controller.

246

EIO0000000067 04/2012

Commissioning

Description of the Save Data / Restore Data Tasks

Overview The Save data task allows you to save data from a controller to the PC running SoMachine to be able to restore the data later with the Restore data task. These functions are intended for use before and after the following functions that remove the values of the variables: z firmware update z executing the Reset Origin command z download of a new application The Save data task allows you to save values of all types of data contained in the application to a comma-separated values (CSV) file including:
Area System Type Memory words Input Output User Prerequisite variables are mapped on %MW variables are mapped on %IW variables are mapped on %QW Example of Declaration of this Variable Memory Word AT %MW0:WORD Output AT %QW0:WORD Input AT %IW0:WORD

all types of variables except function block instances and pointers

Prerequisites The Save data and Restore data tasks are only available if the following conditions apply: z You are logged in on the application of the controller via SoMachine (online mode). z The application of the controller is in STOP mode. Saving Controller Data to a File To save data from a controller to the PC running SoMachine, proceed as follows:
Step 1 Action Comment

In the Commissioning tab right-click the controller Result: The controller with the active application is and execute the command Set application active marked by a green circle that is displayed in the to select the application which data is to be saved controller icon. to file. Click the Save data button from the task selection pane. Result: The Save Variables dialog box opens.

EIO0000000067 04/2012

247

Commissioning

Step 3

Action In the Save Variables dialog box select those variables you want to save to the CSV file by highlighting individual variables or even nodes in the window on the left-hand side that shows those variables that are currently available in the application. Click the > or >> button to move the variable(s) to the right side. Click the Save Data... button. Browse to the folder where you want to save the CSV file, enter a file name and click Save.

Comment

The variables that are displayed on the right-hand side of the window are selected for export to a CSV file. A standard Windows save file dialog box is displayed. The dialog box is closed and the selected variables are saved to the CSV file. After the variables have been saved successfully, a small dialog box is displayed that you have to confirm with OK.

5 6

Restoring Data to the Controller The Restore data overwrites the current values of the variables in the application.

WARNING
UNINTENDED EQUIPMENT OPERATION AND / OR DATA LOSS After the Restore data task has been performed, verify that the modified project contains the intended configurations and provides the intended functions. Failure to follow these instructions can result in death, serious injury, or equipment damage.

248

EIO0000000067 04/2012

Commissioning

To restore data to a controller from the CSV file saved on the PC running SoMachine, proceed as follows:
Step 1 Action Comment

In the Commissioning tab right-click the controller Result: The controller with the active application is and execute the command Set application active marked by a green circle that is displayed in the to select the application which data is to be restored controller icon. from file. In the Commissioning tab select the controller and Result: A standard open file Windows dialog box is displayed. click the Restore data button from the task selection pane. Browse to the folder where the CSV file is stored, select the file and click Open. Click OK to import the CSV file. Check whether the project contains the correct variables and values. Result: A message box is displayed, indicating that this procedure overwrites the values of the variables currently saved in your application. Result: The variables saved in the CSV file are transferred to the controller.

4 5

EIO0000000067 04/2012

249

Commissioning

250

EIO0000000067 04/2012

SoMachine Report EIO0000000067 04/2012

Report

8
Report
The Report Tab The Report tab is only available after you have opened a SoMachine project. It provides tasks to create and customize a report of your project. The task selection pane on the left shows the report creation steps: z Page Setup z Print Preview z Print

EIO0000000067 04/2012

251

Report

Elements of the Report Tab This tab also provides the Customization task to adapt your report to your individual preferences. The figure below shows the elements of the Report tab:

1 2 3 4

tasks for the report creation tree structure of your project for selection task for report customization further information on the selected object

252

EIO0000000067 04/2012

Report

Buttons of the Report Tab The buttons in the work area allow you to view a tree structure of your project and to arrange the items within this structure. Each item of your project provides a check box. Select the check boxes of the items you want to be part of your report.
Buttons for Report Settings Move Up Move Down Meaning Click Move Up to move an item of your project upwards in the tree structure of your project. Click Move Down to move an item downwards in the tree structure of your project. Click Select All to select the check boxes of all your project items Click Select None to unmark the check boxes of all your project items Click Expand All to unfold the details of the tree structure of all your project items Click Collapse All to close the view of the tree structure.

Select All

Select None

Expand All

Collapse All

Setting Up Printing Parameters To set up the parameters for printing the report, click the Page Setup button from the task selection pane on the left. Adapt the settings of the standard Windows Page Setup dialog box to your individual requirements. For further information refer to the Windows online help. Printing a Report To print out your report, proceed as follows:
Step 1 Action Click Print Preview to have a view of the items you have selected. Result: A Print Preview is generated. Navigate in the Print preview by using the Page text box. Click Print to start printing. Result: A Windows dialog box for Print opens. Select your settings and click OK to start printing.

For page setup use the Windows print dialog box.

EIO0000000067 04/2012

253

Report

The Customization Task The Customization task allows you to customize your report according to your personal preferences. If you click the Customization button, the following screen opens:

1 2

The upper part of the work area provides options to customize your report. The lower part of the work area shows a preview of the page configuration. The boxes around the preview allow you to place information in the report.

254

EIO0000000067 04/2012

Report

Options for Report Customization

Options for Customization Adding a logo Steps Click Add to add a logo to your report. Result: A Select Logo dialog box opens that allows you to browse to the picture file you want to use as logo. The logo can be displayed in the header or footer of your report. Click Change to replace the logo by another one or click Remove to delete the logo. In the text boxes Text 1 and Text 2 enter an optional text you wish to be displayed in the header or footer of your report printout. Any entries are displayed in a preview in the lower part of the window. The top and the bottom of your preview provide boxes which allow you to place the selected information Text1, Text2, Logo, Page Title, Date, Project Name, Project Number at a preferred position of the header or the footer of your report. Select the information you want to be placed at the given position from the list.

Changing or removing a logo Adding text

Arranging the information in the report

EIO0000000067 04/2012

255

Report

256

EIO0000000067 04/2012

SoMachine Troubleshooting and FAQ EIO0000000067 04/2012

Troubleshooting and FAQ

III

EIO0000000067 04/2012

257

Troubleshooting and FAQ

258

EIO0000000067 04/2012

SoMachine Generic - Troubleshooting and FAQ EIO0000000067 04/2012

Generic - Troubleshooting and FAQ

9.1

Frequently Asked Questions

Whats in this Section? This section contains the following topics:

Topic Shortcuts and Menus Enabling and Configuring Analog Inputs on CANopen Startup Performance Page 260 262 264

EIO0000000067 04/2012

259

Generic - Troubleshooting and FAQ

Shortcuts and Menus

Overview The menus and shortcuts of the SoMachine software differ depending on the current state, that is, the window or editor that is currently open. For SoMachine 2.0 and prior versions, the menus and shortcuts of the SoMachine graphical user interface were optimized for SoMachine, using a SoMachine standard by default. For SoMachine 3.0 and later versions, the CoDeSys standard shortcuts and menus are implemented by default. You can adapt the shortcuts and menus to your individual preferences or you can load the SoMachine or CoDeSys standard shortcuts and menus as described in the following sections. Customizing Shortcuts and Menus You can adapt the shortcuts and menus to your individual preferences by using the Tools Customize menu. Restoring the SoMachine Standard Shortcuts and Menus To restore the SoMachine standard shortcuts and menus (after you have customized them), proceed as follows:
Step 1 2 3 Action Execute the Customize command from the Tools menu. Result: The Customize dialog box will be displayed. In the Customize dialog box click the Load button. Result: The Load Menu dialog box will be displayed. In the Load Menu dialog box navigate to the folder ...\Program Files\Schneider Electric\SoMachine\CoDeSys\Settings, select the file Standard.opt.menu and click Open. Result: The Customize dialog box now shows the standard SoMachine settings. To load these standard settings to the SoMachine graphical user interface, click OK.

260

EIO0000000067 04/2012

Generic - Troubleshooting and FAQ

Setting the Shortcuts and Menus to CoDeSys Standard To import the CoDeSys shortcuts and menus to your SoMachine graphical user interface, proceed as follows:
Step 1 2 3 Action Execute the Customize command from the Tools menu. Result: The Customize dialog box will be displayed. In the Customize dialog box click the Load button. Result: The Load Menu dialog box will be displayed. In the Load Menu dialog box navigate to the folder ...\Program Files\Schneider Electric\SoMachine\CoDeSys\Settings, select the file CoDeSysStandard.opt.menu and click Open. Result: The Customize dialog box now shows the CoDeSys settings. To load these CoDeSys settings to the SoMachine graphical user interface, click OK.

NOTE: The menus and shortcuts of the SoMachine software differ, depending on the window or editor that is currently open. Expanding Menus SoMachine main menus and context menus can be displayed in a collapsed or full view. In the collapsed mode seldom used or disabled commands are hidden. After clicking the arrow menu item at the bottom of a menu, the corresponding menu expands, showing all its menu items. For always showing the menus in the full viewing mode activate the option Always show full menus in the Tools Options Features dialog.

EIO0000000067 04/2012

261

Generic - Troubleshooting and FAQ

Enabling and Configuring Analog Inputs on CANopen

Overview This section provides instructions on enabling analog inputs according to the CANopen standard by setting the SDO (Service Data Object) 6423 to the value 1. Procedure
Step 1 2 Action Double-click the entry of your analog CANopen device in the Devices window. In the CANopen Remote Device tab, enable the option Enable Expert PDO Settings. Result: Additional tabs are displayed and the Service Data Object tab is populated with information.

262

EIO0000000067 04/2012

Generic - Troubleshooting and FAQ

Step 3

Action Open the Service Data Object tab and click New. Result: The Select item from object directory dialog box is displayed.

From the list of objects, select object 6423, enter 1 as Value and click OK. Result: Analog input transmission on the CANopen bus is activated. You can now configure parameters of the analog values as described in the hardware manual of your device.

For further information refer to the CoDeSys online help.

EIO0000000067 04/2012

263

Generic - Troubleshooting and FAQ

Startup Performance
Overview Beside the PC configuration there are several other conditions wich can increase the time SoMachine is consuming during startup:
Boot Phase first start after SoMachine installation Startup Performance On first start after SoMachine has been installed, the software will generate its working environment on the PC. This is done only one time but has significant impact on the duration of the first startup. After rebooting the PC, the startup time of SoMachine can be longer as usual, because of Microsoft Windows consumes some time in the background to launch services that are needed to run SoMachine. This can have impact on the startup duration and cannot be avoided. Our users experience best performance of the startup each time the system has been started already before on the PC.

first start after reboot

subsequent starts

264

EIO0000000067 04/2012

SoMachine EIO0000000067 04/2012

Appendices

EIO0000000067 04/2012

265

266

EIO0000000067 04/2012

SoMachine Usage of the OPC Server 3 EIO0000000067 04/2012

Usage of the OPC Server 3

A
Overview The description provided in this chapter is dedicated to persons experienced in OPC server technology. The file OPC_V3_how_to_use_E.pdf , that is automatically installed with SoMachine in the directory C:\Program Files\Schneider Electric\SoMachine OPCServer provides a more detailed description of how to configure the OPC server. Whats in this Chapter? This chapter contains the following topics:
Topic General Information Declaring a Variable to be Used With OPC OPC Server Configuration Usage of the CoDeSys OPC Server Page 268 270 273 280

EIO0000000067 04/2012

267

Usage of the OPC Server 3

General Information
What is OPC? OPC is a standardized interface for access to process data. It is based on the Microsoft standard COM/DCOM2 (Component Object Model / Distributed COM) that has been extended due to the requirements of data access in automation, where the interface is mainly used to read data from or write data to the controller. Examples of typical OPC clients visualizations z programs whose purpose is to collect operating data
z

Examples of typical providers of OPC servers z controller systems z field bus interface cards What is an OPC Server? The OPC server is an executable program that is started automatically during the establishment of a connection between client and controller. Hence, the OPC server is able to inform the client about changed variable values or states. The OPC server provides all variables (referred to as Items in OPC) that are available on the controller (Item Pool or Address Space). These items are managed within a Data Cache that helps to ensure fast access to their values. Also possible is a direct, not cached access to the items of the controller. In the OPC server the items can be organized in so-called Groups (Private and Public). The private groups can be composed in the client arbitrarily from particular items. Initially they do not effect the groupings in the OPC server, but if necessary can be transformed to Public Groups. Working with Private Groups, for example, is useful in order to be able to activate or deactivate certain groups of variables with just one single command, depending on whether they should be accessible or not. Grouped data should be read from the OPC server coherently, that is, all variables should be read at the same time. However, this is not always possible in case of target systems with restricted communication buffers. Due to the characteristics of COM / DCOM it is possible to access an OPC running on another computer. It is also allowed that more than one client accesses the data source at the same time. The applicability of different languages (C++, Visual Basic, Delphi, Java) is another benefit of the concept.

268

EIO0000000067 04/2012

Usage of the OPC Server 3

Overview of the CoDeSys OPC Server 3 The CoDeSys OPC server is based on the PLCHandler of 3S - Smart Software Solutions GmbH. This communication module permits a direct communication to those controllers that are programmable with CoDeSys. The OPC server V3. supports the following OPC specifications: z OPC Common Definitions and Interfaces Version 1.0 z Data Access Custom Interface Standard Version 1.0 z Data Access Custom Interface Standard Version 2.05A z Data Access Custom Interface Standard Version 3.0 z Data Access Automation Interface Standard Version 2.0 Communication between OPC server and controller can be carried out via the following interface: z Gateway V3

EIO0000000067 04/2012

269

Usage of the OPC Server 3

Declaring a Variable to be Used With OPC

Steps to Declare a Variable Declare a variable to be used with OPC as follows:
Step 1 2 3 4 Action Create a project. Add and select a controller using the Add Device command. Example ExampleOPC

Configure the name of the device by clicking the device node twice to make MyPLCexample it editable. Create a PROGRAM in your application by right-clicking the Application item and executing the command Add Object POU.... Configure the name of the PROGRAM. Double-click a task and associate the PROGRAM to the task. Example program: Increment a UINT variable: VARIABLEEXAMPLE MyPOUexample Task example: MAST PROGRAM example: MyPOUexample

5 6

Execute the Build All command from the Build menu and verify there is no error detected during execution of the Build command.

270

EIO0000000067 04/2012

Usage of the OPC Server 3

Step 8

Action Create a Symbol configuration object in your application by right-clicking the Application item and executing the command Add Object Symbol configuration....

Example

9 10 11 12

In the Add Symbol configuration dialog box click Open. Click the Refresh link. Expand the Variables item in the Available variables list. Select the variable you want to share with your OPC client from your program.

Variable example: VARIABLEEXAMPLE Program example: MyPOUexample

13

Click the > button to send the variable to a shared data base to make it accessible for the OPC client.

EIO0000000067 04/2012

271

Usage of the OPC Server 3

Step 14 15

Action Execute the Build All command from the Build menu and verify there is no error detected during execution of the Build command. Close the tab Symbol configuration.

Example Remark: In the directory where you have stored your project you will find an XML file which includes a list of the variables which are accessible for the OPC client.

16 17 18

Connect your PC to your controller by using the Communication Setting tab. Download the application. Start the application.

XML File Listing the Variables Accessible for the OPC Client In the directory where you have stored your project, an XML file is automatically created which describes the list of the variables which are accessible for the OPC client.

272

EIO0000000067 04/2012

Usage of the OPC Server 3

OPC Server Configuration

Starting the OPC Configuration Tool Configure the OPC server and link it with the project you have created, as follows:
Step 1 2 3 Action Go to the directory: C:\Program Files\Schneider Electric\SoMachine OPCServer Double-click the: OPCConfig.exe file The configuration tool OPCconfig.exe allows to generate an INI file which is needed to initialize the OPC server with the desired parameters for the communication between the CoDeSys project and the controller(s).

OPC Configuration Tool The configuration tool contains the following elements: z a menu bar z a tree view for mapping the assignments of one or several controllers to the server z a configuration dialog that corresponds to the currently selected tree entry After having started the tool, it will appear as follows, containing the default common settings:

EIO0000000067 04/2012

273

Usage of the OPC Server 3

File Menu of the OPC Configuration Tool The File menu provides commands for loading and saving the configuration files to / from the configuration tool:
Command Open Shortcuts CTRL+O Description For editing an existing configuration. The default dialog box for opening a file opens. Select an already existing INI file. The filter is automatically set to OPCconfg Files *.ini. The configuration described in the chosen INI file will be loaded to the configuration tool. For creating a new configuration. If a configuration is open, you will be asked whether it should be saved before being closed. Then the configuration tool will show the default settings. Saves the current configuration to the currently loaded INI file. Saves the current configuration to a file by another name that you can specify in the default dialog box. List of the INI files which have been edited since having last started the tool. You can select a file to get it reloaded in the configuration tool. Terminates the tool. If any changes to the current configuration have not been saved, you will be asked to do so.

New

CTRL+N

Save Save as <n> recently opened INI-files Exit

CTRL+S

Edit Menu of the OPC Configuration Tool The Edit menu provides the commands for editing the configuration tree in the left part of the configurator.
Command Shortcuts Description A Redundant Group entry will be added below Server. If there are already controller or Redundant Groups listed in the tree, the new Redundant Group will be appended at the end. By default, a new entry is named Redundant<n>, with n being a consecutive number starting with 1. To rename the entry, select it in the tree and either use the command Edit Rename PLC or click it twice to make it editable. A controller entry will be added below Server. A new controller will be appended at the end of the existing tree. By default, a new entry is named PLC<n>, with n being a consecutive number starting with 1. To rename the entry, select it in the tree and either use the command Edit Rename PLC or click it twice to make it editable. The currently selected controller entry will be removed from the configuration tree. The currently selected controller entry can be renamed.
EIO0000000067 04/2012

New CTRL+G Redundancygroup

Append PLC

CTRL+O

Delete PLC Rename PLC 274

CTRL+D CTRL+R

Usage of the OPC Server 3

Command Reset PLC PLC Default Settings...

Shortcuts CTRL+Z

Description The settings of the currently selected controller entry will be reset to the default values defined in the PLC Default Settings. not yet available

Configuring the OPC Server Configure the OPC server as follows:

Step 1 Action Right-click the Server icon and execute the Append PLC command:

Select GATEWAY3 from the Interface list.

EIO0000000067 04/2012

275

Usage of the OPC Server 3

Step 3

Action Double-click the PLC1 item to rename it (for example: MyPLCexample).

Double-click the Connection icon and click the Edit button. Result: The CoDeSys address of PLC dialog box will be displayed:

To be able to access your variable from your OPC client, enter the address of the controller (for example: MyPLCexample). The address is given in the SoMachine Communication Setting dialog box of your project.

The address can be physical or logical. To avoid address value reconfigurations when there are many devices in your project, you should use logical addresses.

276

EIO0000000067 04/2012

Usage of the OPC Server 3

Logical Addressing In our example the address is: MyPLCexample. Enter directly the Node name given in the Communication Setting tab of MyPLCexample in your project. To configure the Node name, click the Edit button.

EIO0000000067 04/2012

277

Usage of the OPC Server 3

Physical Addressing In our example the address is: 007F.6200.0001

Proceed as follows:
Step 1 Action Take this address and configure the value of the CoDeSys address of PLC :

Click the OK button. Result: The following dialog box will be displayed:

278

EIO0000000067 04/2012

Usage of the OPC Server 3

Step 3

Action Open the menu File and execute the command Save As. Click the OK button and the following dialog box will be displayed:

Select the OPCServer.ini and click Save. NOTE: Please note that the name of the file must be OPCServer.ini. Do not use another file name.

EIO0000000067 04/2012

279

Usage of the OPC Server 3

Usage of the CoDeSys OPC Server

Overview After the installation of the OPC server it should be offered for selection by the OPC client (for example visualization). The name of the OPC server is CoDeSys.OPC.DA. The OPC server will be started automatically by the operating system as soon as a client establishes a connection. The OPC server will terminate automatically as soon as the clients have closed their connections to the server. There will be no OPC server icon in the task bar. It will only appear in the Windows Task Manager as a process. Executing the OPC Client on a PC not Running SoMachine To be able to execute the OPC client on a PC where SoMachine is not installed, proceed as follows: z Refer to the chapter Installation of the CoDeSys OPC Server in the SoMachine Introduction document (see SoMachine, Introduction) and execute the following actions: z Install the gateway on the PC where the OPC client is running. z Depending on the OPC client, you need to launch the WinCoDeSysOPC.exe file.
z

Copy the file OPCServer.ini to the same directory where the WinCoDeSysOPC.exe is installed.

280

EIO0000000067 04/2012

SoMachine Glossary EIO0000000067 04/2012

Glossary

0-9
%I According to the IEC standard, %I represents an input bit (for example a language object of type digital IN).

%IW According to the IEC standard, %IW represents an input word register (for example a language object of type analog IN).

%MW According to the IEC standard, %MW represents a memory word register (for example a language object of type memory word).

%Q According to the IEC standard, %Q represents an output bit (for example a language object of type digital OUT).

%QW According to the IEC standard, %QW represents an output word register (for example a language object of type analog OUT).

1-phase counter A 1-phase counter uses 1 hardware input as counter input. It usually counts up or counts down when there is pulse signal in the input.

EIO0000000067 04/2012

281

Glossary

2-phase counter A 2-phase counter uses the phase difference between 2 input counter signals to count up or count down.

A
ADC analog/digital converter

AFB application function block

AMOA An address of modbus of option application board installed on the drive.

analog input An analog input module contains circuits that convert an analog DC input signal to a digital value that can be manipulated by the processor. By implication, the analog input is usually direct. That means a data table value directly reflects the analog signal value.

analog output An analog output module contains circuits that transmit an analog DC signal proportional to a digital value input to the module from the processor. By implication, these analog outputs are usually direct. That means a data table value directly controls the analog signal value.

application source The application source file can be uploaded to the PC to reopen a SoMachine project. This source file can support a full SoMachine project (for example, one that includes HMI application).

ARP The address resolution protocol is the IP network layer protocol for Ethernet that maps an IP address to a MAC (hardware) address.

282

EIO0000000067 04/2012

Glossary

ARRAY An ARRAY is a table containing elements of a single type. The syntax is as follows: ARRAY [<limits>] OF <Type> Example 1: ARRAY [1..2] OF BOOL is a 1-dimensional table with 2 elements of type BOOL. Example 2: ARRAY [1..10, 1..20] OF INT is a 2-dimensional table with 10x20 elements of type INT. ARW anti-reset windup

ASCII The american standard code for information interchange is a communication protocol for representing alphanumeric characters (letters, numbers, and certain graphic and control characters).

assigned variable A variable is "assigned" if its location in controller memory can be known. For example, the Water_pressure variable is said to be assigned through its association with memory location %MW102.Water_pressure. ATC analog tension control

ATV ATV is the model prefix for Altivar drives. (For example, ATV312 refers to the Altivar 312 variable speed drive.)

AWG The american wire gauge standard specifies wire gauges in North America.

EIO0000000067 04/2012

283

Glossary

B
BCD The binary coded decimal format represents decimal numbers between 0 and 9 with a set of 4 bits (a nybble/nibble, also titled as Halfbyte). In this format, the 4 bits used to encode decimal numbers have an unused range of combinations. For example, the number 2,450 is encoded as 0010 0100 0101 0000 BOOL A Boolean type is the basic data type in computing. A BOOL variable can have one of these values: 0 (FALSE), 1 (TRUE). A bit that is extracted from a word is of type BOOL, for example: %MW10.4 is a fifth bit a memory word number 10. Boot application Files that contain machine dependent parameters: machine name z device name or IP address z Modbus Serial Line address z Routing table
z

BOOTP The bootstrap protocol is a UDP network protocol that can be used by a network client to automatically obtain an IP address (and possibly other data) from a server. The client identifies itself to the server using the client MAC address. The server which maintains a pre-configured table of client device MAC addresses and associated IP addressessends the client its pre-configured IP address. BOOTP was originally used as a method that enabled diskless hosts to be remotely booted over a network. The BOOTP process assigns an infinite lease of an IP address. The BOOTP service utilizes UDP ports 67 and 68.

bps bit per second as a definition of transmission rate, also given in conjunction with multiplicator kilo (kbps) and mega (mbps).

BSH BSH is a Lexium servo motor from Schneider Electric.

284

EIO0000000067 04/2012

Glossary

bus base A bus base is a mounting device that is designed to seat an electronic module on a DIN rail and connect it to the TM5 bus for M258 and LMC058 controllers. Each base bus extends the TM5 data and to the power buses and the 24 Vdc I/O power segment. The electronic modules are added to the TM5 system through their insertion on the base bus. The base bus also supplies the articulation point for the terminal blocks.

BYTE When 8 bits are grouped together, they are called a BYTE. You can enter a BYTE either in binary mode or in base 8. The BYTE type is encoded in an 8-bit format that ranges from 16#00 to 16#FF (in hexadecimal format).

C
calibration Graduates a piece of measuring apparatus.

CAN The controller area network protocol (ISO 11898) for serial bus networks is designed for the interconnection of smart devices (from multiple manufacturers) in smart systems for real-time industrial applications. Originally developed for use in automobiles, CAN is now used in a variety of industrial automation control environments.

CANmotion CANmotion is a CANopen-based motion bus with an additional mechanism that provides synchronization between the motion controller and the drives.

CANopen CANopen is an open industry-standard communication protocol and device profile specification.

EIO0000000067 04/2012

285

Glossary

CFC The continuous function chart (an extension of the IEC61131-3 standard) is a graphical programming language that works like a flowchart. By adding simple logic blocks (AND, OR, etc.), each function or function block in the program is represented in this graphical format. For each block, the inputs are on the left and the outputs on the right. Block outputs can be linked to inputs of other blocks in order to create complex expressions.

CiA CAN in automation is a non-profit group of manufacturers and users dedicated to developing and supporting CAN-based higher layer protocols.

CIP When the common industrial protocol is implemented in a network application layer, it can communicate seamlessly with other CIP-based networks without regard to the protocol. For example, the implementation of CIP in the application layer of an Ethernet TCP/IP network creates an EtherNet/IP environment. Similarly, CIP in the application layer of a CAN network creates a DeviceNet environment. In that case, devices on the EtherNet/IP network can communicate with devices on the DeviceNet network through CIP bridges or routers.

CMU The current measurement unit is used to convert the relative current value (%) provided by TeSys into a real ISO value (A).

configuration The configuration includes the arrangement and interconnection of hardware components within a system and the hardware and software selections that determine the operating characteristics of the system.

controller A controller (or programmable logic controller, or programmable controller) is used to automate industrial processes.

controller status output The controller status output is a special function used in circuits that are external to the controller that control the power supply to the output devices or the controller power supply.

286

EIO0000000067 04/2012

Glossary

CPDM controller power distribution module

CRC A network messages cyclic redundancy check field contains a small number of bits that produce a checksum. The message is calculated by the transmitter according to the messages content. Receiving nodes then recalculate the field. Any discrepancy in the two CRC fields indicates that the transmitted message and the received message are different.

CSA The canadian standards association defines and maintains standards for industrial electronic equipment in hazardous environments.

CTS Clear to send is a data transmission signal and acknowledges the RDS signal from the transmitting station.

cyclic task The cyclic scan time has a fixed duration (interval) specified by the user. If the current scan time is shorter than the cyclic scan time, the controller waits until the cyclic scan time has elapsed before starting a new scan.

D
data log The controller logs events relative to the user application in a data log.

DCE Data communications equipment describes devices (often modems) that start, stop, and sustain network sessions.

Derating Derating describes a reduction in an operating specification. For devices in general it is usually a specified reduction in nominal power to facilitate operation at increased ambient conditions like higher temperatures or higher altitudes.

EIO0000000067 04/2012

287

Glossary

DHCP The dynamic host configuration protocol is an advanced extension of BOOTP. DHCP is a more advanced, but both DHCP and BOOTP are common. (DHCP can handle BOOTP client requests.)

digital I/O A digital input or output has an individual circuit connection at the electronic module that corresponds directly to a data table bit that holds the value of the signal at that I/O circuit. It gives the control logic digital access to I/O values.

DIN Deutsches Institut fr Normung is a German institution that sets engineering and dimensional standards.

DINT A double integer type is encoded in a 32-bit format.

DNS The domain name system is the naming system for computers and devices connected to a LAN or the Internet.

drop cable A drop cable is the unterminated derivation cord used to connect a TAP to a device.

DSR Data set ready is a data transmission signal.

DTM With device type managers representing the field device in SoMachine, direct communications are possible to every single field device via SoMachine, the controller and the field bus, thus avoiding the need for individual cable connections.

DWORD A double word type is encoded in a 32-bit format.

288

EIO0000000067 04/2012

Glossary

E
EDS Electronic data sheet contains for example the properties of a device e.g. parameters and settings of a drive.

EEPROM Electrically erasable programmable read-only memory is a type of non-volatile memory used to store data that must be saved when power is removed.

EIA The electronic industries alliance is the trade organization for establishing electrical/electronic and data communication standards (including RS-232 and RS485) in the United States.

EIA rack An electronic industries alliance rack is a standardized (EIA 310-D, IEC 60297 and DIN 41494 SC48D) system for mounting various electronic modules in a stack or rack that is 19 inches (482.6 mm) wide.

electronic module In a programmable controller system, most electronic modules directly interface to the sensors, actuators, and external devices of the machine/process. This electronic module is the component that mounts in a bus base and provides electrical connections between the controller and the field devices. Electronic modules are offered in a variety of signal levels and capacities. (Some electronic modules are not I/O interfaces, including power distribution modules and transmitter/receiver modules.)

EN EN identifies one of many European standards maintained by CEN (European Committee for Standardization), CENELEC (European Committee for Electrotechnical Standardization), or ETSI (European Telecommunications Standards Institute).

encoder An encoder is a device for length or angular measurement (linear or rotary encoders).

EIO0000000067 04/2012

289

Glossary

Equipment An Equipment is a part of the Machine.

ERC eccentric roller conveyor

ESD electrostatic discharge

Ethernet Ethernet is a physical and data link layer technology for LANs, also known as IEE 802.3.

EtherNet/IP The ethernet industrial protocol is an open communications protocol for manufacturing automation solutions in industrial systems. EtherNet/IP is in a family of networks that implements Common Industrial Protocol at its upper layers. The supporting organization (ODVA) specifies EtherNet/IP to accomplish global adaptability and media independence.

expansion bus The expansion bus is an electronic communication bus between expansion modules and a CPU.

expansion I/O module An expansion input or output module is either a digital or analog module that adds additional I/O to the base controller.

expert I/O Expert I/Os are dedicated modules or channels for advanced features. These features are generally embedded in the module in order to not use the resources of the PLC Controller and to allow a fast response time, depending of the feature. Regarding the function, it could be considered as a stand alone module, because the function is independent of the Controller processing cycle, it just exchanges some information with the Controller CPU.

290

EIO0000000067 04/2012

Glossary

F
FAST I/O FAST I/Os are specific I/Os with some electrical features (response time, for example) but the treatment of these channels is done by the Controller CPU.

FAST task The FAST task is a periodic, high-priority task of a short duration that is run on a processor through its programming software. The task fast speed keeps it from interfering with the execution of lower priority master (MAST) tasks. A FAST task is useful when fast periodic changes in discrete inputs need to be monitored.

FB A function block performs a specific automation function, such as speed control, interval control, or counting. A function block comprises configuration data and a set of operating parameters.

FBD A function block diagram is a graphically oriented programming language, compliant with IEC 61131-3. It works with a list of networks whereby each network contains a graphical structure of boxes and connection lines which represents either a logical or arithmetic expression, the call of a function block, a jump, or a return instruction.

FDT Field device tool for standardized communications between field devices and SoMachine.

FE Functional ground is the point of a system or device that must be grounded to help prevent equipment damage.

FG frequency generator

firmware The firmware represents the operating system on a controller.

EIO0000000067 04/2012

291

Glossary

Flash memory Flash memory is nonvolatile memory that can be overwritten. It is stored on a special EEPROM that can be erased and reprogrammed.

FTP File transfer protocol is a standard network protocol (built on a client-server architecture), to exchange and manipulate files over TCP/IP based networks.

function A function: is a POU that returns 1 immediate result z is directly called with its name (as opposed to through an instance) z has no persistent state from one call to the next z can be used as an operand in expressions
z

Examples: boolean (AND) operators, calculations, conversions (BYTE_TO_INT)

function block (FB) See FB.

function block diagram (FBD) See FBD.

FWD forward

G
gross weight Indication of the load weight on an instrument when no tare or predefining device has been used.

GVL The global variable list manages global variables that are available in every application POU.

292

EIO0000000067 04/2012

Glossary

H
HE10 Rectangular connector for electrical signals with frequencies below 3MHz, complying with IEC60807-2.

HMI A human-machine interface is an operator interface (usually graphical) for industrial equipment.

hot swapping Hot swapping is the replacement of a component with a like component while the system remains operational. The replacement component begins to function automatically after it is installed.

HSC high-speed counter

HVAC Heating ventilation and air conditioning applications monitor and control indoor environments.

I
I/O input/output

I/O scan An input/output scan continuously polls I/O modules to collect data bits and status, error, and diagnostics information. This process monitors inputs and controls outputs.

I/O terminal An input/output terminal on the front of an expansion I/O module connects input and output signals.

EIO0000000067 04/2012

293

Glossary

ICMP The internet control message protocol reports errors and provides information related to datagram processing.

IEC The international electrotechnical commission is a non-profit and non-governmental international standards organization that prepares and publishes international standards for all electrical, electronic, and related technologies.

IEC 61131-3 The IEC 61131-3 is an international electrotechnical commission standard for industrial automation equipment (like controllers). IEC 61131-3 deals with controller programming languages and defines 2 graphical and 2 textual programming language standards: z graphical: ladder diagram, function block diagram z textual: structured text, instruction list

IEEE The institute of electrical and electronics engineers is a non-profit international standards and conformity assessment body for advances in all fields of electrotechnology.

IEEE 802.3 IEEE 802.3 is a collection of IEEE standards defining the physical layer, and the media access control (MAC) sublayer of the data link layer, of wired Ethernet.

IL A program written in the instruction list language is composed of a series of instructions executed sequentially by the controller. Each instruction includes a line number, an instruction code, and an operand. (IL is IEC 61131-3 compliant.)

immediate addressing The direct method of addressing memory objects, including physical inputs and outputs, used in programming instructions as operands and parameters by using their direct address (for example, %Iwx or %QWx).

294

EIO0000000067 04/2012

Glossary

The use of immediate addressing in your program may avoid the need to create symbols for these objects, but there are also disadvantages. For example, if you change the program configuration by adding or deleting devices or I/O modules or slices, the immediate addresses used as programming instruction operands and/or parameters are not updated and must be corrected manually, which may cause extensive program modifications and lead to incorrect programming instructions. (See symbolic addressing.)

input filter An input filter is a special function that rejects input noises. It is useful for eliminating input noises and chatter in limit switches. All inputs provide a level of input filtering using the hardware. Additional filtering with software is also configurable through the programing or the configuration software.

input terminal An input terminal on the front of an expansion I/O module connects input signals from input devices (such as sensors, push buttons, and limit switches). For some modules, input terminals accept both sink and source DC input signals.

instruction list language (IL) Refer to IL.

INT A single integer is encoded in 16 bits.

IP The internet protocol is part of the TCP/IP protocol family that tracks the Internet addresses of devices, routes outgoing messages, and recognizes incoming messages.

IP 20 Ingress protection rating according to IEC 60529. IP20 modules are protected against ingress and contact of objects larger than 12.5 mm. The module is not protected against harmful ingress of water.

IP 67 Ingress protection rating according to IEC 60529. IP67 modules are completely protected against ingress of dust and contact. Ingress of water in harmful quantity is not possible when the enclosure is immersed in water up to 1m.
295

EIO0000000067 04/2012

Glossary

K
Kd derivative gain

Ki integral gain

Kp proportional gain

L
Ladder Diagram language See LD.

LAN A local area network local area network is a short-distance communications network that is implemented in a home, office, or institutional environment.

latching input A latching input module interfaces with devices that transmit messages in short pulses. Incoming pulses are captured and recorded for later examination by the application.

LCD liquid crystal display

LD A program in the ladder diagram language includes a graphical representation of instructions of a controller program with symbols for contacts, coils, and blocks in a series of rungs executed sequentially by a controller. IEC 61131-3 compliant.

LED A light emitting diode is an indicator that lights up when electricity passes through it.

296

EIO0000000067 04/2012

Glossary

LINT Long integer is a 64-bit variable (4 times INT or two times DINT).

LMC lexium motion control

load receiver device Part of instrument that will receive the load.

located variable A located variable has an address. (See unlocated variable.)

LRC longitudinal redundancy checking

LREAL Long real is a 64-bit variable.

LSB The least significant bit (or least significant byte) is the part of a number, address, or field that is written as the right-most single value in conventional hexadecimal or binary notation.

LWORD A long word type is encoded in a 64-bit format.

M
MAC address The media access control address is a unique 48-bit number associated with a specific piece of hardware. The MAC address is programmed into each network card or device when it is manufactured.

Machine A Machine consists of several functions and/or equipments which build the machine.

EIO0000000067 04/2012

297

Glossary

Magelis Magelis is the commercial name for Schneider Electrics range of HMI terminals.

MAST A master (MAST) task is a processor task that is run through its programming software. The MAST task has two sections: z IN: Inputs are copied to the IN section before execution of the MAST task. z OUT: Outputs are copied to the OUT section after execution of the MAST task.

master/slave The single direction of control in a network that implements the master/slave model is always from a master device or process to one or more slave devices.

maximum weight Maximum measuring capacity, not taking account of the additive capacity of the tare.

MIB The management information base is an object database that is monitored by a network management system like SNMP. SNMP monitors devices that are defined by their MIBs. Schneider has obtained a private MIB, groupeschneider (3833).

minimum I/O update time The minimum I/O update time is the minimum time it takes for the bus cycle to shut down to force an I/O update at each cycle.

minimum weight Load value under which measuring results can be marred by a relative detected error that is too large.

Modbus The Modbus communication protocol allows communications between many devices connected to the same network.

Modbus SL Modbus serial line

298

EIO0000000067 04/2012

Glossary

MSB The most significant bit (or most significant byte) is the part of a number, address, or field that is written as the left-most single value in conventional hexadecimal or binary notation.

N
NAK negative acknowledge

NC A normally closed contact is a contact pair that is closed when the actuator is deenergized (no power is applied) and open when the actuator is energized (power is applied).

NEC The national electric code dictates the safe installation of electrical wiring and equipment.

NEMA The national electrical manufacturers association publishes standards for the performance of various classes of electrical enclosures. The NEMA standards cover corrosion resistance, ability to protect from rain and submersion, etc. For IEC member countries, the IEC 60529 standard classifies the ingress protection rating for enclosures.

net weight (net) Weight indication of a load placed on an instrument after a tare device has been used. Net weight = Gross weight - Tare weight

network A network includes interconnected devices that share a common data path and protocol for communications.

Nibble A Nibble is a half-byte (representing 4 bits of a byte).

EIO0000000067 04/2012

299

Glossary

NMT Network management protocols provide services for network initialization, error control, and device status control.

NMT state machine A network management state machine defines the communication behavior of any CANopen device. The CANopen NMT state machine consists of an initialization state, a pre-operational state, an Operational state, and a stopped state. After power-on or reset, the device enters the initialization state. After the device initialization is finished, the device automatically enters the pre-operational state and announces the state transition by sending the boot-up message. In this manner, the device indicates that it is ready to work. A device that stays in pre-operational state may start to transmit SYNC-, Time Stamp-, or Heartbeat message. In this state, the device can not communicate through a PDO; it must do so with an SDO. In the operational state, the device can use all supported communication objects.

NO A normally open contact is a contact pair that is open when the actuator is deenergized (no power is applied) and closed when the actuator is energized (power is applied).

node A node is an addressable device on a communication network.

O
ODVA The open deviceNet vendors association supports the family of network technologies that are built on CIP (EtherNet/IP, DeviceNet, and CompoNet).

OS Operating system. Can be used for Firmware that can be uploaded/downloaded by the user.

OSI The open system interconnection reference model is a 7-layer model that describes network protocol communications. Each abstract layer receives services from the layer below it and provides services to the layer above.

300

EIO0000000067 04/2012

Glossary

OTB Optimized terminal block, used in the context of Advantys I/O distributed module

output terminal An output terminal connects output signals to output devices (such as electromechanical relays and solenoid valves).

P
pallet A pallet is a portable platform, which is used for storing or moving goods.

PCI A peripheral component interconnect is an industry-standard bus for attaching peripherals.

PDM A power distribution module distributes either AC or DC field power to a cluster of I/O modules.

PDO A process data object is transmitted as an unconfirmed broadcast message or sent from a producer device to a consumer device in a CAN-based network. The transmit PDO from the producer device has a specific identifier that corresponds to the receive PDO of the consumer devices.

PDU protocol data unit

PE Protective ground is a return line across the bus for fault currents generated at a sensor or actuator device in the control system.

EIO0000000067 04/2012

301

Glossary

periodic execution The master task is executed either cyclically or periodically. In periodic mode, you determine a specific time (period) in which the master task must be executed. If it is executed under this time, a waiting time is generated before the next cycle. If it is executed over this time, a control system indicates the overrun. If the overrun is too high, the controller is stopped.

persistent data Value of persistent data that will be used at next application change or cold start. Only get re-initialized at a reboot of the controller or reset origin. Especially they maintain their values after a download.

PI proportional integral

PID proportional, integral and derivative control

PLC The programmable logic controller is the brain of an industrial manufacturing process. It automates a process, used instead of relay control systems. PLCs are computers suited to survive the harsh conditions of the industrial environment.

PLCopen The PLCopen standard brings efficiency, flexibility, and manufacturer independence to the automation and control industry through the standardization of tools, libraries, and modular approaches to software programming.

PLI pulse latch input

post-configuration Post-configuration files contain machine-independent parameters, including: machine name z device name or IP address z Modbus serial line address z routing table
z

302

EIO0000000067 04/2012

Glossary

POU A program organization unit includes a variable declaration in source code and the corresponding instruction set. POUs facilitate the modular reuse of software programs, functions, and function blocks. Once declared, POUs are available to one another. SoMachine programming requires the utilization of POUs.

POU FB Program organization unit function block types are user programs that can be defined by the user in the ST, IL, LD, or FBD languages. You can use POU FB types in an application to:
z z z z

simplify the design and entry of the program make the program easier to read simplify debugging reduce the amount of generated code

power supply terminals The power supply is connected to these terminals to provide power to the controller.

Profibus DP Profibus Decentralized Peripheral An open bus system that uses an electrical network based on a shielded 2-wire line or an optical network based on a fiber-optic cable. DP transmission allows for highspeed, cyclic exchange of data between the controller CPU and the distributed I/O devices.

protocol A protocol is a convention or standard that controls or enables the connection, communication, and data transfer between two computing endpoints.

Pt100/Pt1000 Platinum resistance thermometer are characterized by their nominal resistance R0 at a temperature of 0 C. z Pt100 (R0 = 100 Ohm) z Pt1000 (R0 = 1 kOhm)

PTO Pulse train outputs are used to control for instance stepper motors in open loop.

EIO0000000067 04/2012

303

Glossary

PWM Pulse width modulation is used for regulation processes (e.g. actuators for temperature control) where a pulse signal is modulated in its length. For these kind of signals, transistor outputs are used.

R
RAM random access memory

REAL Real is a numeric data type. The REAL type is encoded in a 32-bit format.

real-time clock (RTC) See RTC

reflex output In a counting mode, the high speed counter current value is measured against its configured thresholds to determine the state of these dedicated outputs.

retained data A retained data value is used in the next power-on or warm start. The value is retained even after an uncontrolled shutdown of the controller or a normal switch-off of the controller.

RFID Radio-frequency identification is an automatic identification method that relies on the storage and remote retrieval of data using RFID tags or transponders.

RJ-45 This registered jack is a modular connector that is commonly implemented in communication networks.

RPDO A receive PDO sends data to a device in a CAN-based network.

304

EIO0000000067 04/2012

Glossary

RPM revolutions per minute

RPS revolutions per second

RS-232 RS-232 (also known as EIA RS-232C or V.24) is a standard type of serial communication bus, based on three wires.

RS-485 RS-485 (also known as EIA RS-485) is a standard type of serial communication bus, based on two wires.

RTC The real-time clock option keeps the time for a limited amount of time even when the controller is not powered.

RTS Request to send is a data transmission signal and will be acknowledged by the CTS signal from the destination node.

RTU A remote terminal unit is a device that interfaces with objects in the physical world to a distributed control system or SCADA system by transmitting telemetry data to the system and/or altering the state of connected objects based on control messages received from the system.

RxD receiving data (data transmission signal)

S
SCADA A supervisory control and data acquisition system monitors, manages, and controls industrial applications or processes.

EIO0000000067 04/2012

305

Glossary

scale division Value in mass units, expressing the difference between two consecutive indications for one numerical indication.

scan A controller scanning program performs 3 basic functions: [1] It reads inputs and places these values in memory; [2] it executes the application program 1 instruction at a time and stores results in memory; [3] It uses the results to update outputs.

SDO A service data object message is used by the field bus master to access (read/write) the object directories of network nodes in CAN-based networks. SDO types include service SDOs (SSDOs) and client SDOs (CSDOs).

SEL-V A system that follows IEC 61140 guidelines for safety extra low voltage is protected in such a way that voltage between any 2 accessible parts (or between 1 accessible part and the PE terminal for Class 1 equipment) does not exceed a specified value under normal conditions or under single-fault conditions.

Sequential Function Chart See SFC.

SFC A program written in the sequential function chart language can be used for processes that can be split into steps. SFC is composed of steps with associated actions, transitions with associated logic condition, and directed links between steps and transitions. (The SFC standard is defined in IEC 848. It is IEC 61131-3 compliant.)

sink input A sink input is a wiring arrangement in which the device provides current to the input electronic module. A sink input is referenced to 0 Vdc.

SINT Signed integer is a 16-bit value.

SL serial line
306
EIO0000000067 04/2012

Glossary

SMS The short message service is a standard communication service for telephones (or other devices) that send short text messages over the mobile communications system.

SNMP The simple network management protocol can control a network remotely by polling the devices for their status, performing security tests, and viewing information relating to data transmission. It can also be used to manage software and databases remotely. The protocol also permits active management tasks, such as modifying and applying a new configuration

source output A source output is a wiring arrangement in which the output electronic module provides current to the device. A source output is referenced to +24 Vdc.

SSI Serial synchronous interface is a common interface for relative and absolute measurement systems like encoders.

ST See structured text.

STN Scan Twisted Nematic (also known as passive matrix)

STRING A STRING variable is a series of ASCII characters. Structured Text A program written in the structured text (ST) language includes complex statements and nested instructions (such as iteration loops, conditional executions, or functions). ST is compliant with IEC 61131-3.

symbol A symbol is a string of a maximum of 32 alphanumeric characters, of which the first character is alphabetic. It allows you to personalize a controller object to facilitate the maintainability of the application.

EIO0000000067 04/2012

307

Glossary

symbolic addressing The indirect method of addressing memory objects, including physical inputs and outputs, used in programming instructions as operands and parameters by first defining symbols for them using these symbols in association with the programming instructions. In contrast to immediate addressing, this is the recommended method because if the program configuration changes, symbols are automatically updated with their new immediate address associations, whereas any immediate addresses used as operands or parameters are not. (See immediate addressing.)

system time An internal clock provides a device with the system time.

system variable A system variable structure provides controller data and diagnostic information and allows sending commands to the controller.

T
TAP A terminal access point is a junction box connected to the trunk cable that allows you to plug in drop cables.

tare Load placed on the load receiver along with the product to be weighed.

tare device Device allowing the instrument indication to be moved to zero when a load is positioned on the load receiver:

tare predefining device Device allowing a predefined tare value to be subtracted from a gross weight value and indicating the result of the calculation. The load range is consequently reduced.

Tare Value Weight value of a load, determined by a tare full-bridge strain gauge electronic module.

308

EIO0000000067 04/2012

Glossary

taring Action allowing the instrument indication to be moved to zero when a load is positioned on the load receiver.

task A group of sections and subroutines, executed cyclically or periodically for the MAST task, or periodically for the FAST task. A task possesses a level of priority and is linked to inputs and outputs of the controller. These I/O are refreshed in consequence. A controller can have several tasks.

TCP A transmission control protocol is a connection-based transport layer protocol that provides a reliable simultaneous bi-directional transmission of data. TCP is part of the TCP/IP protocol suite.

terminal block The terminal block is the component that mounts in an electronic module and provides electrical connections between the controller and the field devices.

TFT thin film transmission (also known as active matrix)

threshold output Threshold outputs are controlled directly by the HSC according to the settings established during configuration.

TP A touch probe is a position capture that is triggered by a fast input signal (quick sensor). On the rising edge of the touch probe input the position of an encoder is captured. Example: This is used for packaging machines to capture the position of a printmark on a film to cut always on the same position.

TPDO A transmit PDO reads data from a device in a CAN-based system.

EIO0000000067 04/2012

309

Glossary

trunk cable A trunk cable is the main cable that is terminated at both physical ends with line termination resistors.

TVDA tested validated documented architectures

TxD TxD represents a transmit signal.

U
UDINT An unsigned double integer is encoded in 32 bits.

UDP The user datagram protocol is a connectionless mode protocol (defined by IETF RFC 768) in which messages are delivered in a datagram (data telegram) to a destination computer on an IP network. The UDP protocol is typically bundled with the Internet Protocol. UDP/IP messages do not expect a response, and are therefore ideal for applications in which dropped packets do not require retransmission (such as streaming video and networks that demand real-time performance).

UINT An unsigned integer is encoded in 16 bits.

UL Underwriters Laboratories, US organization for product testing and safety certification.

unlocated variable An unlocated variable does not have an address. (See located variable.)

UTC coordinated universal time

310

EIO0000000067 04/2012

Glossary

V
VSD variable speed drive

W
WORD The WORD type is encoded in a 16-bit format.

EIO0000000067 04/2012

311

Glossary

312

EIO0000000067 04/2012

SoMachine Index EIO0000000067 04/2012

Index

B C A
command Build All, 172 Change Device, 166 Export Vijeo-Designer project, 181 Import Vijeo-Designer project, 181 Remote connection, 176 commands single access, 171 Commission machine - start with project, 45 Commission machine - upload project from device, 47 Commissioning, 236 Communication manager configuration, 113 communication managers, 76 Configuration, 64 configuration diagnostic, 116 configuring devices, 73 consistency, 85 Create Boot Application, 173 Create new machine, 33 creating libraries, 138 Custom Information, 61 Customer Image, 59 Customer Service Tool, 246

A
Add application, 83 adding controllers, 110 adding devices, 71 analog inputs CANopen, 262 applications, 83 AS-Interface, 79 AS-Interface configurations, 155 ASCII Managers, 149 attachments, 61

B
Boot Application, 227 boot applications, 173 Browse for existing project, 28 Build All command, 172

C
CANopen analog inputs, 262 CANopen devices, 113 CANopen interface, 143 Change Device command, 166 changing the project name, 58 close project, 26 closing projects, 23 Collapse All, 69

D
deleting devices, 71 device templates, 205, 206 devices adding, 115 display manager, 69
313

EIO0000000067 04/2012

Index

displaying panes, 23 download, 227 Boot Application, 227

I
IEC Objects fieldbus Diagnostic/O mapping, 115 images, 59 import Vijeo-Designer projects, 181 import command, 181 information pane, 23

E
Ethernet configurations, 140 Expand All, 69 Expand Last, 69 expansion modules, 79, 111, 112 export Vijeo-Designer projects, 181 export command, 181

L
language setting, 23 Learning Center, 52 libraries, 120, 123 adding libraries, 97 library creation, 138 Library Manager, 120 Library Repository, 120 login, 227 login/logout, 239

F
FFB Finder, 162 field devices configuration, 113 fieldbus health information, 115 fieldbus manager adding slave devices, 77 fieldbusses supported by templates, 195 firmware check, 231 Function and Function Block Finder, 162 function templates, 218

M
main selection screen, 23 menus, 260 message window, 23 Modbus configurations, 149 Modbus IOScanners, 149 Modbus Managers, 149 Modbus SL devices, 113 Multiple Download task, 244

G
general functions, 26 graphical configuration editor, 69 graphical user interface elements, 23 GUI elements, 23

N H
handles, 23 health information fieldbus, 115 heartbeat settings, 143 hiding panes, 23 network connections, 85 Network Managers, 149 nodeguarding settings, 143 NVL considerations, 108 controllers supporting NVL, 108 network variables list, 106

314

EIO0000000067 04/2012

Index

O
online help, 23 OPC server, 268 OPC Server 3, 267 OPC server configuration, 273

P
placeholder concept, 97 Preferences, 26 Profibus DP configurations, 152 Program, 90 programming logic, 83 projects close, 23 Properties tab, 56 Protocol Managers, 149 publishing variables, 187 publishing variables (HMI), 189

Source Download, 246 standard project, 34 Start with application, 40 Start with empty project, 36 Start with existing project, 42 Start with standard project, 34 Start with TVD Architecture, 37 startup performance of SoMachine, 264 startup window, 23 stop, 230 symbol configuration, 102

T
task Multiple Download, 244 Restore data, 247 Save data, 247 task selection pane, 23 tasks adding, 94 template libraries, 205 templates, 192 TVD architecture, 37

R
Remote connection command, 176 Report tab, 251 Reroute, 69 Reroute On Drop, 69 Restore data task, 247 run, 230

U
Update Device Version, 83 Update firmware, 50, 83 USB Mass Storage, 174

S
Save data task, 247 save project, 26 saving the project to a different folder, 58 saving to USB mass storage device, 174 selecting variables, 188 Serial Line configurations, 149 Set active application, 83 set active path automatically, 239 shortcuts, 260 Show All, 69 Show existing machine, 28 single access commands, 171 slave devices, 77
EIO0000000067 04/2012

V
variable definition, 183 variable types, 183 variables persistent, 100 publishing, 187 publishing (HMI), 189 remanent, 100 visualizations, 209

W
work area, 23
315

Index

316

EIO0000000067 04/2012