SoMachine Basic

EIO0000001354 12/2015

SoMachine Basic
Operating Guide

EIO0000001354.06

12/2015

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.
2015 Schneider Electric. All rights reserved.

EIO0000001354 12/2015

Table of Contents
Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Part I Getting Started with SoMachine Basic . . . . . . . . .

Chapter 1 Introduction to SoMachine Basic . . . . . . . . . . . . . . . . .
1.1 System Requirements and Supported Devices . . . . . . . . . . . . . . . . . .
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported Programming Languages. . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 SoMachine Basic User Interface Basics . . . . . . . . . . . . . . . . . . . . . . .
Creating Projects With SoMachine Basic . . . . . . . . . . . . . . . . . . . . . .
Developing Programs With SoMachine Basic . . . . . . . . . . . . . . . . . . .
Navigating Within SoMachine Basic . . . . . . . . . . . . . . . . . . . . . . . . . .
Operating Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 2 Starting with SoMachine Basic . . . . . . . . . . . . . . . . . . .

2.1 The Start Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction to the Start Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Registering the SoMachine Basic Software . . . . . . . . . . . . . . . . . . . .
Projects Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connect Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Project Templates Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Directly Downloading an Application . . . . . . . . . . . . . . . . . . . . . . . . . .
Memory Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Part II Developing SoMachine Basic Applications . . . . .

Chapter 3 The SoMachine Basic Window . . . . . . . . . . . . . . . . . . .
3.1 Overview of the SoMachine Basic Window . . . . . . . . . . . . . . . . . . . . .
Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 4 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.1 Overview of the Properties Window . . . . . . . . . . . . . . . . . . . . . . . . . .
The Properties Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

EIO0000001354 12/2015

7
9
17
19
20
21
22
24
25
26
27
28
29
31
32
33
34
35
36
40
41
42
43
45
46
47
49
51
53
55
56
57
58

Chapter 5 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5.1 Overview of the Configuration Window . . . . . . . . . . . . . . . . . . . . . . . .
Overview of the Configuration Window . . . . . . . . . . . . . . . . . . . . . . . .
Building a Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 6 Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.1 Overview of the Programming Workspace. . . . . . . . . . . . . . . . . . . . . .
Overview of the Programming Workspace. . . . . . . . . . . . . . . . . . . . . .
6.2 Special Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Symbolic Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Memory Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ladder/List Reversibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.3 Configuring Program Behavior and Tasks . . . . . . . . . . . . . . . . . . . . . .
Application Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tasks and Scan Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.4 Managing POUs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Managing POUs with Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Managing Rungs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Managing Grafcet (SFC) POUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Free POUs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.5 Master Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Master Task Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Master Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.6 Periodic Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating Periodic Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Periodic Task Scan Duration . . . . . . . . . . . . . . . . . . . . . .
6.7 Event Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of Event Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating Event Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.8 Using Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Animation Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Memory Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
I/O Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4

61
62
63
64
65
66
66
67
68
69
71
72
78
79
82
85
86
87
89
92
94
97
98
99
101
102
104
105
106
107
108
109
112
113
115
118
121
122

EIO0000001354 12/2015

6.9

6.10

6.11

6.12

6.13

Network Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Software Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PTO Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Communication Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Search and Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Symbol List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Memory Consumption View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rung Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ladder Language Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction to Ladder Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming Principles for Ladder Diagrams. . . . . . . . . . . . . . . . . . .
Ladder Diagram Graphic Elements . . . . . . . . . . . . . . . . . . . . . . . . . . .
Comparison Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operation Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instruction List Programming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of Instruction List Programs. . . . . . . . . . . . . . . . . . . . . . . . .
Operation of List Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List Language Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Parentheses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Grafcet (List) Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description of Grafcet (List) Programming . . . . . . . . . . . . . . . . . . . . .
Grafcet Program Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Use Grafcet Instructions in a SoMachine Basic Program . . . .
Grafcet (SFC) Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction to Grafcet (SFC) Programming . . . . . . . . . . . . . . . . . . . .
Using the Grafcet (SFC) Graphical Editor . . . . . . . . . . . . . . . . . . . . . .
Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Programming Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Debugging in Online Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trace Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Forcing Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Online Mode Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 7 Commissioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7.1 Overview of the Commissioning Window . . . . . . . . . . . . . . . . . . . . . .
Overview of the Commissioning Window . . . . . . . . . . . . . . . . . . . . . .
EIO0000001354 12/2015

123
124
125
126
127
129
133
135
137
138
140
141
147
148
149
150
153
154
156
157
161
164
165
166
169
171
172
175
178
182
183
184
186
187
188
191
192
192
5

7.2 Connect to a Logic Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Connecting to a Logic Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Downloading and Uploading Applications . . . . . . . . . . . . . . . . . . . . . .
7.3 Controller Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Controller Firmware Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7.4 Memory Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating and Reading Logic Controller Images . . . . . . . . . . . . . . . . . .
Managing Logic Controller Memory . . . . . . . . . . . . . . . . . . . . . . . . . . .
7.5 Controller Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Controller Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7.6 RTC Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Managing the RTC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 8 Simulator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of the SoMachine Basic Simulator . . . . . . . . . . . . . . . . . . . .
SoMachine Basic Simulator I/O Manager Window . . . . . . . . . . . . . . .
SoMachine Basic Simulator Time Management Window . . . . . . . . . .
Modifying Values Using SoMachine Basic Simulator. . . . . . . . . . . . . .
How to Use the SoMachine Basic Simulator . . . . . . . . . . . . . . . . . . . .
Launching Simulation in Vijeo-Designer . . . . . . . . . . . . . . . . . . . . . . .

Chapter 9 Saving Projects and Closing SoMachine Basic . . . . .

Saving a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Saving a Project As a Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Closing SoMachine Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A SoMachine Basic Keyboard Shortcuts . . . . . . . . . . . .
SoMachine Basic Keyboard Shortcuts. . . . . . . . . . . . . . . . . . . . . . . . .

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

193
194
198
200
200
201
202
205
207
207
209
209
211
212
214
216
218
222
223
225
226
227
228
229
231
231
237
241

EIO0000001354 12/2015

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.

EIO0000001354 12/2015

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.

EIO0000001354 12/2015

About the Book

At a Glance
Document Scope
This guide describes how to use the SoMachine Basic software to configure, program, and
commission applications for supported logic controllers.
Validity Note
The information in this manual is applicable only for SoMachine Basic products.
This document has been updated for the release of SoMachine Basic V1.4.
The technical characteristics of the devices described in this document also appear online. To
access this information online:
Step

Action

Go to the Schneider Electric home page www.schneider-electric.com.

In the Search box type the reference of a product or the name of a product range.
Do not include blank spaces in the reference or product range.
To get information on grouping similar modules, use asterisks (*).

If you entered a reference, go to the Product Datasheets search results and click on the
reference that interests you.
If you entered the name of a product range, go to the Product Ranges search results and click
on the product range that interests you.

If more than one reference appears in the Products search results, click on the reference that
interests you.

Depending on the size of your screen, you may need to scroll down to see the data sheet.

To save or print a data sheet as a .pdf file, click Download XXX product datasheet.

The characteristics that are presented in this manual should be the same as those characteristics
that appear online. In line with our policy of constant improvement, we may revise content over time
to improve clarity and accuracy. If you see a difference between the manual and online information,
use the online information as your reference.

EIO0000001354 12/2015

Related Documents
Title of Documentation

Reference Number

SoMachine Basic Generic Functions - Library Guide

EIO0000001474 (ENG)
EIO0000001475 (FRA)
EIO0000001476(GER)
EIO0000001477 (SPA)
EIO0000001478 (ITA)
EIO0000001479 (CHS)
EIO0000001480 (POR)
EIO0000001481 (TUR)

Modicon M221 Logic Controller Advanced Functions - Library Guide EIO0000002007 (ENG)
EIO0000002008 (FRE)
EIO0000002009(GER)
EIO0000002010 (SPA)
EIO0000002011 (ITA)
EIO0000002012 (CHS)
EIO0000002013 (TUR)
EIO0000002014 (POR)

10

Modicon M221 Logic Controller - Programming Guide

EIO0000001360 (ENG)
EIO0000001361 (FRE)
EIO0000001362 (GER)
EIO0000001363 (SPA)
EIO0000001364 (ITA)
EIO0000001365 (CHS)
EIO0000001369 (TUR)
EIO0000001368 (POR)

Modicon M221 Logic Controller - Hardware Guide

EIO0000001384 (ENG)
EIO0000001385 (FRA)
EIO0000001386 (GER)
EIO0000001387 (SPA)
EIO0000001388 (ITA)
EIO0000001389 (CHS)
EIO0000001370 (POR)
EIO0000001371 (TUR)

Modicon TMC2 Cartridge - Programming Guide

EIO0000001782 (ENG)
EIO0000001783 (FRA)
EIO0000001784 (GER)
EIO0000001785 (SPA)
EIO0000001786 (ITA)
EIO0000001787 (CHS)
EIO0000001788 (POR)
EIO0000001789 (TUR)

EIO0000001354 12/2015

Title of Documentation

Reference Number

Modicon TMC2 Cartridge - Hardware Guide

EIO0000001768 (ENG)
EIO0000001769 (FRE)
EIO0000001770 (GER)
EIO0000001771 (SPA)
EIO0000001772 (ITA)
EIO0000001773 (CHS)
EIO0000001775 (TUR)
EIO0000001774 (POR)

Modicon TM3 Expansion Modules Configuration - Programming

Guide

EIO0000001396 (ENG)
EIO0000001397 (FRA)
EIO0000001398 (GER)
EIO0000001399 (SPA)
EIO0000001400 (ITA)
EIO0000001401 (CHS)
EIO0000001374 (POR)
EIO0000001375 (TUR)

Modicon TM3 Digital I/O Modules - Hardware Guide

EIO0000001408 (ENG)
EIO0000001409 (FRA)
EIO0000001410 (GER)
EIO0000001411 (SPA)
EIO0000001412 (ITA)
EIO0000001413 (CHS)
EIO0000001376 (POR)
EIO0000001377 (TUR)

Modicon TM3 Analog I/O Modules - Hardware Guide

EIO0000001414 (ENG)
EIO0000001415 (FRA)
EIO0000001416 (GER)
EIO0000001417 (SPA)
EIO0000001418 (ITA)
EIO0000001419 (CHS)
EIO0000001378 (POR)
EIO0000001379 (TUR)

Modicon TM3 Expert Modules - Hardware Guide

EIO0000001420 (ENG)
EIO0000001421 (FRA)
EIO0000001422 (GER)
EIO0000001423 (SPA)
EIO0000001424 (ITA)
EIO0000001425 (CHS)
EIO0000001380 (POR)
EIO0000001381 (TUR)

EIO0000001354 12/2015

11

Title of Documentation

Reference Number

Modicon TM3 Safety Modules - Hardware Guide

EIO0000001831 (ENG)
EIO0000001832 (FRA)
EIO0000001833 (GER)
EIO0000001834 (SPA)
EIO0000001835 (ITA)
EIO0000001836 (CHS)
EIO0000001837 (POR)
EIO0000001838 (TUR)

Modicon TM3 Transmitter and Receiver Modules - Hardware Guide

EIO0000001426 (ENG)
EIO0000001427 (FRA)
EIO0000001428 (GER)
EIO0000001429 (SPA)
EIO0000001430 (ITA)
EIO0000001431 (CHS)
EIO0000001382 (POR)
EIO0000001383 (TUR)

Modicon TM2 Expansion Modules Configuration - Programming

Guide

EIO0000000396 (ENG)
EIO0000000397 (FRE)
EIO0000000398 (GER)
EIO0000000399 (SPA)
EIO0000000400 (ITA)
EIO0000000401 (CHS)

Modicon TM2 Digital I/O Modules - Hardware Guide

EIO0000000028 (ENG)
EIO0000000029 (FRA)
EIO0000000030 (GER)
EIO0000000031 (SPA)
EIO0000000032 (ITA)
EIO0000000033 (CHS)

Modicon TM2 Analog I/O Modules - Hardware Guide

EIO0000000034 (ENG)
EIO0000000035 (FRA)
EIO0000000036 (GER)
EIO0000000037 (SPA)
EIO0000000038 (ITA)
EIO0000000039 (CHS)

SR2MOD02 and SR2MOD03 Wireless Modem - User Guide

EIO0000001575 (ENG)

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

12

EIO0000001354 12/2015

Product Related Information

WARNING
LOSS OF CONTROL

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.
1

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.

WARNING
UNINTENDED EQUIPMENT OPERATION

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.
Terminology Derived from Standards
The technical terms, terminology, symbols and the corresponding descriptions in this manual, or
that appear in or on the products themselves, are generally derived from the terms or definitions
of international standards.
In the area of functional safety systems, drives and general automation, this may include, but is not
limited to, terms such as safety, safety function, safe state, fault, fault reset, malfunction, failure,
error, error message, dangerous, etc.

EIO0000001354 12/2015

13

Among others, these standards include:

Standard

Description

EN 61131-2:2007

Programmable controllers, part 2: Equipment requirements and tests.

ISO 13849-1:2008

Safety of machinery: Safety related parts of control systems.

General principles for design.

EN 61496-1:2013

Safety of machinery: Electro-sensitive protective equipment.

Part 1: General requirements and tests.

ISO 12100:2010

Safety of machinery - General principles for design - Risk assessment and risk
reduction

EN 60204-1:2006

Safety of machinery - Electrical equipment of machines - Part 1: General

requirements

EN 1088:2008
ISO 14119:2013

Safety of machinery - Interlocking devices associated with guards - Principles

for design and selection

ISO 13850:2006

Safety of machinery - Emergency stop - Principles for design

EN/IEC 62061:2005

Safety of machinery - Functional safety of safety-related electrical, electronic,

and electronic programmable control systems

IEC 61508-1:2010

Functional safety of electrical/electronic/programmable electronic

safety-related systems: General requirements.

IEC 61508-2:2010

Functional safety of electrical/electronic/programmable electronic

safety-related systems: Requirements for electrical/electronic/programmable
electronic safety-related systems.

IEC 61508-3:2010

Functional safety of electrical/electronic/programmable electronic

safety-related systems: Software requirements.

IEC 61784-3:2008

Digital data communication for measurement and control: Functional safety

field buses.

2006/42/EC

Machinery Directive

2004/108/EC

Electromagnetic Compatibility Directive

2006/95/EC

Low Voltage Directive

In addition, terms used in the present document may tangentially be used as they are derived from
other standards such as:

14

Standard

Description

IEC 60034 series

Rotating electrical machines

IEC 61800 series

Adjustable speed electrical power drive systems

IEC 61158 series

Digital data communications for measurement and control Fieldbus for use in
industrial control systems

EIO0000001354 12/2015

Finally, the term zone of operation may be used in conjunction with the description of specific
hazards, and is defined as it is for a hazard zone or danger zone in the EC Machinery Directive
(EC/2006/42) and ISO 12100:2010.
NOTE: The aforementioned standards may or may not apply to the specific products cited in the
present documentation. For more information concerning the individual standards applicable to the
products described herein, see the characteristics tables for those product references.

EIO0000001354 12/2015

15

16

EIO0000001354 12/2015

SoMachine Basic
Getting Started with SoMachine Basic
EIO0000001354 12/2015

Part I
Getting Started with SoMachine Basic

Getting Started with SoMachine Basic

What Is in This Part?
This part contains the following chapters:
Chapter

Chapter Name

Page

Introduction to SoMachine Basic

19

Starting with SoMachine Basic

31

EIO0000001354 12/2015

17

Getting Started with SoMachine Basic

18

EIO0000001354 12/2015

SoMachine Basic
Introduction to SoMachine Basic
EIO0000001354 12/2015

Chapter 1
Introduction to SoMachine Basic

Introduction to SoMachine Basic

What Is in This Chapter?
This chapter contains the following sections:
Section

Topic

Page

1.1

System Requirements and Supported Devices

20

1.2

SoMachine Basic User Interface Basics

25

EIO0000001354 12/2015

19

Introduction to SoMachine Basic

Section 1.1
System Requirements and Supported Devices

System Requirements and Supported Devices

What Is in This Section?
This section contains the following topics:
Topic

20

Page

System Requirements

21

Supported Devices

22

Supported Programming Languages

24

EIO0000001354 12/2015

Introduction to SoMachine Basic

System Requirements
Overview
The minimum system requirements for the PC on which SoMachine Basic software is installed are:
Intel Core 2 Duo processor or greater
1 GB RAM
Display resolution 1280 x 768 pixels or higher
The 32- or 64-bit version of one of the following operating systems:
Microsoft Windows XP Service Pack 3
Microsoft Windows 7
Microsoft Windows 8

EIO0000001354 12/2015

21

Introduction to SoMachine Basic

Supported Devices
M221 Logic Controllers
For more information about the M221 logic controller configuration, refer to the following
programming and hardware guides:
Logic Controller Type

Hardware Guide

Programming Guide

M221 Logic Controllers

Modicon M221 Logic Controller

Hardware Guide

Modicon M221 Logic Controller

Programming Guide

TM3 Expansion Modules

For more information about module configuration, refer to the following programming and
hardware guides of each expansion module type:
Expansion Module Type

Hardware Guide

Programming Guide

TM3 Digital I/O Expansion Modules

TM3 Digital I/O Expansion Modules

Hardware Guide

TM3 Expansion Modules

Programming Guide

TM3 Analog I/O Expansion Modules

TM3 Analog Modules Hardware Guide

TM3 Expert I/O Expansion Modules

TM3 Expert I/O Modules Hardware

Guide

TM3 Safety Modules

TM3 Safety Modules Hardware Guide

TM3 Transmitter and Receiver Modules TM3 Transmitter and Receiver

Modules Hardware Guide

TM2 Expansion Modules

For more information about module configuration, refer to the programming and hardware guides
of each expansion module type:
Expansion Module Type

Hardware Guide

Programming Guide

TM2 Digital I/O Modules

TM2 Digital I/O Modules Hardware

Guide

TM2 Expansion Modules

Programming Guide

TM2 Analog I/O Modules

TM2 Analog I/O Modules Hardware

Guide

TMC2 Cartridges
For more information about cartridge configuration, refer to the following programming and
hardware guides:
Cartridge Type

Hardware Guide

Programming Guide

TMC2 Cartridges

TMC2 Cartridges Hardware Guide

TMC2 Cartridges Programming

Guide

22

EIO0000001354 12/2015

Introduction to SoMachine Basic

TMH2GDB Remote Graphic Display

For information about the Remote Graphic Display installation, compatibility, configuration, and
operation, refer to the following guide:
Display Type

User Guide

Remote Graphic Display

TMH2GDB Remote Graphic Display User Guide

EIO0000001354 12/2015

23

Introduction to SoMachine Basic

Supported Programming Languages

Overview
A programmable logic controller reads inputs, writes outputs, and solves logic based on a control
program. Creating a control program for a logic controller consists of writing a series of instructions
in one of the supported programming languages.
SoMachine Basic supports the following IEC-61131-3 programming languages:
Ladder Diagram language
Instruction List language
Grafcet (List)
Grafcet (SFC)

24

EIO0000001354 12/2015

Introduction to SoMachine Basic

Section 1.2
SoMachine Basic User Interface Basics

SoMachine Basic User Interface Basics

What Is in This Section?
This section contains the following topics:
Topic

Page

Creating Projects With SoMachine Basic

26

Developing Programs With SoMachine Basic

27

Navigating Within SoMachine Basic

28

Operating Modes

29

EIO0000001354 12/2015

25

Introduction to SoMachine Basic

Creating Projects With SoMachine Basic

Overview
SoMachine Basic is a graphical programming tool designed to make it easy to configure, develop,
and commission programs for logic controllers.
Some Essential Terminology
SoMachine Basic uses the following terms:
Project: A SoMachine Basic project contains details about the developer and purpose of the
project, the configuration of the logic controller and associated expansion modules targeted by
the project, the source code of a program, symbols, comments, documentation, and all other
related information.
Application: Contains all parts of the project that are downloaded to the logic controller,
including the compiled program, hardware configuration information, and non-program data
(project properties, symbols, and comments).
Program: The compiled source code that runs on the logic controller.
POU (program organization unit): The reusable object that contains a variable declaration and
a set of instructions used in a program.

26

EIO0000001354 12/2015

Introduction to SoMachine Basic

Developing Programs With SoMachine Basic

Introduction
The following diagram shows the typical stages of developing a project in SoMachine Basic (the
Configuration, Programming and Commissioning tabs):

EIO0000001354 12/2015

27

Introduction to SoMachine Basic

Navigating Within SoMachine Basic

Start Page
The Start Page window is always displayed when you launch SoMachine Basic. Use this window
to register your SoMachine Basic software, manage the connection to the logic controller, and
create or select a project to work with.
Module Areas
Once you have selected a project to work with, SoMachine Basic displays the main window.
At the top of the main window, a toolbar (see page 47) contains icons that allow you to perform
common tasks, including returning to the Start Page window.
Next to the toolbar, the status bar (see page 49) displays informational messages about the
current state of the connection to the logic controller.
Below this, the main window is divided into a number of modules. Each module controls a different
stage of the development cycle, and is accessible by clicking a tab at the top of the module area.
To develop an application, work your way through the modules from left to right:
Properties (see page 55)
Set up the project properties
Configuration (see page 61)
Define the hardware configuration of the logic controller and associated expansion modules
Programming (see page 65)
Develop your program in one of the supported programming languages
Commissioning (see page 191)
Manage the connection between SoMachine Basic and the logic controller, upload/download
applications, test, and commission the application.

28

EIO0000001354 12/2015

Introduction to SoMachine Basic

Operating Modes
Introduction
The operating modes provide control to develop, debug, monitor, and modify the application when
the controller is connected or not connected to SoMachine Basic.
SoMachine Basic can operate in the following modes.
Offline mode
Online mode
Simulator mode

Offline Mode
SoMachine Basic operates in offline mode when no physical connection to a logic controller has
been established.
In offline mode, you configure SoMachine Basic to match the hardware components you are
targeting, then develop your application.
Online Mode
SoMachine Basic operates in online mode if:
a logic controller is physically connected to the PC.
SoMachine Basic is simulating a virtual logic controller (known as simulator mode).

In online mode, you can proceed to download your application to the logic controller (downloading
and uploading application is not possible in the simulator mode because the application is directly
saved in the simulated logic controller). SoMachine Basic then synchronizes the application in the
PC memory with the version stored in the logic controller, allowing you to debug, monitor, and
modify the application.
You cannot modify a program in online mode.
NOTE: Online program modifications are subjected to the predefined configuration. See Memory
Management (see page 42). In addition, refer to Debugging in Online Mode (see page 183) for
more information.
Simulator Mode
SoMachine Basic operates in simulator mode when a connection has been established with a
simulated logic controller. In simulator mode, no physical connection to a logic controller is
established; instead SoMachine Basic simulates a connection to a logic controller and the
expansion modules to run and test the program.
For more information, refer to SoMachine Basic Simulator.

EIO0000001354 12/2015

29

Introduction to SoMachine Basic

30

EIO0000001354 12/2015

SoMachine Basic
Starting with SoMachine Basic
EIO0000001354 12/2015

Chapter 2
Starting with SoMachine Basic

Starting with SoMachine Basic

EIO0000001354 12/2015

31

Starting with SoMachine Basic

Section 2.1
The Start Page

The Start Page

What Is in This Section?
This section contains the following topics:
Topic

32

Page

Introduction to the Start Page

33

Registering the SoMachine Basic Software

34

Projects Window

35

Connect Window

36

Project Templates Window

40

Directly Downloading an Application

41

Memory Management

42

EIO0000001354 12/2015

Starting with SoMachine Basic

Introduction to the Start Page

Overview
The Start Page window is always the first window that is displayed when you start SoMachine
Basic.
The Start Page window has the following windows:
Register (see page 34)
To register SoMachine Basic software and view license details.
Projects (see page 35)
To create a new project or open an existing project.
Connect (see page 36)
To connect to a logic controller, download/upload application to/from the controller, back
up/restore controller memory, and to flash the LEDs of the connected controller.
Templates (see page 40)
To create a new project using an example project as a template.
Help
To display the online help.
About
To display information about SoMachine Basic.
Exit
To exit from SoMachine Basic.

EIO0000001354 12/2015

33

Starting with SoMachine Basic

Registering the SoMachine Basic Software

Overview
You can use the SoMachine Basic software for 30 days before you are required to register the
software. When you register, you receive an authorization code to use the software.
Registering your SoMachine Basic software entitles you to receive technical support and software
updates.
Registering
To register your SoMachine Basic software:
Step

Action

Click the Register now button at the top of the Start Page window.

Follow the instructions on the Registration Wizard. Click the Help button for more details.

To view details on the license key installed on your PC, click About on the Start Page window.

34

EIO0000001354 12/2015

Starting with SoMachine Basic

Projects Window
Overview
Use the Projects window to create a new SoMachine Basic project or to open an existing
SoMachine Basic, TwidoSoft, or TwidoSuite project to work with.
The right-hand area of the Projects window contains links to additional useful information.
Opening a SoMachine Basic Project File
Follow these steps to open a project file:
Step

Action

Click Projects on the Start Page window.

Do one of the following:

Click a recent project in the Recent projects list.
Click Create a new project.
Click Open an existing project and select an existing SoMachine Basic project file (*.smbp)
or a sample project file (*.smbe).
Result: The project file opens and the Configuration tab is displayed.

Opening a TwidoSuite or TwidoSoft Project File

SoMachine Basic allows you to open applications created for Twido programmable controllers and
convert them to SoMachine Basic project files.
Follow these steps to open a TwidoSuite or TwidoSoft project file:
Step

Action

Click Projects on the Start Page window.

Click Open an existing project, select any of the following in the Files of type list, and then
browse and select an existing project with respective extension:
TwidoSuite Project Files (*.xpr)
Twido Archive Project Files (*.xar)
TwidoSoft Project Files (*.twd)
Result: The selected project file opens and the Configuration tab is displayed.

NOTE: TwidoSuite uses %I0.0.1 (or %I0.0.7) as the Pulse input on the Very Fast Counter
(%VFC) function block. In SoMachine Basic the equivalent High Speed Counter (%HSC) function
block uses %I0.0 (or %I0.6). Make appropriate modifications to your applications after
conversion.

EIO0000001354 12/2015

35

Starting with SoMachine Basic

