Cms X-Tools - User Manual - Ion Simotion T001.en
Cms X-Tools - User Manual - Ion Simotion T001.en
Preface 1
Scope of Delivery 2
Product Characteristics 3
CMS X-TOOLS
CMS X-TOOLS ION SIMOTION T001 Add Library into the Project 4
Manual
Software Engineering 5
Block Description 6
References 7
English
Release 2012-01 Contact Information 8
English
Release 2012-01 1 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
Safety Guidelines
This document contains notices which you should observe to ensure your own personal safety as well as to avoid property damage. The
notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring to property damage only
have no safety alert symbol.
Danger
indicates an imminently hazardous situation which, if not avoided, will result in death or serious injury.
Warning
indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury.
Caution
used with the safety alert symbol indicates a potentially hazardous situation which, if not avoided, may result in minor or mod-
erate injury.
Caution
used without safety alert symbol indicates a potentially hazardous situation which, if not avoided, may result in property dam-
age.
Notice
used without the safety alert symbol indicates a potential situation which, if not avoided, may result in an undesirable result or
state.
When several danger levels apply, the notices of the highest level (lower number) are always displayed. If a notice refers to personal
damages with the safety alert symbol, then another notice may be added warning of property damage.
Qualified Personnel
The device/system may only be set up and operated in conjunction with this documentation. Only qualified personnel should be allowed to
install and work on the equipment. Qualified persons are defined as persons who are authorized to commission, to earth, and to tag cir-
cuits, equipment and systems in accordance with established safety practices and standards.
Intended Use
Please note the following:
Warning
This device and its components may only be used for the applications described in the catalog or technical description, and
only in connection with devices or components from other manufacturers approved or recommended by Siemens.
This product can only function correctly and safely if it is transported, stored, set up and installed correctly, and operated and
maintained as recommended.
Trademarks
All designations marked with ® are registered trademarks of Siemens AG. Other designations in this documentation might be trademarks
which, if used by third parties for their purposes, might infringe upon the rights of the proprietors.
Copyright Siemens AG 2010 All rights reserved.
Reproduction, transmission or use of this document or its contents is not permitted without express written authority. Offenders will be
liable for damages. All rights, including rights created by patent grant or registration of a utility model or design, are reserved.
Disclaimer of Liability
We have checked the contents of this document for agreement with the hardware and software described. Since deviations cannot be
precluded entirely, we cannot guarantee full agreement. However, the data in the manual are reviewed regularly, and any necessary cor-
rections will be included in subsequent editions. Suggestions for improvement are welcomed.
Siemens AG
Industry Sector
P.O. Box 4848
90327 Nuremberg Siemens AG 2010
Germany Technical data subject to change
English
Release 2012-01 2 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
Table of Contents
1 Preface .......................................................................................................................................... 4
1.1 Purpose of this Document ......................................................................................................... 4
1.2 Basic Knowledge Required........................................................................................................ 4
1.3 Validity of this Document ........................................................................................................... 4
1.4 Terms ....................................................................................................................................... 4
2 Scope of Delivery ........................................................................................................................... 5
2.1 Scope of Delivery ...................................................................................................................... 5
2.2 Unpacking and Checking........................................................................................................... 5
3 Product Characteristics ..................................................................................................................6
3.1 What is CMS X-TOOLS? ........................................................................................................... 6
3.2 Introduction ............................................................................................................................... 6
3.3 Hard- and Software Requirements............................................................................................. 6
3.3.1 Hardware ............................................................................................................................. 6
3.3.2 Software............................................................................................................................... 7
3.4 Ordering Numbers..................................................................................................................... 7
4 Installation...................................................................................................................................... 8
4.1 L_CS_ION ................................................................................................................................ 8
4.2 Setting of Constants .................................................................................................................. 8
5 Software Engineering ..................................................................................................................... 9
5.1 Function Call ............................................................................................................................. 9
5.2 Function Parameters ............................................................................................................... 10
5.3 UIK ......................................................................................................................................... 11
5.4 Program example .................................................................................................................... 11
6 Block Description ......................................................................................................................... 13
6.1 Data Structures ....................................................................................................................... 13
6.1.1 ChannelType...................................................................................................................... 13
6.1.2 StructION_SIMOTION_T001_Comm .................................................................................. 13
6.2 Function blocks ....................................................................................................................... 13
6.2.1 FB_ION_SIMOTION_T001_Data........................................................................................ 13
6.2.2 FB_ION_SIMOTION_T001_Comm..................................................................................... 14
7 Tips and Tricks............................................................................................................................. 15
7.1 Configuration of windows firewall............................................................................................. 15
8 References .................................................................................................................................. 16
8.1 Other Documentation .............................................................................................................. 16
9 Contact Information ...................................................................................................................... 17
English
Release 2012-01 3 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
1 Preface
This document supports you when commissioning and using the software
· CMS X-TOOLS ION SIMOTION T001
of the CMS X-TOOLS productline.
In order to understand this manual, general knowledge of automation technology and software packages CMS
X-Tools and SIMOTION Scout is required.
In addition, you must be familiar with network technology (UDP/IP) and with using computers with
MS Windows XP.
1.4 Terms
Definition Description
CMS Condition Monitoring System
ION I/O-Node
UIK Universal Identification Key
URN User Node
English
Release 2012-01 4 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
2 Scope of Delivery
Caution
Do not use any content / parts that show evidence of damage!
English
Release 2012-01 5 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
3 Product Characteristics
CMS X-TOOLS is an industrial-suited Condition Monitoring System for technical and techno-
logical services in industrial plants. CMS X-TOOLS is a modular, scalable analysis and diag-
nosis system. It is optimized for reaction less measurement of analog, binary and numerical
data. CMS X-TOOLS can be integrated in existing and new industrial plants.
3.2 Introduction
The ION SIMOTION T001 is used in order to acquire numerical data from a SIMOTION controller and to trans-
mit the recorded data via Ethernet to a superior industrial PC. The usage of an ION SIMOTION T001 allows
transmitting up to 171 channels (171 x 4 = 684 Bytes) per measurement cycle of the controller. In order to
transmit more data, multiple ION SIMOTION T001 can be engineered into the program of the controller.
The ION SIMOTION T001 consists of two functional blocks which must be engineered into SIMOTION control-
lers. After the engineering, the ION SIMOTION T001 is used for the communication with CMS X-TOOLS X-
Tools (during the following pages referred as X-Tools) and for the transmission of measurement data to X-
Tools.
The engineered ION SIMOTION T001 identifies itself to X-Tools as Ethernet device which communicates via
UDP. When the measurement data transmission is started through X-Tools, the ION SIMOTION T001 sends
the requested values of the SIMOTION to the used PC during each cycle.
3.3.1 Hardware
3.3.2 Software
Further information is obtained from your local Siemens office and from the homepage
http://www.siemens.com/siplus-cms.
English
Release 2012-01 7 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
4 Installation
4.1 L_CS_ION
Installation
1. Insert the product-CD CMS X-TOOLS IONSIMOTION T001 into the CD/DVD-drive of your PC.
2. Start the SIMOTION Scout and open the project, in which the library should be imported.
3. Inside the project-navigator click on the container LIBRARIES.
4. Chose in the context menu: Import Object.
5. Chose under source-path and source-name of the import the path of your CD/DVD-drive and open the
XML-file: “<CD-path>:\CMS X-TOOLS \ION SIMOTION T001\L_CS_ION.xml” from the product-CD.
6. Apply with OK.
7. The import will start. In the details of register “XML Export/Import State” the successful import will be
shown. In the project navigator the library L_CS_ION is shown.
The maximum count of Channels and internal Buffers has to be defined by engineering the Unit ION_Cfg.
1. In the Unit ION_Cfg, the user constants have to be set as follows:
//################ User Constants #######################################
NUM_OF_BUFFER_LAYERS : INT := 20; //Buffer depth, min 1
// should be big enough for greater BackGroundTask times
MAX_CHANNEL : INT := 171; //MIN 1, MAX 171
// Maximum count of data channels
//#######################################################################
English
Release 2012-01 8 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
5 Software Engineering
The ST-Sourcecode-Example shows a possibility for the call and it is possible to insert it into a new ST-Source
directly. Depending on usage and system configuration it is wise to make custom changes.
Condition for the call of the functional-block is, that the library L_CS_ION with the functional-block is imported
into your user project (see chapter 4). To work with the functional-block in your program proceed as follows:
1. Add a new program (à insert ST-programm) or open an existing program.
2. In the Interfacearea of the Program the library L_CS_ION has to be included with the command
USELIB L_CS_ION;.
3. Next step is to declare the common variables for the function block parameters. These parameters
could also be set at the call of the function block.The instances of the function blocks and the two pat-
terns (StructION_SIMOTION_T001_Comm and ChannelType) must be declared for every
ION SIMOTION T001 in controller. To declare it there are two possibilities:
· The variables and instances were defined as global variables in the IMPLEMENTATION-Area of
the source (see example). So they are only valid in the particular unit. This option is advisable by
calling more then one ION SIMOTION T001 in one project.
· The variables and instances were defined as global Variables in the INTERFACE-Area of the
source. In this case they are available in the whole project and it is easy to load data into them.
By calling more then one ION SIMOTION T001 all IONs must have their own variables and Instances
with their unique values (port-number, name,...). In the example the following variables were declared:
4. The program for the BackGroundTask (CS_Bkgrnd) is calling the instance of the communication block
(myFB_Comm). This call is parameterized with the declared variables (see Chapter 5.2). It is also pos-
sible to do the parameterization directly at the communication block.
5. In the program for the synchron task (CS_Cycl) the data channels were filled with data and the instance
of the data block (myFB_Data) is called. See chapter 5.2 for more details for parameterization.
English
Release 2012-01 9 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
Note
The programs must be assigned to the system sequences. Alternate it is possible to use available programs.
First the channels that should be transmitted were served according to the variable myChannel. There are up
to 171 channels available with 4 bytes for every channel, in total 684 byte. These data were send cyclic to the
PC, after X-Tools is connected to ION SIMOTION T001. The origin measurement data were defined with the
configuration of these 171 channels.
The different data types must be converted to DWORD. It is possible to use one channel for different data, e.g.
4 BOOL's, 4 BYTE's or 2 INT's (see also the examples).
English
Release 2012-01 10 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
5.3 UIK
Every ION SIMOTION T001 must have a unique identification in the complete system, the UIK. This UIK is used
by X-Tools for the unique identification of every ION SIMOTION T001.
Normaly it is created with 2 null bytes and the MAC-address (6 Bytes) of the assembly. Insert after the second
byte the MAC-address byte-by-byte (hex view). In the following example the MAC-Adresse 08-00-06-71-CE-C6
is used.
VAR_GLOBAL
...
myUIK : ARRAY[0..7] OF BYTE :=[16#0,16#0,16#08,16#00,16#06,16#71,16#CE,16#C6];
...
END_VAR
If there were more then one ION SIMOTION T001 function blocks operated on one assembly, it is essential, that
the UIK is unique. In this case, use the first two bytes for a serial numbering of the blocks.
IMPLEMENTATION
VAR_GLOBAL
myFB_Data :
FB_ION_SIMOTION_T001_Data; // FB for collected data – cyclic call
myFB_Comm :
FB_ION_SIMOTION_T001_Comm; // FB for communication - BackGroundTask
myCommData :
StructION_SIMOTION_T001_Comm; // Structure for the common Data of the FBs
myChannel :
ChannelType; // ARRAY[1..MAX_CHANNEL] OF DWORD
// Data channels, every Date channel has Type DWORD
// must be filled with data cyclic .
// Interpretation in CMS X-TOOLS as Intel-Notation
myUIK : UIKType :=[16#0,16#0,16#08,16#00,16#06,16#71,16#CE,16#C6];
// Universal Identification Key - unique ION-Identifier
// normaly created with 2 null bytes and the MAC-Address of the assembly
CycleTime : UDINT := 3000; // Executing interval of the synchronous Tasks in microseconds
myCommandPort : UINT := 2000;
myDataPort : UINT := 2001;
numOfChannels : INT := 171; //Count of the actual transmitted data channels
myDEVICE_DESCRIPTION : DeviceDescriptionType := 'ION SIMOTION T001 (000008-00-0671CEC6)';
// Description of assembly or asset must be unique
myDEVICE_LOCATION : DeviceLocationType := 'Unknown Location';
// Location of assembly or asset
END_VAR
VAR
//Example variables
i : INT;
myBool0 : BOOL;
myBool1 : BOOL;
myBool2 : BOOL;
myBool3 : BOOL;
myInt0 : INT;
myInt1 : INT;
English
Release 2012-01 11 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
myDint : DINT;
myReal : REAL;
myLreal : LREAL;
END_VAR
myInt0 := myInt0 + 1;
IF myInt0 >= 133 THEN
myInt0 := 0;
END_IF;
myInt1 := myInt1 + 2;
myReal := myReal + 1.256;
myLreal := myLreal + 5.3558;
IF myLreal >= 273.33 THEN
myLreal := 20.00;
END_IF;
IF myCommData.ctrlStartStream THEN
// The different data types must be converted to DWORD
// it is possible to use one channel for different signals, e.g. 16 BOOL's,
// 4 BYTE's or 2 INT's
FOR i := 5 TO numOfChannels DO
myChannel[i] := REAL_TO_DWORD(myReal);
END_FOR;
END_IF;
END_PROGRAM
END_IMPLEMENTATION
English
Release 2012-01 12 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
6 Block Description
6.1.1 ChannelType
6.1.2 StructION_SIMOTION_T001_Comm
6.2.1 FB_ION_SIMOTION_T001_Data
In FB_ION_SIMOTION_T001_Data the data were collected in buffers and provided with timestamps. The data
sending to X-Tools occurs with FB_ION_SIMOTION_T001_Comm.
Required is the calling from a SynchronousTask or a TimerInterruptTask.
English
Release 2012-01 13 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
6.2.2 FB_ION_SIMOTION_T001_Comm
The function block _FB_ION_SIMOTION_T001_Comm is used for communication between ION SIMOTION
T001 and X-Tools. After X-Tools has registered itself over the CommandPort (here 2000) the FB activates
and a data exchange with X-Tools begins. For data transmission a dedicated DataPort (here 2001) is used.
The functional block must be integrated into the BackGroundTask. Alternative, in case of long cycle times of
the BackGroundTask, the functional block can be integrated into a separate MotionTask in an infinite loop. The
infinite loop task must end with the _waitTime(t#0ms) command.
PROGRAM CS_MotionTask //Aufruf in einer MotionTask
WHILE TRUE DO
myFB_Comm(
COM_RST := FALSE
,CYCLE_T := myCycleTime
,COMMAND_PORT := myCommandPort
,DATA_PORT := myDataPort
,CURRENT_CHANNELS := numOfChannels
,UIK := myUIK
,DEVICE_DESCRIPTION := myDEVICE_DESCRIPTION
,DEVICE_LOCATION := myDEVICE_LOCATION
,CommData := myCommData);
myRetDINT := _waitTime(t#0ms);
END_WHILE;
END_PROGRAM
English
Release 2012-01 14 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
If the firewall does not allow X-Tools server application then the communication will not start
between the automation system and CMS X-Tools. Please verify the configuration as follow.
1. Open „Allow a program through Windows Firewall” from the “Control Panel\System and Security” window
English
Release 2012-01 15 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
8 References
English
Release 2012-01 16 / 17
CMS X-TOOLS ION SIMOTION T001 User Manual CMS X-TOOLS
9 Contact Information
Should you have any questions concerning the software application, please refer to the Industry Sector Tech-
nical Support.
Department
Siemens AG
Industry Sector
Phone
+49 (0) 911 895 7222 (Monday to Friday, 09:00 am to 05:00 pm CET/CEST)
Fax
+49 (0) 911 895 7223
Internet
www.siemens.de/automation/service&support
Thank you for using one of the above mentioned contacts to ensure your inquiry is registered and can
be processed.
English
Release 2012-01 17 / 17