Connect Window
Connected Devices
The Connect window presents two lists of devices:
1. Local Devices
Displays all devices connected to the PC giving access to logic controllers:
via the physical COM ports of the PC (COM1, for example)
via USB cables
via the virtualized COM ports (by USB-to-serial converters or Bluetooth dongles)
via modem(s) and associated telephone number(s) that you manually add to this list
NOTE: If a COM port is selected and the Keep Modbus driver parameters check box is
activated, the communication is established with the parameters defined in the Modbus driver.
2. Ethernet Devices
Displays all logic controllers that are accessible on the same Ethernet subnet as the PC running
SoMachine Basic. Devices behind a router or any device that blocks UDP broadcasts are not
listed.
The list includes logic controllers that are automatically detected by SoMachine Basic as well as
any controllers that you choose to add manually.
Manually Adding Controllers
Follow these steps to add a logic controller to the Ethernet Devices list:
Step

Action

1 In the Remote Lookup field, type the IP address of the logic controller to add, for example,
12.123.134.21
2 Click Add to add the device to the Ethernet Devices list.

36

EIO0000001354 12/2015

Starting with SoMachine Basic

Adding Modem Connections

To add a modem connection to the Local Devices list:
Step

Action

1
Click
Add modem configuration button.
Result: The Modem configuration window appears.
2

Select the COM port of the modem from the drop-down list:

Configure the communication parameters.

For detailed information on the modem configuration parameters, refer to the table below.

Click Apply.

NOTE: This button is enabled only if all settings are configured.

Result: The modem connection is added to the Local Devices list (for example
COM2@0612345678,GenericModem).
5

If necessary, you can edit the Modem Configuration by selecting the modem to edit in the Local
Devices list and clicking on the
list.

EIO0000001354 12/2015

Modify Modem Configuration button located above the

37

Starting with SoMachine Basic

Modem Configuration Parameters

This table describes each parameter of the modem configuration:

38

Parameter

Value

Default value

Description

COM Port

COMx

To select the COM port of the modem from

the dropdown list.

Device

Contains the modem name.

Phone Number

To enter the phone number of the modem

connected to the logic controller.
This text field accepts all the characters and is
limited to 32 characters in total. This field
must contain at least one character to be able
to apply the configuration.

Modem initialization command

AT&D0

To edit the AT initialization command of the

modem.
The AT initialization command is optional
(if the field is empty the AT string is sent).

Escape character

To edit the escape character for the hang-up

procedure.

Baud rate

1200
2400
4800
9600
19200
38400
57600
115200

19200

To select the data transmission rate of the

modem.

Parity

None
Even
Odd

Even

To select the parity of the transmitted data for

error detection.

Data bits

7
8

To select the number of data bits.

Stop bits

1
2

To select the number of stop bits.

Timeout (ms)

0...60000

15000

To specify the transmission timeout (in ms).

Inter-Character
timeout (ms)

0...10000

10

Allows you to specify the interframe

timeout (in ms).
If the check box Automatic is activated, the
value is automatically calculated.

EIO0000001354 12/2015

Starting with SoMachine Basic

Connecting to a Controller
Follow these steps to connect a controller to SoMachine Basic:
Step

Action

1
Click

(Refresh Devices button) to refresh the list of connected devices.

2 Select one of the logic controllers in the Local Devices or Ethernet Devices lists.
If a controller is connected by Ethernet on the same network cable as your PC, the IP address of the
controller appears in the list. Selecting the IP address in the list enables
(IP Address
Configuration button). Click this button to change the IP address of the controller.

NOTE: If you activate the check box Write to post configuration file, the Ethernet parameters are
modified in the post configuration file and kept after a power cycle.
3
If necessary, click
(Start Flashing LEDs button) to flash the LEDs of the selected controller in
order to identify the controller physically. Click this button again to stop flashing the LEDs.
4 Click Login button to log in to the selected controller.
If the logic controller is password protected, you are prompted to provide the password. Type the
password and click OK to connect.
Result: A status bar appears showing the connection progress.
5 When the connection is successfully established, details about the logic controller appear in the
Selected Controller area of the window and the following buttons are available:
Download application to controller: To download an application to the logic controller without
opening it in SoMachine Basic. Refer to Directly Downloading an Application (see page 41).
Memory Management: To Back up (see page 205) or restore (see page 206) the logic controller
memory to or from a PC. Refer to Memory Management (see page 42).
Upload application from controller: To create a new SoMachine Basic project file by uploading
an application from the connected logic controller. Refer to Uploading an Application
(see page 199).
6 Click Logout button to log out from the connected controller.

EIO0000001354 12/2015

39

Starting with SoMachine Basic

Project Templates Window

Overview
You can use example projects to form the basis of new SoMachine Basic projects.
Opening a Project Template
Follow these steps to create a new project based on a project template:
Step

Action

Select the Templates tab on the Start Page window.

Select a project template file (*.smbe) in the Projects list and click Open Template.
Result: A new project is created as a copy of the selected template.

NOTE: SoMachine Basic also provides a Vijeo-Designer application file and a System User
Guide for some example projects. Read the description of the selected project in the Description
area to know whether these files are provided with your project or not. If these files are provided,
Open associated folder option gets activated on selection of such projects. Select the project
and click Open associated folder to browse through the project template files (*.smbe) and
Vijeo-Designer application files (*.vdz) in the Windows Explorer.

40

EIO0000001354 12/2015

Starting with SoMachine Basic

Directly Downloading an Application

Overview
You can download the application contained in a project file to a logic controller without having to
open the project in SoMachine Basic. This is useful if the project is protected in download only
mode, which prevents users from opening the project unless they have the password.
Only downloading is possible in this way.To upload an application from the logic controller to
SoMachine Basic, refer to Uploading an Application (see page 199).
Directly Downloading an Application
To directly download an application to a logic controller:
Step
1

Action
Physically connect the PC running SoMachine Basic to the logic controller using a serial, USB,
or Ethernet cable.

Select the Connect tab on the Start Page window.

Select the logic controller in the Local Devices or Ethernet Devices list and click Login.
Result: SoMachine Basic establishes the connection to the logic controller.

Click Download application to controller.

In the Project File field, click the browse button, select the SoMachine Basic project file (*.smbp)
to download, and click Open.
Information about the selected project file appears in the Information area of the window:
Whether the project file is protected with a password and, if so, whether View and Download
are both allowed, or Download only.
Information about the configuration contained in the project file, for example, whether the
detected configuration of the logic controller system is compatible with the configuration
contained in the selected project.

SoMachine Basic compiles the application in the selected project file. Any errors detected during
compilation are listed under Compilation errors. SoMachine Basic does not allow the
application to be downloaded if compilation errors have been detected; open the project in
SoMachine Basic, correct the errors, then try again.

Before downloading, you can click the following buttons to control the current logic controller
state:
Stop Controller
Start Controller
Initialize Controller

Click PC to Controller (download).

Result: SoMachine Basic downloads the application to the connected logic controller.

EIO0000001354 12/2015

41

Starting with SoMachine Basic

Memory Management
Overview
Click the Memory Management button on the Connect window to back up or restore the logic
controller memory.
Select the action to perform:
Backing up to a PC (see page 205)
Restore from a PC (see page 206)

42

EIO0000001354 12/2015

SoMachine Basic
Developing SoMachine Basic Applications
EIO0000001354 12/2015

Part II
Developing SoMachine Basic Applications

Developing SoMachine Basic Applications

What Is in This Part?
This part contains the following chapters:
Chapter

Chapter Name

Page

The SoMachine Basic Window

45

Properties

55

Configuration

61

Programming

65

Commissioning

191

Simulator

211

Saving Projects and Closing SoMachine Basic

225

EIO0000001354 12/2015

43

Developing SoMachine Basic Applications

44

EIO0000001354 12/2015

SoMachine Basic
SoMachine Basic
EIO0000001354 12/2015

Chapter 3
The SoMachine Basic Window

The SoMachine Basic Window

EIO0000001354 12/2015

45

SoMachine Basic

Section 3.1
Overview of the SoMachine Basic Window

Overview of the SoMachine Basic Window

What Is in This Section?
This section contains the following topics:
Topic

46

Page

Toolbar Buttons

47

Status Area

49

System Settings

51

Print Reports

53

EIO0000001354 12/2015

SoMachine Basic

Toolbar Buttons
Introduction
The toolbar appears at the top of the SoMachine Basic window to provide easy access to
commonly-used functions.
Toolbar
The toolbar has the following buttons:
Icon

Description
Create a new project (CTRL+N)

Open an existing project (CTRL+O)

Save the current project (CTRL+S). Click the down arrow to display a menu with
additional save options.
Print a report (CTRL+P). Click the down arrow to select the report to print
(see page 53) or to configure the report content and format (see page 54).
Cut (CTRL+X)

Copy (CTRL+C)

Paste (CTRL+V)

Undo (CTRL+Z). Click once to undo the most recent action in the program editor.
Click the down arrow and select an action from the list to undo all actions up to and
including the selected action.
You can undo up to 10 actions.
Redo (CTRL+Y). Click once to cancel the most recent Undo action.
Click the down arrow and select an action from the list to redo all actions up and
including the selected action.
You can redo up to 10 actions.
Display the System Settings (see page 51) window.

Display online help (F1). For context-sensitive help, press SHIFT+F1 and click on the
item you need help with.

EIO0000001354 12/2015

47

SoMachine Basic

Icon

Description
Start the logic controller (CTRL+M). Only available in online mode and when the
controller is not already in RUN state.
Stop the logic controller (CTRL+L). Only available in online mode and when the
controller is in RUN state.
Reinitialize the logic controller. Only available in online mode.

Compile the program.

Log in (CTRL+G) to or log out (CTRL+H) from the selected controller.

NOTE: The name of the selected controller appears to the left of this button.
Launch (CTRL+B) or stop (CTRL+W) the SoMachine Basic simulator.

48

EIO0000001354 12/2015

SoMachine Basic

Status Area
Overview
The status area at the top of the main window displays information on the present system status:

1 Program status:
Indicates whether the program has errors detected or not.
2 Connection status:
Indicates the connection status between SoMachine Basic and either the logic controller or the
simulated logic controller.
3 Controller status:
Indicates the present state of the logic controller (RUNNING, STOPPED, HALTED, and so on).
4 Scan time:
Indicates the last scan time.
5 Controller last error detected:
Indicates the most recent error detected. Information is extracted from the system bits and
system words if the logic controller is in STOPPED or HALTED state.
Status Area Messages
The following messages can appear in the status area:
Message Type

Possible Message

Description

Program status

[No errors]

No errors detected in the program.

[Program advisory(ies)
detected]

Program is incomplete.

[Program error(s) detected]

No program or the program contains error(s).

[Not connected]

SoMachine Basic is running in offline mode.

[Online]

SoMachine Basic is running in online mode.

Connection status

EIO0000001354 12/2015

49

SoMachine Basic

Message Type

Possible Message

Description

Controller status
(only in online
mode)

[Not Connected]

Controller is not connected to SoMachine Basic.

[Halted]

Controller is in HALTED state.

Controller is stopped due to an application error being detected.

[Stop]

Controller is in STOPPED state.

Controller has a valid application which is stopped.

[Run]

Controller is in RUNNING state.

Controller is executing the application.

[Powerless]

Controller is in POWERLESS state.

Controller is powered only by the USB cable and is ready to
download/upload the firmware by USB.

[Firmware download]

Controller is downloading the firmware.

[Firmware Error]

Firmware error detected. Version of the firmware downloading

to the controller is older than present firmware version.

[No Application]

Controller has no application.

[Power Up]

Controller is starting (BOOTING).

Scan time
(only in online
mode)

[Scan Time 0 s]

The most recent scan time in microseconds.

Controller last
detected error
(only in online
mode)

[No error(s) detected]

No system error detected in the controller.

[Controller could not switch Controller is not OK to run.

to RUN mode]
[Battery level low]

Controller battery is low.

[Run/Stop input]

Controller is stopped due to Run/Stop input command.

[Stop command]

Controller is stopped due to stop command.

[Software error detected

(exceeding the controller
scan)]

Controller is halted due to software detected error. Controller

scan time overshoot. Controller scan time is greater than the
period defined by the user program in configuration.

[Stop due to detected

hardware error]

Controller is stopped due to detected error in the hardware.

[Power outage]

Controller is stopped due to power outage.

[Controller is configured in
'Start in Stop' mode]

Controller does start in automatic application execution mode

due to configuration of the startup behavior.

[Init command]

Init in cold start.

[Unknown stop reason: {0}]

Unidentified reason.

Refer to the programming guide of the logic controller for a complete list of the system bits and
system words.

50

EIO0000001354 12/2015

SoMachine Basic

System Settings
Overview
This window allows you to set the language of the SoMachine Basic software, customize the
Ladder editor, and choose the default logic controller that appears on the Configuration tab when
you create a new project.
Changing the User Interface Language
Follow these steps to change the user interface language:
Step

Action

Choose System Settings General on the System Settings window.

Select the language to use in the Language list.

The default language is English.

Click Apply and close the System Settings window.

Close and restart SoMachine Basic to view the user interface in the new language.

Customizing the Ladder Editor

Follow these steps to customize the Ladder editor:
Step
1
2

Action
Choose System Settings Ladder Editor on the System Settings window.
Choose the Grid lines style for the Ladder editor.
Dots (default)
Dashed Lines
Lines

Set the Number of columns (11...30) for the cells in the Ladder editor.
The default value of number of cells is 11.
For more information, refer to Programming Principles for Ladder Diagrams (see page 140).

Under Tool Selection Conservation, select:

Keep selected tool (default): After selecting and placing a graphic element in a rung, the
most recently selected graphic element remains selected. This allows you to place the same
element in a rung again without reselecting it. Press the ESC key or right-click an empty cell
in the rung to select the pointer tool

Reset to pointer: After selecting and placing a contact or a coil in a rung, the pointer tool

is automatically selected.To insert the same contact or coil element again, select it in the
toolbar.

EIO0000001354 12/2015

51

SoMachine Basic

Step
5

Action
Choose the Shortcuts and toolbar style setting for the Ladder Editor:
SoMachine Basic set (default)
Asian set 1
Asian set 2
European set
American set
For the selected style, the table displays a list of keyboard shortcuts for each of the toolbar
buttons displayed.

Click Apply and close the System Settings window to view the changes in the Ladder editor.

Choosing a Default Logic Controller

Follow these steps to choose a default logic controller:
Step

52

Action

Choose System Settings Configuration on the System Settings window.

Click Preferred controller and choose a default logic controller from the list.

Click Apply and close the System Settings window.

Close and restart SoMachine Basic to view the new default logic controller in the Configuration
tab when a new project is created.

EIO0000001354 12/2015

SoMachine Basic

Print Reports
Presentation
You can generate customizable reports to print or to save in PDF format on the PC.
The Print button provides the following options:
Print Project Report to print a customized report which can include the listing of the hardware
components, the application architecture and the contents of the project, program, and
application.
Print Bill Of Material to print a listing of the hardware components used in the project
configuration.
Settings to customize the project report, allowing you to select which elements to include and
the page layout.

Printing the Project Report

To print the project report:
Step

Action

1
Click the down arrow to the right of the Print button
on the toolbar and choose the
Print Project Report menu command, or press CTRL+P.
The Print Preview window is displayed.
2
Click

on the toolbar of the Print Preview window to print the project report.

Click

on the toolbar of the Print Preview window to save the project report as a PDF
file on the PC.

Printing the Bill Of Material

To print the Bill Of Material:
Step

Action

1
Click the down arrow to the right of the Print button
Print Bill Of Material menu command.
The Print Preview window is displayed.

on the toolbar and choose the

2
Click

on the toolbar of the Print Preview window to print the Bill Of Material.

Click

on the toolbar of the Print Preview window to save the Bill Of Material as a PDF
file on the PC.

EIO0000001354 12/2015

53

SoMachine Basic

Customizing the Project Report

To select which items to include in the project report and configure its layout:
Step

Action

1
Click the down arrow to the right of the Print button
menu command.
The Settings window is displayed.

on the toolbar and choose the Settings

Click the Report node to configure the format settings of the report (paper size, margins, and
orientation).

Select the items to include in the project report:

Description is the project description as in the Project Information window.
Bill Of Material is the listing of the hardware components used in the project configuration.
Hardware Configuration is a listing of the hardware devices used in the configuration:
IO Bus is a list of the I/O expansion modules used.
Cartridges is a list of the cartridges used.
Software Configuration is to include/exclude the following items:
Constant words is a list of constant word (%KW) objects used in the project.
Network objects is a list of objects used to communicate with Ethernet/IP or Modbus TCP

devices.
Software Objects lists the software objects used in the program, such as timers and

counters.
PTO objects lists PTO function blocks used in the program.
Communication Objects lists the communication objects used in the program.
Program is to include/exclude the following items:
Behavior is the settings configured in the Behavior window.
Memory consumption is the amount of controller memory used by the application, program,

and associated user data.

Application architecture is the settings configured in the Master Task and Periodic Task

windows.
POU is a listing of the POUs used in the program.
Display is a report section containing information about the Remote Graphic Display:
General properties is the general parameters that appear on the Display tab. There is an

option to print the password in your report.

Alarm View displays a list of triggered alarms.
Pages is a list of operator interface pages created on the Display tab.
Symbols is a list of all symbols or of the symbols used in the project.
Cross-reference is a table containing the used addresses, objects, rungs, and the line of code

in which they are used.

Animation table is a table containing the objects added to animation tables in the project.

54

Close the window.

EIO0000001354 12/2015

SoMachine Basic
Properties
EIO0000001354 12/2015

Chapter 4
Properties

Properties

EIO0000001354 12/2015

55

Properties

Section 4.1
Overview of the Properties Window

Overview of the Properties Window

What Is in This Section?
This section contains the following topics:
Topic

56

Page

The Properties Window

57

Project Properties

58

EIO0000001354 12/2015

Properties

The Properties Window

Overview
The Properties tab allows you to specify information about the project and whether it is to be
password-protected:

1
2

Details about the developer and the company developing the project.
Information about the project itself.
If the project is to be password protected, the password that must be entered correctly to open
the project in SoMachine Basic.
If the application stored in the logic controller controller is to be password protected, the
password that must be entered correctly to upload the application into a SoMachine Basic
project.

The left hand area displays a list of the available properties.

The right hand area displays the properties of the item that is currently selected in the left hand area.

EIO0000001354 12/2015

57

Properties

Project Properties
Overview
Use the Properties window to provide details about the user of SoMachine Basic, the company
developing the application, and the project. In this window, you can also password protect the
project file and the application when stored in the logic controller.
Specifying Application Developer Properties
To specify the application developer properties:
Step

Action

Display the Properties tab and click Project Properties Front Page.

Complete the information.

Click Apply.

NOTE: This information appears in the Windows Explorer properties window when you right-click
on a SoMachine Basic project file.
Specifying Company Properties
To specify the company properties:
Step

Action

Display the Properties tab and click Project Properties Company.

Complete the information.

To upload the company logo image, click Change then browse to select the file to upload.
Click Removed to delete the current image.

Click Apply.

Specifying Project Information

To specify project information:
Step

58

Action

Display the Properties tab and click Project Properties Project Information.

Complete the information.

To upload an image, such as a photograph or CAD image of the instrumented machine, click
Change then browse to select the file to upload. Click Removed to delete the current image.

Click Apply.

EIO0000001354 12/2015

Properties

Password Protecting a Project

It is possible to protect the project file. When a project is password protected, you are prompted for
the password whenever the project is opened in SoMachine Basic.
Follow these steps to password protect a project file:
Step

Action

Display the Properties tab and click Project Properties Project Protection.

Select the Active option. Required items of information are marked with an asterisk (*).

Type the password to use in the Password field then type it again in the Confirmation field.

Select one of the following options:

View and Download (default): Allows you to view the contents of an application and
download the application to a logic controller without knowing the password. However, you
must enter the password to modify the contents of the application.
Download Only: You can download the application to a logic controller without knowing the
password. This is done through the Connect window in the Start Page (see page 36).
However, you must enter the correct password when opening the project to view or modify
the application.

Click Apply.

Removing Password Protection from a Project

Follow these steps to remove password protection from a project:
Step

Action

Display the Properties tab and click Project Properties Project Protection.

Select the Inactive option.

Click Apply.

NOTE: If prompted to provide the current password before the Inactive option applies
successfully, type the password and click Apply.

EIO0000001354 12/2015

59

Properties

Password Protecting an Application

SoMachine Basic allows an application stored in the logic controller to be protected with a
password. This password controls uploading of the application from the logic controller into a
SoMachine Basic project.
Follow these steps to password protect an application:
Step

Action

Display the Properties tab and click Project Properties Application Protection.

Choose the level of application protection:

Select Active and leave Password blank to disable application upload from the logic
controller to the PC.
Select Active and type the same password in the Password and Confirmation fields to
password protect the application. You must then enter this password when prompted before
uploading the application from the logic controller to the PC.

Click Apply.

Removing Password Protection from an Application

Follow these steps to remove password protection from an application:
Step

Action

Display the Properties tab and click Project Properties Application Protection.

Select the Inactive option.

Click Apply.

NOTE: If prompted to provide the current password before the Inactive option applies
successfully, type the password and click Apply.

60

EIO0000001354 12/2015

SoMachine Basic
Configuration
EIO0000001354 12/2015

Chapter 5
Configuration

Configuration

EIO0000001354 12/2015

61

Configuration

Section 5.1
Overview of the Configuration Window

Overview of the Configuration Window

What Is in This Section?
This section contains the following topics:
Topic

62

Page

Overview of the Configuration Window

63

Building a Configuration

64

EIO0000001354 12/2015

Configuration

Overview of the Configuration Window

Introduction
Use the Configuration window to recreate the hardware configuration of the logic controller and
expansion modules to be targeted by the program.

1
2
3
4

The Hardware Tree - a structured view of the hardware configuration.

The configuration - a logic controller and expansion modules.
Catalog references of the supported logic controller and expansion module hardware components. To add
a component to the hardware configuration, drag and drop it onto the configuration.
The properties of the component selected in the configuration, or the properties of the selected item in the
Hardware Tree.

EIO0000001354 12/2015

63

Configuration

Building a Configuration
Replacing the Default Logic Controller
When you create a new SoMachine Basic project, a logic controller reference appears in the
central area of the Configuration window.
Step
1

Action
Click the Configuration tab.

Expand the logic controller category in the catalog area on the right, if it is not already displayed.

Select a logic controller reference. A short description of the physical properties of the logic
controller appear in the Device description area.

Drag the logic controller reference over the image of the existing logic controller in the central
area of the window and drop it.

Click Yes when prompted to confirm replacing the logic controller reference.

NOTE: The default controller reference is specified in the System Settings window (see page 51).
Configuring the Logic Controller
Use the Configuration window to configure the logic controller.
Refer to the Programming Guide of the logic controller used in the configuration for details.
Configuring Expansion Modules
Use the Configuration window to add and configure expansion modules.
Refer to the Programming Guide of the expansion module used in the configuration for details.

64

EIO0000001354 12/2015

SoMachine Basic
Programming
EIO0000001354 12/2015

Chapter 6
Programming

Programming
What Is in This Chapter?
This chapter contains the following sections:
Section

Topic

Page

6.1

Overview of the Programming Workspace

66

6.2

Special Functions

67

6.3

Configuring Program Behavior and Tasks

78

6.4

Managing POUs

85

6.5

Master Task

97

6.6

Periodic Task

101

6.7

Event Task

105

6.8

Using Tools

112

6.9

Ladder Language Programming

137

6.10

Instruction List Programming

153

6.11

Grafcet (List) Programming

164

6.12

Grafcet (SFC) Programming

171

6.13

Debugging in Online Mode

183

EIO0000001354 12/2015

65

Programming

Section 6.1
Overview of the Programming Workspace

Overview of the Programming Workspace

Overview of the Programming Workspace
Overview
The Programming tab is split into 3 main areas:

1
2
3

66

The Programming Tree allows you to select the properties of the program and its objects, and functions,
as well as a number of tools which you can use to monitor and debug the program.
The upper central area is the programming workspace where you enter the source code of your program.
The lower central area allows you to view and configure the properties of the item selected in the
programming workspace or the Programming Tree.
EIO0000001354 12/2015

Programming

Section 6.2
Special Functions

Special Functions
What Is in This Section?
This section contains the following topics:
Topic

Page

Objects

68

Symbolic Addressing

69

Memory Allocation

71

Ladder/List Reversibility

72

EIO0000001354 12/2015

67

Programming

Objects
Overview
In SoMachine Basic, the term object is used to represent an area of logic controller memory
reserved for use by an application. Objects can be:
Simple software variables, such as memory bits and words
Addresses of digital or analog inputs and outputs
Controller-internal variables, such as system words and system bits
Predefined system functions or function blocks, such as timers and counters.
Controller memory is either pre-allocated for certain object types, or automatically allocated when
an application is downloaded to the logic controller.
Objects can only be addressed by a program once memory has been allocated. Objects are
addressed using the prefix %. For example, %MW12 is the address of a memory word, %Q0.3 is the
address of an embedded digital output, and %TM0 is the address of a Timer function block.

68

EIO0000001354 12/2015

Programming

Symbolic Addressing
Introduction
SoMachine Basic supports the symbolic addressing of language objects; that is, the indirect
addressing of objects by name. Using symbols allows for quick examination and analysis of
program logic, and greatly simplifies the development and testing of an application.
Example
For example, WASH_END is a symbol that could be used to identify an instance of a Timer function
block representing the end of a wash cycle. Recalling the purpose of this name is easier than trying
to remember the role of a program address such as %TM3.
To Define a Symbol in the Properties Window
To define a symbol in the properties window:
Step

Action

Select the Tools tab in the left-hand area of the Programming window.

Select the type of object with which to define a symbol, for example I/O objects
Digital inputs, to display the properties of digital inputs.
The properties window of the object type appears in the lower central area of the Programming
window.

Double-click in the Symbol column of the properties table and type the symbol to define for a
particular item, for example Input_1 for the input %I0.2

Click Apply.

EIO0000001354 12/2015

69

Programming

To Define a Symbol in the Ladder Editor

To define a symbol within the Ladder editor:
Step

Action

In the Ladder editor, click the Symbol line of a graphic element, for example a latch or function
block. A cursor appears:

Type the symbol to use, for example Input_1 and press Enter. The following rules apply to
symbols:
A maximum of 32 characters.
Letters (A-Z), numbers (0-9), or underscores (_).
First character must be a letter. You cannot use the percentage sign (%).
Symbols are not case-sensitive. For example, Pump1 and PUMP1 are the same symbol and
can only be used uniquely for any given object; that is, you cannot assign the same symbol
to different objects.

If the graphic element is not yet associated with an object, the Remark window appears. Select
an object to associate with the symbol and click OK.
Otherwise, click Yes when prompted to associate the symbol with the object.

Double-click either the symbol or object of the graphic element to display the symbol in the
Symbol column of the properties window:

Displaying All Defined Symbols

Choose Tools Symbol list to display a list of all defined symbols (see page 129).
Storing Symbols
Symbols are a part of non-program data. They are stored in the logic controller as part of a
SoMachine Basic application.

70

EIO0000001354 12/2015

Programming

Memory Allocation
Introduction
SoMachine Basic allows you to pre-allocate (reserve) blocks of logic controller memory for use by
certain object types used in a program, including simple objects (memory words, constant words)
and software objects (function blocks).
Allocation Modes
In offline mode, you can specify the memory allocation mode for each object type. When
configuring these objects (Programming Tools), the following window then appears above the
list of configurable objects:

Choose the memory allocation mode to use:

Automatic. All objects from offset 0 to the highest memory address used in the program, or
associated with a symbol, are automatically allocated in logic controller memory. For example:
if the memory word %MW20 is used in the program, all objects from %MW0 to %MW20 inclusive (21
objects) are automatically allocated in memory.
If you later switch to online mode, you cannot allocate new memory objects with addresses
higher than the highest address that was used before you went online.
Manual. Specify a number of objects to be allocated in memory in the No. of Objects box.
When you switch to online mode, you can add new contacts, coils, or equations in your program
(up to the limit of memory allocated) without having to log out from the logic controller, modify
the program, log in, and download the application again.

SoMachine Basic displays the total number of Allocated memory objects and the Maximum
number of memory objects available in the logic controller.

EIO0000001354 12/2015

71

Programming

Ladder/List Reversibility
Introduction
SoMachine Basic supports conversion of rungs from Ladder Diagram to Instruction List and from
Instruction List back to Ladder Diagram. This is called program reversibility.
In SoMachine Basic, you can toggle rungs between programming languages at any time as
required. You can therefore display a program with some rungs in Ladder Diagram and other rungs
in Instruction List.
NOTE: You cannot convert Ladder and Instruction List programs to Grafcet (SFC), or Grafcet
(SFC) programs to Ladder or Instruction List, or Grafcet (IL) to Grafcet (SFC).
Understanding Reversibility
A key to understanding program reversibility is examining the relationship between a Ladder
Diagram rung and the associated Instruction List rung:
Ladder Diagram rung: A collection of Ladder Diagram instructions that constitute a logical
expression.
List sequence: A collection of Instruction List programming instructions that correspond to the
Ladder Diagram instructions and represents the same logical expression.
The following illustration displays a common Ladder Diagram rung and its equivalent program logic
expressed as a sequence of Instruction List instructions.

Equivalent Instruction List instruction:

72

EIO0000001354 12/2015

Programming

A program is always stored internally as Instruction List instructions, regardless of whether it is

originally written in the Ladder Diagram or Instruction List language. SoMachine Basic takes
advantage of the program structure similarities between the 2 languages and uses this internal
Instruction List image of the program to display it either as an Instruction List program, or
graphically as a Ladder Diagram.
Instructions Required for Reversibility
The structure of a reversible function block in Instruction List language requires the use of the
following instructions:
BLK marks the block start, and defines the beginning of the rung and the start of the input portion
to the block.
OUT_BLK marks the beginning of the output portion of the block.
END_BLK marks the end of the block and the rung.
The use of these reversible function block instructions is not mandatory for a properly functioning
Instruction List program.
Programming Situations and IL/Ladder Reversibility
The following table lists programming situations for the Ladder or IL languages which, if left
untreated, generate advisories or errors and a possible loss of reversibility.
Situation

IL

Ladder

Rung
reversible

Jump to a label which has not been defined

Error

Error

Yes

Call to undefined subroutine

Error

Error

Yes

Activate or deactivate an undefined Grafcet step

Error

Error

Yes

Jump instruction between parentheses

Error

No

Label between parentheses

Error

No

Subroutine between parentheses

Error

No

More than 32 nested parentheses

Error

No

Closing parenthesis without opening parenthesis

Error

No

Reserved

Unbalanced parentheses

Error

No

BLK without END_BLK

Error

No

OUT_BLK or END_BLK without BLK

Error

No

Label definition not followed by LD or BLK

Error

No

Subroutine definition not followed by LD or BLK

Error

No

Reserved

More than 11 nested MPS

Error

No

MRD without MPS

Error

No

EIO0000001354 12/2015

73

Programming

74

Situation

IL

Ladder

Rung
reversible

MPP without MPS

Error

No

Use Grafcet instruction in POST

Error

Error

Yes

Grafcet definition not followed by BLK or LD

Error

No

Unbalanced stack operations

Error

No

Reserved

Duplicate label

Error

Error

Only LD->IL

Duplicate Subroutine

Error

Error

Only LD->IL

Duplicate Grafcet step

Error

Error

Only LD->IL

Reserved

Duplicate POST

Error

Error

Only LD->IL

Nested FB

Error

No

OUT_BLK between BLK and END_BLK

Error

No

BLK not followed by LD

Error

No

LD of FB output not in OUT_BLK

Error

No

FB outputs used outside their respective FB structure Error

No

FB outputs repeated or out of order

No

Error

FB inputs not in BLK before OUT_BLK

Error

No

FB inputs used outside their respective FB structure

Error

No

FB inputs repeated or out of order

Error

No

Label declared in BLK

Error

No

Subroutines declared in BLK

Error

No

Grafcet steps declared in BLK

Error

No

Attempted LD of a non FB output in OUT_BLK

Error

No

FB output used between BLK and END_BLK

Error

No

Nested subroutines

Error

Error

No

Subroutine call between MPS and MPP

Error

Error

No

Subroutine call between parentheses

Error

No

Reserved

First instruction of program not a rung delimiter

Error

No

Jump instruction between MPS and MPP

Error

Error

No

Rung contains syntax error

Error

No

Reserved

Reserved

EIO0000001354 12/2015

Programming

Situation

IL

Ladder

Rung
reversible

MPP without MPS

Error

No

Use Grafcet instruction in POST

Error

Error

Yes

Grafcet definition not followed by BLK or LD

Error

No

Unbalanced stack operations

Error

No

Reserved

Duplicate label

Error

Error

Only LD->IL

Duplicate Subroutine

Error

Error

Only LD->IL

Duplicate Grafcet step

Error

Error

Only LD->IL

Reserved

Duplicate POST

Error

Error

Only LD->IL

Nested FB

Error

No

OUT_BLK between BLK and END_BLK

Error

No

BLK not followed by LD

Error

No

LD of FB output not in OUT_BLK

Error

No

FB outputs used outside their respective FB structure Error

No

FB outputs repeated or out of order

Error

No

FB inputs not in BLK before OUT_BLK

Error

No

FB inputs used outside their respective FB structure

Error

No

FB inputs repeated or out of order

Error

No

Label declared in BLK

Error

No

Subroutines declared in BLK

Error

No

Grafcet steps declared in BLK

Error

No

Attempted LD of a non FB output in OUT_BLK

Error

No

FB output used between BLK and END_BLK

Error

No

Nested subroutines

Error

Error

No

Subroutine call between MPS and MPP

Error

Error

No

Subroutine call between parentheses

Error

No

Reserved

First instruction of program not a rung delimiter

Error

No

Jump instruction between MPS and MPP

Error

Error

No

Rung contains syntax error

Error

No

Reserved

Reserved

EIO0000001354 12/2015

75

Programming

Situation

IL

Ladder

Rung
reversible

Program instructions following JMP or END

unconditional instructions

Error

No

No

Rung beginning with LD instruction does not terminate Advisory

with a conditional action instruction

76

Action instruction between parentheses

Error

No

Stack instruction between parentheses

Error

No

Direct-access instructions for FB (ex: ""CU %C0"")

Advisory

No

Action instructions in the input section of a FB

Error

No

Instructions after END_BLK

Error

No

FB outputs used with AND and OR instructions

Advisory

No

OR instruction inside a FB output not between

parentheses

Advisory

No

Instruction preceding MRD or MPP not either a

conditional action or associated with stack
instructions

Advisory

No

Unnested OR between MPS and MPP

Advisory

No

OR after an action instruction

Advisory

No

OR after MPS, MRD or MPP

Advisory

No

Reserved

Subroutine call or JMPC not the last action instruction

of the rung

Advisory

Error

No

Canonic rung exceeds 7x11 cells in Twido,

256 x 30 cells in SoMachine Basic

Advisory

No

Unconditional action instruction between BLK and

END_BLK

Error

No

OUT_BLK not followed by LD of a valid FB output or

END_BLK

Error

No

FB cannot occupy first cell

Yes

FB on top of the rung, it replaces items occupying the cells

Yes

No logic above or below a FB

Error

No

XOR in first column

Error

No

Contacts and horizontal connectors in last column

Error

No

Down connectors in last row or last column

Error

No

Allow only valid subroutines 0 to 63

Error

No

Allow only valid labels 0 to 63

Error

No

EIO0000001354 12/2015

Programming

Situation

IL

Ladder

Rung
reversible

Invalid operate expressions in operation block

Error

No

Invalid comparison expressions in comparison block

Error

No

Invalid address or symbol in contact and coil

Error

No

Invalid operand or expression with Ladder instruction -

Error

No

Rung with no output action item

Error

No

Discontinuity between left and right power bars

Error

No

Dangling Ladder rung

Error

No

Ladder rung contains items that are short-circuited

using connectors

Error

No

All divergences that contain only boolean logic items

must converge in reverse order

Error

No

FB has no input associated

Error

No

FB output pins cannot be connected together

Error

No

XOR connected to power bar

Error

No

Subroutine call and jump not the last output action

item

Advisory

Error

No

Canonic rung that contains a FB with part of the FB in the last column

No

Canonic rung exceeds 7x11 cells in Twido,

256 x 30 cells in SoMachine Basic

Advisory

Error

No

OPEN and SHORT connected to the left node of

subnetwork

Error

No

XOR connected to the left node of subnetwork

Error

No

There is not at least one existing LIST sentence that

can represent the ladder rung

Error

No

EIO0000001354 12/2015

77

Programming

Section 6.3
Configuring Program Behavior and Tasks

Configuring Program Behavior and Tasks

What Is in This Section?
This section contains the following topics:
Topic

78

Page

Application Behavior

79

Tasks and Scan Modes

82

EIO0000001354 12/2015

Programming

Application Behavior
Overview
You can configure the following aspects of how the application interacts with the logic controller:
Functional levels (see page 79)
Startup (see page 80)
Watchdog (see page 81)
Fallback behavior (see page 81)

Configuring Application Behavior

Follow these steps to configure the application behavior:
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select the Behavior item.

Result: The Behavior properties appear in the lower central area of the Programming window.

Modify the properties as required.

Click Apply to save the changes.

Functional Levels
Your system could include logic controllers with different firmware versions, and therefore with
different capability levels. SoMachine Basic supports functional level management to allow you to
control the functional level of your application.
Select a level from the Functional levels list:
Level 4.0: Contains support for sink transistor output controllers, Grafcet (SFC), Frequency
Generator, Retentive Timer, Memory Management, Remote Graphic display evolution.
Level 3.3: Contains enhancements (PTO Motion Task, HSC evolution).
Level 3.2: Contains enhancements to support Optional module feature, EtherNet/IP adapter,
and %SEND_RECV_SMS function block.
Level 3.1: Contains enhancements (Unconditional Start In Run feature).
Level 3.0: Contains enhancements (communications, modem, Remote Graphic Display) to the
previous level of software and hardware.
Level 2.0: Contains any enhancements and corrections over the previous level software and
firmware. For example, for Pulse Train Output (PTO) support, it would be necessary to select
this functional level or greater.
Level 1.0: First release of the combination of the SoMachine Basic software and the compatible
firmware version(s).

EIO0000001354 12/2015

79

Programming

Startup
Specify how the program behaves following a restart of the logic controller:
Start In Previous State: The logic controller starts in the state that it was in before it was
stopped.
Start In Stop: The logic controller does not automatically start application execution.
Start In Run (default): The logic controller automatically starts application execution given run
criteria, such as the presence and charge of a battery, are met.
Unconditional Start In Run: The logic controller automatically starts application execution
even if the controller battery is absent or discharged.

When using the Start In Run feature, the controller will start executing program logic when power
is applied to the equipment. It is essential to know in advance how automatic reactivation of the
outputs will affect the process or machine being controlled. Configure the Run/Stop input to help
control the Start In Run feature. In addition, the Run/Stop input is designed to give local control
over remote RUN commands. If the possibility of a remote RUN command after the controller had
been stopped locally by SoMachine would have unintended consequences, you must configure
and wire the Run/Stop input to help control this situation.

WARNING
UNINTENDED MACHINE START-UP

Confirm that the automatic reactivation of the outputs does not produce unintended
consequences before using the Start In Run feature.
Use the Run/Stop input to help control the Start In Run feature and to help prevent the
unintentional start-up from a remote location.
Verify the state of security of your machine or process environment before applying power to
the Run/Stop input or before issuing a Run command from a remote location.

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

WARNING
UNINTENDED MACHINE OR PROCESS START-UP

Verify the state of security of your machine or process environment before applying power to
the Run/Stop input.
Use the Run/Stop input to help prevent the unintentional start-up from a remote location.

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

80

EIO0000001354 12/2015

Programming

When using the Unconditional Start In Run feature, the controller will attempt to start executing
program logic when power is applied to the equipment, independent of the reason the controller
had previously stopped. This occurs even if there is no charge in the battery, or if the battery is not
present. Therefore, the controller will start with all memory values re-initialized to zero or other
predetermined default values. It is conceivable that if the controller attempts to restart, for example,
after a short power outage, the values in memory at the time of the outage would be lost, and
restarting the machine may have unintended consequences as there was no battery to maintain
memory values. It is essential to know in advance how an unconditional start will affect the process
or machine being controlled. Configure the Run/Stop input to help control the Unconditional Start
In Run feature.

WARNING
UNINTENDED MACHINE OPERATION

Conduct a thorough risk analysis to determine the effects, under all conditions, of configuring
the controller with the Unconditional Start In Run feature.
Use the Run/Stop input to help avoid an unwanted unconditional restart.

Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Watchdog
A watchdog is a special timer used so that programs do not overrun their allocated scan time.
The watchdog timer has a default value of 250 ms. Specify the duration of the watchdog scan task.
The possible range is 10...500 ms.
Fallback Behavior
Specify the fallback behavior to use when the logic controller enters the STOPPED or an exception
state for any reason.
Two fallback behaviors exist:
You can set individual fallback values to outputs. By default, the outputs are set to the fallback
values defined in the configuration properties of the embedded logic controller and expansion
module outputs.
Refer to the Programming Guide of the logic controller or expansion module for information on
configuring fallback values for outputs.
Individual fallback values cannot be defined for configured PTO and FREQGEN outputs. The
fallback value for these objects is 0 and cannot be modified.
Select Maintain values to keep each output to the state it was when the logic controller entered
the STOPPED or an exception state. In this mode, the fallback values configured for logic
controller and expansion module outputs are ignored and, instead, are set to the last value
assumed by the output.
Maintain values behavior is not applied to fast outputs (HSC reflex outputs, PLS, PWM, PTO,
and FREQGEN) and, instead, the fallback value for these objects is 0.
EIO0000001354 12/2015

81

Programming

Tasks and Scan Modes

Overview
SoMachine Basic has the following scan modes for Master task:
Normal mode
Continuous cyclic scanning mode (Freewheeling mode); a new scan starts immediately after the
previous scan has completed.
Periodic mode
Periodic cyclic scanning mode; a new scan starts only after the configured scan time of the
previous scan has elapsed. Every scan is therefore the same duration.

SoMachine Basic offers the following task types:

Master task: Main task of the application.
Master task is controlled by continuous cyclic scanning (in normal scan mode) or by specifying
the scan period of 2...150 ms (default 100 ms) in periodic scan mode.
Periodic task: A short duration subroutine processed periodically.
Periodic tasks are configured by specifying the scan period of 2...255 ms (default 255 ms).
Event task: A very short duration subroutine to reduce the response time of the application.
Event tasks are triggered by the physical inputs or the HSC function blocks. These events are
associated with embedded digital inputs (%I0.2...%I0.5) (rising, falling or both edges) or with the
high speed counters (%HSC0 and %HSC1) (when the count reaches the high speed counter
threshold). You can configure 2 events for each HSC function block.
Tasks Priorities
This table summarizes the task types and their priorities:
Task Type

Master

Scan Mode

Triggering Condition

Configurable
Range

Maximum
Number of
Tasks

Priority

Lowest

Normal

Normal

Not applicable

Periodic

Software timer

2...150 ms

Periodic

Periodic

Software timer

2...255 ms

Higher than master

task and lower than
event tasks

Event

Periodic

Physical inputs

%I0.2...%I0.5

Highest

%HSC function blocks

2 events per
%HSC object

Events Priorities
Refer to Event Priorities and Queues (see page 108).

82

EIO0000001354 12/2015

Programming

Master Task in Normal Scan Mode

This graphic shows the relationship between master task and periodic task execution when the
master task is configured in normal scan mode:

NOTE: The master task sleep time is at least 30% of the total cycle time with a minimum of
1 millisecond.
Master Task in Periodic Scan Mode
This graphic shows the relationship between master task and periodic task when the master task
is configured in periodic scan mode:

EIO0000001354 12/2015

83

Programming

Event Priority Over Master and Periodic Tasks

Event priorities control the relationship between the event tasks, master task, and periodic task.
The event task interrupts the master task and periodic task execution.
This figure shows the relationship between event tasks, master tasks, and periodic tasks in the
periodic mode:

The event tasks are triggered by a hardware interruption that sends a task event to the event task.

84

EIO0000001354 12/2015

Programming

Section 6.4
Managing POUs

Managing POUs
What Is in This Section?
This section contains the following topics:
Topic

Page

POUs

86

Managing POUs with Tasks

87

Managing Rungs

89

Managing Grafcet (SFC) POUs

92

Free POUs

94

EIO0000001354 12/2015

85

Programming

POUs
Overview
A Program Organization Unit (POU) is a reusable object used in a program. Each POU consists of
a variable declaration and a set of instructions in the source code of a supported programming
language.
One POU always exists and is linked to the master task of the program. This POU is then called
automatically whenever the program starts.
You can create additional POUs containing other objects, for example, functions or function blocks.
When first created, a POU can be either:
associated with a task (see page 87), or
a Free POU (see page 94). A Free POU is not associated with a specific task or event. A Free
POU can, for example, contain library functions that are maintained independently of the main
program. Free POUs are called from within programs as either subroutines or jumps. A periodic
task (see page 102) is a subroutine that is implemented as a Free POU.

86

EIO0000001354 12/2015

Programming

Managing POUs with Tasks

Adding a New POU Associated with a Task
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Add a new POU by one of the following methods:

Right-click the Master Task and choose Add POU from the contextual menu that appears.
Select the Master Task and click

(Add POU) on the toolbar at the top of the Tasks

tab.
Result: A new POU is added to the program structure immediately below the default/last POU
in the Master Task. The default name is n - New POU, where n is an integer incremented each
time a POU is created.
3

To reposition a POU in the Master Task, select a POU and click the UP or DOWN button on the
toolbar at the top of the Tasks tab to move the selected POU up or down in the program
structure.

Inserting a New POU

Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select an existing POU above which to insert the POU.

Right-click the selected POU and choose Insert POU from the contextual menu that appears.

To reposition a POU in the Master Task, select a POU and click the UP or DOWN button on the
toolbar at the top of the Tasks tab to move the selected POU up or down in the program
structure.

Copying and Pasting Existing POUs Associated with a Task

Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple POUs:

Select an existing POU in the Master Task.
Press and hold the CTRL key and select each POU in the Master Task.

Right-click one of the selected POU in the Master Task and choose Copy POU from the
contextual menu that appears.

Right-click the Master Task and choose Paste POU from the contextual menu that appears.
Result: One or multiple POUs are added to the program structure immediately below the
selected POU in the Master Task with the same name as the copied POU.

EIO0000001354 12/2015

87

Programming

Renaming a POU
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Edit the POU name by one of the following methods:

Right-click a POU and choose Rename POU from the contextual menu that appears.
Double-click a POU.
Select a POU and double-click the POU name in the programming workspace.
Select a POU and press the F2 key.

Type the new name for the POU and press ENTER.

Removing POUs
Step

88

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple POUs:

Select an existing POU in the Master Task.
Press and hold the CTRL key and select each POU in the Master Task.

Delete the selected POUs:

Right-click a selected POU in the Master Task and choose Delete POU from the contextual
menu that appears.
Press the DELETE key.

EIO0000001354 12/2015

Programming

Managing Rungs
Creating a Rung
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Add a rung in a POU by any of the following methods:

Right-click a POU and choose Add Rung from the contextual menu that appears.
Select a POU and click

(Add Rung button) on the toolbar at the top of the Tasks

tab.
Select a POU and click

(Create a new Rung button) on the toolbar at the top of

the programming workspace.

Result: A new rung is added to the program structure immediately below the last rung.
3

To reposition a rung in a POU, select a rung and click the UP or DOWN button on the toolbar at
the top of the Tasks tab to move the selected rung up or down in the program structure.

The rung is given sequence identifier, such as Rung0. You may additionally add a rung comment
to identify the rung by clicking the rung header.

The default programming language is LD (ladder). To select a different programming language

for this rung, click LD and choose a different programming language.

If this rung is to be called with a JUMP instruction, assign a label to the rung by clicking the
drop-down button below the rung sequence identifier Rungx, where x is the rung number in a
POU, and choose %L from the list.
Result: The rung is labeled as %Ly, where y is the label number.%L appears on the button and
the label number y appears in suffix with the button.

NOTE: The label number is incremented by 1 as you define the next label.
To modify the label number, double-click the label number in a rung and enter the new number
and then press ENTER.

Inserting a Rung Above an Existing Rung

Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select an existing rung in the Programming workspace.

3
Click
(Insert a new Rung button) on the toolbar at the top of the programming
workspace.
Result: A new rung appears above the selected rung.

EIO0000001354 12/2015

89

Programming

Step

Action

The rung is given sequence identifier, such as Rung0. You may additionally add a rung comment
to identify the rung by clicking the rung header.

The default programming language is LD (ladder). To select a different programming language

for this rung, click LD and choose a different language.

If this rung is to be called with a JUMP instruction, assign a label to the rung by clicking the
drop-down button below the rung sequence identifier Rungx, where x is the rung number in a
POU, and choose %L from the list.
Result: The rung is labeled as %Ly, where y is the label number. %L appears on the button and
the label number y appears in suffix with the button.

NOTE: The label number is incremented by 1 as you define the next label.
To modify the label number, double-click the label number in a rung and enter the new number
and then press ENTER.

Copying Rungs
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple rungs:

Select an existing rung.
Press and hold the CTRL key and select each rung.

Right-click one of the selected rung to copy and choose Copy selected rung from the contextual
menu that appears.

Right-click a rung and choose Paste Rung from the contextual menu that appears.
Result: A copy of the rung is inserted with no label.

NOTE: Label of the rung is not copied when you copy a rung.
NOTE: You can also copy and paste rungs in the Programming window:
Step

90

Action

Right-click the rung to copy and choose Copy selected rung.

Right-click in the programming workspace and choose Paste Rung.

EIO0000001354 12/2015

Programming

Renaming a Rung
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Edit the rung name by one of the following methods:

Right-click a rung and choose Rename Rung from the contextual menu that appears.
Double-click a rung.
Select a rung and double-click the rung name or the text name in the programming
workspace.
Select a rung and press the F2 key.

Type the new name for the rung and press ENTER.

Removing Rungs
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Delete a rung by one of the following methods:

Right-click a rung and choose Delete Rung from the contextual menu that appears.
Select a rung and click

(Delete Rung button) on the toolbar at the top of the Tasks

tab.
Select a rung and click

(Delete the Rung button) on the toolbar at the top of the

programming workspace.
Right-click a rung in the programming workspace and choose Delete the selected rung from
the contextual menu that appears.
Select a rung and press the DELETE key.
3

EIO0000001354 12/2015

If the rung is not empty, you are prompted to confirm deleting the rung.

91

Programming

Managing Grafcet (SFC) POUs

Creating a Grafcet POU
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Add a new Grafcet POU by one of the following methods:

Right-click on Master task and choose Add Grafcet POU from the contextual menu that
appears.
Click the

(Add Grafcet POU) button on the toolbar at the top of the Tasks tab.

Result: A n - Grafcet node appears below the Master task node, where n is an integer
incremented each time a Grafcet POU is created.

Inserting a New Grafcet POU

Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select an existing Grafcet POU above which to insert the new Grafcet POU.

Right-click the selected POU and choose Insert Grafcet POU from the contextual menu that
appears.

To reposition a Grafcet POU in the Master Task, select a Grafcet POU and click the UP or
DOWN button on the toolbar at the top of the Tasks tab to move the selected Grafcet POU up
or down in the program structure.

Copying and Pasting Grafcet POUs

Step

92

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple Grafcet POUs:

Select an existing Grafcet POU in the Master Task.
Press and hold the CTRL key and select each Grafcet POU in the Master Task.

Right-click one of the selected Grafcet POU in the Master Task and choose Copy POU from the
contextual menu that appears.

Right-click the Master Task and choose Paste POU from the contextual menu that appears.
Result: One or multiple Grafcet POUs are added to the program structure immediately below the
selected Grafcet POU in the Master Task with the same name as the copied Grafcet POU.

EIO0000001354 12/2015

Programming

Renaming a Grafcet POU

Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Edit the Grafcet POU name by one of the following methods:

Right-click on a Grafcet POU and choose Rename POU from the contextual menu that
appears.
Double-click a Grafcet POU.
Select a Grafcet POU and press the F2 key.

Type the new name for the Grafcet POU node and press ENTER.

Removing Grafcet POUs

Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple Grafcet POUs:

Select an existing Grafcet POU in the Master Task.
Press and hold the CTRL key and select each Grafcet POU in the Master Task.

Delete the selected Grafcet POUs:

Right-click a selected Grafcet POU in the Master Task and choose Delete POU from the
contextual menu that appears.
Press the DELETE key.

EIO0000001354 12/2015

93

Programming

Free POUs
Introduction
In SoMachine Basic, a Free POU is a special type of POU that is not explicitly associated with a
task:

Each Free POU is implemented as a subroutine and is made up of 1 or more rungs written in the
Ladder or IL programming languages.
NOTE: Grafcet POUs cannot be Free POUs.
Free POUs are consumed when:
Called using a subroutine call (SRi) from within a program rung
Configured as the periodic task
Configured as an event task, for example, the subroutine for threshold 0 of a High Speed
Counter (HSC) function block (%HSCi.TH0)

When consumed as periodic or event tasks, the Free POU subroutine is automatically moved from
the Free POUs area of the Tasks window to the Periodic Task or Events area of the window,
respectively.
When no longer consumed as a periodic task of event task, the subroutine moves back to the Free
POUs area and available to be consumed by other tasks or events.
Creating a New Free POU
Proceed as follows to create a new Free POU:
Step

94

Action

Select the Tasks tab in the left-hand area of the Programming window.

Right-click on Free POUs and choose Add Free POU from the contextual menu that appears.
Result: A new POU with the default name Free POU_0 and default subroutine number SR0
appears below the Free POUs branch and a new rung appears in the Programming workspace.

Optionally, right-click on the new POU and choose Rename POU, then type a new name for the
POU and press Enter.
The name of the Free POU is also updated in the rung that appears in the Programming
workspace.

Optionally, type a comment (see page 149) to associate with the Free POU.
EIO0000001354 12/2015

Programming

Step

Action

Select Subroutine number to the right of the comment box and choose a subroutine number
from the list.
Result: The POU description in the Free POUs list is updated with the subroutine number
chosen, for example SR11.

Create the rungs/steps and source code for the Free POU/Free Grafcet POU, in the Ladder or
IL programming language.

Inserting a New Free POU

Proceed as follows to insert a new Free POU:
Step
1

Action
Select the Tasks tab in the left-hand area of the Programming window.

Select an existing Free POU above which to insert the new Free POU.

Right-click the selected Free POU and choose Insert Free POU from the contextual menu that
appears.

To reposition a Free POU, select a Free POU and click the UP or DOWN button on the toolbar
at the top of the Tasks tab to move the selected Free POU up or down in the program structure.

Copying and Pasting Existing Free POUs

Proceed as follows to copy and paste existing POUs associated with a task to create a Free POU:
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple Free POUs:

Select an existing Free POU.
Press and hold the CTRL key and select each Free POU.

Right-click one of the selected Free POU and choose Copy POU from the contextual menu that
appears.

Right-click and choose Paste POU from the contextual menu that appears.
Result: One or multiple new Free POUs with the name Free POU_x, where x is the next
available Free POU number, and default subroutine number SRx , where x is the next available
subroutine number, appear below Free POUs. All rungs of the POU are automatically associated
with the new Free POU subroutine number.

EIO0000001354 12/2015

95

Programming

Removing Free POUs

Proceed as follows to remove Free POUs:
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select one or multiple Free POUs:

Select an existing Free POU.
Press and hold the CTRL key and select each Free POU.

Delete the selected Free POUs:

Right-click a selected Free POU and choose Delete POU from the contextual menu that
appears.
Press the DELETE key.

NOTE: Unassign (see page 103) a Free POU from a task before removing it.
Assigning Free POUs to Events or Periodic Tasks
By default, Free POUs and subroutines are not associated with any events or tasks.
Refer to Creating Periodic Task (see page 102) for information on how to associate a Free POU
with a periodic task.
Refer to Creating Event Task (see page 109) for information on how to associate a Free POU with
an event.

96

EIO0000001354 12/2015

Programming

Section 6.5
Master Task

Master Task
What Is in This Section?
This section contains the following topics:
Topic

Page

Master Task Description

98

Configuring Master Task

99

EIO0000001354 12/2015

97

Programming

Master Task Description

Overview
The master task represents the main task of the application program. It is obligatory and is created
by default. The master task is made up of sections and subroutines represented within Program
Organizational Units (POUs). Each POU of the master task can be programmed in any of the
supported programming languages.
Procedure

98

For

Refer To

Creating a new POU in the master task

Creating a New POU Associated with a Task (see page 87)

Renaming a POU in the master task

Renaming a POU (see page 88)

Removing a POU from the master task

Removing a POU (see page 88)

EIO0000001354 12/2015

Programming

Configuring Master Task

Procedure
Follow these steps to configure the master task:
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select the Master Task item.

Result: The Master Task properties appear in the lower central area of the SoMachine Basic
window.

Modify the properties as required.

Click Apply to save the changes.

Master Task Properties

Scan Mode
Choose the scan mode to use for the program:
Normal: When a logic controller is in normal (freewheeling) scan mode, a new scan starts
immediately after the previous scan has completed.
Periodic: In periodic scan mode, the logic controller waits until the configured scan time has
elapsed before starting a new scan. Every scan is therefore the same duration.
Specify the scan Period for the periodic scan mode of 2...150 ms. The default value is 100 ms.

The default scan mode is Normal.

System Bits and Words Controlling the Master Task
The master task can be controlled by system bits (%S) and system words (%SW):
This table lists the system bits:
System BIts

Description

%S11

Watchdog overflow

%S19

Scan period overrun (periodic scan mode)

EIO0000001354 12/2015

99

Programming

This table lists the system words:

System Words

Description

%SW0

Logic controller scan period (periodic scan mode)

%SW30, %SW70

Last scan time. Indicates the execution time of the last

controller scan cycle, that is, the time elapsed between the
start (acquisition of inputs) and the end (update of outputs) of
a master task scan cycle. %SW30 provides the millisecond
part, and %SW70 provides the microseconds part.
For example, if the scan time is 2.250 ms, %SW30 = 2 and
%SW70 = 250.

%SW31, %SW71

Maximum scan time. Indicates the execution time of the

longest controller scan time since the last cold start of the
logic controller. %SW31 provides the millisecond part, and
%SW71 provides the microseconds part.
For example, if the scan time is 2.250 ms, %SW31 = 2 and
%SW71 = 250.

%SW32, %SW72

Minimum scan time. Indicates the execution time of the

shortest controller scan time since the last cold restart of the
logic controller.%SW32 provides the millisecond part, and
%SW72 provides the microseconds part.
For example, if the scan time is 2.250 ms, %SW32 = 2 and
%SW72 = 250.

Refer to the Programming Guide for your hardware platform for a complete list of system bits and
words and their meaning.

100

EIO0000001354 12/2015

Programming

Section 6.6
Periodic Task

Periodic Task
What Is in This Section?
This section contains the following topics:
Topic

Page

Creating Periodic Task

102

Configuring Periodic Task Scan Duration

104

EIO0000001354 12/2015

101

Programming

Creating Periodic Task

Overview
A periodic task is a subroutine, usually of short duration, that is processed periodically. In
SoMachine Basic, this subroutine is implemented as a Free POU (see page 94). The subroutine
can be written in any of the programming languages supported by SoMachine Basic.
Assigning a Subroutine to a Periodic Task
Step
1

Action
Create a new Free POU (see page 94) containing the periodic task subroutine.

Select the Tasks tab in the left-hand area of the Programming window.

Assign a subroutine to the periodic task by one of the following methods:

Select the Periodic Task and click

(Assign Free POU button) on the toolbar at the top

of the Tasks tab.
Right-click the Periodic Task and choose Assign Free POU from the contextual menu that
appears.
Result: The Select a Free POU window is displayed:

NOTE: You can directly add a Free POU to the periodic task. Right-click the Periodic Task and
choose Add Free POU from the contextual menu that appears. In this case, a Free POU is
created and assigned to the periodic task.
4

102

Select a Free POU to assign to the periodic task and click OK.
Result: The selected subroutine is assigned to the Periodic Task and no longer avaialble in the
Free POU branch of the Tasks tab.
For example, if the Free POU Free POU_0 containing the subroutine SR4 is assigned to the
periodic task, the Free POU_0 (%SR4) subroutine moves from the Free POU branch to the
Periodic Task branch of the Tasks tab.

EIO0000001354 12/2015

Programming

Removing a Subroutine from a Periodic Task

Step

Action

Click the Tasks tab in the left-hand area of the Programming window.

Remove the subroutine from the Periodic Task by one of the following methods:
Select the Periodic Task and click

(Unassign Free POU button) on the toolbar at the

top of the Tasks tab.
Right-click the Periodic Task and choose Unassign Free POU from the contextual menu that
appears.
Result: The selected subroutine is removed from the Periodic Task and available as a Free
POU in the Free POUs branch of the Tasks tab.

EIO0000001354 12/2015

103

Programming

Configuring Periodic Task Scan Duration

Procedure
Follow these steps to configure scan duration for periodic task:
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select the Periodic Task item.

Result: The Periodic Task properties appear in the lower central area of the SoMachine Basic
window.

Modify the properties as required.

Click Apply to save the changes.

Periodic Task Properties

Specify the scan Period for the periodic task from 2...255 ms. The default value is 255 ms.

104

EIO0000001354 12/2015

Programming

Section 6.7
Event Task

Event Task
What Is in This Section?
This section contains the following topics:
Topic

Page

Overview of Event Tasks

106

Event Sources

107

Event Priorities

108

Creating Event Task

109

EIO0000001354 12/2015

105

Programming

Overview of Event Tasks

Introduction
An event task:

Is a part of a program executed when a given condition is met (event source)

Has a higher priority than the main program
Produces a rapid response time, enabling the overall response time of the system to be
reduced.

Description of an Event
An event is composed of:

106

An event source: a software or hardware condition that interrupts the program when the event
is triggered.
A POU: an independent program entity (subroutine) associated with an event.
A priority level: a priority assigned to events to determine the order in which they are executed.

EIO0000001354 12/2015

Programming

Event Sources
Overview
8 event sources are available:

4 linked to selected physical inputs of the logic controller

4 linked to the HSC function block thresholds

An event source is always attached to a single event. When an event is triggered, it interrupts the
controller, which then executes the subroutine associated with the event.
Physical Input Events of a Logic Controller
The embedded digital inputs %I0.2, %I0.3, %I0.4 and %I0.5 of a logic controller can be configured
as event sources (filtering must be disabled).
For each of these event sources, you can choose to:

Trigger events on detection of a rising edge, falling edge, or both rising and falling edges
Assign a priority to the event
Identify the subroutine associated with the event.

For further details on configuring input events, refer to the Programming Guide of the logic
controller.
Threshold Output Event of an %HSC Function Block
The threshold outputs TH0 and TH1 of the %HSC function block can be used as event sources.
Outputs TH0 and TH1 are set as follows:

TH0 = 0 and TH1 = 0 when the value is less than threshold S0 and threshold S1
TH0 = 1 and TH1 = 0 when the value is greater than threshold S0 and less than threshold S1
TH0 = 1 and TH1 = 1 when the value is greater than threshold S0 and threshold S1

For each of these event sources, you can choose to:

Trigger events on detection of a rising edge, falling edge, or both rising and falling edges.
Assign a priority to the event.
Identify the subroutine associated with the event.

A rising or falling edge of these outputs can activate an event process.

For further details on configuring output event, refer to the Programming Guide of the logic
controller.

EIO0000001354 12/2015

107

Programming

Event Priorities
Event Priorities
Events have one of 8 possible priorities, from 7 (the lowest) to 0 (the highest).
Assign a priority to each event source. Two events cannot have the same priority. Thus, the order
of execution depends on their relative priorities and the order in which they are detected.
Event tasks interrupt both master and periodic task execution. For more information, refer to Event
Priority Over Master and Periodic Tasks (see page 84).
NOTE: Care must be exercised when writing to global areas of memory or affecting I/O values
when event tasks are called during the execution of other tasks. Modifying values that are
otherwise used in the other tasks could affect logical outcomes of those tasks adversely.

WARNING
UNINTENDED EQUIPMENT OPERATION
Thoroughly test and validate all tasks (Master, Periodic and any Event tasks) and the interactive
affect they have on one another before putting your application into service.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
For configuring the event task priorities, refer to Programming Guide of your controller.
Event Management
Each time an interrupt linked to an event source appears, the following sequence is launched:

108

Step

Description

Interrupt event occurs.

Save the context.

Execution of the programming section (subroutine labeled SRi:) linked to the event.

Update the embedded outputs.

Restore the context.

EIO0000001354 12/2015

Programming

Creating Event Task

Overview
You can view currently configured event sources, subroutines currently attached to events, and
check the current status of events using system bits and words.
To view the currently assigned event sources and subroutines (Free POUs) assigned to events,
do the following action:
Step

Action

Select the Tasks tab in the left-hand area of the Programming window.

Select Events:

NOTE: Configured event sources that have not yet been assigned a subroutine appear in red.
NOTE: Only embedded controller inputs/outputs can be used in an event subroutine.

EIO0000001354 12/2015

109

Programming

Assigning a Free POU to an Event Source

Proceed as follows to assign a Free POU to a configured event source:
Step

Action

Create a new Free POU (see page 94) containing the subroutine to use for the event.

Select the Tasks tab in the left-hand area of the Programming window.

Assign a subroutine to the event source by one of the following methods:

Select the event source in the Events list and click

(Assign Free POU button) on the

toolbar at the top of the Tasks tab.
Right-click the event source in the Events list and choose Assign Free POU from the
contextual menu that appears.
Result: The Select a Free POU window is displayed:

NOTE: You can directly add a Free POU to the event source. Right-click the event source in the
Events list and choose Add Free POU from the contextual menu that appears. In this case, a
Free POU is created and assigned to the event source.
4

110

Select a Free POU to assign to the event source and click OK.
Result: The selected subroutine is assigned to the event source and no longer avaialble in the
Free POU branch of the Tasks tab.
For example, if the Free POU Free POU_0 containing the subroutine SR1 is assigned to the
event source, the Free POU_0 (%SR1) subroutine moves from the Free POU branch to the
event source branch of the Tasks tab.

EIO0000001354 12/2015

Programming

Removing a Subroutine from an Event

To remove the association between a subroutine and an event source, follow these steps:
Step

Action

Click the Tasks tab in the left-hand area of the Programming window.

Remove the subroutine from the event source by one of the following methods:
Select the event source in the Events list and click

(Unassign Free POU button) on the

toolbar at the top of the Tasks tab.
Right-click the event source in the Events list and choose Unassign Free POU from the
contextual menu that appears.
Result: The selected subroutine is removed from the event source and available as a Free POU
in the Free POUs branch of the Tasks tab.

Checking Events with System Bits and Words

The following system bits are used to check the events:
System Bit

Description

%S38

Used to enable (%S38 = 1) or disable (%S38 = 0) events processing.

%S39

Used to determine if events are lost.

The following system words are used to check the events:

System Word

Description

%SW48

The number of events that have been executed since the last cold start of the
logic controller.

The values of %S39 and %SW48 are reset to 0 and the value of system bit %S38 is set to its initial
state 1 following a cold restart or after an application is loaded. Their values remain unchanged
after a warm restart.

EIO0000001354 12/2015

111

Programming

Section 6.8
Using Tools

Using Tools
What Is in This Section?
This section contains the following topics:
Topic

112

Page

Messages

113

Animation Tables

115

Memory Objects

118

System Objects

121

I/O Objects

122

Network Objects

123

Software Objects

124

PTO Objects

125

Communication Objects

126

Search and Replace

127

Symbol List

129

Memory Consumption View

133

Rung Templates

135

EIO0000001354 12/2015

Programming

Messages
Overview
SoMachine Basic continuously compiles the source code displayed in the Programming tab into
a program ready to be downloaded to the logic controller.
If errors or advisories are detected, an icon is displayed in the Programming tab:

The icon is also displayed in the Tools tab next to Messages:

The icon that is displayed depends on the message severity:

Icon

Meaning
Advisory
Error

If both advisory and error messages are detected, only the Error icon

is displayed.

Displaying Messages
To display a list of error and advisory messages:
Step

Action

Click the icon on the Programming tab

or:
Click Tools Messages
A list of messages is displayed in the lower central area of the Programming window..

In the Messages area, click the Advisory button to display advisory messages, or the Error
button to display error messages. Click the button again to hide the list of messages.

EIO0000001354 12/2015

113

Programming

Rung Compilation Status

SoMachine Basic also displays the compilation status of each rung in the program individually.
If a rung compiles successfully and there are no messages to display, a green tick symbol appears:

An Advisory icon appears if SoMachine Basic cannot compile the program because the rung is
incomplete, for example, it does not contain a final instruction such as an END, CALL, or Jump:

An Error icon appears if SoMachine Basic detects errors that prevent successful compilation of the
rung:

Advisory and Error icons are also displayed next to the name of each rung with errors in the Tasks
tab:

114

EIO0000001354 12/2015

Programming

Animation Tables
Overview
You can manually add objects to animation tables. An animation table allows you to:

select objects to be displayed in the Trace window (see page 184).

view symbols associated with objects.
view and modify the real-time values of certain object types when SoMachine Basic is
connected to the logic controller and the program is running (online mode).

Animation tables are a component of a SoMachine Basic application, and so are downloaded to
the logic controller as part of the non-program data together with the program. This allows the
objects stored in animation tables to be retrieved when an application is later uploaded from the
logic controller.

Creating an Animation Table

Step

Action

Select the Tools tab in the left-hand area of the Programming window.

Right-click on Animation tables and choose Add new animation table from the contextual
menu that appears.
Result: A new animation table item appears below the Animation Tables area of the
Tools window, and a properties window appears in the lower central area of the window.

EIO0000001354 12/2015

115

Programming

Adding Items To an Animation Table

Step

Action

Select the Tools tab in the left-hand area of the Programming window.

Select the animation table to configure in the Animation tables area of the Tools window.
Result: The properties window appears in the lower central area of the window.

To add a new item to the bottom of the animation table, type the object name into the text box and press
Enter, or click Add.
The following objects can be added to an animation table:
I/O objects
Bit strings (example: %Mx:L where L is the bit count, multiple of 8)
Word tables (example: %MWx:L where L is the word count)
Bits of words (example: %MWx:X where X is the offset of the bit)

To add a new object immediately above an existing object, select a row in the animation table, type the
name of the object to add into the text box, and click Insert.

Animation Table Properties

This table describes the properties of the animation tables:
Parameter

Editable

Value

Description

Used

No

True/False

Indicates whether the object is currently being used in a

program.

Trace

Yes(1)

True/False

Select the object to trace in the Trace window (see page 184).

Address

No

Object address

Displays the address of the object.

Symbol

No

A valid symbol

The name of the symbol associated with this object, if defined.

Value

Yes(2)

Current value

The current value of the object.

If the object type has read/write access and you are in online
mode (see page 29), double-click and type a new object value if
required. The value of the object is updated in real time in the
program running in the logic controller.
See Modifying Real-Time Values (see page 186) for details.

Force

Yes(2)

Force to 0
Force to 1
Not Forced

Only appears for digital inputs and digital outputs. Only editable
when in online mode (see page 29). Allows you to force the
value of the input or output to 0 or 1 as required.
Choose Not Forced to remove any forcing currently applied to
the address.

Comment

No

A valid comment

The comment associated with this object, if defined.

(1) You can select up to 8 objects.

(2) Depending on the object type and on whether you are in online mode.

116

EIO0000001354 12/2015

Programming

Configuring Items In an Animation Table

To search for and optionally replace an object in an animation table, right-click on the object and
choose Search and Replace. Refer to Search and Replace (see page 127) for further details.
To remove an object from an animation table, right-click on the object and choose Remove from
animation table.
Renaming an Animation Table
Step

Action

Right-click on the animation table to rename in the Animation tables area of the Tools window
and click Rename animation table.

Type the new name of the animation table and press Enter.

Deleting an Animation Table

Step
1

Action
Right-click on the animation table to delete in the Animation tables area of the Tools window
and click Delete animation table.

Opening the Trace Window

Step

Action

Select up to 8 objects in the Trace column of an animation table.

Connect (see page 197) to the logic controller or launch the simulator (see page 212).

Select a value in the Time Base list. This determines the refresh frequency of the Trace window
(see page 184), in seconds.

Click Open Trace window.

The Trace window is displayed.

EIO0000001354 12/2015

117

Programming

Memory Objects
Overview
Memory objects include:
Memory bits
Memory words
Constant words

Selecting the Memory Allocation Mode

Before viewing or updating the properties of memory objects, choose the memory allocation mode
(see page 71) to use.
Memory Bit Properties
This table describes each parameter of the Memory bits screen:
Parameter

Editable

Value

Default Value

Description

Used

No

True/False

False

Indicates whether the memory bit is currently

being used in a program.

Address

No

Refer to Bit
Objects

N/A

Displays the address of the memory bit,

where x is the number of memory bits
supported by the logic controller.

Symbol

Yes

A valid symbol

None

Allows you to associate a symbol with this

memory bit.

Value

Yes

Refer to Bit
Objects.

The value of this memory bit.

Comment

Yes

A valid comment

None

Allows you to associate a comment with this

memory bit

Memory Word Properties

First choose the memory word type to display properties for:

%MW. Memory words
%MD. Double words
%MF. Floating-point words

118

EIO0000001354 12/2015

Programming

This table describes the properties of Memory words:

Parameter

Editable

Value

Default Value

Description

Used

No

True/False

False

Indicates whether the memory word is

currently being used in a program.

Equ Used

No

True/False

False

Indicates whether the memory word is

currently being used in an equation.

Address

No

Refer to Word
Objects
(see SoMachine
Basic, Generic
Functions Library
Guide)

N/A

Displays the address of the memory word.

Symbol

Yes

A valid symbol

None

Allows you to associate a symbol with this

memory word.

Value

Yes

Refer to Word
Objects
(see SoMachine
Basic, Generic
Functions Library
Guide).

The value of this memory word.

Comment

Yes

A valid comment

None

Allows you to associate a comment with this

memory word.

Constant Word Properties

First choose the constant word type to display properties for:

%KW. Constant words.
%KD. Double constant words
%KF. Floating-point constant words.

EIO0000001354 12/2015

119

Programming

This table describes each parameter of the Constant words screen:

120

Parameter

Editable

Value

Default
Value

Description

Used

No

True/False

False

Indicates whether the constant word is

currently being used in a program.

Equ Used

No

True/False

False

Indicates whether the constant word is

currently being used in an equation.

Address

No

Refer to Word Objects

(see SoMachine Basic,
Generic Functions
Library Guide)

N/A

Displays the address of the constant word.

Symbol

Yes

A valid symbol

None

Allows you to associate a symbol with this

constant word.

Value

Yes

Refer to Word Objects

(see SoMachine Basic,
Generic Functions
Library Guide)

The value of this constant word.

Comment

Yes

A valid comment

None

Allows you to associate a comment with this

constant word.

EIO0000001354 12/2015

Programming

System Objects
Overview
System bits and words are specific to the logic controller. For details, refer to the Programming
Guide of your logic controller.

EIO0000001354 12/2015

121

Programming

I/O Objects
Overview
The following object types are hardware-specific and depend on the logic controller being used:
Digital inputs and outputs
Analog inputs and outputs
Advanced function blocks such as fast counters, high-speed counters, and pulse generators.

For more details, refer to the Programming Guide and Advanced Functions Library Guide of your
logic controller.

122

EIO0000001354 12/2015

Programming

Network Objects
Presentation
Network objects are used to communicate with EtherNet/IP or Modbus TCP devices.
There are two types of network object for EtherNet/IP communication:
%QWEi: Input Assembly
%IWEi: Output Assembly

There are two types of network object for Modbus TCP communication:
%QWMi: Input registers
%IWMi: Output registers

NOTE: References to input and output are from the point of view of the EtherNet/IP master or
Modbus TCP client.
For more information on how to configure network objects, refer to the programming guide for your
logic controller (see Modicon M221, Logic Controller, Programming Guide).

EIO0000001354 12/2015

123

Programming

Software Objects
Overview
SoMachine Basic supports the following generic software objects:
Object

Description

Timers

Used to specify a period of time before doing something, for example,

triggering an event.

Counters

Provides up and down counting of events.

Messages

Allows communication with external devices.

LIFO/FIFO Registers

A memory block that can store up to 16 words of 16 bits each in FIFO

or LIFO modes.

Drum Registers

Operates on a principle similar to an electromechanical Drum

Controller, which changes step according to external events. On each
step, the high point of a cam gives a command which is executed by the
logic controller.

Shift Bit Registers

Provides a left or right shift of binary data bits (0 or 1).

Step Counters

Provides a series of steps to which actions can be assigned.

Schedule Blocks

Used to control actions at a predefined month, day, and time.

PID

Allows regulation of the Proportional Integral Derivative (PID) function.

These function blocks are described in the SoMachine Basic Generic Functions Library Guide.
Selecting the Memory Allocation Mode
Before viewing or updating the properties of software objects, choose the memory allocation mode
(see page 71) to use.

124

EIO0000001354 12/2015

Programming

PTO Objects
Overview
The PTO objects provide the function blocks used for programming the PTO functions. The PTO
function blocks are categorized as:
Motion
These function blocks control motions of the axis. For example, power to axis, movement of the
axis, and so on.
Administrative
These function blocks control the status and diagnostics of the axis movement. For example,
status and value of actual velocity, actual position, axis control detected errors, and so on.
For more details on the PTO function blocks, refer to the Advanced Function Library Guide of your
controller.

EIO0000001354 12/2015

125

Programming

Communication Objects
Overview
Communication objects are used to communicate with Modbus devices, and to send/receive
messages in character mode (ASCII).
For details, refer to the chapter Communication Objects (see SoMachine Basic, Generic Functions
Library Guide).

126

EIO0000001354 12/2015

Programming

Search and Replace

Overview
Search and Replace allows you to find all occurrences of an object used anywhere in a program
and optionally replace it with a different object.
Searching and Replacing Items
Step
1

Action
Select the Tools tab in the left-hand area of the Programming window.
It is also possible to invoke the search and replace function from various other locations in
SoMachine Basic, for example, by right-clicking on an entry in an animation table (see page 115)
and selecting Search & Replace.
You can use any of the following methods to display the Search and Replace window:
Click Search and Replace in the Tools tab of the Programming window.
Right-click on a rung or a selected item in the rung and click Search and Replace in the

context menu that appears.

Right-click on a line in the properties window of any object and click Search and Replace in

the context menu that appears.

This graphic shows the Search and Replace window:

In the Find box type the object or symbol name to find. The Find field is pre-filled if the search
was started by right-clicking on a selected item in a rung or an item in a properties window of an
object.)
You can use the following wildcard characters:
Asterisk (*). Replaces 0 or more characters in the search term. For example, %MW1* would
find both %MW1 and %MW101.
Question mark (?). Replaces exactly 1 character in the search term. For example, typing
COIL?2 would find COIL12 but not COIL012

Optionally, in the Replace box type a replacement object or symbol name.

Select Program to search for the item within the source code of the current program.
Select Comments to search for the item within program comments.

EIO0000001354 12/2015

127

Programming

Step

128

Action

Click Search or Replace. You can also press ENTER to start the search.
Replace button is enabled only when the replacement object or symbol name is given in the
Replace box.
All items found are listed in the Results list:

Optionally, select Show symbols to display instead any symbols defined for objects:

Click on any of the listed results to jump directly to the line of code in the program.

EIO0000001354 12/2015

Programming

Symbol List
Overview
You can display a list of all the symbols that have been associated with objects in your program.
All objects with symbols are displayed, except the system bits (%S) and system words (%SW).
Defining and Using Symbols (see page 69) describes how to create symbols and use them in your
programs.
Displaying the Symbol List
Step

Action

Select the Tools tab in the left-hand area of the Programming window.

Click Symbol list.

Result: The Symbol list window is displayed. For each item the following information is
displayed:
Used: Whether the symbol is currently being used in the program.
Address: The address of the object with which the symbol is associated.
Symbol: The symbol name.
Comment: The comment associated with this object, if defined.

Importing Symbols
Step

Action

Either click the Import button or right-click anywhere in the list of symbols and choose
Import symbols.
Result: The Import Symbols window is displayed.

Browse and select the File path of the Comma Separated Values (CSV) file containing the
symbols to import.

Optionally, click Import options and configure formatting options for the imported symbols:

EIO0000001354 12/2015

129

Programming

Step

Action

Click Import.
Result: All symbols in the selected CSV file are created and displayed in the Symbol list
window with the specified formatting options.
If errors are detected during import, a report is displayed listing them:

Click Save to write the contents of the report to a plain text (.txt) file.

Exporting the Symbol List

Step

130

Action

Either click the Export button or right-click anywhere in the list of symbols and choose
Export symbols You are prompted to save changes.
The Export Symbols window is displayed.

Browse and select the File path and File name of the Comma Separated Values (CSV) file to
be created.

Optionally, click Export options and configure formatting options for the exported values:

Click Export.
Result: A CSV file is created with the specified formatting options.

EIO0000001354 12/2015

Programming

Sharing Symbols Between a SoMachine Basic Project and a Vijeo-Designer Project

Before sharing the symbols with a Vijeo-Designer project, verify that all symbols that you want to
share are defined in the SoMachine Basic project. If not, create/open a project in SoMachine Basic,
define the symbol names, and save the product.
Follow these steps to share SoMachine Basic symbols with a Vijeo-Designer project:
Step

Action

Start Vijeo-Designer.

Create/open a project in Vijeo-Designer.

Click the Project tab in the Navigator window, right-click IO Manager and select
New Driver... Insert.
Result: The New Driver window opens.

Select a driver from the Driver list, select an equipment from the Equipment list, and click OK.
For example:
Driver: Modbus TCP/IP
Equipment: Modbus Equipment
Result: The Equipment Configuration window opens.

Enter the details for each parameter and click OK. For example, IP Address, Unit ID, IP
Protocol, and so on.
Result: A new driver is created to open the communication with the controller. The selected
driver and the selected equipment appear under the IO Manager node in the Project tab of the
Navigator window.

In the Vijeo-Designer menu bar, click Variable Link Variables.

Result: The Link Variable window opens.

Select the Files of type filter to SoMachine Basic project files (*.SMBP) and select the
Equipment filter to the driver that you have created for communication.

Select the SoMachine Basic project in which you have defined the symbols and click Open.
Result: All the symbols are automatically extracted from the project and linked to the driver that
you have created.

Select the variables that you want to use and add them to your HMI application.
Result: All the variables with same names as symbols are added in the list of available
variables. The variable list appears under the Variables node in the Project tab of the
Navigator window.

NOTE: If you have already shared the symbols with a Vijeo-Designer project before and if you
change the existing symbols and/or add new symbols to your project in SoMachine Basic, you
must update the symbols in the Vijeo-Designer project.

EIO0000001354 12/2015

131

Programming

To update the symbols in a Vijeo-Designer project, first define new symbols and/or modify the
existing symbols, save the SoMachine Basic project, and open the Vijeo-Designer project and
follow these steps:
Step

132

Action

In the Project tab of the Navigator window, right-click Variables and select Update Link.
Result: The equipment driver and the existing symbols are updated.

Right-click Variables again, select New Variables from Equipment and select the new
variables that you have created in the SoMachine Basic project.
Result: The new variables from the SoMachine Basic project are added in the list of variables.
These variables appear under the Variables node in the Project tab of the Navigator window.

EIO0000001354 12/2015

Programming

Memory Consumption View

Overview
You can display information about the controller memory used by the application, program, and
associated user data.
Displaying the Memory Consumption View
The program must first compile with no errors detected to use this feature. Refer to the Messages
window (see page 113) for the current program status.
To open the Memory consumption view, follow this procedure:
Step

Action

Select the Tools tab in the left-hand area of the Programming window.

Click Memory Consumption.

The Memory Consumption window is displayed.

Description of the Memory Consumption View

NOTE: This view is available only if there is a valid compilation.
The following tables describe the fields of the Memory consumption view:
Field

Description

Last Compilation

The date and time on which the program was last compiled.

NOTE:
This value is updated whenever:

the Compile button

on the toolbar is clicked
a login to a controller is initiated
a program upload is started
a program modification is sent to the controller in online mode
the simulator is launched

Program lines
Field

Description

Program lines used

The number of lines of code being used by the program.

Program lines remaining

The maximum number of lines available for the program minus the number of lines
being used.

EIO0000001354 12/2015

133

Programming

Cache memory
Field

Description

Periodic and Event tasks

The amount of cache memory occupied by periodic and event tasks, in bytes.

Reserved for system

The amount of cache memory reserved for system use, in bytes.

Memory remaining

The amount of cache memory available to the program, in bytes.

RAM memory
Field

Description

Master task and subroutines

The amount of RAM memory occupied by the program master task and all
subroutines, in bytes.

Configuration

The amount of RAM memory used to contain the hardware configuration of the logic
controller and expansion modules, in bytes.

Memory objects

The amount of RAM memory occupied by memory objects (memory bits, memory
words, and constant words) used by the application, in bytes.

Display

The size of the Remote Graphic Display application, in bytes. Zero if the logic
controller does not support the Remote Graphic Display.

Non-program data

The amount of RAM memory occupied by project properties, symbols, and

comments, in bytes.

Memory remaining

The amount of RAM memory available to the program, in bytes.

134

EIO0000001354 12/2015

Programming

Rung Templates
Overview
A rung template is a pre-configured portion of source code that you can insert into your programs
to make programming quicker while reducing coding errors. SoMachine Basic maintains separate
lists of Ladder Diagram and Instruction List rung templates.
Inserting a Rung Template into a Program
Follow these steps to insert a rung template into a program:
Step

Action

Select the Tools tab in the left-hand area of the Programming window.

Click Rung templates Ladder or Rung templates Instruction List.

A list of current rung templates in Ladder Diagram or Instruction List format is displayed.

Inserting a rung template into a program is possible by any of the following methods:
Select a rung in your program in the programming workspace and then double-click a rung
template.
Right-click on a rung template and click Copy rung in the context menu and then right-click
in the programming workspace and click Paste Rung in the context menu.
Result: The rung template is always inserted after the last rung in a POU. Use UP and DOWN
arrow button on the toolbar at the top of the Tasks tab to reposition the rungs in your program.

This graphic shows the rung templates in Ladder Diagram language:

EIO0000001354 12/2015

135

Programming

This graphic shows the rung templates in Instruction List language:

136

EIO0000001354 12/2015

Programming

Section 6.9
Ladder Language Programming

Ladder Language Programming

What Is in This Section?
This section contains the following topics:
Topic

Page

Introduction to Ladder Diagrams

138

Programming Principles for Ladder Diagrams

140

Ladder Diagram Graphic Elements

141

Comparison Blocks

147

Operation Blocks

148

Adding Comments

149

Programming Best Practices

150

EIO0000001354 12/2015

137

Programming

Introduction to Ladder Diagrams

Introduction
Ladder Diagrams are similar to relay logic diagrams that represent relay control circuits. The main
differences between the 2 are the following features of Ladder Diagram programming that are not
found in relay logic diagrams:

All inputs and binary logic bits are represented by contact symbols (

All outputs and binary logic bits are represented by coil symbols (
).
Numerical operations are included in the graphical Ladder instruction set.

).

Ladder Diagram Equivalents to Relay Circuits

The following illustration shows a simplified wiring diagram of a relay logic circuit:

The equivalent Ladder diagram:

In the above illustration, all inputs associated with a switching device in the relay logic diagram are
shown as contacts in the Ladder Diagram. The M1 output coil in the relay logic diagram is
represented with an output coil symbol in the Ladder Diagram. The address numbers appearing
above each contact/coil symbol in the Ladder Diagram are references to the locations of the
external input/output connections to the logic controller.

138

EIO0000001354 12/2015

Programming

Ladder Diagram Rungs

A program written in Ladder Diagram language is composed of rungs which are sets of graphical
instructions drawn between 2 vertical potential bars. The rungs are executed sequentially by the
logic controller.
The set of graphical instructions represents the following functions:

Inputs/outputs of the controller (push buttons, sensors, relays, pilot lights, and so on)
Functions of the controller (timers, counters, and so on)
Math and logic operations (addition, division, AND, XOR, and so on)
Comparison operators and other numerical operations (A<B, A=B, shift, rotate, and so on)
Internal variables in the controller (bits, words, and so on)

These graphical instructions are arranged with vertical and horizontal connections leading
eventually to one or several outputs and/or actions. A rung cannot support more than one group of
linked instructions.
Example of Ladder Diagram Rungs
The following diagram is an example of a Ladder Diagram program composed of 2 rungs.

EIO0000001354 12/2015

139

Programming

Programming Principles for Ladder Diagrams

Programming Grid
Each Ladder rung consists of a grid of up to 1,000 rows by 11...30 columns that are organized into
2 zones as shown in the following illustration:

n Number of configured columns (11...30). For more information on configuration of number of

columns, refer to Customizing the Ladder Editor (see page 51).
Grid Cells
Cells allow you to position graphical elements in the grid. Each cell in the grid is delimited by 4 dots
at the corners of the cell.
Grid Zones
By default, the Ladder Diagram programming grid is divided into 2 zones:

140

Test zone
Contains the conditions that are tested in order to perform actions. Consists of columns 1 to n1, where n is the number of configured columns and contains contacts, function blocks, and
comparison blocks.
Action zone
Contains the output or operation that will be performed according to the results of the tests of
the conditions in the Test zone. Consists of columns n-1 to n, where n is the number of
configured columns and contains coils and operation blocks.

EIO0000001354 12/2015

Programming

Ladder Diagram Graphic Elements

Introduction
Instructions in Ladder Diagrams are inserted by dragging and dropping graphic elements from the
toolbar that appears above the programming workspace into a grid cell.
Inserting a Graphic Element
To insert a graphic element in a rung:
Step

Action

Click the graphic element on the toolbar to insert. If the graphic element is a menu, the graphic items in
the menu appear; click the menu item to insert.

Move the mouse to the position in the rung to insert the graphic element and click.
Note: Some elements have to be inserted in the test or action zones of the rung; refer to the description
of individual graphic elements for details.

3
If necessary, click the [Selection mode] graphic element

on the toolbar to reset the selection.

Rungs
Use the following graphic elements to manage the rungs in a program:
Graphic
Element

Name

Function

Create a rung
(see page 89)

Inserts a new empty rung below the last rung in the program workspace.

Insert a rung
(see page 89)

Inserts a new empty rung immediately above the currently selected rung.

Delete the rung

(see page 91)

Removes the currently selected rung from the program. If the rung is not empty, you
are asked to confirm that you want to delete the contents of the rung.

Branching Modes
Use the following graphic elements to manage the branch in Ladder diagram:
Graphic
Element

EIO0000001354 12/2015

Name

Function

Normal mode

Lets you place the programming elements (for example, contacts, coils,
and so on, except the function blocks) inline with the wire line.

Branching mode

Lets you place the programming elements (for example, contacts, coils,
and so on, except the function blocks) in branch with the wire line.
141

Programming

Selections and Lines

Use the following graphic elements to select graphic elements and draw lines:
Graphic
Element

Name

Function

Selection mode

Selection mode.

Draw line

Draws a wire line between 2 graphic elements.

Erase line

Erases a wire line.

Contacts
Use the following graphic elements to insert contacts (one row high by one column wide).
Graphic
Element

142

Name

Instruction
List

Function

Normally open contact

LD

Passing contact when the controlling bit object is at

state 1.

Normally closed
contact

LDN

Passing contact when the controlling bit object is at

state 0.

Contact for detecting a

rising edge

LDR

Rising edge: detecting the change from 0 to 1 of the

controlling bit object.

Contact for detecting a

falling edge

LDF

Falling edge: detecting the change from 1 to 0 of

the controlling bit object.

EIO0000001354 12/2015

Programming

Comparison Block
Comparison blocks are placed in the test zone of the programming grid. The block may appear in
any row or column in the test zone as long as the entire length of the instruction resides in the test
zone.
The graphic element for comparison blocks takes up 2 cells (1 row high by 2 columns wide).
Graphic
Element

Name

Instruction
List

Function

Comparison block

Any valid
comparison
expression

Use the Comparison block graphical symbol to

insert Instruction List comparison expressions
(see page 147) into Ladder Diagram rungs.
A comparison expression compares 2 operands;
the output changes to 1 when the result is checked.

Boolean Operations
The graphic element for boolean operations takes up 1 cell (1 row high by 1 column wide).
Graphic
Element

EIO0000001354 12/2015

Name

Operator

Function

XOR instructions

XOR,
XORN,
XORR,
XORF

The XOR instruction performs an exclusive OR

operation between the operand and the Boolean
result of the preceding instruction.
The XORN instruction performs an exclusive OR
operation between the inverse of the operand and
the Boolean result of the preceding instruction.
The XORR instruction performs an exclusive OR
operation between the rising edge of the operand
and the Boolean result of the preceding instruction.
The XORF instruction performs an exclusive OR
operation between the falling edge of the operand
and the Boolean result of the preceding instruction.

143

Programming

Functions
Function blocks always appear in the first row of the Ladder Diagram programming grid; no Ladder
instructions or lines of continuity may appear above or below the function block. Ladder test
instructions lead to the left side of the function block, and test instructions and action instructions
lead from the right side of the function.
The graphic elements of function blocks can only be placed in the test zone and require 2, 3, or 4
rows by 2 columns of cells.
Graphic
Element

Name

Function

Timers, counters,
registers, and so on.

Each of the function blocks uses inputs and outputs that enable
links to the other graphic elements.

NOTE: Outputs of function blocks cannot be connected to each

other (vertical shorts).

Coils
The coil graphic elements can only be placed in the action zone and take up 1 cell (1 row high and
1 column wide).
Graphic
Element

Name

Operator

Function

Direct coil

ST

The associated bit object takes the value of the test

zone result.

Inverse coil

STN

The associated bit object takes the negated value

of the test zone result.

Set coil

The associated bit object is set to 1 when the result

of the test zone is 1.

Reset coil

The associated bit object is set to 0 when the result

of the test zone is 1.

Grafcet (List) Instructions

Use the following graphic elements to manage the branch in Ladder diagram:
Graphic
Element

144

Name

Operator

Function

Grafcet step activation/

Current step deactivation

Deactivates the current step and optionally

activates another step in the Grafcet program.

EIO0000001354 12/2015

Programming

Graphic
Element

Name

Operator

Function

Grafcet step deactivation

#D

Deactivates a step in the Grafcet program in

addition to deactivating the current step.

Operation Blocks
The operation block element placed in the action zone and occupy 2 columns by 1 row:
Graphic
Element

Name

Operator

Function

Operation block

Any valid operator

or assignment
instruction

Use the Operation block graphical symbol to insert

Instruction List operations and assignment
instructions (see page 148) into Ladder Diagram
rungs.

Other Items

The Other Items menu

groups together miscellaneous instructions.

The OPEN and SHORT instructions provide a convenient method for debugging and troubleshooting
Ladder programs. These special instructions alter the logic of a rung by either shorting or opening
the continuity of a rung as explained in the following table.
The END/JUMP graphic elements are placed in the action zone and take up 1 cell (1 row high and
1 column wide).
Graphic
Element

Name

Operator

Function

Logical NOT

Passes the inverse value of its operand.

OPEN

LD 0
AND 0

At the beginning of the rung.

Within a rung: Creates a break in the continuity of a Ladder
rung regardless of the results of the last logical operation.

SHORT

LD 1
OR 1

At the beginning of the rung.

Within a rung: Allows the continuity to pass through the rung
regardless of the results of the last logical operation.

Stop program

END

Defines the end of the program.

Conditional stop ENDCN

program

EIO0000001354 12/2015

Defines a conditional end of the program.

145

Programming

Graphic
Element

Name

Operator

Jump or
subroutine call

JMP

Conditional
jump or
subroutine call

JMPCN

Function
Connect to an upstream or downstream labeled rung.

NOTE: When programming in IL, connection is to an

upstream or downstream labeled instruction.
Conditional connect to an upstream or downstream labeled
rung.

NOTE: When programming in IL, connection is to an

upstream or downstream labeled instruction.

Contacts and Coils

Once inserted in a cell, additional information is displayed about the object associated with
contacts and coils:

Legend

146

Item

Description

User comment

Click to add a comment (see page 149).

Symbol

Click to type the name of a symbol (see page 69) to associate with
the object contained in the cell.

Address

Click to type the address of the object contained in the cell.

Graphic element

The graphic element.

Real-time value

When in online mode (connected to a logic controller and program

running), displays the real-time value of the object in the cell.

EIO0000001354 12/2015

Programming

Comparison Blocks
Inserting IL Comparison Expressions in Ladder Diagrams
You can use the Comparison Block graphical symbol to insert Instruction List comparison
expressions into Ladder Diagram rungs:

Proceed as follows:
Step

Action

1
Click the Comparison Block

button on the toolbar.

Click anywhere in the rung to insert the Comparison Block.

Double-click the Comparison expression line.

Type a valid Instruction List comparison operation and press ENTER.

Getting Help with Syntax

If the syntax of the Instruction List comparison operation is incorrect, the border of the Comparison
expression box turns red. For assistance, either:
Move the mouse over the Comparison expression line, or
Select Tools Program Messages.

EIO0000001354 12/2015

147

Programming

Operation Blocks
Inserting IL Operations and Assignment Instructions in Ladder Diagrams
You can use the Operation Block graphical symbol to insert Instruction List operations and
assignment instructions into Ladder Diagram rungs:

To insert an operation block in a rung:

Step

Action

1
Click the Operation Block

button on the toolbar.

Click in the Action zone (last 2 columns) of the rung to insert the Operation Block.

Double-click the operation expression line.

Type a valid Instruction List operation or assignment instruction and press ENTER.

Getting Help with Syntax

If the syntax of the Instruction List operation or assignment instruction is incorrect, the border of
the operation expression box turns red. For assistance, either:
Move the mouse over the operation expression line, or
Select Tools Program Messages.

148

EIO0000001354 12/2015

Programming

Adding Comments
To Add Comments to Ladder Diagrams
To add comments to a Ladder Diagram program, follow these steps:
Step

Action

Insert a graphic element into the rung.

If necessary, click the selection pointer or press Esc.

Double-click the Comment line at the top of the graphic element.

Type the comment for the graphic element and press ENTER.

Example of Ladder Diagram Comments

This illustration shows an example of comments in a rung of a Ladder Diagram:

EIO0000001354 12/2015

149

Programming

Programming Best Practices

Handling Program Jumps
Use program jumps with care to avoid long loops that can increase scan time. Avoid jumps to
instructions that are located upstream.
NOTE: An upstream instruction line appears before a jump in a program. A downstream instruction
line appears after a jump in a program.
Programming of Outputs
Physical outputs, as well as logical bits, should only be modified once in the program. In the case
of physical outputs, only the last value scanned is taken into account when they are updated.
Using Directly-Wired Emergency Stop Sensors
Sensors used directly for emergency stops must not be processed by the logic controller. They
must be connected directly to the corresponding outputs and applied in conformity with local,
national and/or international regulations.
Handling Power Returns
After a power outage, make power returns conditional on a manual operation. An automatic restart
of the installation could cause unintended operation of equipment (use system bits %S0, %S1, and
%S49). Other system bits and system words may also help manage restarts after power outages.
Refer to System Bits (%S) and System Words (%SW).

WARNING
UNINTENDED EQUIPMENT OPERATION
Do not use the equipment configured and programmed by this software in safety-critical machine
functions, unless the equipment and software are otherwise designated as functional safety
equipment and conforming to applicable regulations and standards.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Time and Schedule Block Management
The state of system bit %S51, which indicates any detected RTC errors, should be verified.
Syntax Validation
As you are programming, SoMachine Basic validates the syntax of the instructions, the operands,
and their associations.

150

EIO0000001354 12/2015

Programming

Additional Notes on Using Parentheses

Do not place assignment instructions within parentheses:

The equivalent Ladder Diagram produces a short circuit error:

In order to perform the same function, program the instructions in the following manner:

EIO0000001354 12/2015

151

Programming

The equivalent Ladder Diagram:

If several contacts are in parallel, nest them within each other:

Alternatively, completely separate the contacts as follows:

152

EIO0000001354 12/2015

Programming

Section 6.10
Instruction List Programming

Instruction List Programming

What Is in This Section?
This section contains the following topics:
Topic

Page

Overview of Instruction List Programs

154

Operation of List Instructions

156

List Language Instructions

157

Using Parentheses

161

EIO0000001354 12/2015

153

Programming

Overview of Instruction List Programs

Introduction
A program written in Instruction List language consists of a series of instructions that are executed
sequentially by the logic controller. Each instruction is represented by a single program line and
consists of the following components:

Line number
Current value (in online mode only)
Instruction operator
Operand(s)
Optional comment

Example of an Instruction List Program

The following is an example of an Instruction List program.

Line Numbers
Four-digit line numbers are generated when you create a new program line and managed
automatically by SoMachine Basic.
Current Values
WhenSoMachine Basic is in online mode (see page 29) (connected to a logic controller and the
program is running), SoMachine Basic displays the current value of object types in the IL editor
window.
The displayed values of these objects are updated.

154

EIO0000001354 12/2015

Programming

Instruction Operators
The instruction operator is a mnemonic symbol, called an operator, that identifies the operation to
be performed using the operands. Typical operators specify Boolean and numerical operations.
For example, in the sample program above, LD is the mnemonic for the LOAD operator. The LOAD
instruction places (loads) the value of the operand %M1 into an internal register called the boolean
accumulator.
There are basically 2 types of operators:

Test operators
These set up or test for the conditions necessary to perform an action. For example, LOAD (LD)
and AND.
Action operators
These perform actions as a result of preceding logic. For example, assignment operators such
as STORE (ST) and RESET (R).

Operators, together with operands, form instructions.

Operands
An operand is an object, address, or symbol representing a value that a program can manipulate
in an instruction. For example, in the sample program above, the operand %M1 is an address
assigned the value of an embedded input of the logic controller. An instruction can have from 0 to
3 operands depending on the type of instruction operator.
Operands can represent the following:

Controller inputs and outputs such as sensors, push buttons, and relays.
Predefined system functions such as timers and counters.
Arithmetic, logical, comparison, and numerical operations.
Controller internal variables such as system bits and words.

Comments
To add comments to an Instruction List program
Step

Action

Optionally, click the comment box that appears at the top of the rung above the first line 0000
and type a comment for the rung.

Insert an instruction line.

Click in the Comment area to the right of the instruction.

Type the comment and press Enter.

EIO0000001354 12/2015

155

Programming

Operation of List Instructions

Introduction
Instruction List binary instructions normally have only one explicit operand; the other operand is
implied. The implied operand is the value in the Boolean accumulator. For example, in the
instruction LD %I0.1, %I0.1 is the explicit operand. An implicit operand is loaded in the
accumulator and the previous value of the accumulator is overwritten by the value of %I0.1. This
value now becomes the implicit value for the subsequent instruction.
Operation
An Instruction List instruction performs a specified operation on the contents of the accumulator
and the explicit operand, and replaces the contents of the accumulator with the result. For
example, the operation AND %I1.2 performs a logical AND between the contents of the
accumulator and the input 1.2 and will replace the contents of the accumulator with this result.
All Boolean instructions, except for Load, Store, and Not, operate on 2 operands. The value of
the 2 operands can be either True or False, and program execution of the instructions produces a
single value: either True or False. Load instructions place the value of the operand in the
accumulator while Store instructions transfer the value in the accumulator to the operand. The
Not instruction has no explicit operands and simply inverts the state of the accumulator.
Supported List Instructions
This table shows a selection of instructions in Instruction List language:

156

Type of Instruction

Example

Function

Boolean instruction

LD %M10

Loads the value of internal

bit %M10 into the
accumulator

Block instruction

IN %TM0

Starts the timer %TM0

Word instruction

[%MW10 := %MW50+100]

Addition operation

Program instruction

SR5

Calls subroutine #5

EIO0000001354 12/2015

Programming

List Language Instructions

Introduction
The Instruction List language consists of the following types of instructions or block of instructions:

Test Instructions
Action instructions
Function blocks

This section identifies and describes the instructions for List programming.
Test Instructions
This table describes test instructions in List language.
Mnemonic

Name

LD

Load

Loads the boolean value of the operand into the

accumulator.

LDN

Load Not

Loads the negated boolean value of the operand into

the accumulator.

LDR

Load Rising

Loads the boolean value of the operand into the

accumulator when the value changes from 0 to 1
(rising edge). The value of the accumulator thereafter
will be loaded with 0 until the next transition of the
operand from 0 to 1.

LDF

Load Falling

Loads the boolean value of the operand into the

accumulator when the value changes from 1 to 0
(falling edge). The value of the accumulator thereafter
will be loaded with 1 until the next transition of the
operand from 1 to 0.

AND

And

The Boolean result is equal to the AND logic between

the Boolean result of the previous instruction
(which is stored in the accumulator) and the status of
the operand. The result of the instruction is then itself
implicitly loaded into the accumulator overwriting the
previous value.

ANDN

And Not

The Boolean result is equal to the AND logic between

the Boolean result of the previous instruction
(which is stored in the accumulator) and the inverse
(negated) status of the operand. The result of the
instruction is then itself implicitly loaded into the
accumulator overwriting the previous value.

EIO0000001354 12/2015

Equivalent Graphic
Element

Function

157

Programming

Mnemonic

Name

ANDR

And Rising

The Boolean result is equal to the AND logic between

the Boolean result of the previous instruction and the
detection of the operand's rising edge
(1 = rising edge). The result of the instruction is then
itself implicitly loaded into the accumulator overwriting
the previous value.

ANDF

And Falling

The Boolean result is equal to the AND logic between

the Boolean result of the previous instruction and the
detection of the operand's falling edge
(1 = falling edge). The result of the instruction is then
itself implicitly loaded into the accumulator overwriting
the previous value.

OR

Or

The Boolean result is equal to the OR logic between

the Boolean result of the previous instruction and the
status of the operand (which is stored in the
accumulator).

AND(

And With

Logic AND (Maximum 32 levels of parentheses). The

parentheses specify an intermediate logical result of
the instructions between them, and then that result is
logically AND'd with the value in the accumulator.

OR(

Or With

Logic OR (Maximum 32 levels of parentheses). The

parentheses specify an intermediate logical result of
the instructions between them, and then that result is
logically OR'd with the value in the accumulator.

XOR
XORN
XORR
XORF

Ex Or
Ex Or Not
Ex Or Rising
Ex Or Falling

Exclusive OR

158

Equivalent Graphic
Element

Function

EIO0000001354 12/2015

Programming

Mnemonic

Name

Equivalent Graphic
Element

Function

MPS
MRD
MPP

Memory Push Store

Memory ReaD
Memory PoP

Branch operators for output actions.

Not

Inverts the value of the operand.

Action Instructions
This table describes action instructions in List language.
Mnemonic

Name

ST

Store

The associated operand takes the value of the test

zone result.

STN

Store Not

The associated operand takes the reverse value of the

test zone result.

Set

The associated operand is set to 1 when the result of

the test zone is 1.

Reset

The associated operand is set to 0 when the result of

the test zone is 1.

JMP

Jump

Connect unconditionally to a labeled sequence,

upstream, or downstream.

SRn

Subroutine

Connection at the beginning of a subroutine

(subroutine call).

END

End

End of program.

ENDCN

End Conditional

Conditionally ends the program at a Boolean

result of 0.

EIO0000001354 12/2015

Equivalent Graphic
Element

Function

159

Programming

Function Blocks
This table describes function blocks in List language.
Name
Timers, counters,
registers, and so on.

160

Equivalent
Graphic Element

Function
For each of the function blocks, there are instructions for
controlling the block.
A structured form is used to connect the block inputs and
outputs.
Note: Outputs of function blocks cannot be connected to each
other (vertical shorts).
For more information, refer to Sotfware Objects
(see SoMachine Basic, Generic Functions Library Guide).

EIO0000001354 12/2015

Programming

Using Parentheses
Introduction
With AND and OR logical operators, parentheses are used to nest logical instructions. In so doing,
they specify divergences (branches) in the Ladder editor. Parentheses are associated with
instructions as follows:
Opening the parentheses is associated with the AND or OR operator.
Closing the parentheses is an instruction (an operator with no operand) which is required for
each open parenthesis.
Example Using an AND Instruction
The following examples show how to use parentheses with an AND instruction:
Rung

Instruction

LD
AND
OR
ST

%I0.0
%I0.1
%I0.2
%Q0.0

LD
AND(
OR
)
ST

%I0.0
%I0.1
%I0.2
%Q0.1

NOTE: Refer to the reversibility procedure to obtain the equivalent Ladder Diagram.
Example Using an OR Instruction
The following example shows how to use parentheses with an OR instruction:
Rung

Instruction

LD
AND
OR(
AND
)
ST

%I0.0
%I0.1
%I0.2
%I0.3
%Q0.0

NOTE: Refer to the reversibility procedure to obtain the equivalent Ladder Diagram.

EIO0000001354 12/2015

161

Programming

Modifiers
This table lists modifiers that can be assigned to parentheses.
Modifier

Function

Example

Negation

AND(N or OR(N

Falling edge

AND(F or OR(F

Rising edge

AND(R or OR(R

Comparison

See Comparison Instructions.

NOTE: The '[' modifier can also be used in conjunction with other instructions serving as an
operator. For more uses of the '[' in other instructions, refer to the Introduction to Numerical
Operations.
Nesting Parenthesis
It is possible to nest up to 32 levels of parentheses.
Observe the following rules when nesting parentheses:
Each open parenthesis must have a corresponding closed parenthesis.
Labels (%Li:), subroutines (SRi:), JMP instructions (JMP), and function block instructions must
not be placed in expressions between parentheses.
Store instructions (ST, STN, S, and R) must not be programmed between parentheses.
Stack instructions (MPS, MRD, and MPP) cannot be used between parentheses.

Examples of Nesting Parentheses

The following examples show how to nest parentheses:

162

Rung

Instruction

LD
AND(
OR(N
AND
)
)
ST

%I0.0
%I0.1
%I0.2
%M3

%Q0.0

EIO0000001354 12/2015

Programming

Rung

Instruction

LD
AND(
OR(
AND
)
AND
OR(
AND
)
)
ST

%I0.1
%I0.2
%I0.5
%I0.6
%I0.4
%I0.7
%I0.8

%Q0.0

NOTE: Refer to the reversibility procedure to obtain the equivalent Ladder Diagram.

EIO0000001354 12/2015

163

Programming

Section 6.11
Grafcet (List) Programming

Grafcet (List) Programming

What Is in This Section?
This section contains the following topics:
Topic

164

Page

Description of Grafcet (List) Programming

165

Grafcet Program Structure

166

How to Use Grafcet Instructions in a SoMachine Basic Program

169

EIO0000001354 12/2015

Programming

Description of Grafcet (List) Programming

Introduction
Grafcet (List) programming in SoMachine Basic offer a simple method of translating a control
sequence in to steps. You can translate control sequences in to Grafcet steps and then use these
steps in a program using Grafcet instructions.
The maximum number of Grafcet steps depend on the controller. The number of steps active at
any one time is limited only by the total number of steps.
Grafcet Instructions
A SoMachine Basic Grafcet program has the following instructions:
Operator

Operand

IL Instruction

Instruction Name

Graphic
Equivalent

Description

=*=

=*= x

INITIAL STEP

This instruction defines the intial

step in the program.

=*= POST

Not
applicable

=*= POST

POST
PROCESSING
(implicit operand)

This instruction defnes the

post-processing and end sequential
processing.

-*-

-*- x

STEP

This instruction defines a step in the

program for transition validation.

Not
applicable

DEACTIVATE
CURRENT STEP
(implicit operand)

This instruction deactivates the

current step in the program.

#x

DEACTIVATE
CURRENT STEP
and ACTIVATE
STEPx

This instruction deactivates the

current step and activates step x in
the program.

#D

#D x

DEACTIVATE
CURRENT STEP
and STEPx

This instruction deactivates the

current step and step x in the
program.

x Grafcet step number (an integer starting from 1).

EIO0000001354 12/2015

165

Programming

Grafcet Program Structure

Introduction
A SoMachine Basic Grafcet program has the following parts:

Preprocessing
Sequential processing
Post-Processing

Preprocessing
Preprocessing consists of the following:
Power returns
Error management
Changes of operating mode
Pre-positioning Grafcet steps
Input logic
In this example, the system bit %S21 to 1 with the rising edge of input %I0.6. This disables the
active steps and enables the initial steps:

Preprocessing begins with the first line of the program and ends with the first occurrence of a =*=
or -*- instruction.

166

EIO0000001354 12/2015

Programming

System bits %S21, %S22, and %S23 are dedicated to Grafcet control. Each of these system bits is
set to 1 (if needed) by the application, normally in preprocessing. The associated function is
performed by the system at the end of preprocessing and the system bit is then reset to 0 by the
system.
System Bit

Name

Description

%S21

Grafcet initialization

All active steps are deactivated and the initial steps are activated.

%S22

Grafcet re-initialization

All steps are deactivated.

%S23

Grafcet pre-positioning

This bit must be set to 1 if %Xi objects are explicitly written by the
application in preprocessing. If this bit is maintained to 1 by the
preprocessing without any explicit change of the %Xi objects,
Grafcet is frozen (no updates are taken into account).

Sequential Processing
Sequential processing takes place in the chart (instructions representing the chart):
Steps
Actions associated with steps
Transitions
Transition conditions
Example:

Sequential processing ends with the execution of the POST instruction or with the end of the
program.
EIO0000001354 12/2015

167

Programming

Post-Processing
Post-processing consists of the following:
Commands from the sequential processing for controlling the outputs
Interlocks specific to the outputs

Example:

168

EIO0000001354 12/2015

Programming

How to Use Grafcet Instructions in a SoMachine Basic Program

NOTE: Grafcet instructions can only be used in the master task of a program.
Creating Grafcet Steps in Ladder
Follow these steps to create Grafcet steps in a program:
Step
1

Action
In a POU, select a rung and click the drop-down button below the rung sequence identifier Rungx,
where x is the rung number in a POU.

Result: A menu appears listing the Grafcet instructions.

2

Click an instruction in the list to define the rung as an initial step, post processing, or a step of the
Grafcet program.
Result: The rung is set for a Grafcet instruction. The operator of the instruction appears on the
button and the operand (step number) appears in suffix with the button.

NOTE: The step number is incremented by 1 as you define the next STEP or INITIAL STEP
instruction. You can define only one POST instruction in a program; therefore the POST instruction
does not have any step number.
To modify the step number, double-click the step number in a rung and enter the new number and
then press ENTER.

EIO0000001354 12/2015

169

Programming

Activating or Deactivating Grafcet Steps in Ladder

Follow these steps to activate or deactivate Grafcet steps in a program:
Step
1

Action
In a POU, select a rung in your program.

2
Click
(to deactivate the current step and optionally activate a specified step) or
(to deactivate the current step and to deactivate the specified step) and insert this element in the
action zone of the rung (refer to Inserting a Graphic Element (see page 141)).
3

Alternatively, Press ALT+A to use ACTIVATE instruction or press ALT+D to use DEACTIVATE
instruction in the rung.
Result: The activate or deactivate ladder symbol appears in the action zone of the rung.
Press ENTER to insert this element.

In the program rung, double-click Address field on the Grafcet activate or deactivate symbol and
enter the Grafcet bit address (%Xi, where i is the step number).
For example, %X4 refers to the step 4 of the Grafcet program. If %X4 is the address for the deactivate
symbol, step 4 will be deactivated when the output of the rung, in which this symbol is used, is true.

NOTE: Current step is deactivated in every case.

170

EIO0000001354 12/2015

Programming

Section 6.12
Grafcet (SFC) Programming

Grafcet (SFC) Programming

What Is in This Section?
This section contains the following topics:
Topic

Page

Introduction to Grafcet (SFC) Programming

172

Using the Grafcet (SFC) Graphical Editor

175

Branching

178

Programming Best Practices

182

EIO0000001354 12/2015

171

Programming

Introduction to Grafcet (SFC) Programming

Introduction
Grafcet (SFC) is a graphical programming language that describes a chronological order of
execution of discrete tasks, known as steps. The order in which steps are executed is determined
by transitions connecting the steps.
Elements of a Grafcet (SFC) POU
A Grafcet (SFC) POU has the following components:
Step: A step executes a set of actions defined in one of more rungs written in the Ladder/IL
programming languages. Steps can be:
Initial step: Executed at the beginning of the program or following a controller restart. It is
represented by a cell with a double border.
Regular step: Steps conditionally executed after the initial step completes execution.

Transition: A boolean expression evaluated between steps. It is the link between two or more
steps. The boolean expression is defined in a single rung written in the Ladder/IL programming
languages.

The following diagram is an example of a Grafcet (SFC) POU with an initial step, one regular step,
and two transitions:

1
2
3
4

Initial step
Transition from step 1 to step 2
Regular step
Transition from step 2 back to step 1. An arrow is displayed on the link to indicate that the order of step
execution is not the default left to right, top to bottom.

Grafcet (SFC) POU Rules

Grafcet POU can only be created in the master task of a program.
Multiple Grafcet POUs can be created.

172

EIO0000001354 12/2015

Programming

Grafcet (SFC) Processing

The following rules are applied by the logic controller when executing the Grafcet (SFC):
The master task cycle starts.
The POUs that precede the first Grafcet (SFC) step are executed in a sequential way.
The first Grafcet (SFC) step launches the Grafcet monitor.
When the Grafcet monitor ends, the first POU that follows the last Grafcet (SFC) step is called.

Grafcet monitor behavior:

1. The logic controller processes the associated Grafcet (SFC) system bits %S21, %S22, and
%S23.
2. The logic controller updates the activation states of each Grafcet (SFC) step.
Steps marked to be deactivated are deactivated.
Steps marked to be activated are activated.
Steps marked to be activated and deactivated at the same time will be or will remain
activated.
Activation and deactivation lists are reset.
3. The logic controller scans the steps (loop from lowest defined step number to highest defined
step number). When a scanned step is activated, the associated step code is called.
4. When a transition code activates or deactivates a step, this action is placed respectively in the
activation or deactivation list for the next task cycle.
5. When the last active step code is executed, the Grafcet monitor ends.
Multi-Token Behavior
SoMachine Basic Grafcet POU is multi-token which does not conform IEC 61131-3).
The initial situation is controlled by the steps defined as initial steps.
Multiple steps can be active at the same time in a Grafcet POU.
The active signal status processes take place along the directional links, triggered by switching one
or more transitions. The direction of the process follows the directional links and runs from the
underside of the predecessor step to the top side of the successive step.
A transition is evaluated if the steps immediately preceding it are active. Transitions are not
evaluated if the steps immediately preceding them are not active.
A transition is triggered when the associated transition conditions are satisfied.
Triggering a transition marks as deactivated the immediately preceding steps that are linked to the
transition, and marks as activated the immediately following steps.
The real activation or deactivation of the steps is performed at the beginning of each master task
cycle (see Grafcet monitor (see page 173)).
If more than one transition condition in a row of sequential steps has been satisfied, then one step
is processed per cycle.
If a step is activated and deactivated at the same time, then the step will be or will remain activated.
More than one branch can be active with alternative branches.

EIO0000001354 12/2015

173

Programming

The branches to be run are determined by the result of the transition conditions of the transitions
that follow the alternative branch. Branch transitions are processed in parallel.
The branches with satisfied transitions are triggered.
Subroutine calls can be used in step actions.
Bits Controlling Grafcet (SFC)
Control bit

Name

Description

%S21

Grafcet initialization

If set to 1, the initial steps in the Grafcet POU are

evaluated.

%S22

Grafcet reset

If set to 1, the steps are deactivated and execution

restarts.

%S23

Preset and freeze

Grafcet

If set to 1, execution of the Grafcet POU stops until the

bit is set to 0.

%Xi

Grafcet steps

Bits %X1 to %Xi are associated with Grafcet steps. Step

bit %Xi is set to 1 when the corresponding step is active,
and set to 0 when the step is deactivated. The bit is not
writable when using Grafcet (SFC).

Refer to the description of System Bits (see Modicon M221, Logic Controller, Programming Guide)
for further details.

174

EIO0000001354 12/2015

Programming

Using the Grafcet (SFC) Graphical Editor

Overview
The Grafcet Graphical Editor is used for programming in Grafcet (SFC).
To display the Grafcet Graphical Editor, select any n - Grafcet node in the tree view.
The Grafcet Graphical Editor contains a grid of cells. Each cell contains one step, one transition,
or both.
The minimum size of a Grafcet POU is one step.
The maximum number of steps is 96 for the application.
Inserting Steps
Double-click in any grid cell to add a step.
You can move a step by dragging and dropping in another grid cell.
Defining a Step as an Initial Step
The first step created in the Grafcet Graphical Editor is by default an initial step.
A Grafcet POU must contain at least one initial step. More than one step can be defined as initial
steps.
Step

Action

The first step inserted in a grid is by default an initial an initial step.

To change the step type (initial/regular) right-click the step and choose
Set/Unset as Initial Step.
Result: A double border appears around the step.

To change the initial step to a regular step, or a regular step to an initial step, right-click, and
choose Set/Unset as Initial Step.

Copying and Pasting a Step

Step

Action

Right-click on the step to copy and choose Copy from the contextual menu that appears.

Right-click in an empty grid cell and choose Paste.

Result: A copy of the step appears. Copies of Ladder/IL rungs associated with the step are
added below the corresponding Step subnode in the tree view.

EIO0000001354 12/2015

175

Programming

Creating Transitions
Link steps together to define the order of execution of steps.
To create a transition between two steps:
Step

Action

Move the mouse over the bottom of a step.

Result: A green block appears

Drag the mouse to the step you want to link to.

Release the mouse button.

Result: A link and transition appear.

Editing Labels
To edit the default labels of any step or transition.
Step

Action

Double-click the label of any Grafcet (SFC) step or transition.

Type the new name for the Grafcet (SFC) element and press ENTER.
For example, change the default Step_1 label to INIT.

Programming Step Functionality

The functionality of a step is defined in one or more IL/Ladder language rungs.
To define the functionality of a step:
Step

Action

Either:
Double-click a step in the Grafcet Graphical Editor.
Select a Step node in the tree view, where n is the step number.

Right-click on the selected Step node and choose Add rung from the contextual menu that
appears.
Result: Rungs appear as subnodes of the Step node in the tree view window.

Program the rung in the Ladder or IL programming language and create additional rungs if
needed, as described in Ladder Language Programming (see page 137) or Instruction List
Programming (see page 153).

Select the n -Grafcet POU node to display the Grafcet Graphical Editor again, where n is the
number of the Grafcet POU.

Result: The Grafcet Graphical Editor is closed.

176

EIO0000001354 12/2015

Programming

Programming Transition Functionality

The functionality of a transition is defined in a single IL/Ladder language rung.
To define the functionality of a transition:
Step

Action

Either:
Double-click a transition in the Grafcet Graphical Editor.
Select a Transitions Trn node in the tree view

Program the rung in the Ladder or IL programming language, as described in Ladder Language
Programming (see page 137) or Instruction List Programming (see page 153).

Result: The Grafcet Graphical Editor is closed and a Ladder language rung displayed.

NOTE: The rung ends with an ENDT (end transition) instruction. This instruction cannot be
selected or modified and must be the last instruction in the rung
3

Select the n -Grafcet POU node to display the Grafcet Graphical Editor again, where n is the
number of the Grafcet POU.

Undo/Redo
You can use the Undo or Redo buttons on the toolbar for a maximum of 10 actions stored.
Deleting a Step or Transition
Step
1

Action
In the Grafcet Graphical Editor:
Select a step or transition and press the DELETE key.
Right-click on the step or transition and choose Delete the selected items in the contextual
menu.
Result: The selected step or transition is deleted.

NOTE: You cannot delete a step or transition from the tree view.

EIO0000001354 12/2015

177

Programming

Branching
Introduction
A Grafcet (SFC) POU can contain branches.
Two types of branch exist:
Parallel branching: two or more steps are processed simultaneously when the preceding
transition is true.
Alternative branching: one or more alternative steps are processed depending on the result of
evaluating the preceding transition conditions (multi-token behavior).

Parallel Branching
A parallel branch allows a transition from a single step to multiple steps.
A parallel branch must be preceded and followed by a step.
Parallel branches can contain nested alternative branches or other parallel branches.
The following figure shows an example Grafcet POU with 4 steps before creation of parallel
branching:

178

EIO0000001354 12/2015

Programming

To create a parallel branch for Steps 2 and 3:

Step

Action

Create a transition between Step 1 and Step 2. A new link and transition appears.

Draw a link between Step 3 and the transition: move the mouse to the top of Step 3, then drag
to the transition and release the mouse button.
Result: A horizontal double line appears below the existing transition (see the figure that
follows).

To rejoin the branch with the main processing branch, create a transition between Step 2 and
Step 4.

Draw a link between Step 3 and the new transition: move the mouse to the bottom of Step 3, then
drag to the transition and release the mouse button.
Result: A horizontal double line appears above the transition (see the figure that follows).

The following figure shows a Grafcet POU after the creation of parallel branching:

Notice that the horizontal lines before and after the branched areas are double lines.
Alternative Branching
An alternative branch must begin and end with a transition.
Alternative branches can contain nested parallel branches or other alternative branches.
With multi-token behavior, more than one parallel switch can be made from the transitions. The
branches to be run are determined by the result of the transition conditions of the transitions that
follow the alternative branch. The transitions of the branches are processed. The branches with
satisfied transitions are triggered.
If alternative branches need to be switched exclusively (mono-token behavior), then this must be
defined explicitly within the transition code.

EIO0000001354 12/2015

179

Programming

The following figure shows an example Grafcet POU with 3 steps before creation of alternative
branching for Step 3 and Step 4:

To create an alternative branch:

Step

180

Action

Create a transition between Step 1 and Step 4.

Result: A new link and transition appears.

Draw a transition between Step 1 and Step 3: move the mouse to the bottom of Step 1, then drag
to Step 3 and release the mouse button.
Result: A new link and transition appears, with the branch above the existing transition (see the
figure that follows).

Draw a transition between Step 3 and Step 4.

Result: A new link and transition appears, with the branch below the existing transition between
Step 1 and Step 4 (see the figure that follows).

EIO0000001354 12/2015

Programming

The following figure shows the Grafcet POU after creation of alternative branching:

Notice that the horizontal lines before and after the branched area are single lines.

EIO0000001354 12/2015

181

Programming

Programming Best Practices

Grafcet (SFC) Rules

Steps must be connected by a transition:

You can add only one Grafcet POU in the same Grafcet Graphical Editor:

Crossed Links
You can have crossed links for the following reasons:
Alternative (logical OR) branching (fork or junction)
To save space on the cell grid. When lines cross there is no interaction between the lines and
it is used only for symbolic representation.
182

EIO0000001354 12/2015

Programming

Section 6.13
Debugging in Online Mode

Debugging in Online Mode

What Is in This Section?
This section contains the following topics:
Topic

Page

Trace Window

184

Modifying Values

186

Forcing Values

187

Online Mode Modifications

188

EIO0000001354 12/2015

183

Programming

Trace Window
Overview
The Trace window allows you to display in graphical form the values of specific analog and/or
digital variables (limited to 12 hours of continuous recording). You can export the data to a file for
further analysis.
Trace Window Presentation

184

EIO0000001354 12/2015

Programming

Select Elapsed time to set tracing start time to 00:00:00, or Controller time to use the time and
date of the logic controller as the start time of the trace.
The Trace window displays separate graphs for each data type selected for tracing in the animation
table:
Integer and real values appear in the Numerical trace area.
All numerical values share the same scale on the graph.
Select Auto scale for values to automatically adjust the vertical axis to display all values.
Otherwise, type Maximum and Minimum values to display a fixed range of values.
NOTE: You can type either integer or real values for Maximum and Minimum

Binary values appear in the Logical trace area.

Each binary value is traced on an individual scale of 0 and 1.

Starting, Pausing, and Resetting the Trace

Click Start to begin tracing the variables.
Click Stop to pause real-time tracing.
Click Reset to clear all previously traced data from graphs and reset the Recording duration
value to 0.
Exporting the Trace
Click Export to export all traced data to a file on the PC.
The data is saved in comma-separated value (CSV) format.

EIO0000001354 12/2015

185

Programming

Modifying Values
Introduction
When in online mode, SoMachine Basic allows you to modify the values of certain object types.
Online updating is only possible if the object has read/write access. For example:

The value of an analog input cannot be modified.

The value of the Preset parameter (%TM0.P object) of a Timer function block can be updated.

Refer to the description of objects in the SoMachine Basic Generic Functions Library Guide or the
Programming Guide of your hardware platform for information on which object types have
read/write access.
To modify the value of an object, add it to an animation table (see page 116) and set its properties
as required.

186

EIO0000001354 12/2015

Programming

Forcing Values
Overview
When in online mode, you can force the values of digital inputs and outputs to False (0) or True
(1). This allows you to set addresses to specific values and prevent the program logic or an external
system from changing the value. This function is mainly used for the debugging and fine-tuning of
programs.
To force the values of digital inputs or outputs when in online mode, either modify their
configuration properties or use an animation table (see page 115).
Digital inputs and outputs cannot be forced when:
an input is used as a Run/Stop input
configured as fast counter (FC) inputs
configured as high speed counter (HSC) inputs
configured as reflex outputs

EIO0000001354 12/2015

187

Programming

Online Mode Modifications

Overview
You can modify your program, in both the Instruction List (IL) and Ladder (LD) editors, while in
online mode. However, there are certain limits to the type of editing that you may do, and the
instructions that you may edit, depending on whether your controller is in RUN or STOP. These limits
help protect the state of the controller and the integrity of the program. You can switch the display
between Instruction List (IL) and Ladder (LD), even when in online mode.
Sending Modifications in Online Mode
In IL, the modifications, when allowed, are automatically sent to the logic controller after validation
of the current IL edited line. If the modification is not allowed, a message appears.
In Ladder, the modifications are not sent automatically. A Send button enables you to send the
modifications to the logic controller in STOP/RUN mode. This button is only available when the
program is valid. A Rollback button enables you to restore the initial rung.
In either case, rungs that are modified are evaluted for their viability in the context of whether the
controller is in RUN or STOP. Some modifications will be accepted, while other modifications will be
rejected because they would cause run time errors, or change the structure of the program
memory.
The following table indicates in which cases modifications are allowed:
Operations

In STOP in IL

In RUN in IL

In STOP in
Ladder

In RUN in
Ladder

Event task content

editable

rejected

editable

non-editable

Master / Periodic task content

editable

editable

editable

editable

Free POU content

editable

editable

non-editable

non-editable

Rung with label

editable

rejected

non-editable

non-editable

Rung with end, jump, or calling a non-editable

subroutine or label

non-editable

non-editable

non-editable

Rung with any Grafcet instruction non-editable

non-editable

non-editable

non-editable

Add/modify label

non-editable

non-editable

non-editable

non-editable

NOTE: This table does not take into account all program structure modifications. In each rung
where modifications are not allowed, the entire rung is disabled (gray foreground on the rung).

188

EIO0000001354 12/2015

Programming

EIO0000001354 12/2015

189

Programming

190

EIO0000001354 12/2015

SoMachine Basic
Commissioning
EIO0000001354 12/2015

Chapter 7
Commissioning

Commissioning
What Is in This Chapter?
This chapter contains the following sections:
Section

Topic

Page

7.1

Overview of the Commissioning Window

192

7.2

Connect to a Logic Controller

193

7.3

Controller Update

200

7.4

Memory Management

201

7.5

Controller Info

207

7.6

RTC Management

209

EIO0000001354 12/2015

191

Commissioning

Section 7.1
Overview of the Commissioning Window

Overview of the Commissioning Window

Overview of the Commissioning Window
Introduction
The Commissioning window allows you:

1
2

192

Login to or logout from a logic controller.

Upgrade (or downgrade) the logic controller firmware.
Manage logic controller memory (for example, by performing backup and restore operations).
View information about the logic controller you are connected to.
Manage the real time clock (RTC) of the logic controller.

The Commissioning Tree displays the available commissioning tasks.

The right-hand area allows you to perform operations of the commissioning task.

EIO0000001354 12/2015

Commissioning

Section 7.2
Connect to a Logic Controller

Connect to a Logic Controller

What Is in This Section?
This section contains the following topics:
Topic

Page

Connecting to a Logic Controller

194

Downloading and Uploading Applications

198

EIO0000001354 12/2015

193

Commissioning

Connecting to a Logic Controller

Overview
Click Connect on the Commissioning window to manage the connection with the logic controller.
Connected Controllers
2 lists of logic controllers are displayed:
1. Local Devices
Displays all logic controllers connected to the PC:
with the physical COM ports of the PC (COM1, for example),
with USB cables,
through the virtualized COM ports (by USB-to-serial converters or Bluetooth dongles),
with modem connection that you choose to add manually.
NOTE: If a COM port is selected and the Keep Modbus driver parameters check box is ticked,
the communication is established with the parameters defined in the Modbus driver.
2. Ethernet Devices
Displays all logic controllers that are accessible by Ethernet (on the same subnet and not under
a router or any device that blocks UDP broadcasts). This list includes logic controllers that are
automatically detected by SoMachine Basic as well as any controllers that you choose to add
manually.
Manually Adding Ethernet Controllers
To manually add a logic controller to the Ethernet Devices list:
Step

Action

In the Remote lookup field, type the IP address of the logic controller to add,
for example 12.123.134.21

Click Add to add the device to the Ethernet Devices list.

Manually Adding Modem Connection

Prerequisites for availability of modem:
If no modem is installed on the PC, the button is disabled.
Verify in the Phone and Modem option of the Windows Control Panel that the modem is
installed and perform a test (in the Modem tab, click the modem to test and click Properties
Diagnostics Query Modem). The response of the modem must be valid.
If the modem is an external modem connected on a COM port, verify that the communication
settings are the same in:
the modem advanced parameters,
the communication port parameters,
the Modbus driver parameters.

194

EIO0000001354 12/2015

Commissioning

For more details on the installation and setting of SR2MOD03 modem, refer to the SR2MOD02 and
SR2MOD03 Wireless Modem User Guide (see page 10).
To manually add a modem connection to the Local Devices list:
Step

Action

2
Click
(Add modem configuration button) to open the Modem configuration window.
Result: The Modem configuration window appears.
3

Select the COM port of the modem from the drop-down list:

Configure the communication parameters.

For detailed information on the modem configuration parameters, refer to the table below.

Click Apply.

NOTE: This button is enabled only if all settings are correctly configured.
Result: The modem connection is added to the Local Devices list
(for example COM2@0612345678,GenericModem).

EIO0000001354 12/2015

195

Commissioning

This table describes each parameter of the modem configuration:

196

Parameter

Value

Default value

Description

Port

COMx

Allows you to select the COM port of the modem from

the dropdown list.

Device

Displays the modem name.

Phone Number

Type the phone number of the remote modem

connected to the logic controller.
This text field accepts all the characters and is limited
to 32 characters in total. This field must contain at least
one character to be able to apply the configuration.

AT init cmd

AT&D0

Allows you to edit the AT initialization command of the

modem.
The AT initialization command is not mandatory
(if the field is empty the AT string is sent).

Escape chars

Allows you to edit the escape character for the

hang-up procedure.

Baud rate

1200
2400
4800
9600
19200
38400
57600
115200

19200

Allows you to select the data transmission rate

(bits per second) of the modem.

Parity

None
Even
Odd

Even

Allows you to select the parity of the transmitted data

for error detection.

Data bits

7
8

Allows you to select the number of data bits.

Stop bits

1
2

Allows you to select the number of stop bits.

Timeout (ms)

0...60000

15000

Allows you to specify the transmission timeout (in ms).

Break timeout (ms)

0...10000

10

Allows you to specify the interframe timeout (in ms).

If the check box Automatic is ticked, the value is
automatically calculated.

EIO0000001354 12/2015

Commissioning

Connecting to a Logic Controller

To log in to a logic controller:
Step

Action

1
Click
2

(Refresh Devices button) to refresh the list of connected Ethernet devices.

Select one of the logic controllers in the Local Devices or Ethernet Devices lists.
If a controller is connected by Ethernet on the same network cable than your PC, the IP address
of the controller appears in the list. Selecting the IP address in the list enables
(IP Address Configuration button). Click this button to change the IP address of the controller.

NOTE: If you tick the check box Write to post configuration file, the Ethernet parameters are
modified in the post configuration file and kept after a power cycle.
3
If required, click
(Start Flashing LEDs button) to flash the LEDs of the selected controller
to identify the controller physically by its flashing LEDs. Click this button again to stop flashing
the LEDs.
4

Click Login button to log in to the selected controller.

If the logic controller is password protected, you are prompted to provide the password. Type the
password and click OK to connect.
Result: A status bar appears showing the connection progress.

When connected, the protection status of the application currently stored in the logic controller
appears in the Selected Controller area of the window.
When the connection is successfully established, details about the logic controller appear in the
Selected Controller area of the window:
The firmware revision
The logic controller reference number
The reference numbers of all expansion modules connected to the logic controller
The current state of the connection between SoMachine Basic and the logic controller.

SoMachine Basic checks whether the hardware configuration of the logic controller is compatible
with the configuration of the current project.
If so, the application can be downloaded to the controller. The PC to Controller (download)
button is enabled and you can proceed to download the application (see page 198).

EIO0000001354 12/2015

197

Commissioning

Downloading and Uploading Applications

Downloading the Application
Follow these steps to download the application currently open in SoMachine Basic to the logic
controller:
Step

Action

Click Connect in the commissioning tree of the Commissioning window.

Select one of the logic controllers in the Local Devices or Ethernet Devices lists.

Click Login to log in to the selected controller.

If the logic controller is password protected, type the password and click OK to connect.

4
If you do not want %MW memory words to be reset after the download, click
settings and clear the Reset memories option.

Download

NOTE: This option is available for the logic controllers with firmware version greater than or
equal to 1.3.3.y.

198

Click PC to Controller (download).

If the PC to Controller (download) button is not available, confirm whether:
The application stored in the logic controller is identical to the SoMachine Basic application.
The hardware configuration of the logic controller system is not compatible with the
configuration in the SoMachine Basic application.

If the application has been configured to Start in Run, a hazard message is displayed and
prompts you to confirm that the application has been so configured.
Click OK to confirm the download of the application or click Cancel and modify the configuration.

Click OK to continue the transfer and overwrite the logic controller application.
Result: A status bar appears showing the connection status.

To run the application you have downloaded, click Run controller and click OK to confirm the
action.
If a message appears informing you that the operating mode cannot be changed, click Close and
verify the RUN/STOP switch on the logic controller, and/or, the RUN/STOP input as they may
prevent the controller from passing into RUNNING. Otherwise, refer to the Hardware Guide of
your logic controller for details.

EIO0000001354 12/2015

Commissioning

Uploading an Application
Follow these steps to upload the application stored in the logic controller to SoMachine Basic:
Step

Action

Click Connect in the commissioning tree of the Commissioning window.

Select one of the logic controllers in the Local Devices or Ethernet Devices lists.

Click Login to log in to the selected controller.

If the logic controller is password protected, type the password and click OK to connect.

Click Controller to PC (upload).

If the Controller to PC (upload) button is not available, confirm whether the application stored
in the logic controller is identical to the SoMachine Basic application.

Click OK to confirm upload from the logic controller.

Result: A status bar appears showing the connection status. When the transfer completes,
the application is uploaded from the logic controller into SoMachine Basic.

EIO0000001354 12/2015

199

Commissioning

Section 7.3
Controller Update

Controller Update
Controller Firmware Updates
Overview
You can download firmware updates to the logic controller either directly from SoMachine Basic or
using an SD card.
Downloading a Firmware Update to the Logic Controller
Performing a firmware update preserves the application program present in the controller,
including the Boot Application in the non-volatile memory.
Follow these steps to download firmware updates to the logic controller:
Step

Action

Verify that you are not connected to the logic controller when using Firmware Update.

Click Commissioning Controller Update.

Click Update.
The first page of the executive loader (OS loader) wizard appears.

If there is a power outage or communication interruption during the transfer of the application
program or a firmware change, your device may become inoperative. If a communication
interruption or a power outage occurs, reattempt the transfer.

NOTICE
INOPERABLE EQUIPMENT

Do not interrupt the transfer of the application program or a firmware change once the transfer
has begun.
Do not place the device into service until the transfer has completed successfully.

Failure to follow these instructions can result in equipment damage.

200

EIO0000001354 12/2015

Commissioning

Section 7.4
Memory Management

Memory Management
Overview
Memory management allows you to create SD card scripts and the associated files needed to
configure the following elements for your machines:
Logic controller firmware.
Logic controller program.
User memory (%M, %MW).
Post configuration.
What Is in This Section?
This section contains the following topics:
Topic

Page

Creating and Reading Logic Controller Images

202

Managing Logic Controller Memory

205

EIO0000001354 12/2015

201

Commissioning

Creating and Reading Logic Controller Images

Definition
The logic controller image includes the controller firmware and program. It also includes the scripts
that allow the transfer to a logic controller.
When creating a logic controller image, choosing an SD card as destination allows to use directly
this SD card in a logic controller to download the firmware and program.
Creating or reading logic controller image is only available offline.
Creating a Logic Controller Image
Creating a logic controller image is an offine operation. This allows you to generate scripts and files
to configure the following elements:
Firmware contained in the installed SoMachine Basic software.
Program of the currently opened project.
Optionally to delete the post configuration that can exist in the logic controller in which the SD
card will be later inserted.
Follow these steps to create a logic controller image file:
Step

202

Action

In the Commissioning tab, select Memory Management.

Under Action, choose Create Controller image.

Under Destination PC, click the browse button, navigate to the folder in which to write the
image file.

Select the elements to include:

Firmware
Program
Post configuration file deletion (optional)

Click Create Controller image to begin the SD card scripts creation with associated files.
Result: a .smbk image file is created

EIO0000001354 12/2015

Commissioning

Settings example:

Reading a Logic Controller Image

Offline operation to open a .smbk image file in SoMachine Basic as a project.
NOTE: The image opened has been previously created either through Create Controller image
operation or by a backup from the controller (see page 205).
Follow these steps to read a logic controller image file (program element only):
Step

Action

In the Commissioning tab, select Memory Management.

Under Action, choose Read image.

Under Destination PC, click the browse button, navigate to the folder in which to read the
image file.

Click Read image to read the program and open a project.

EIO0000001354 12/2015

203

Commissioning

Settings example:

204

EIO0000001354 12/2015

Commissioning

Managing Logic Controller Memory

Overview
In SoMachine Basic, you can back up, restore or erase the different elements from or to the logic
controller to which you are connected.
Backup, restore, and erase options are available only in online mode.
Backing Up to a PC or Controller SD Card
Follow these steps to back up the logic controller memory to a PC or to the controller SD card:
Step
1

Action
Log in to the logic controller.

In the Commissioning tab, select Memory Management.

Under Action, choose Backup from Controller.

To back up to a PC: Under Destination, choose PC. Click the browse button, navigate to the
folder in which to write the backup file.
or
To back up to an SD card: Under Destination, choose Controller SD Card folder. Insert an SD
card into the SD card slot of the logic controller.

NOTE: The SD card must not be empty or contain a script.cmd file to avoid creating a clone
or the script execution (see Modicon M221, Logic Controller, Programming Guide).
5

Select the elements to back up:

Firmware
Program
Memory values
Log file
Post configuration file
When Include memory values is selected in a PC backup, specify the First Memory Bit,
Last Memory Bit, First Memory Word, and Last Memory Word to be included in the backup.

Click Backup from Controller to begin the backup operation.

The elements are saved to the specified PC folder or SD card as an SD card.
A report window appears displaying a list of information or detected error messages about the
backup operation.

NOTE: If you choose to back up memory values, you can initiate a backup while the logic controller
is in RUNNING state. However, depending on the number of memory variables you specify to be
included in the backup, the backup may not be accomplished between logic scans. As a
consequence, the backup would not necessarily be coherent because the memory variables value
can be modified from one scan to another. If you wish to have a consistent set of values for the
variables, you may need to first put the logic controller into STOPPED state.

EIO0000001354 12/2015

205

Commissioning

Restoring
Follow these steps to restore logic controller elements from a PC:
Step

Action

Log in to the logic controller.

In the Commissioning tab, select Memory Management.

In the Action list, choose Restore to Controller.

Choose the source folder that contains the backup files on the PC.

Select the elements you want to restore to the logic controller.

Click Restore to Controller to begin the restore operation.

A report window appears displaying a list of information or detected error messages about the
restore operation.

If there is a power outage or communication interruption during the restore of the application data,
your machine may become inoperative. If a communication interruption or a power outage occurs,
reattempt the restore.

NOTICE
INOPERABLE EQUIPMENT

Do not interrupt the restore of the application data once the restore has begun.
Do not place your machine into service until the restore has completed successfully.

Failure to follow these instructions can result in equipment damage.

To restore a backup from a controller SD card, refer to the Programming Guide of the logic
controller.
Erasing Logic Controller Elements
Follow these steps to erase logic controller elements:
Step
1

206

Action
In the Commissioning tab, select Memory Management.

In the Action list, choose Erase in Controller.

Select the elements you want to erase in the logic controller.

Click Erase in Controller button to begin the erase operation.

A report window appears displaying a list of information or detected error messages about the
erase operation.

EIO0000001354 12/2015

Commissioning

Section 7.5
Controller Info

Controller Info
Controller Information
Overview
Click Controller info in the left-hand area of the Commissioning window to display the following
information on the present state of the logic controller:

Executable RAM: This option verifies if a valid application is stored in the RAM memory of the
logic controller.
Protected RAM: This option is checked if the application in the RAM memory of the logic
controller is password protected.
Forced I/O: This option is checked if 1 or more digital inputs or outputs on the logic controller
are being forced to a specific value (see page 116).
Status: The present state of the logic controller.
This information can also be obtained from within a program by testing the system word %SW6.
For more information on controller states, see the programming guide of your logic controller.
Last stopped on: The date and time that the logic controller was last stopped (STOPPED,
HALTED, and so on).
This information can also be obtained from within a program by testing the system word %SW54
through %SW57.
Last stopped reason: Displays the reason for the most recent stop of the logic controller.
This information can also be obtained from within a program by testing the system word %SW58.
Scan time (s): The following scan times:
Minimum (in microseconds): Shortest scan time since the last power-on of the logic
controller.
This information can also be obtained from within a program by testing the system word
%SW32 (in milliseconds).
Current (in microseconds): The scan time.
This information can also be obtained from within a program by testing the system word
%SW30 (in milliseconds).
Maximum (in microseconds): The longest scan time since the last power-on of the logic
controller.
This information can also be obtained from within a program by testing the system word
%SW31 (in milliseconds).

EIO0000001354 12/2015

207

Commissioning

208

Controller time: The following information is displayed only if the logic controller has a real time
clock (RTC):
Date (DD/MM/YYYY): The present date stored in the logic controller.
This information can also be obtained from within a program by testing the system words
%SW56 and %SW57.
Time (HH:MM:SS): The present time stored in the logic controller.
This information can also be obtained from within a program by testing the system words
%SW54 and %SW55.
The date and time are presented in same format as specified for the PC.
Ethernet information: The following information is displayed only if the logic controller has an
embedded Ethernet connection:
IP address: The IP address of the logic controller.
This information can also be obtained from within a program by testing the system words
%SW33 and %SW34.
Subnet mask: The subnet mask of the logic controller.
This information can also be obtained from within a program by testing the system words
%SW35 and %SW36.
Gateway address: The gateway address of the logic controller.
This information can also be obtained from within a program by testing the system words
%SW37 and %SW38.
Post Configuration status for SL1: The parameters with the activated check box are defined
by the post configuration file.
Post Configuration status for SL2: The parameters with the activated check box are defined
by the post configuration file.
Post Configuration status for Ethernet: The parameters with the activated check box are
defined by the post configuration file.

EIO0000001354 12/2015

Commissioning

Section 7.6
RTC Management

RTC Management
Managing the RTC
Overview
The RTC Management window enables you to set the real time clock (RTC) of the logic controller.
This is only possible if SoMachine Basic is connected to a logic controller that supports an RTC.
Updating the RTC
Step

Action

Select the RTC Management option in the left-hand area of the Commissioning window.

If in online mode, the Current controller time is displayed.

Choose the mode for setting the logic controller time:
Manual : This mode displays the date and time and lets you manually choose what date and
time to set in the logic controller.
Automatic : This mode sets the time in the logic controller to the current time of the PC on
which SoMachine Basic is installed.

Click Apply.

EIO0000001354 12/2015

209

Commissioning

210

EIO0000001354 12/2015

SoMachine Basic
Simulator
EIO0000001354 12/2015

Chapter 8
Simulator

Simulator
What Is in This Chapter?
This chapter contains the following topics:
Topic

Page

Overview of the SoMachine Basic Simulator

212

SoMachine Basic Simulator I/O Manager Window

214

SoMachine Basic Simulator Time Management Window

216

Modifying Values Using SoMachine Basic Simulator

218

How to Use the SoMachine Basic Simulator

222

Launching Simulation in Vijeo-Designer

223

EIO0000001354 12/2015

211

Simulator

Overview of the SoMachine Basic Simulator

Introduction
SoMachine Basic simulator allows you:
to simulate a connection between the PC, the logic controller, and any expansion modules.
to run and test a program without a logic controller and expansion modules, connected to the
PC physically.

The philosophy of operation is such that the simulator replicates the behavior of the controller and
is, in fact, a virtual controller that you connect to with SoMachine Basic. Once you launch the
simulator, you can connect, run, stop and other associated actions that you would normally
accomplish while connected to a physical controller.
NOTE: The simulator supports up to two simultaneous connections to the logic controller from two
different PC.
Accessing the SoMachine Basic Simulator
You can launch the simulator by any of the following methods:
Click Launch simulator button in the commissioning task area.
Press CTRL+B in the Commissioning window.

Click

(launch simulator button) in the SoMachine Basic tool bar.

Before launching the simulator, ensure that the program is valid. Otherwise, the simulator launch
is interrupted with a compilation error detected message that appears on the screen.
SoMachine Basic Simulator Windows
SoMachine Basic simulator has the following 2 windows:
Simulator time management window
Lets you control the RTC of the controller in order to simulate the passage of time and its effect
on the logical constructs affected by the RTC.
Simulator I/O manager window
Lets you manage the state of inputs/outputs of the controller and the expansion modules.

212

EIO0000001354 12/2015

Simulator

After the connection between the PC and the virtual logic controller has been successfully
established (refer to How to Use the SoMachine Basic Simulator (see page 222)), SoMachine
Basic simulator windows appear on the screen:

1 Simulator I/O manager window (see page 214)

2 Simulator Time Management window (see page 216)

EIO0000001354 12/2015

213

Simulator

SoMachine Basic Simulator I/O Manager Window

Overview
Simulator I/O manager window has the following components:
LED status:
To monitor the LED status of a simulated controller.
Input/output status:
To control the inputs and outputs when the program is running.

Simulator I/O Manager Window

This graphic shows the simulator I/O manager window:

Click the pin symbol on the left-top of this window to pin or unpin the window to the foreground.
Click the minimize symbol on the right-top of this window to minimize the window in taskbar.
LED Status
The PWR, RUN, ERR, and STAT LEDs are simulated in the SoMachine Basic simulator I/O
manager window as they would appear on a connected base controller.
The following are the LED states displayed in the simulator I/O manager window of a simulated
logic controller:

214

LED

Status Information

PWR

Indicates whether the simulated logic controller is powered up or not.

RUN

Indicates the RUN state of the simulated logic controller.

ERR

Indicates the ERR state of the simulated logic controller.

STAT

The operation of the STAT LED is defined by the user logic.

EIO0000001354 12/2015

Simulator

Input/Output Status
Simulator I/O manager window lets you monitor and control the I/Os of a controller and expansion
module when a program is running.
The inputs and outputs are displayed in a list of numbers. This list depends on the I/Os of the
selected controller and expansion module. For example, if your controller has n digital inputs, the
number list will display number starting from 0...(n-1), where each number corresponds to the
digital input at the corresponding input channel.
For a controller, the I/Os displayed are:
IN: Digital inputs.
OUT: Digital outputs.
ANA: Analog inputs.

For an expansion module, the I/Os displayed are:

IN: Digital/analog inputs.
OUT: Digital/analog outputs.

NOTE: The analog I/Os are displayed with their current values on right-hand side of the analog
input number.
Digital I/O status is identified by the text color of the I/O numbers:
Green: I/O is set to 1.
Black: I/O is set to 0.
Analog I/O status is identified by the value:
- (hyphen): I/O is not configured.
Number: Current value of the I/O.

EIO0000001354 12/2015

215

Simulator

SoMachine Basic Simulator Time Management Window

Overview
Simulator Time Management window has the following components:
Date / Time simulation range for the execution of the program in the simulator:
Beginning Date and Time
End Date and Time
Stop at the End check box (stop the execution of the program when the End Date and Time
are reached)

Time control scroll bar:

To move the simulation of the passage of time manually forward or back

Date and Time display:

Date and Time of the simulated RTC of the simulator

Control buttons:
To reset, jump back, jump forward, or end the time management associated with the RTC

Increment bar:
To fix the rate of the simulated passage of time relative to real time

Simulator Time Management Window

This graphics depicts the simulator Time Management window:

1
2
3
4
5
6

216

Date / Time simulation range (Beginning End)

Stop at the end (of Date / Time range) check box
Time control scroll bar
RTC date and time
Increment bar
Elapsed time control buttons

EIO0000001354 12/2015

Simulator

Simulator Date / Time Simulation Range

The simulation range allows you to establish and control the RTC of the simulator. The RTC is set
with the Beginning date and time fields when you set the simulator into a RUN state. The End
date and time fields establishes the end of your simulation. If you check the Stop at the End check
box, the simulator enters a STOP state at the expiration of the simulation range. Otherwise, the
simulator will continue to run, as will the RTC, until you manually stop the simulator with SoMachine
Basic.
Time Control Scroll Bar
The time control scroll bar allows you to manually manipulate the date and time you have
established simulation range. Click and hold the right mouse button while pointing at the arrow
below the bar and moving the mouse to the right advances the time and date of the RTC. Doing
the same and moving the mouse to the left reverse the time and date of the RTC.
RTC Date and Time
The RTC date and time zone displays the value of the RTC as it relates to the ongoing simulation.
The initial time of the RTC is established by the Beginning date and time when you place the
simulator in a RUN state. Thereafter, the display is updated with the ongoing clocking of the RTC
in the simulator. You can alter the RTC either with the time control scroll bar or with the Time elapse
speed control buttons.
Increment Bar
The increment bar allows you to establish a relative increment for Jumping forward or back the
RTC value when using the elapsed time control buttons. By clicking the bar you can set various
increments that are relative to the simulation range you have established.
Elapsed Time Control Buttons
You can use the control buttons to effect the RTC value, and therefore manipulate its affect on your
program running in the simulator as follows:
Graphic
Element

Command

Description

Initialize

Allows you to reset the date and time back to that which is set in the Beginning time/date
field.

Jump Forward

Allows you to move forward the time and date from its current value in increments
established by the Increment bar.

Jump Back

Allows you to reverse the time and date from its current value in increments established
by the Increment bar.

End

Allows you to jump the date and time to that which is set in the End time/date field.

EIO0000001354 12/2015

217

Simulator

Modifying Values Using SoMachine Basic Simulator

Overview
When in online mode, SoMachine Basic simulator I/O manager window allows you to:
Modify values of the inputs.
Trace the outputs.

Modifying Values of Digital Inputs

Follow these steps to modify the digital input value, using single-click operation:
Step

Action

1 Click the digital input number in the simulator I/O manager window to change the discrete input value.
Result: Text color of the input number changes. Digital input values are identified by the text color:
Green: I/O is set to 1.
Black: I/O is set to 0.
2 Click again on the same input number to toggle the value.

Follow these steps for bulk operation of modifying digital input values together:
Step

Action

1 Double-click the digital input number in the simulator I/O manager window,
Result: Set Discrete Inputs window listing all digital inputs, appears on the screen:

218

EIO0000001354 12/2015

Simulator

Step

Action

2 In the Operation area of the Set Discrete Inputs window, click:

Set all to 0: To set the value of all inputs to 0.
Set all to 1: To set the value of all inputs to 1.
Result: If the checkbox is selected, input value is set to 1. If not selected, input value is set 0.
3 Alternatively, in the All Discrete Inputs area of the Set Discrete Inputs window, click the checkbox
corresponding to the input to modify the values individually.
4 Click OK to save the changes and exit from the Set Discrete Inputs window.

Modifying I/O Values of Analog Inputs

Follow these steps for modifying analog input values:
Step

Action

1 Double-click the analog input number in the simulator I/O manager window,
Result: Set Analog Inputs window listing all analog inputs, appears on the screen:

2 In the All Analog Inputs area of the Set Analog Inputs window, double-click the value field in the
Change Value column corresponding to the input to be modified.
3 Enter the value in the range 0...1023 and press ENTER.
4 Alternatively, in the Set Analog Inputs window, select an input from the Inputs list and move the
slider in the Change Value area to adjust the input value between 0...1023.
When you move the slider from left to right, the value increases and vice versa.
5 Click OK to save the changes and exit from the Set Analog Inputs window.

EIO0000001354 12/2015

219

Simulator

Tracing the Outputs

Output values depend on the program; therefore you cannot modify the values but SoMachine
Basic simulator offers you to trace the digital and analog outputs.
Follow these steps for modifying analog input values:
Step

Action

1 Double-click the output number in the simulator I/O manager window,

Result: Tracing window appears on the screen.

2 Click Configure button to select the outputs to trace.

Result: Tracing Configuration window appears on the screen.

3 In the Select checkbox column, click the checkboxes corresponding to the outputs to trace.

220

EIO0000001354 12/2015

Simulator

Step

Action

4 Select the Sample Interval from the drop-down menu to set the sample time interval for output
tracing:
1 second
5 seconds
10 seconds
20 seconds
5 Click Ok to save and exit from the Tracing Configuration window.
Result: Selected outputs are added to the Tracing window that displays tracing of the outputs with
simulated values:

6 Click OK to exit from the Tracing window.

EIO0000001354 12/2015

221

Simulator

How to Use the SoMachine Basic Simulator

Procedure
Follow these steps to run the SoMachine Basic Simulator to test your program:
Step

222

Action

Ensure that you have a valid program by checking the status message in the status area
(for more information, refer to Status Area (see page 49)). The program status should be No errors.
You can also run SoMachine Basic simulator when the program status is Advice.

Launch the simulator (refer to Accessing the Simulator (see page 212)).

Run the controller.

In the Commissioning window, select Connect in the commissioning tree and then click
Run controller button in the commissioning task area.

Command your program using the simulator main window (refer to Control Buttons (see page 217)).

Check the LED status in the simulator main window (refer to LED Display (see page 215)).

Check the status of the inputs/outputs in the simulator I/O manager window (refer to Input/Output
Status (see page 215)).

Check the LED status in the simulator I/O manager window (refer to LED Status (see page 214)).

Modify the I/O values as required (refer to Modifying Values Using the Simulator (see page 218).

Trace the outputs as required (refer to Tracing the Outputs (see page 220).

10

Stop the controller.

In the Commissioning window, select Connect in the commissioning tree and then click
Stop controller button in the commissioning task area.

11

Stop the simulator.

In the Commissioning window, select Connect in the commissioning tree and then click
Stop controller button in the commissioning task area or press CTRL+W to exit from the simulator.

EIO0000001354 12/2015

Simulator

Launching Simulation in Vijeo-Designer

Procedure
Prior to launching the HMI simulation in Vijeo-Designer, first start the logic controller simulator in
SoMachine Basic.
Follow these steps to launch the simulation in Vijeo-Designer:
Step

Action

1 Start Vijeo-Designer.
2 Open the Vijeo-Designer project that contains the symbols from a SoMachine Basic project.

NOTE: If the Vijeo-Designer project does not exist, create a project in Vijeo-Designer and share the
symbols with the SoMachine Basic project. For more information, refer to Sharing Symbols Between
a SoMachine Basic Project and a Vijeo-Designer Project (see page 131).
3 Click the Project tab in the Navigator window, right-click the equipment node under the IO Manager
node, and select Configuration.
Result: The Equipment Configuration window opens.
4 Enter the IP Address and click OK.

NOTE: The IP address must be a local host address or local address of your PC. For example,
127.0.0.1
5 Start Device Simulation Tool.
6 Click the Variables tab and select the check boxes of the variables to include in the simulation.

NOTE: If the View All icon is selected, all variables selected in the Variables tab are displayed in
the Simulation tab.
7 Click the Simulation tab.
8 Select a variable, select an operation for the variable, and then select the Active check box.

NOTE: Only one simulation operation can be applied to any given variable at a time.
9 Define the parameters of the variable simulation operation.
10 Click the Simulation icon to start the simulation.
11 Change the variable values as required during the simulation:
For a slider operation, you can change the value by moving the slider, moving the wheel on your
mouse, or typing the arrow keys on the keyboard.
For a toggle operation, click Set or Reset to write the corresponding string to the variable.
12 Click the Simulation icon again to stop the simulation.
13 Press CTRL+Z to exit the Device Simulation Tool.

EIO0000001354 12/2015

223

Simulator

224

EIO0000001354 12/2015

SoMachine Basic
Saving Projects and Closing SoMachine Basic
EIO0000001354 12/2015

Chapter 9
Saving Projects and Closing SoMachine Basic

Saving Projects and Closing SoMachine Basic

What Is in This Chapter?
This chapter contains the following topics:
Topic

Page

Saving a Project

226

Saving a Project As a Template

227

Closing SoMachine Basic

228

EIO0000001354 12/2015

225

Saving Projects and Closing SoMachine Basic

Saving a Project
Overview
SoMachine Basic projects can be saved as files to the local PC. This file has the extension *.smbp
and contains:

The source code of the program contained on the Programming tab

The current hardware configuration contained on the Configuration tab
Settings and preferences set in the SoMachine Basic project.

Saving the Project

Step

Action

1
Click Save

on the toolbar, or press Ctrl-S

If this is the first time you have saved the project, browse and select the folder in which to store
the project file.

Type the name of the project file and click Save.

Saving the Project with a Different Name

Step

Action

1
Click the menu arrow next to the Save button

226

on the toolbar and choose Save as.

Browse and select the folder in which to store the project file.

Type the new name of the project file and click Save.

EIO0000001354 12/2015

Saving Projects and Closing SoMachine Basic

Saving a Project As a Template

Overview
SoMachine Basic projects can be saved as templates. The project is then listed on the Templates
tab of the Start page (see page 40). You can then use the project as the starting point for new
projects.
Saving a Project as a Template
Step

Action

1
Click the menu arrow next to the Save button

on the toolbar and choose Save as template.

If it is not already selected, browse to the Examples folder in your SoMachine Basic installation
folder.

Type the name of the project.

Choose Sample Project Files (*.smbe) as the file Type and click Save.

EIO0000001354 12/2015

227

Saving Projects and Closing SoMachine Basic

Closing SoMachine Basic

Overview
To exit SoMachine Basic, click the Close button in the top right-hand corner of the SoMachine
Basic window.
You can also click the Exit button on the Start page window.

228

EIO0000001354 12/2015

SoMachine Basic
EIO0000001354 12/2015

Appendices

EIO0000001354 12/2015

229

230

EIO0000001354 12/2015

SoMachine Basic
SoMachine Basic Keyboard Shortcuts
EIO0000001354 12/2015

Appendix A
SoMachine Basic Keyboard Shortcuts

SoMachine Basic Keyboard Shortcuts

SoMachine Basic Keyboard Shortcuts
Keyboard Shortcuts List
Modifier

Key

Command

View

Condition

CTRL

Copy

Textbox

CTRL

Paste

Textbox

CTRL

Cut

Textbox

ALT

Left

Go to previous tab

All

ALT

Right

Go to following tab

All

F1

Show help

All

F1

Show contextual help

All

SHIFT
ALT

F4

Exit SoMachine Basic

All

CTRL

Run simulator

All

CTRL

Login

All

CTRL

Logout

All

CTRL

Stop controller

All

CTRL

Run controller

All

CTRL

New project

All

CTRL

Open project

All

CTRL

Print project report

All

CTRL

Exit SoMachine Basic

All

CTRL

Save project

All

CTRL

Stop simulator

All

CTRL

Download

Commissioning

CTRL

Upload

Commissioning

ALT

Show Ladder shortcuts

Programming

Del

Delete

Programming

items are selected

CTRL

Convert all rungs in program

to Ladder

Programming

CTRL+ALT

Convert all rungs in program

to IL

Programming

EIO0000001354 12/2015

231

SoMachine Basic Keyboard Shortcuts

Modifier

Key

Command

View

Condition

CTRL

Search

Programming

CTRL

Insert a new rung before the

selected rung

Programming

CTRL

Redo

Programming

CTRL

Undo

Programming

CTRL

Arrow key

Draw line

Ladder rung

Drawing tool selected

CTRL

Arrow key

Erase line

Ladder rung

Erasing tool selected

CTRL

Arrow key

Select/unselect next ladder

cell (cell by cell)

Ladder rung

Selection tool selected

SHIFT

Arrow key

Select/unselect next ladder

cells (select by area)

Ladder rung

Selection tool selected

ESC

Reset pointer to selection tool Ladder rung

ESC

Cancel the pending line

Ladder rung

Drawing in progress

ESC

Cancel the erasing line

Ladder rung

Erasing in progress

ESC

Cancel move selected item(s) Ladder rung

(restore initial position)

Ladder items are being dragged

ESC

Close suggestions list

Ladder rung

A suggestions list is opened

(like the available descriptors
for a contact)

ESC

Close menu item of ladder

toolbar

Ladder rung

A menu of the ladder toolbar is

opened (like function blocks)

ENTER

Start/stop moving ladder

elements

Ladder rung

At least one selected cell

Arrow key

Move floating cell

Ladder rung

Moving cell started

Arrow key

Change current cell

Ladder rung

By default

F5

Open contact

Ladder rung

Asian set 1 ladder toolbar

SHIFT
SHIFT

Selected tool is not draw wire or

erase wire, no items are being
dragged, no popup is opened

F6

Open branch

Ladder rung

Asian set 1 ladder toolbar

F5

Close contact

Ladder rung

Asian set 1 ladder toolbar

F6

Close branch

Ladder rung

Asian set 1 ladder toolbar

F7

Coil

Ladder rung

Asian set 1 ladder toolbar

CTRL

F7

Negated coil

Ladder rung

Asian set 1 ladder toolbar

CTRL

F5

Set coil

Ladder rung

Asian set 1 ladder toolbar

CTRL

232

F6

Reset coil

Ladder rung

Asian set 1 ladder toolbar

F8

Application instruction

Ladder rung

Asian set 1 ladder toolbar

F9

Draw horizontal line

Ladder rung

Asian set 1 ladder toolbar

EIO0000001354 12/2015

SoMachine Basic Keyboard Shortcuts

Modifier

Key

Command

View

Condition

F10

Draw vertical line

Ladder rung

Asian set 1 ladder toolbar

CTRL

F9

Delete horizontal line

Ladder rung

Asian set 1 ladder toolbar

CTRL

F10

Delete vertical line

Ladder rung

Asian set 1 ladder toolbar

SHIFT

F7

Rising pulse open contact

Ladder rung

Asian set 1 ladder toolbar

SHIFT

F8

Falling pulse open contact

Ladder rung

Asian set 1 ladder toolbar

ALT

F7

Rising pulse open branch

Ladder rung

Asian set 1 ladder toolbar

ALT

F8

Falling pulse open branch

Ladder rung

Asian set 1 ladder toolbar

CTRL+SHIFT

Comparison block

Ladder rung

Asian set 1 ladder toolbar

XOR blocks

Ladder rung

Asian set 1 ladder toolbar

Function blocks

Ladder rung

Asian set 1 ladder toolbar

Activate step

Ladder rung

Asian set 1 ladder toolbar

Deactivate step

Ladder rung

Asian set 1 ladder toolbar

F10

Reverse operation results

Ladder rung

Asian set 1 ladder toolbar

Other Ladder items

Ladder rung

Asian set 1 ladder toolbar

ALT

F10

Free-drawn line

Ladder rung

Asian set 1 ladder toolbar

ALT

F9

Delete free-drawn line

Ladder rung

Asian set 1 ladder toolbar

New contact

Ladder rung

Asian set 2 ladder toolbar

New close contact

Ladder rung

Asian set 2 ladder toolbar

CTRL+ALT

New contact OR

Ladder rung

Asian set 2 ladder toolbar

New close contact OR

Ladder rung

Asian set 2 ladder toolbar

CTRL+SHIFT

F4

Rising edge

Ladder rung

Asian set 2 ladder toolbar

CTRL+SHIFT

F5

Falling edge

Ladder rung

Asian set 2 ladder toolbar

CTRL+SHIFT

Comparison block

Ladder rung

Asian set 2 ladder toolbar

ALT

XOR blocks

Ladder rung

Asian set 2 ladder toolbar

F10

New vertical line

Ladder rung

Asian set 2 ladder toolbar

ALT

New horizontal line

Ladder rung

Asian set 2 ladder toolbar

New coil

Ladder rung

Asian set 2 ladder toolbar

New close coil

Ladder rung

Asian set 2 ladder toolbar

CTRL

F9

Set coil

Ladder rung

Asian set 2 ladder toolbar

CTRL+SHIFT

F9

Reset coil

Ladder rung

Asian set 2 ladder toolbar

Activate step

Ladder rung

Asian set 2 ladder toolbar

Deactivate step

Ladder rung

Asian set 2 ladder toolbar

New instruction

Ladder rung

Asian set 2 ladder toolbar

New function block

Ladder rung

Asian set 2 ladder toolbar

EIO0000001354 12/2015

233

SoMachine Basic Keyboard Shortcuts

Modifier

Key

Command

View

Condition

ALT

Other Ladder items

Ladder rung

Asian set 2 ladder toolbar

F2

Deactivate branching mode

Ladder rung

European or American ladder

toolbar

SHIFT

F2

Activate branching mode

Ladder rung

European or American ladder

toolbar

SHIFT

F3

Normally open contact

Ladder rung

European ladder toolbar

SHIFT

F4

Normally close contact

Ladder rung

European ladder toolbar

CTRL+SHIFT

F4

Rising edge

Ladder rung

European ladder toolbar

CTRL+SHIFT

F5

Falling edge

Ladder rung

European ladder toolbar

CTRL+SHIFT

Operation block

Ladder rung

European ladder toolbar

CTRL+SHIFT

Comparison block

Ladder rung

European ladder toolbar

XOR blocks

Ladder rung

European ladder toolbar

SHIFT

F7

Assignment

Ladder rung

European ladder toolbar

CTRL+SHIFT

F9

Negated coil

Ladder rung

European ladder toolbar

SHIFT

F9

Set coil

Ladder rung

European ladder toolbar

F9

Reset coil

Ladder rung

European ladder toolbar

Activate step

Ladder rung

European ladder toolbar

Deactivate step

Ladder rung

European ladder toolbar

SHIFT

F5

Function block

Ladder rung

European ladder toolbar

CTRL+SHIFT

F6

Operation block

Ladder rung

European ladder toolbar

F3

Line

Ladder rung

European ladder toolbar

F3

Draw wire line

Ladder rung

European ladder toolbar

F4

Erase wire line

Ladder rung

European ladder toolbar

Other Ladder items

Ladder rung

European ladder toolbar

F2

Activate branching mode

Ladder rung

SoMachine ladder toolbar

F2

Deactivate branching mode

Ladder rung

SoMachine ladder toolbar

SHIFT

SHIFT
SHIFT

F3

Draw wire line

Ladder rung

SoMachine ladder toolbar

F3

Erase wire line

Ladder rung

SoMachine ladder toolbar

F4

Normal contact

Ladder rung

SoMachine ladder toolbar

F4

Negated contact

Ladder rung

SoMachine ladder toolbar

CTRL

F9

Coil

Ladder rung

SoMachine ladder toolbar

CTRL+SHIFT

F9

Negative coil

Ladder rung

SoMachine ladder toolbar

F9

Set Coil

Ladder rung

SoMachine ladder toolbar

SHIFT

F9

Reset Coil

Ladder rung

SoMachine ladder toolbar

CTRL+SHIFT

F4

Rising edge

Ladder rung

SoMachine ladder toolbar

234

EIO0000001354 12/2015

SoMachine Basic Keyboard Shortcuts

Modifier

Key

Command

View

Condition

CTRL+SHIFT

F5

Falling edge

Ladder rung

SoMachine ladder toolbar

CTRL+SHIFT

{6, 7}

Operation Block

Ladder rung

SoMachine ladder toolbar

CTRL+SHIFT

{O, P}

Comparison Block

Ladder rung

SoMachine ladder toolbar

X or ALT+X

XOR blocks

Ladder rung

SoMachine ladder toolbar

O or ALT+O

Other Ladder items

Ladder rung

SoMachine ladder toolbar

A or ALT+A

Activate step

Ladder rung

SoMachine ladder toolbar

D or ALT+D

Deactivate step

Ladder rung

SoMachine ladder toolbar

EIO0000001354 12/2015

235

SoMachine Basic Keyboard Shortcuts

236

EIO0000001354 12/2015

SoMachine Basic
Glossary
EIO0000001354 12/2015

Glossary
!
%S
According to the IEC standard, %S represents a system bit.
%SW
According to the IEC standard, %SW represents a system word.

A
animation table
A software table that displays the real-time values of objects such as input bits and memory words.
When SoMachine Basic is connected to a logic controller, the values of certain object types in
animation tables can be forced to specific values. Animation tables are saved as part of SoMachine
Basic applications.
application
A program including configuration data, symbols, and documentation.

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

E
EtherNet/IP
(Ethernet industrial protocol) An open communications protocol for manufacturing automation
solutions in industrial systems. EtherNet/IP is in a family of networks that implement the common
industrial protocol at its upper layers. The supporting organization (ODVA) specifies EtherNet/IP
to accomplish global adaptability and media independence.

F
flash memory
A non-volatile memory that can be overwritten. It is stored on a special EEPROM that can be
erased and reprogrammed.

EIO0000001354 12/2015

237

Glossary

Free POU
A programmable object unit (POU), typically containing library functions, that can be programmed
and updated independently of the master task of a program. Free POUs are available to be called
from within programs as subroutines or jumps. For example, the periodic task is a subroutine that
is implemented as a Free POU.

G
GRAFCET
The functioning of a sequential operation in a structured and graphic form.
This is an analytical method that divides any sequential control system into a series of steps, with
which actions, transitions, and conditions are associated.

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

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

M
master task
A processor task that is run through its programming software. The master task has 2 sections:
IN: Inputs are copied to the IN section before execution of the master task.
OUT: Outputs are copied to the OUT section after execution of the master task.

N
non-program data
Data in a SoMachine Basic application that is not directly used by the program, such as project
properties, symbols, and comments.

238

EIO0000001354 12/2015

Glossary

P
post configuration
(post configuration) An option that allows to modify some parameters of the application without
changing the application. Post configuration parameters are defined in a file that is stored in the
controller. They are overloading the configuration parameters of the application.
POU
(program organization unit) A variable declaration in source code and a corresponding instruction
set. POUs facilitate the modular re-use of software programs, functions, and function blocks. Once
declared, POUs are available to one another.

S
symbol
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.
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 preferred method because if the program
configuration changes, symbols are automatically updated with their new immediate address
associations. By contrast, any immediate addresses used as operands or parameters are not
updated (refer to immediate addressing).

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

W
watchdog
A watchdog is a special timer used to ensure that programs do not overrun their allocated scan
time. The watchdog timer is usually set to a higher value than the scan time and reset to 0 at the
end of each scan cycle. If the watchdog timer reaches the preset value, for example, because the
program is caught in an endless loop, an error is declared and the program stopped.

EIO0000001354 12/2015

239

Glossary

240

EIO0000001354 12/2015

SoMachine Basic
Index
EIO0000001354 12/2015

Index
A
accumulator, 156
action zone, 140
addressing
symbolic, 69
allocating memory in controller, 71
allocation mode, 71
animation tables, 115
application
behavior, configuring, 79
definition of, 26
downloading to controller, 198
protecting with a password, 57
protecting with password, 60
whether password-protected, 207
assignment instructions
inserting in Ladder Diagram rungs, 148

B
bill of material (BOM), printing, 53
Boolean
accumulator, 156
Boolean operators
graphic elements for, 143
branching modes
graphic element, 141

C
cache memory, consumption of, 133
catalog, 63
replacing logic controller with reference
from, 64
coils
graphic elements for, 144
graphical representation of outputs, 138
comments
adding to Instruction List, 155
adding to Ladder Diagrams, 149
EIO0000001354 12/2015

commissioning, 28
comparison block
graphic elements for, 143
comparison blocks
inserting IL expressions in, 147
comparison expression
inserting in Ladder Diagram rungs, 147
compile, date and time of last, 133
configuration
current, 63
replacing logic controller in, 64
configuring
application behavior, 79
master task, 98
periodic task duration, 104
project properties, 57
contacts
graphic elements for, 142
graphical representation of inputs, 138
controller time, displaying in trace, 184
copying and pasting
Grafcet POUs, 92
POU, 95
creating
Free POU, 94
Grafcet POUs, 92
customizing, Ladder Editor, 51

D
developing programs, stages of, 27
development stages, 28
digital inputs
configuring as event sources, 107
downloading
application directly to controller, 41
firmware updates, 200
user application to controller, 198

241

Index

E
end/jump
graphic elements, 145
Ethernet
configuration using post configuration file,
207
event source
assigning subroutine as, 110
types of, 107
event tasks
managing, 109
overview, 106
events
since last cold restart, 111
triggering subroutines with, 107
EXCEPTION state
fallback behavior, 81
expansion modules
supported devices, 22
exporting
symbol list, 130
trace, 185

F
fallback
behavior, specifying, 81
firmware, downloading updates to controller,
200
forcing values
in animation tables, 115
of I/Os, 207
Free POU
assigning to an event source, 110
assigning to events, 96
assigning to periodic task, 96
Free POU
creating, 94
Free POU
for periodic task, 102
Free POU
inserting, 95
Free POU
introduction to, 86

242

Free POUs
removing, 96
function blocks
graphic element, 144
functional levels, 79

G
general settings, 51
Grafcet, 165
graphical elements, 144
how to use the instructions, 169
instructions, 165
post-processing, 168
preprocessing, 166
program structure, 166
sequential processing, 167
Grafcet POU
creating, 92
renaming, 93
Grafcet POUs
copying and pasting, 92
removing, 93
graphic elements
Ladder diagrams, 141
grid lines, style of in Ladder Editor, 51

H
hardware tree, 63

I
importing
symbol list, 129
inputs
configuring as event sources, 107
modifying, 150
inserting
Free POU, 95
new Grafcet POUs, 92
Instruction List
comments, 155
using rung templates with, 135

EIO0000001354 12/2015

Index

instructions
upstream/downstream, 150

K
keyboard shortcuts, 51

L
Ladder diagrams
comments, 149
graphic elements, 141
introduction, 138
programming principles, 140
reversing to Instruction List, 72
rungs, 139
using parentheses in, 151
using rung templates with, 135
Ladder Editor
customizing, 51
ladder editor
defining symbols in, 70
Ladder Editor
resetting pointer after insertion, 51
language, of user interface, 51
life cycle state
of logic controller, 49
line
graphic element, 142
List instructions, 157
List language
overview, 154
logic controller
date and time last stopped, 207
displaying state, 207
downloading an application directly to, 41
replacing current in configuration, 64
state on startup, configuring, 80
supported types, 22
updating RTC of, 209

EIO0000001354 12/2015

M
master task
assigning POU as, 86
configuring, 98
system bits and words controlling, 99
memory allocation, 71
memory consumption, viewing, 133
modem
connections, adding, 37
modem, displaying status of, 207
modes, offline/online/simulator, 29
module areas, 28

N
network objects, 123
new Grafcet POU
inserting, 92
non-program data, 26
normal scan mode, 99

O
objects
definition of, 68
network, 123
to trace in animation table, 115
updating values of in real time, 115
offline mode
displayed in status area, 49
overview, 29
online mode, 71
animation tables in, 115
displayed in status area, 49
editing values in animation table, 116
overview, 29
updating RTC in, 209
operands, 156
operation blocks
graphic element, 145
inserting assignment instructions in, 148
operations
inserting in Ladder Diagram rungs, 148
outputs
modifying, 150
243

Index

P
parentheses
modifiers, 162
nesting, 162
using in Ladder diagrams, 151
using in programs, 161
password
protecting an application , 60
removing from application, 60
removing from project, 59
requiring to open project file, 59
whether application is protected with, 207
password-protecting an application, 57
period, scan, 99
periodic
scan mode, 99
scan period, 104
tasks, 102
periodic task
assigning Free POU to, 96
configuring duration of, 104
post configuration
using Ethernet parameters from, 207
using serial line parameters from, 207
post configuration file, writing Ethernet parameters to, 39
POU
copying, 95
Free, 102
pasting, 95
printing reports, 53
priority level, of events, 106
program
compiling, 47
definition of, 26
displaying number of lines in, 133
jumps, 150
program development, stages of, 27
program organization unit (POU), 86
program, configuring fallback behaviors, 81
programming
best practices, 150
grid, 140
languages, supported, 24

244

project
configuring properties, 57
definition of, 26
displaying report for, 53
protecting with password, 59
templates, 40
properties, 57
pulse width (TON) , 99

R
RAM memory
executable contains application, 207
RAM memory, consumption of, 133
relay circuits, representing as Ladder diagrams, 138
removing
Free POUs, 96
Grafcet POUs, 93
removing password protection, 59, 60
renaming
a Grafcet POU, 93
replacing
logic controller in configuration, 64
reports
exporting, 53
printing, 53
reversibility
introduction to, 72
RTC
displaying date and time, 207
managing with system bits, 150
updating in controller, 209
rung templates, 135
rungs
graphic element, 141

S
scan modes, 82, 99
scan task, configuring watchdog, 81
scan time
displaying minimum, maximum, current,
207
minimum, displayed in status area, 49
EIO0000001354 12/2015

Index

sections
in events, 106
of master task, 98
selection
graphic element, 142
serial line
configuration using post configuration file,
207
settings
general, 51
sharing
symbol list, 131
sharing symbols
with Vijeo Designer project, 131
simulator, 212
accessing the simulator, 212
how to use, 222
I/O manager window, 214
modifying values, 218
modifying values of analog inputs, 219
modifying values of digital inputs, 218
output tracing, 220
simulator windows, 212
Time Management window, 216
simulator mode
overview, 29
sources of events, 107
stages of developing a program, 28
Start Page, 28
startup state of logic controller, 80
state
initial logic controller, configuring, 80
of controller, displaying, 207
status area, 49
stop sensors, wiring, 150
STOPPED state
fallback behavior, 81
subroutine
assigning to periodic task, 102
assigning to tasks, 109
implementing as Free POU, 86
of master task, 98
triggering execution with an event, 107
supported devices, 22

EIO0000001354 12/2015

symbol list
displaying, 129
exporting, 130
importing, 129
sharing with Vijeo Designer project, 131
symbolic addressing, 69
symbols
addressing with, 69
defining in graphic elements of ladder editor, 70
defining in Properties window, 69
list of used, 129
storing in logic controller, 70
system bits
%S0, 150
%S11, 99
%S19, 99
%S31, 111
%S38, 111
%S39, 111
%S49, 150
%S51, 150
system bits/words
controlling events with, 111
in symbol list, 129
system words
%SW0, 99
%SW27, 99
%SW30, 99
%SW30...%SW32, 207
%SW31, 99
%SW32, 99
%SW35...%SW38, 207
%SW48, 111
%SW54...%SW57, 207
%SW58, 207
%SW6, 207

T
task
event, 106
periodic, 102
tasks, 82
tasks and scan modes, 82
245

Index

template
inserting into rung, 135
project, 40
test zone, 140
TH0, TH1
configuring as event sources, 107
threshold outputs (of %HSC)
configuring as event sources, 107
time base (for trace), 117
timer, watchdog, 81
toolbar buttons, 47
trace
displaying, 184
exporting to PDF, 185
selecting objects to, 115
selecting time base for, 117
trace window
displaying, 117

U
uploading
preventing with a password, 60
user interface, setting language of, 51

W
watchdog timer, configuring, 81
wiring stop sensors, 150

X
XOR
graphic elements for, 143

246

EIO0000001354 12/2015