CMS X-Tools Library – User Manual CMS

Preface 1

Scope of Delivery 2

Installation 3

CMS X-Tools Library

User Manual - 01 - Introduction Product Characteristics 4

List of Abbreviations 5
English
Release 2016-09 Contact Information 6

English
Release 2016-09 1 / 102
CMS X-Tools Library – User Manual CMS

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
moderate injury.

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 prod-
uct can only function correctly and safely if it is transported, stored, set up and installed correctly, and operated and main-
tained 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 2016. 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
DF PL DS PAS R&D
91056 Erlangen Siemens AG 2016
Germany Technical data subject to change

English
Release 2016-09 2 / 102
CMS X-Tools Library – User Manual CMS

Table of Contents

1 Preface .......................................................................................................................................... 8
1.1 Purpose of this Document ......................................................................................................... 8
1.2 Validity of this Document ........................................................................................................... 8
1.3 Audience ...................................................................................................................................8
1.4 Notations................................................................................................................................... 9
2 Scope of Delivery ......................................................................................................................... 10
2.1 Scope of Delivery .................................................................................................................... 10
2.2 Unpacking and Checking......................................................................................................... 10
3 Installation.................................................................................................................................... 11
3.1 Licenses.................................................................................................................................. 11
3.2 Library..................................................................................................................................... 12
3.3 Analyzing Bundle 1 ................................................................................................................. 16
3.4 Fast Analysis........................................................................................................................... 18
4 Product Characteristics ................................................................................................................ 19
4.1 Introduction ............................................................................................................................. 19
4.1.1 What is CMS X-Tools? ....................................................................................................... 19
4.1.2 What is CM Library? ........................................................................................................... 19
4.1.3 What is Analyzing Bundle 1? .............................................................................................. 19
4.1.4 What is CM Fast Analysis? ................................................................................................. 19
4.2 General ................................................................................................................................... 20
4.2.1 Anti-Aliasing Filter .............................................................................................................. 20
4.2.2 Frequency Spectra ............................................................................................................. 20
4.2.3 Order Spectra .................................................................................................................... 20
4.2.4 Orbit ................................................................................................................................... 20
4.2.5 Order Spectra and Orbit ..................................................................................................... 20
4.2.6 Default Settings .................................................................................................................. 21
4.2.7 Example Parameters .......................................................................................................... 21
4.3 User Functions ........................................................................................................................ 22
4.3.1 CM Alarm Handling ............................................................................................................ 22
4.3.1.1 AddLog ......................................................................................................................... 22
4.3.1.2 CnvCntrlV ..................................................................................................................... 26
4.3.1.3 GblCntrlV ...................................................................................................................... 29
4.3.1.4 LmtChk ......................................................................................................................... 32
4.3.1.5 LmtChk2 ....................................................................................................................... 34
4.3.1.6 SendLog ....................................................................................................................... 36
4.3.2 CM Broadband Analysis ..................................................................................................... 42
4.3.2.1 FltrAccEnv..................................................................................................................... 42
4.3.2.2 SpmAccEnv .................................................................................................................. 44
4.3.3 CM Current Signature Analysis........................................................................................... 47
4.3.3.1 ABOrbit ......................................................................................................................... 47
English
Release 2016-09 3 / 102
CMS X-Tools Library – User Manual CMS

4.3.3.2 ABZ............................................................................................................................... 50
4.3.3.3 SymComAns ................................................................................................................. 52
4.3.4 CM Displacement Analysis ................................................................................................. 56
4.3.4.1 OrbitAns ........................................................................................................................ 56
4.3.5 CM General Signal Analysis ............................................................................................... 61
4.3.5.1 CharVal ......................................................................................................................... 61
4.3.5.2 ExtrmVal ....................................................................................................................... 64
4.3.5.3 FltrSgn .......................................................................................................................... 66
4.3.5.4 OprtngHrs ..................................................................................................................... 68
4.3.5.5 OSDscnt ....................................................................................................................... 70
4.3.5.6 OSDtctn ........................................................................................................................ 72
4.3.5.7 OSVld ........................................................................................................................... 72
4.3.5.8 SpdToTrg ...................................................................................................................... 73
4.3.5.9 Spm .............................................................................................................................. 75
4.3.5.10 SpmOrd ........................................................................................................................ 77
4.3.5.11 TrgCnv .......................................................................................................................... 82
4.3.5.12 WFToTrg....................................................................................................................... 84
4.3.6 CM Machine Analysis ......................................................................................................... 86
4.3.6.1 CrstFctr ......................................................................................................................... 86
4.3.6.2 FltrVel ........................................................................................................................... 88
4.3.6.3 PkValAcc ...................................................................................................................... 90
4.3.6.4 PkValVel ....................................................................................................................... 92
4.3.6.5 RMSVel......................................................................................................................... 94
4.3.6.6 SpmVel ......................................................................................................................... 96
4.4 Fast Analysis........................................................................................................................... 98
5 List of Abbreviations ................................................................................................................... 100
6 Contact Information .................................................................................................................... 102

English
Release 2016-09 4 / 102
CMS X-Tools Library – User Manual CMS

Table of Figures

Figure 1: Licenses – X-Tools licenses within the Automation License Manager................................................11

Figure 2: Licenses – Server log entries ............................................................................................................11
Figure 3: CM Library Location – add Location to X-Tools (part 1).....................................................................12
Figure 4: CM Library Location – add Location to X-Tools (part 2).....................................................................12
Figure 5: CM Library Location – add Location to X-Tools (part 3).....................................................................12
Figure 6: CM Library Location – add Location to X-Tools (part 4).....................................................................13
Figure 7: CM Library Location – password protected User Function Files .........................................................14
Figure 8: CM Library Location – compiled User Functions ................................................................................15
Figure 9: Analyzing Bundle 1 – Install (part 1) ..................................................................................................16
Figure 10: Analyzing Bundle 1 – Install (part 2) ................................................................................................16
Figure 11: Analyzing Bundle 1 – Analyzing Functions.......................................................................................17
Figure 12: CM Fast Analysis Location – add Location to X-Tools .....................................................................18
Figure 13: CM Fast Analysis Location – Analyzing Script Files .........................................................................18
Figure 14: Default Settings – SpmAcc User Function Overview ........................................................................21
Figure 15: CM Alarm Handling – AddLog User Function ...................................................................................22
Figure 16: CM Alarm Handling – AddLog Analyzing Model ...............................................................................23
Figure 17: CM Alarm Handling – AddLog error log entry ...................................................................................23
Figure 18: CM Alarm Handling – AddLog folders within XTS directory ..............................................................24
Figure 19: CM Alarm Handling – AddLog status file ..........................................................................................24
Figure 20: CM Alarm Handling – CnvCntrlV User Function ...............................................................................26
Figure 21: CM Alarm Handling – CnvCntrlV Analyzing Model ...........................................................................27
Figure 22: CM Alarm Handling – CnvCntrlV Monitoring View ............................................................................27
Figure 23: CM Alarm Handling – GblCntrlV User Function ................................................................................29
Figure 24: CM Alarm Handling – GblCntrlV Analyzing Model ............................................................................30
Figure 25: CM Alarm Handling – GblCntrlV Monitoring View.............................................................................30
Figure 26: CM Alarm Handling – LmtChk User Function ...................................................................................32
Figure 27: CM Alarm Handling – LmtChk Analyzing Model ...............................................................................32
Figure 28: CM Alarm Handling – LmtChk Monitoring View ................................................................................33
Figure 29: CM Alarm Handling – LmtChk2 User Function .................................................................................34
Figure 30: CM Alarm Handling – LmtChk2 Analyzing Model .............................................................................34
Figure 31: CM Alarm Handling – LmtChk2 Monitoring View ..............................................................................35
Figure 32: CM Alarm Handling – SendLog User Function .................................................................................36
Figure 33: CM Alarm Handling – SendLog Analyzing Model .............................................................................36
Figure 34: CM Alarm Handling – SendLog folders within XTS directory ............................................................37
Figure 34: CM Alarm Handling – SendLog TCP IP Test Server (startup) ..........................................................38
Figure 34: CM Alarm Handling – SendLog TCP IP Test Server (socket) ...........................................................38
Figure 34: CM Alarm Handling – SendLog TCP IP Test Server (configure) .......................................................39
Figure 34: CM Alarm Handling – SendLog TCP IP Test Server (listen) .............................................................39
Figure 34: CM Alarm Handling – SendLog TCP IP Test Server (report) ............................................................39
Figure 35: CM Alarm Handling – SendLog text file ...........................................................................................40
English
Release 2016-09 5 / 102
CMS X-Tools Library – User Manual CMS

Figure 36: CM Alarm Handling – SendLog matching entry ................................................................................40

Figure 37: CM Alarm Handling – SendLog log file ............................................................................................40
Figure 38: CM Broadband Analysis – FltrAccEnv User Function .......................................................................42
Figure 39: CM Broadband Analysis – FltrAccEnv Analyzing Model ...................................................................42
Figure 40: CM Broadband Analysis – FltrAccEnv Monitoring View ....................................................................43
Figure 41: CM Broadband Analysis – SpmAccEnv User Function.....................................................................44
Figure 42: CM Broadband Analysis – SpmAccEnv Analyzing Model .................................................................44
Figure 43: CM Broadband Analysis – SpmAccEnv calculation results ...............................................................45
Figure 44: CM Broadband Analysis – SpmAccEnv Monitoring View..................................................................46
Figure 45: CM Current Signature Analysis – ABOrbit User Function .................................................................47
Figure 46: CM Current Signature Analysis – ABOrbit Analyzing Model .............................................................47
Figure 47: CM Current Signature Analysis – ABOrbit Monitoring View ..............................................................48
Figure 48: CM Current Signature Analysis – ABZ User Function ......................................................................50
Figure 49: CM Current Signature Analysis – ABZ Analyzing Model...................................................................50
Figure 50: CM Current Signature Analysis – ABZ Monitoring View ...................................................................51
Figure 51: CM Current Signature Analysis – SymComAns User Function .........................................................52
Figure 52: CM Current Signature Analysis – SymComAns Analyzing Model .....................................................53
Figure 53: CM Current Signature Analysis – SymComAns Monitoring View ......................................................54
Figure 54: CM Displacement Analysis – OrbitAns User Function ......................................................................56
Figure 55: CM Displacement Analysis – OrbitAns Analyzing Model ..................................................................57
Figure 56: CM Displacement Analysis – OrbitAns calculation results ................................................................59
Figure 57: CM Displacement Analysis – OrbitAns Monitoring View ...................................................................59
Figure 58: CM General Signal Analysis – CharVal User Function .....................................................................61
Figure 59: CM General Signal Analysis – CharVal Analyzing Model .................................................................62
Figure 60: CM General Signal Analysis – CharVal Monitoring View ..................................................................63
Figure 61: CM General Signal Analysis – ExtrmVal User Function ...................................................................64
Figure 62: CM General Signal Analysis – ExtrmVal Analyzing Model................................................................64
Figure 63: CM General Signal Analysis – ExtrmVal Monitoring View ................................................................65
Figure 64: CM Machine Analysis – FltrSgn User Function ................................................................................66
Figure 65: CM Machine Analysis – FltrSgn Analyzing Model ............................................................................66
Figure 66: CM Machine Analysis – FltrSgn Monitoring View .............................................................................67
Figure 67: CM General Signal Analysis – OprtngHrs User Function..................................................................68
Figure 68: CM General Signal Analysis – OprtngHrs Analyzing Model ..............................................................68
Figure 69: CM General Signal Analysis – OprtngHrs Monitoring View ..............................................................69
Figure 70: CM General Signal Analysis – OSDscnt User Function ....................................................................70
Figure 71: CM General Signal Analysis – OSDscnt Analyzing Model ................................................................70
Figure 72: CM General Signal Analysis – OSDscnt Monitoring View .................................................................71
Figure 73: CM General Signal Analysis – OSDtctn User Function ....................................................................72
Figure 74: CM General Signal Analysis – OSVld User Function........................................................................72
Figure 75: CM General Signal Analysis – SpdToTrg User Function ..................................................................73
Figure 76: CM General Signal Analysis – SpdToTrg Analyzing Model ..............................................................73
Figure 77: CM General Signal Analysis – SpdToTrg Monitoring View ...............................................................74
English
Release 2016-09 6 / 102
CMS X-Tools Library – User Manual CMS

Figure 78: CM General Signal Analysis – Spm User Function ..........................................................................75

Figure 79: CM General Signal Analysis – Spm Analyzing Model.......................................................................75
Figure 80: CM General Signal Analysis – Spm Monitoring View .......................................................................76
Figure 81: CM General Signal Analysis – SpmOrd User Function.....................................................................77
Figure 82: CM General Signal Analysis – SpmOrd Analyzing Model (1)............................................................78
Figure 83: CM General Signal Analysis – SpmOrd Analyzing Model (2)............................................................79
Figure 84: CM General Signal Analysis – SpmOrd calculation results ...............................................................80
Figure 85: CM General Signal Analysis – SpmOrd Monitoring View..................................................................81
Figure 86: CM General Signal Analysis – TrgCnv User Function ......................................................................82
Figure 87: CM General Signal Analysis – TrgCnv Analyzing Model ..................................................................82
Figure 88: CM General Signal Analysis – TrgCnv Monitoring View ...................................................................83
Figure 89: CM General Signal Analysis – WFToTrg User Function ...................................................................84
Figure 90: CM General Signal Analysis – WFToTrg Analyzing Model ...............................................................84
Figure 91: CM General Signal Analysis – WFToTrg Monitoring View ................................................................85
Figure 92: CM Machine Analysis – CrstFctr User Function ...............................................................................86
Figure 93: CM Machine Analysis – CrstFctr Analyzing Model ...........................................................................86
Figure 94: CM Machine Analysis – CrstFctr Monitoring View ............................................................................87
Figure 95: CM Machine Analysis – FltrVel User Function .................................................................................88
Figure 96: CM Machine Analysis – FltrVel Analyzing Model .............................................................................88
Figure 97: CM Machine Analysis – FltrVel Monitoring View ..............................................................................89
Figure 98: CM Machine Analysis – PkValAcc User Function.............................................................................90
Figure 99: CM Machine Analysis – PkValAcc Analyzing Model .........................................................................90
Figure 100: CM Machine Analysis – PkValAcc Monitoring View........................................................................91
Figure 101: CM Machine Analysis – PkValVel User Function ...........................................................................92
Figure 102: CM Machine Analysis – PkValVel Analyzing Model........................................................................92
Figure 103: CM Machine Analysis – PkValVel Monitoring View ........................................................................93
Figure 104: CM Machine Analysis – RMSVel User Function .............................................................................94
Figure 105: CM Machine Analysis – RMSVel Analyzing Model .........................................................................94
Figure 106: CM Machine Analysis – RMSVel Monitoring View ..........................................................................95
Figure 107: CM Machine Analysis – SpmVel User Function .............................................................................96
Figure 108: CM Machine Analysis – SpmVel Analyzing Model .........................................................................96
Figure 109: CM Machine Analysis – SpmVel Monitoring View ..........................................................................97
Figure 110: CM Fast Analysis – Spm call .........................................................................................................98
Figure 111: CM Fast Analysis – Spm calculation results ...................................................................................99
Figure 112: CM Fast Analysis – Spm Monitoring View ......................................................................................99

English
Release 2016-09 7 / 102
CMS X-Tools Library – User Manual CMS

1 Preface

1.1 Purpose of this Document

This document provides an introduction about the functionalities and usage of the following X-Tools Locations:
∂ CM Library V xx.xx
∂ CM Fast Analysis V xx.xx
In addition to the introduction which is found within this document and which provides an overview about the
available functionality, the following documentation is available for detailed information:
∂ CMS X-Tools Analyzing Bundle 1 User Manual - V xx.xx.pdf
o provides detailed information about used special Analyzing Functions, which are not X-Tools standard

1.2 Validity of this Document

This document is valid for the following software:

∂ CMS X-Tools V xx.xx

1.3 Audience

This document is intended for personnel involved in the commissioning and using of the software:
∂ CMS X-Tools

English
Release 2016-09 8 / 102
CMS X-Tools Library – User Manual CMS

1.4 Notations

The following notations are used within this document:

∂ bold, italic text is being used for the main executables of X-Tools
∂ bold text is being used for the software modules of X-Tools
o examples: Main Management System, Device Profile Editor, IPE Socket T001
∂ green text is being used for controls like tables and trees
o examples: Main Profile Settings table, Device Profile Data table
∂ orange text is being used for simple controls like a menu button, a single row/column/cell of a table or a
branch of a tree
o examples: Open… menu button, IP Address column, Target Device Name cell, Interfaces Branch
∂ dark yellow text is being used for the entries of context menus
o examples: Advanced Append…, Edit
∂ Camel Notation is being used for major terms of X-Tools
o examples: Main Profile, Interface Profile, User Accounts File, Analyzing Function
∂ < and > brackets are being used for keyboard keys
o examples: <Ctrl>, <Alt>, <Shift>, <Del>
∂ [ and ] brackets are being used for mouse operations
o examples: [left mouse button down], [mouse move]

English
Release 2016-09 9 / 102
CMS X-Tools Library – User Manual CMS

2 Scope of Delivery

2.1 Scope of Delivery

What is shipped?
∂ CM Library V xx.xx
∂ CM Fast Analysis V xx.xx

2.2 Unpacking and Checking

After unpacking, please check

∂ the packet for completeness and
∂ all parts for transport damage.

Notice
Do not use any parts that show evidence of damage!

English
Release 2016-09 10 / 102
CMS X-Tools Library – User Manual CMS

3 Installation

3.1 Licenses

Before the User Functions of the CM Library and the Analyzing Functions of the Analyzing Bundle 1 can be
used, the following valid licenses have to be present within the Automation License Manager.

Figure 1: Licenses – X-Tools licenses within the Automation License Manager

A license check is performed during each X-Tools Server startup. Valid licenses generate the following Server
log entries.

Figure 2: Licenses – Server log entries

English
Release 2016-09 11 / 102
CMS X-Tools Library – User Manual CMS

3.2 Library

As preparation for a new X-Tools Project the delivered zip file CM Library has to be extracted. After the zip file
is extracted and the corresponding folder have been copied or moved to the desired place at the hard disc, the
CM Library can be added to the X-Tools Server as Location Type Configuration Files. This is done within the
explorer of one Subsystem (DME, MTE, ANE, and STE) -> SERVERNAME -> Files -> Add Location…

Figure 3: CM Library Location – add Location to X-Tools (part 1)

Within the upcoming window the folder path of the CM Library Location can be browsed by clicking onto the
button.

Figure 4: CM Library Location – add Location to X-Tools (part 2)

The folder CM Library has to be marked and is confirmed by clicking onto the OK button. The subfolders ANE,
DME, MTE and STE have to be visible right under the CM Library folder.

Figure 5: CM Library Location – add Location to X-Tools (part 3)

English
Release 2016-09 12 / 102
CMS X-Tools Library – User Manual CMS

After the browsing window is closed, the next window can be confirmed directly by clicking again onto the OK
button.

Figure 6: CM Library Location – add Location to X-Tools (part 4)

Once the CM Library has been added, the X-Tools Server compiles the User Function Files and generates the
multi instance blocks (User Functions) accordingly. This may take up to several seconds. During this time no
actions shall be taken by the user.

English
Release 2016-09 13 / 102
CMS X-Tools Library – User Manual CMS

The following figure shows the password protected User Function Files of the CM Library Location within the
Analyzing System Explorer.

Figure 7: CM Library Location – password protected User Function Files

English
Release 2016-09 14 / 102
CMS X-Tools Library – User Manual CMS

The compiled User Functions can be found below the section Libraries of the Analyzing System Explorer. This
section is divided in Analyzing- and User Functions. All these functions can be used multiple times in one and
the same Analyzing Model as well as in different Analyzing Models at the same time. The following figures show
the User Functions which are available and ready to be implemented by the user.

Figure 8: CM Library Location – compiled User Functions

English
Release 2016-09 15 / 102
CMS X-Tools Library – User Manual CMS

3.3 Analyzing Bundle 1

The CM Library requires the Analyzing Functions of the Analyzing Bundle 1. In order to install these Analyzing
Functions the correct zip file has to be chosen which matches to the present operating system platform (x32 or
x64). After extraction of the zip file, the Install.exe can be executed. It is not necessary to shut down the X-
Tools Server and the Client before the installation.

Figure 9: Analyzing Bundle 1 – Install (part 1)

When executing the Install.exe it is recommended to use Full Installation. The next steps have to be followed
whereby the installer automatically recognizes the correct X-Tools Server directory, if a suitable version of the
Analyzing Bundle 1 has been chosen.

Figure 10: Analyzing Bundle 1 – Install (part 2)

After the dll files have been installed they appear within the Analyzing System Explorer below section -> Li-
braries -> Analyzing Functions -> Analyzing Bundle 1.

English
Release 2016-09 16 / 102
CMS X-Tools Library – User Manual CMS

Figure 11: Analyzing Bundle 1 – Analyzing Functions

A detailed description of each Analyzing Function provided by the Analyzing Bundle 1 is found in the X-Tools
Server directory “C:\Program Files\Siemens\CMS X-Tools Pro\Documents\CMS X-Tools (All Editions) Analyzing
Bundle 1.EN.pdf”.

English
Release 2016-09 17 / 102
CMS X-Tools Library – User Manual CMS

3.4 Fast Analysis

As preparation the delivered zip file CM Fast Analysis has to be extracted. After the zip file is extracted and the
corresponding folder have been copied or moved to the desired place at the hard disc, the CM Fast Analysis
can be added to the X-Tools Server as Location Type Fast Analysis. This can only be done within Analyzing
System Explorer -> SERVERNAME -> Files -> Add Location…

Figure 12: CM Fast Analysis Location – add Location to X-Tools

This Location consists out of Analyzing Script Files which cannot be used without the corresponding CM Li-
brary. The following Analyzing Scripts Files are content of the CM Fast Analysis Location and become visible
only within the Analyzing System Explorer.

Figure 13: CM Fast Analysis Location – Analyzing Script Files

English
Release 2016-09 18 / 102
CMS X-Tools Library – User Manual CMS

4 Product Characteristics

4.1 Introduction

4.1.1 What is CMS X-Tools?

CMS X-Tools is a cost-effective, modular, PC-based measurement system, which has been specially optimized
to perform reactionless measurement of analog, binary and numerical signals in industrial plants. It consists out
of a PC-based software (CMS X-Tools) and various types of measurement devices (IONs, IFNs and CTNs)
With a sampling rate of up to 192 kHz, even highly dynamic processes and occurrences can be recorded with
high resolution. The system is used as a portable and/or installed unit in the fields of research & development,
testing, error tracking and production.
Input and output signals are handled by individual devices. To accommodate a higher number of signals, basi-
cally up to 62 devices can be networked over the IEEE1394 bus system and can be connected to any PC, lap-
top or server with an IEEE1394 interface.
Despite the considerable features of the system, an experienced technician, with no prior knowledge about
CMS X-Tools, can carry out measurements within a very short period of time. Simple measurement tasks, such
as paperless recording of plant signals or fault recording, are quickly and effectively carried out.
For higher sophisticated measurements, such as remote service & maintenance or condition monitoring, a high
level of graphical configuration and parameterization is possible within CMS X-Tools. In addition, the powerful
trigger machine and the analyzing engine enable the user to perform more extensive measurement tasks.
The following topics provide a short overview about the functionalities of the main parts of the CMS X-Tools
software.
For detailed information about CMS X-Tools please refer to the documentation delivered with CMS X-Tools

4.1.2 What is CM Library?

The CM Library contains User Functions which allow the processing of signals in order to obtain specific calcu-
lation results for evaluating rotating equipment or entire drive trains.

4.1.3 What is Analyzing Bundle 1?

The Analyzing Bundle 1 provides application specific Analyzing Functions which are not content of the stand-
ard Analyzing Function library.

4.1.4 What is CM Fast Analysis?

The CM Fast Analysis allows applying specific User- and Analyzing Functions to any online- or offline data
directly out of the MDS.

English
Release 2016-09 19 / 102
CMS X-Tools Library – User Manual CMS

4.2 General

4.2.1 Anti-Aliasing Filter

The application of an Anti-Aliasing Filter becomes essential when the Analyzing Model performs a down-
sampling (Cycle Time smaller than Sampling Rate of to be processed input data). This can be done by means
of the Analyzing Function InAAF whereby the data of interest is read in.
It has to be considered that when down-sampling without an InAAF the resulting output data may be affected by
artefacts and further processing of that data can lead to inappropriate results.

4.2.2 Frequency Spectra

Frequency based spectra are used to evaluate the spectral composition of the given input signal considering a
fixed frequency range (speed independent). The Cycle Time has to be chosen in dependence to the frequency
range which is of interest whereas the spectrum parameters can be chosen according to the resolution or to be
averaged spectra which are desired in order to resolve specific frequency components properly.

4.2.3 Order Spectra

Order based spectra are used to evaluate the spectral composition of the given input signal considering a varia-
ble angle synchronous order range (representing a speed dependent frequency range). For the calculation of an
angle synchronous order spectrum a speed related synchronic impulse train is required which has been record-
ed time synchronous to the signal of interest. It is necessary that this signal and the corresponding impulse train
consist out of the same number of values. This is done by processing both signals in one and the same Analyz-
ing Model (the order spectrum is calculated in a second Analyzing Model). Resulting quantities are a pre-filtered
signal and a binary impulse train.
Filter settings for the pre-filtering as well as the Cycle Time have to be chosen in dependence to the excitation
area and the number of orders respectively the frequency range of which the filtered signal shall consist of. The
chosen number of orders represents a speed dependent frequency range
The spectrum parameters can be chosen according to the resolution or to be averaged spectra which are de-
sired in order to resolve specific orders properly.

4.2.4 Orbit

As well as order spectra, the orbit requires a speed related synchronic impulse train which has been recorded
time synchronous to the signal of interest.

4.2.5 Order Spectra and Orbit

Whenever order- or orbit analysis is performed using a rotational speed signal instead of a speed related syn-
chronic impulse train, the resulting order spectrum as well as the orbit do not provide any information regarding
the mechanical angle.

English
Release 2016-09 20 / 102
CMS X-Tools Library – User Manual CMS

4.2.6 Default Settings

All User Functions have a default parameter setup which can be applied to the most standard applications de-
pending on the Measuring Task the User Function shall be used for. The following figure shows the standard
parameters of the User Function SpmAcc which can be viewed by right clicking onto the User Function ->
Overview.

Figure 14: Default Settings – SpmAcc User Function Overview

4.2.7 Example Parameters

The Analyzing Model Parameters which are used for the illustrations in this document have been chosen ac-
cording to the given example input data in order to produce valid results.
Furthermore the Analyzing Model Files as well as the corresponding Monitoring View Files are content of the
CM Training Location and the example input data are content of the CM Training Offline Data Location. For
training purposes this data can be loaded via an Analyzing Script File and the Analyzing Models Parameters
can be modified for a subsequently re-execution of the Analyzing Model Files.

English
Release 2016-09 21 / 102
CMS X-Tools Library – User Manual CMS

4.3 User Functions

4.3.1 CM Alarm Handling

In this subsection of the CM Library, all User Function Files for Alarm Handling are present. Purpose of these
User Functions is to manage so called control values whereby changing conditions can be detected. Control
values are integer values (“0”, “1” or “2” for status “ok”, “warning” and “alarm”) which are generated by defined
Analyzing Models. Every monitored Measuring Task (e.g. Spectrum Velocity) has an additional Analyzing Model
which provides a Measuring Task and Point related control value representing the level of violated thresholds. In
addition User Functions for monitoring scalar (speed, torque, pressure etc.) quantities are found in this subsec-
tion as well.
However, these User Functions can be applied to any suitable signal which is of interest.

4.3.1.1 AddLog

Purpose of the User Function AddLog is to generate a specific log entry according to the given control values.
This log entry is written with priority class error to the system. Among others this log entry consists out of two
integer values for alarm and warning which can be extracted and decrypted afterwards by the User Function
SendLog.

Figure 15: CM Alarm Handling – AddLog User Function

English
Release 2016-09 22 / 102
CMS X-Tools Library – User Manual CMS

The following table shows the Analyzing Model Parameters and the Offline Time Configuration which have been
used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [Hz] 1
Output Data Class Offline

Offline Time Configuration

Time Input Mode Minimum Time and Time Interval

Minimum Time Format None (use Start Time of the Analyzing Model)
Time Interval Format s
Time Interval Value 1

Figure 16: CM Alarm Handling – AddLog Analyzing Model

AddLog converts the given control values and creates the log entry accordingly as it is shown in the following
figure.

Figure 17: CM Alarm Handling – AddLog error log entry

Depending on which control values are currently present at the inputs, the corresponding integer alarm- and
warning values are generated.
The alarm integer value is the sum of all inputs with value “2”.
-> 26 + 210 + 214 = “17472” (alarm integer).
The warning integer value is the sum of all inputs with value “1”.
0 3 8 9 11
-> 2 + 2 + 2 + 2 2 = “2825” (warning integer).

English
Release 2016-09 23 / 102
CMS X-Tools Library – User Manual CMS

After the Analyzing Model has been started for the first time, the folder SendReport is created within the X-
Tools Server directory and contains the conditions of all processed AddLog User Functions. This folder is also
used by SendLog.

Figure 18: CM Alarm Handling – AddLog folders within XTS directory

The conditions of one AddLog are stored in a file as the following figure shows. A new entry is only created in
case of changing conditions or the number of same states has been reached (NoSts).

Figure 19: CM Alarm Handling – AddLog status file

English
Release 2016-09 24 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input0 In0 input integer control value which shall be used for conversion
Input1 In1 input integer control value which shall be used for conversion
Input2 In2 input integer control value which shall be used for conversion

Input3 In3 input integer control value which shall be used for conversion
Input4 In4 input integer control value which shall be used for conversion

Input5 In5 input integer control value which shall be used for conversion
Input6 In6 input integer control value which shall be used for conversion

Input7 In7 input integer control value which shall be used for conversion
Input8 In8 input integer control value which shall be used for conversion
Input9 In9 input integer control value which shall be used for conversion

Input10 In10 input integer control value which shall be used for conversion
Input11 In11 input integer control value which shall be used for conversion
Input(s) Input12 In12 input integer control value which shall be used for conversion
Input13 In13 input integer control value which shall be used for conversion
Input14 In14 input integer control value which shall be used for conversion

Input15 In15 input integer control value which shall be used for conversion
System Sys name of the system

Subsystem SubSys name of the subsystem

Component Comp name of the component

ID ID ID number
NumberOfStates NoSts receives the number of same status cycles which have to be reached to
initiate a new log entry

Value Value receives the value which shall be sent

CodeType CodeType name of the sensor type (txt file with error description)
Enable EN enables or disables the internal calculation

Output(s) OutputReady OutRdy indicates whether a log entry has been created

English
Release 2016-09 25 / 102
CMS X-Tools Library – User Manual CMS

4.3.1.2 CnvCntrlV

Purpose of the User Function CnvCntrlV is to convert up to 16 given control values. Resulting quantities are
two integer values for alarm and warning which can be sent via TCP/IP to a control unit. The control unit can
extract the information about all inputs with status alarm and warning when converting the integer values into
binary values.

Figure 20: CM Alarm Handling – CnvCntrlV User Function

The following table shows the Analyzing Model Parameters and the Offline Time Configuration which have been
used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [Hz] 1

Output Data Class Offline

Offline Time Configuration

Time Input Mode Minimum Time and Time Interval
Minimum Time Format 2016-01-01 00:00:00:000.000.000

Time Interval Format s

Time Interval Value 1

English
Release 2016-09 26 / 102
CMS X-Tools Library – User Manual CMS

Figure 21: CM Alarm Handling – CnvCntrlV Analyzing Model

Depending on which control values are currently present at the inputs, the corresponding integer alarm- and
warning values are generated.
The alarm integer value is the sum of all inputs with value “2”.
-> 26 + 210 + 214 = “17472” (alarm integer).
The warning integer value is the sum of all inputs with value “1”.
-> 20 + 23 + 28 + 29 211 = “2825” (warning integer).

Figure 22: CM Alarm Handling – CnvCntrlV Monitoring View

English
Release 2016-09 27 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input0 In0 input integer control value which shall be used for conversion
Input1 In1 input integer control value which shall be used for conversion
Input2 In2 input integer control value which shall be used for conversion

Input3 In3 input integer control value which shall be used for conversion
Input4 In4 input integer control value which shall be used for conversion

Input5 In5 input integer control value which shall be used for conversion
Input6 In6 input integer control value which shall be used for conversion

Input7 In7 input integer control value which shall be used for conversion
Input(s) Input8 In8 input integer control value which shall be used for conversion
Input9 In9 input integer control value which shall be used for conversion

Input10 In10 input integer control value which shall be used for conversion
Input11 In11 input integer control value which shall be used for conversion

Input12 In12 input integer control value which shall be used for conversion
Input13 In13 input integer control value which shall be used for conversion
Input14 In14 input integer control value which shall be used for conversion

Input15 In15 input integer control value which shall be used for conversion
Enable EN enables or disables the internal calculation

OutputAlarm OutAlrm receives the conversion result of the control values for alarm
Output(s)
OutputWarning OutWarn receives the conversion result of the control values for warning

English
Release 2016-09 28 / 102
CMS X-Tools Library – User Manual CMS

4.3.1.3 GblCntrlV

Purpose of the User Function GblCntrlV is to convert up to 16 control values into one global control value. This
global control value contains the highest integer value based on the inputs and therefore represents the highest
violated threshold. GblCntrlV is mainly used when it is necessary to acquire the control values of all Measuring
Tasks for one Measuring Point. Subsequently this global control value can be converted by the User Function
CnvCntrlV in order to obtain Measuring Point related status information.

Figure 23: CM Alarm Handling – GblCntrlV User Function

The following table shows the Analyzing Model Parameters and the Offline Time Configuration which have been
used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant
Cycle Time [Hz] 1

Output Data Class Offline

Offline Time Configuration

Time Input Mode Minimum Time and Time Interval

Minimum Time Format 2016-01-01 00:00:00:000.000.000
Time Interval Format s

Time Interval Value 1

English
Release 2016-09 29 / 102
CMS X-Tools Library – User Manual CMS

Figure 24: CM Alarm Handling – GblCntrlV Analyzing Model

Depending on which control values are currently present at the inputs, this User Function detects and provides
the highest integer value to the output.

Figure 25: CM Alarm Handling – GblCntrlV Monitoring View

English
Release 2016-09 30 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) Input0 In0 input integer control value which shall be used for the generation of the
global control value

Input1 In1 input integer control value which shall be used for the generation of the
global control value

Input2 In2 input integer control value which shall be used for the generation of the
global control value

Input3 In3 input integer control value which shall be used for the generation of the
global control value

Input4 In4 input integer control value which shall be used for the generation of the
global control value

Input5 In5 input integer control value which shall be used for the generation of the
global control value

Input6 In6 input integer control value which shall be used for the generation of the
global control value

Input7 In7 input integer control value which shall be used for the generation of the
global control value

Input8 In8 input integer control value which shall be used for the generation of the
global control value

Input9 In9 input integer control value which shall be used for the generation of the
global control value

Input10 In10 input integer control value which shall be used for the generation of the
global control value

Input11 In11 input integer control value which shall be used for the generation of the
global control value

Input12 In12 input integer control value which shall be used for the generation of the
global control value

Input13 In13 input integer control value which shall be used for the generation of the
global control value

Input14 In14 input integer control value which shall be used for the generation of the
global control value

Enable EN enables or disables the internal calculation

Output(s) GlobalControl GblCntrlV receives the global control value

English
Release 2016-09 31 / 102
CMS X-Tools Library – User Manual CMS

4.3.1.4 LmtChk

Purpose of the User Function LmtChk is to monitor scalar quantities against defined upper warning and alarm
thresholds. In order to ensure a valid monitoring result it has to be considered that the input of the warning
threshold has to be lower than the alarm level. These inputs are provided to the output for trending purposes
and a control value is generated.

Figure 26: CM Alarm Handling – LmtChk User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Action based and once

Action Mode Run one Calculation when at least one Input provides a new Value
Output Data Class Offline

Figure 27: CM Alarm Handling – LmtChk Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name MotorSpeed

Type Speed
Unit 1/min
Length 30 s

English
Release 2016-09 32 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the following figure shows the monitored speed signal and the defined upper
warning- and alarm thresholds as well as the control value changing according to the violated thresholds.

Figure 28: CM Alarm Handling – LmtChk Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
InputSignal InSgn data or values to which the limit check shall be applied

WarningLevel WarnLvl input warning threshold

Input(s)
AlarmLevel AlrmLvl input alarm threshold

Enable EN enables or disables the internal calculation

Control Cntrl receives the result of the limit check
Output(s) Warning Warn receives the warning threshold

Alarm Alrm receives the alarm threshold

English
Release 2016-09 33 / 102
CMS X-Tools Library – User Manual CMS

4.3.1.5 LmtChk2

Purpose of the User Function LmtChk2 is to monitor scalar quantities against defined lower warning and alarm
thresholds. In order to ensure a valid monitoring result it has to be considered that the input of the warning
threshold has to be greater than the alarm level. These inputs are provided to the output for trending purposes
and a control value is generated.

Figure 29: CM Alarm Handling – LmtChk2 User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Action based and once

Action Mode Run one Calculation when at least one Input provides a new Value
Output Data Class Offline

Figure 30: CM Alarm Handling – LmtChk2 Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name MotorSpeed
Type Speed
Unit 1/min

Length 30 s

English
Release 2016-09 34 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the following figure shows the monitored speed signal and the defined lower
warning- and alarm thresholds as well as the control value changing according to the violated thresholds.

Figure 31: CM Alarm Handling – LmtChk2 Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
InputSignal InSgn data or values to which the limit check shall be applied

WarningLevel WarnLvl input warning threshold

Input(s)
AlarmLevel AlrmLvl input alarm threshold

Enable EN enables or disables the internal calculation

Control Cntrl receives the result of the limit check
Output(s) Warning Warn receives the warning threshold

Alarm Alrm receives the alarm threshold

English
Release 2016-09 35 / 102
CMS X-Tools Library – User Manual CMS

4.3.1.6 SendLog

Purpose of the User Function SendLog is to build and send specific reports based on the received error log
entries which are created by AddLog. SendLog is supervising all submodules (DME, MTE, ANE and STE) and
in case there is a new error log entry which contains the phrase CMR, SendLog decrypts the alarm and warn-
ing integer values and picks up the right text messages from the error text file for building and sending the report
via TCP/IP.

Figure 32: CM Alarm Handling – SendLog User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [Hz] 1

Output Data Class Online

Figure 33: CM Alarm Handling – SendLog Analyzing Model

English
Release 2016-09 36 / 102
CMS X-Tools Library – User Manual CMS

After the Analyzing Model has been started for the first time, SendLog creates two additional folders within the
X-Tools Server directory. In case the folder SendReport does not exist, the folder is also created.

Figure 34: CM Alarm Handling – SendLog folders within XTS directory

The AC.txt file has to be copied from “…\CM Training V 04.04.00\_errorDescr\” to “...\CMS X-Tools Profession-
al\Server\User\SendReport\errorDescr\”. Furthermore the TCP IP Test Server has to be started for receiving the
reports. This has to be done via the Analyzing Script “00 Start TCP IP Test Server”.

English
Release 2016-09 37 / 102
CMS X-Tools Library – User Manual CMS

This Analyzing Script starts the TCP IP Test Server and the following window comes up.

Figure 35: CM Alarm Handling – SendLog TCP IP Test Server (startup)

For receiving the reports which are sent by the User Function SendLog, a socket connection has to be config-
ured. This is done via the menu bar -> Socket -> Listen.

Figure 36: CM Alarm Handling – SendLog TCP IP Test Server (socket)

English
Release 2016-09 38 / 102
CMS X-Tools Library – User Manual CMS

The Server IP and Port Number have to be typed in according to the parameters of the Analyzing Model Send-
Log and are confirmed by clicking onto the OK button.

Figure 37: CM Alarm Handling – SendLog TCP IP Test Server (configure)

If the Analyzing Model SendLog has been started before the TCP IP Test Server it may take a couple of
minutes till the connection is established. This can be prevented by restarting the Analyzing Model SendLog
after the TCP IP Test Server has been started.

Figure 38: CM Alarm Handling – SendLog TCP IP Test Server (listen)

A new report is sent after the Analyzing Model AddLog has been executed several times according to the pa-
rameter NumberOfStatus (NoSts). Once a new error log entry has been created, SendLog builds up the specif-
ic report and sends it to the TCP IP Test Server.

Figure 39: CM Alarm Handling – SendLog TCP IP Test Server (report)

The report is displayed by the table column Message.

English
Release 2016-09 39 / 102
CMS X-Tools Library – User Manual CMS

The folder errorDescr contains the text files (can be created user defined) which contains the clear text mes-
sages for specific types of signals, e.g. for acceleration AC.txt. This text file can be filled as follows.

Figure 40: CM Alarm Handling – SendLog text file

According to the created log entry by the User Function AddLog and the given text file, the report is built as
follows.
YYYY-MM-DD hh:mm:ss:mmm:uuu:nnn: Error List, System, Sub System, Component, ID – Alarm: …, …., … -
Warning: …, …, …;Value

Figure 41: CM Alarm Handling – SendLog matching entry

The folder Log contains a text file SendReport.log which contains all sent reports.

Figure 42: CM Alarm Handling – SendLog log file

English
Release 2016-09 40 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) IPAddress IP receives the IP address for sending the data or values
Port Port receives the port for sending the data or values
Enable EN enables or disables the internal calculation

Output(s) OutputReady OutRdy indicates whether a log entry has been sent

English
Release 2016-09 41 / 102
CMS X-Tools Library – User Manual CMS

4.3.2 CM Broadband Analysis

In this subsection of the CM Library, all User Function Files for Broadband Analysis are present. These User
Functions are intended to be applied only to signals received from IEPE (Integrated Electronic Piezo Electric)
vibration acceleration sensors. Resulting scalar and spectral quantities are mainly used to detect gear meshing-
and antifriction bearing faults of gearboxes and / or electrical machines.
However, it has to be considered that these User Functions produce inappropriate results when applied to sig-
nals received from vibration velocity transducers for instance.

4.3.2.1 FltrAccEnv

Purpose of the User Function FltrAccEnv is to calculate the filtered acceleration envelope of the given input
signal as a pre-processing for subsequent order or frequency spectrum calculation.

Figure 43: CM Broadband Analysis – FltrAccEnv User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 20

Output Data Class Offline

Figure 44: CM Broadband Analysis – FltrAccEnv Analyzing Model

English
Release 2016-09 42 / 102
CMS X-Tools Library – User Manual CMS

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01
Type Acceleration

Unit m/s²
Length 15 s

Based on the given input signal, the next figure shows the correspondingly calculated filtered acceleration enve-
lope signal and the speed related synchronic impulse train which is required for order analysis. The impulse
train represents one impulse per revolution.

Figure 45: CM Broadband Analysis – FltrAccEnv Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

AccelerationRaw AccRaw acceleration raw signal

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

Input(s) HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

CutoffFrequency CutFrq cutoff frequency of the lowpass filter
Enable EN enables or disables the internal calculation

FilteredAccelerationEnvelope FltrAccEnv receives the result of the filtering

Output(s) FilteredAccelerationEnvelopeCF FltrAccEnvCF receives the result of the filtering multiplied by the correction factor
for the windowing

English
Release 2016-09 43 / 102
CMS X-Tools Library – User Manual CMS

4.3.2.2 SpmAccEnv

Purpose of the User Function SpmAccEnv is to calculate the frequency spectrum of the given acceleration
envelope signal which is pre-processed by the User Function FltrAccEnv. The resulting frequency spectrum
can be used to visualize specific ball passing and / or gear meshing frequencies under consideration that this
spectrum represents only the frequencies of periodically repeating shocks caused by damaged bearings or
gears for instance. Therefore no information about the spectral composition can be extracted.

Figure 46: CM Broadband Analysis – SpmAccEnv User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 3
Output Data Class Offline

Figure 47: CM Broadband Analysis – SpmAccEnv Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01_FltrAccEnv
Type Acceleration envelope

Unit m/s²
Length 15 s

English
Release 2016-09 44 / 102
CMS X-Tools Library – User Manual CMS

The following table describes the mathematical equations which are needed to calculate frequency spectra.
Equation Description

1 NoV < NoP ∗ NoP √ ( NoS , 1) √ (1 , Lap ) Number of Values which are used for the calculation of one frequency
spectrum

2 NoV Required time signal length for the calculation

t Signal < ∗ Delay
f Cycle
3 f Cycle Resolution of the spectrum
Χ<
NoP
Based on the given spectrum parameters the following values can be calculated.
Number of Values (NoV)
NoV < NoP ∗ NoP √ ( NoS , 1) √ (1 , Lap)
NoV < 16384∗ 16384√ (3 , 1) √ (1 , 0.6)
NoV < 29491.2
Time signal length (tSignal)

NoV
t Signal < ∗ Delay
CT
29491.2
t Signal < ∗ 3s
3kHz
t Signal < 12.83s

Resolution (∆)
f Cycle
Χ<
NoP
3kHz
Χ<
16384
Χ < 0.183Hz
Three spectra are calculated and used by the averaging afterwards to obtain one averaged spectrum of the
given input signal. The calculation results can be viewed in the MDX.

Figure 48: CM Broadband Analysis – SpmAccEnv calculation results

English
Release 2016-09 45 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated acceleration envelope
frequency spectrum.

Figure 49: CM Broadband Analysis – SpmAccEnv Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) FilteredAccelerationEnvelope FltrAccEnv filtered acceleration envelope signal

NumberOfPoints NoP determines number of points containing in the buffer which are used
for the calculation

Overlap Lap defines the overlapping length of the input values in the buffer
NumberOfSpectra NoS determines number of spectra which shall be used by the averaging
NumberOfSpectraOut NoSOut determines the maximal number of output spectra

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“

Enable EN enables or disables the internal calculation

Output(s) OutputSpectrum OutSpm receives the frequency spectrum

OutputReadySpectrum OutRdySpm indicates whether the output data in OutputSpectrum is valid

English
Release 2016-09 46 / 102
CMS X-Tools Library – User Manual CMS

4.3.3 CM Current Signature Analysis

In this subsection of the CM Library, all User Function Files for Current Signature Analysis are present. These
User Functions are intended to be applied to signals received from current clamps or directly from an inverter
which provide the three phase current signals. Resulting scalar, vector and spectral quantities are mainly used
to detect electrical faults in asynchronous and synchronous machines.
However, it has to be considered that these User Functions produce inappropriate results when applied to RMS
signals for instance.

4.3.3.1 ABOrbit

Purpose of the User Function ABOrbit is to calculate a filtered orbit of the given three phase current signals
according to the Clarkes Transformation. Resulting quantity is a stator related orbit which can be used to visual-
ize stator field related asymmetries such as internal winding shorts or an imbalanced infeed. Additionally the
characteristic values (Smax, AglSmax, and Spp) of the orbit are extracted and provided to the outputs for trend-
ing purposes.

Figure 50: CM Current Signature Analysis – ABOrbit User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 4

Output Data Class Offline

Figure 51: CM Current Signature Analysis – ABOrbit Analyzing Model

English
Release 2016-09 47 / 102
CMS X-Tools Library – User Manual CMS

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 03 Load Data Current

Name I1, I2, I3
Type Current

Unit A
Length 15 s

Based on the given input signals, the next figure shows the correspondingly calculated filtered three phase cur-
rent orbit as well as the characteristic values.

Figure 52: CM Current Signature Analysis – ABOrbit Monitoring View

English
Release 2016-09 48 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) I1 I1 phase current signal i1

I2 I2 phase current signal i2
I3 I3 phase current signal i3

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

NumberOfRevolutions NoR determines the number of revolutions inside single orbit

NumberOfPointsPerRevolution NoPpR specifies the number of points to which the collected input data shall
be resampled

AverageRevolutions AvgR specifies the number of revolutions over which an average shall be
built

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Output(s) OutputOrbit OutOrb receives the result of the orbit calculation

NormSmax NrmSmax receives the calculated norm of Smax

AngleSmax AglSmax receives the calculated angle of Smax

NormSpp NrmSpp receives the calculated norm of Spp

OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 49 / 102
CMS X-Tools Library – User Manual CMS

4.3.3.2 ABZ

Purpose of the User Function ABZ is to transform three phase current signals into a stator fixed coordinate sys-
tem according to the Clarkes Transformation. Resulting quantities are two 90° shifted phase current signals also
known as alpha-beta components. In addition the zero component is calculated which represents the asymme-
tries of a three phase current system as well as the two-dimensional alpha beta vector.

Figure 53: CM Current Signature Analysis – ABZ User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 4
Output Data Class Offline

Figure 54: CM Current Signature Analysis – ABZ Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 03 Load Data Current

Name I1, I2, I3

Type Current
Unit A
Length 15 s

English
Release 2016-09 50 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signals, the next figure shows the correspondingly calculated alpha-beta components
as well as the resulting two-dimensional vector.

Figure 55: CM Current Signature Analysis – ABZ Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) I1 I1 phase current signal i1

I2 I2 phase current signal i2

I3 I3 phase current signal i3

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter
DelayTime DlyTm delay time which shall be used for compensating filter settling times

DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Output(s) AlphaBetaVector ABVector receives the 2-dimensional calculated alpha-beta vector

IAlpha IAlpha receives the alpha component

IBeta IBeta receives the beta component

IZero IZero receives the zero component
OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 51 / 102
CMS X-Tools Library – User Manual CMS

4.3.3.3 SymComAns

Purpose of the User Function SymComAns is to calculate the symmetric components of the given three phase
current system according to the Fortescue Transformation. Resulting quantities are the positive, negative and
the zero sequence as well as the two-dimensional vector of each phase current.
Positive sequence
The positive sequence illustrates the three phase current system. The space vector rotates to the rota-
tional direction with a magnitude proportional to the current demand of the three phase current system.
Negative sequence
The negative sequence illustrates the entire stator asymmetries. The space vector rotates against the
rotational direction of the positive sequence with a motor specific basic magnitude. Each motor pos-
sesses a certain magnitude of the negative sequence even though the motor comes straight from the
factory. Due to the fact that the negative sequence is a function of speed and torque, the magnitude can
in- or decreases according to the operation point. Equally the magnitude depends on the strength of
faults in the machine, e.g. increasing number of stator winding shorts results in an increasing or de-
creasing magnitude of the negative sequence. If the magnitude increases, the magnitude of the positive
system will increase proportional to compensate the negative sequence magnitude, which results in
thermal stress for the motor, caused by the higher demand of current.
Zero sequence
The zero sequence illustrates the sum zero term. While the motor is running correct isolated, the magni-
tude of the zero sequence is next to zero.

Figure 56: CM Current Signature Analysis – SymComAns User Function

English
Release 2016-09 52 / 102
CMS X-Tools Library – User Manual CMS

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 4
Output Data Class Offline

Figure 57: CM Current Signature Analysis – SymComAns Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 03 Load Data Current

Name I1, I2, I3

Type Current
Unit A
Length 15 s

English
Release 2016-09 53 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signals, the next figure shows the correspondingly calculated symmetric components
as well as the two-dimensional vectors.

Figure 58: CM Current Signature Analysis – SymComAns Monitoring View

English
Release 2016-09 54 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) I1 I1 phase current signal i1

I2 I2 phase current signal i2
I3 I3 phase current signal i3

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

NumberOfPeriods NoPrd determines number of periods which are used for the calculation of the
phases
NumberOfPoints NoP determines number of points containing in the buffer which are used for the
calculation

DelayTime DlyTm delay time which shall be used for compensating filter settling times

DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation
Output(s) I1Vector I1Vector receives the 2-dimensional calculated vector of I1

I2Vector I2Vector receives the 2-dimensional calculated vector of I2

I3Vector I3Vector receives the 2-dimensional calculated vector of I3

I0Vector I0Vector receives the 2-dimensional calculated vector of I0

PositiveSequence PS receives the result of the positive sequence calculation

NegativeSequence NS receives the result of the negative sequence calculation

ZeroSequence ZS receives the result of the zero sequence calculation
OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 55 / 102
CMS X-Tools Library – User Manual CMS

4.3.4 CM Displacement Analysis

In this subsection of the CM Library, all User Function Files for Displacement Analysis are present. These User
Functions are intended to be applied to signals received from analog displacement sensors. Typically eddy cur-
rent principle with external electronic build-in in a driver module. Resulting scalar and spectral quantities are
mainly used to detect developing faults of single rotating components which leads to an inappropriate behavior
of electrical machines or entire drive trains.
However, these User Functions can be applied to any suitable displacement signal which is of interest.

4.3.4.1 OrbitAns

Purpose of the User Function OrbitAns is to calculate a filtered orbit of the given displacement signals. Result-
ing quantity is a filtered displacement orbit which can be used to visualize the shaft movements within a sleeve
bearing. Additionally the characteristic values (Smax, AglSmax, and Spp) of the orbit are extracted and provided
to the outputs for trending purposes.

Figure 59: CM Displacement Analysis – OrbitAns User Function

English
Release 2016-09 56 / 102
CMS X-Tools Library – User Manual CMS

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 4
Output Data Class Offline

Figure 60: CM Displacement Analysis – OrbitAns Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Dsp01X, Dsp02Y, ImpulseTrainXY

Type Displacement

Unit µm
Length 15 s

English
Release 2016-09 57 / 102
CMS X-Tools Library – User Manual CMS

The following table describes the mathematical equations which are needed to calculate an orbit.
Equation Description

1
f Trigger √ ∋t Signal , Delay ( The number of revolutions per orbit (NoRpOrbit) is calculated as the result of
NoRpOrbit < the trigger frequency (fTrigger) times the effective signal length (tSignal – Delay)
and divided by the number of impulses per revolution (NoIpR)
NoIpR
2 NoRpOrbit The number of calculated orbits (NoO) is calculated as the result of the num-
NoO < ber of revolutions per orbit (NoRpOrbit) divided by the number of revolutions
NoR (NoR)

3
NoPSignal < f Cycle √ ∋t Signal , Delay( The number of signal points is calculated as the result of the Cycle Time
(fCycle) times the effective signal length (tSignal – Delay).

4 The maximum number of points per revolution (MaxNoPpR) is calculated as

1
MaxNoPpR < √ NoPSignal the result of the trigger period duration times the number of the signal points
fTrigger (NoPSignal).

Based on the given orbit parameters the following values can be calculated.
Number of Revolutions per Orbit (NoRpOrbit)

f Trigger √ ∋t Signal , Delay(

NoRpOrbit <
NoIpR
24.95Hz √ ∋15s , 3s (
NoRpOrbit <
1
NoRpOrbit < 299.4

Number of Orbits (NoO)

NoRpOrbit
NoO <
NoR
299.4
NoO <
290
NoO < 1.03

Number of Points Signal (NoPSignal)

NoPSignal < f Cycle √ ∋t Signal , Delay(
NoPSignal < 4kHz √ ∋15s , 3s (
NoPSignal < 48000

Max Number of Points per Revolution (MaxNoPpR)

1
MaxNoPpR < √ NoPSignal
f Trigger
1
MaxNoPpR < √ 48000
24.95Hz
MaxNoPpR < 1923.84

English
Release 2016-09 58 / 102
CMS X-Tools Library – User Manual CMS

One orbit is calculated which contains 290 revolutions. These 290 revolutions are taken for the averaging which
results in one orbit with one averaged revolution. The calculation results can be viewed in the MDX.

Figure 61: CM Displacement Analysis – OrbitAns calculation results

Based on the given input signals, the next figure shows the correspondingly calculated filtered displacement
orbit as well as the characteristic values.

Figure 62: CM Displacement Analysis – OrbitAns Monitoring View

English
Release 2016-09 59 / 102
CMS X-Tools Library – User Manual CMS

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) DisplacementRawX DspRawX displacement raw x signal

DisplacementRawY DspRawY displacement raw y signal
LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

SelectionTypeOfInputSignal SlctTypIn determines type of the input signal (“0” = impulse train, “1” = speed
signal)

SelectionTypeOfSpeedSignal SlctTypSpd determines type of the speed signal (“0” = 1/min, “1” = Hz)
ImpulseTrain ImpTrn impulse train

RotationalSpeed RtnlSpd speed signal

NumberOfRevolutions NoR determines the number of revolutions inside single orbit

NumberOfPointsPerRevolution NoPpR specifies the number of points to which the collected input data shall
be resampled
AverageRevolutions AvgR specifies the number of revolutions over which an average shall be
built

AngleX AngleX specifies the angle of the x-axis sensor

AngleY AngleY specifies the angle of the y-axis sensor

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“

Enable EN enables or disables the internal calculation

Output(s) OutputOrbit OutOrb receives the result of the orbit calculation

NormSmax NrmSmax receives the calculated norm of Smax

AngleSmax AglSmax receives the calculated angle of Smax

NormSpp NrmSpp receives the calculated norm of Spp

OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 60 / 102
CMS X-Tools Library – User Manual CMS

4.3.5 CM General Signal Analysis

In this subsection of the CM Library, all User Function Files for General Signal Analysis are present. These
User Functions are intended to be applied to any kind of signal received from analog sensors, IEPE (Integrated
Electronic Piezo Electric) vibration acceleration and velocity sensors or from control units for instance. Resulting
scalar and spectral quantities are mainly used to detect developing faults of single stationary and transient rotat-
ing components which leads to an inappropriate behavior of electrical machines or entire drive trains.
However, these User Functions can be applied to any suitable signal which is of interest.

4.3.5.1 CharVal

Purpose of the User Function CharVal is to calculate specific characteristic values of the given input signal.
Resulting quantities are maxima and minima, peak-peak, average and the percentage dynamic which are cru-
cial for evaluating inappropriate machine behavior for instance. The dynamic can be calculated in dependence
to up to four defined operating states.

Figure 63: CM General Signal Analysis – CharVal User Function

English
Release 2016-09 61 / 102
CMS X-Tools Library – User Manual CMS

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [Hz] 200
Output Data Class Offline

Figure 64: CM General Signal Analysis – CharVal Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name MotorTorque
Type Torque

Unit kNm
Length 30 s

English
Release 2016-09 62 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated characteristic values.

Figure 65: CM General Signal Analysis – CharVal Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) InputSignal InSgn data or values of which the characteristic value calculation shall
be applied

NumberOfPoints NoP determines number of points containing in the buffer which are
used for the calculation

OperatingStateNumber OSNmbr input of the present operating state

OperatingStateValidationNumber1 OSVldNmbr1 valid operating state number which enables the output Dynamic

OperatingStateValidationNumber2 OSVldNmbr2 valid operating state number which enables the output Dynamic
OperatingStateValidationNumber3 OSVldNmbr3 valid operating state number which enables the output Dynamic

OperatingStateValidationNumber4 OSVldNmbr4 valid operating state number which enables the output Dynamic
DelayTime DlyTm delay time which shall be used for compensating filter settling
times

DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Output(s) Maximum Max receives the result of the buffer global maximum detection
Minimum Min receives the result of the buffer global minimum detection
PeakPeak PkPk receives the result of the peak-peak calculation

Average Avg receives the result of the buffer arithmetical average calculation
Dynamic Dyn receives the result of the percentage dynamic calculation

OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 63 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.2 ExtrmVal

Purpose of the User Function ExtrmVal is to calculate the extreme values of the given input signal. Resulting
quantities are maxima and minima which can be taken into account for evaluating inappropriate machine behav-
ior for instance.

Figure 66: CM General Signal Analysis – ExtrmVal User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [Hz] 200

Output Data Class Offline

Figure 67: CM General Signal Analysis – ExtrmVal Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration
Name MotorTorque

Type Torque
Unit kNm

Length 30 s

English
Release 2016-09 64 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated extreme values.

Figure 68: CM General Signal Analysis – ExtrmVal Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) InputSignal InSgn data or values of which the extreme value calculation shall be applied

NumberOfPoints NoP determines number of points containing in the buffer which are used for
the calculation

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Output(s) Maximum Max receives the result of the buffer global maximum detection
Minimum Min receives the result of the buffer global minimum detection

OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 65 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.3 FltrSgn

Purpose of the User Function FltrSgn is to calculate the filtering of the given input signal as a pre-processing for
subsequent order spectrum calculation.

Figure 69: CM Machine Analysis – FltrSgn User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 4

Output Data Class Offline

Figure 70: CM Machine Analysis – FltrSgn Analyzing Model

English
Release 2016-09 66 / 102
CMS X-Tools Library – User Manual CMS

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Dsp01X
Type Displacement

Unit µm
Length 15 s

Based on the given input signal, the next figure shows the correspondingly calculated filtered signal and the
speed related synchronic impulse train which is required for order analysis. The impulse train represents one
impulse per revolution.

Figure 71: CM Machine Analysis – FltrSgn Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

InputSignal InSgn data or values which shall be filtered

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter
Input(s)
HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter
Enable EN enables or disables the internal calculation
FilteredSignal FltrSgn receives the result of the filtering
Output(s) FilteredSignalCF FltrSgnCF receives the result of the filtering multiplied by the correction factor
for the windowing

English
Release 2016-09 67 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.4 OprtngHrs

Purpose of the User Function OprtngHrs is to count the operating hours in dependence to the given input sig-
nal. A compare values starts and stops the counting according to the actual value of the input signal. Provided
outputs are the total operating seconds, minutes and hours.

Figure 72: CM General Signal Analysis – OprtngHrs User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [Hz] 1

Output Data Class Online

Figure 73: CM General Signal Analysis – OprtngHrs Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name MotorSpeed
Type Speed

Unit 1/min
Length 30 s

English
Release 2016-09 68 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the total counted operating hours-, minutes- and sec-
onds.

Figure 74: CM General Signal Analysis – OprtngHrs Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) InputSignal InSgn data or values of which the operating hours shall be applied

CompareValue CmpVal compare value for starting the operating hours counting
CycleTime CT cycle time of the parent analyzing model

Enable EN enables or disables the internal calculation

Output(s) Seconds ss receives the result of the operating seconds counting
Minutes mm receives the result of the operating minutes counting

Hours hh receives the result of the operating hours counting

English
Release 2016-09 69 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.5 OSDscnt

Purpose of the User Function OSDscnt is to detect operating state discontinuity during an already triggered
data recording. The User Functions OSDscnt, OSDtctn and OSVld depend to each other and work as a bun-
dle.

Figure 75: CM General Signal Analysis – OSDscnt User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [Hz] 10

Output Data Class Online

Figure 76: CM General Signal Analysis – OSDscnt Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name MotorSpeed
Type Speed
Unit 1/min

Length 30 s

English
Release 2016-09 70 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the operating state detection and validation as well as the
subsequent rawdata triggering.

Figure 77: CM General Signal Analysis – OSDscnt Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) OperatingState OS input of the operating state which is active

OperatingStateActive OSActv input of the operating state detection result
NumberOfPointsValidationTime NoPVldTm determines number of points containing in the buffer which are used to
check for operating state discontinuity

Enable EN enables or disables the internal calculation

Output(s) OutputEnable OutEN enables or disables the writing of the scalar operating state validation
number

OutputValidation OutVld receives the result of the operating state validation ("0" = continuity, "1"
= discontinuity)

English
Release 2016-09 71 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.6 OSDtctn

Purpose of the User Function OSDtctn is to detect a defined operating state according to the given input signal.
The upper- and lower input values determine the condition range which shall be used for the operating state
detection. The output is true whenever the signal is inside- and false whenever the signal is outside the condi-
tion range. The User Functions OSDscnt, OSDtctn and OSVld depend to each other and work as a bundle.

Figure 78: CM General Signal Analysis – OSDtctn User Function

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) InputSignal InSgn data or values which shall be used for the operating state detection
UpperValue UppVl upper compare value for the condition range

LowerValue LowVl lower compare value for the condition range

Enable EN enables or disables the internal calculation

Output(s) OperatingStateActive OSActv receives the result of the operating state detection

4.3.5.7 OSVld

Purpose of the User Function OSVld is to assure the validity of the chosen input operating state. The input has
to be true for a certain period of time before the rawdata recording is triggered subsequently. The output pro-
vides the operating state number as long as the input is true and switches to zero whenever the input is false
which also resets the validation time immediately. The User Functions OSDscnt, OSDtctn and OSVld depend
to each other and work as a bundle.

Figure 79: CM General Signal Analysis – OSVld User Function

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) OperatingStateActive OSActv input of the operating state detection result

NumberOfPointsValidationTime NoPVldTm determines number of points containing in the buffer which are used to
calculate the minimum time of a stable condition

OperatingState OS input of the operating state number

Enable EN enables or disables the internal calculation

Output(s) OutputOperatingState OutOS provides the operating state number while active

English
Release 2016-09 72 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.8 SpdToTrg

Purpose of the User Function SpdToTrg is to generate a speed related synchronic impulse train according to
the given speed signal. The input signal can be any speed signal in “1/s” or “1/min” received from a control unit
for instance.

Figure 80: CM General Signal Analysis – SpdToTrg User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [Hz] 200

Output Data Class Offline

Figure 81: CM General Signal Analysis – SpdToTrg Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name MotorSpeed
Type Speed

Unit 1/min
Length 30 s

English
Release 2016-09 73 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated binary impulse train as
well as the input speed signal.

Figure 82: CM General Signal Analysis – SpdToTrg Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) Speed Spd speed signal

SelectionTypeOfSpeedSignal SlctTypSpd determines type of the speed signal (“0” = 1/min, “1” = Hz)
Enable EN enables or disables the internal calculation

Output(s) ImpulseTrain ImpTrn receives the generated impulse train

English
Release 2016-09 74 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.9 Spm

Purpose of the User Function Spm is to calculate the frequency spectrum of the given input signal. The result-
ing frequency spectrum can be used to visualize specific passing and meshing frequencies or any kind of exci-
tation frequencies as well as speed dependent and independent sources of vibrations or for detecting new grow-
ing frequency components representing a possibly developing fault.

Figure 83: CM General Signal Analysis – Spm User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 2

Output Data Class Offline

Figure 84: CM General Signal Analysis – Spm Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Dsp01X
Type Acceleration

Unit m/s²
Length 15 s

English
Release 2016-09 75 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated frequency spectrum.

Figure 85: CM General Signal Analysis – Spm Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

Input(s) InputSignal InSgn data or values of which the spectrum calculation shall be applied
LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter
HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

NumberOfPoints NoP determines number of points containing in the buffer which are used
for the calculation

Overlap Lap defines the overlapping length of the input values in the buffer
NumberOfSpectra NoS determines number of spectra which shall be used by the averaging
NumberOfSpectraOut NoSOut determines the maximal number of output spectra

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“

Output(s) OutputSpectrum OutSpm receives the frequency spectrum

OutputReadySpectrum OutRdySpm indicates whether the output data in OutputSpectrum is valid

English
Release 2016-09 76 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.10 SpmOrd

Purpose of the User Function SpmOrd is to calculate an angle synchronous order spectrum of the given pre-
filtered signal. The resulting order spectrum can be used to visualize specific passing and meshing frequencies
or any kind of excitation frequencies as well as speed dependent and independent sources of vibrations or for
detecting new growing frequency components representing a possibly developing fault.

Figure 86: CM General Signal Analysis – SpmOrd User Function

English
Release 2016-09 77 / 102
CMS X-Tools Library – User Manual CMS

The following table shows the Analyzing Model Parameters of the pre-filtering which have been used for this
example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 4
Output Data Class Offline

Figure 87: CM General Signal Analysis – SpmOrd Analyzing Model (1)

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Dsp01X, ImpulseTrainXY

Type Displacement, impulse train

Unit µm, V
Length 15 s

English
Release 2016-09 78 / 102
CMS X-Tools Library – User Manual CMS

The following table shows the Analyzing Model Parameters of the order spectrum calculation which have been
used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 8

Figure 88: CM General Signal Analysis – SpmOrd Analyzing Model (2)

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Dsp01X_FltrDsp, Dsp01X_ImpTrnDsp

Type Displacement, impulse train

Unit µm, V
Length 15 s

English
Release 2016-09 79 / 102
CMS X-Tools Library – User Manual CMS

The following table describes the mathematical equations which are needed to calculate order spectra.
Equation Description

1
f Trigger √ 2 √ MaxOrder √ (t Signal , Delay) Number of calculated order spectra (NoSpm)
NoSpm < Maximum order which have to be displayed
NoP ∗ NoP √ ( NoS , 1) √ (1 , Lap) (MaxOrder)

2 NoSpm √ ( NoP ∗ NoP √ ( NoS , 1) √ (1 , Lap)) Converted equation 1 to calculate the required
t Signal < ∗ Delay time signal length
( fTrigger √ 2 √ MaxOrder)
3 2 √ MaxOrder Resolution of the order spectrum
Χ<
NoP
Based on the given order spectrum parameters the following values can be calculated.
Number of Spectra (NoSpm)
f Trigger √ 2 √ MaxOrder √ (t Signal , Delay )
NoSpm <
NoP ∗ NoP √ ( NoS , 1) √ (1 , Lap )
24.95 Hz √ 2 √ 16 √ (15s , 3s)
NoSpm <
4096 ∗ 4096 √ ( 4 , 1) √ (1 , 0.6)
NoSpm < 1.06

Resolution (∆)
2 √ MaxOrder
Χ<
NoP
2 √ 16
Χ<
4096
Χ < 0.008
Four order spectra are calculated and used by the averaging afterwards to obtain one averaged order spectrum
of the pre-filtered signal. The calculation results can be viewed in the MDX.

Figure 89: CM General Signal Analysis – SpmOrd calculation results

English
Release 2016-09 80 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated displacement order spec-
trum.

Figure 90: CM General Signal Analysis – SpmOrd Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) SignalName SgnName name of the simple data from the system which shall be read and
order re-sampled provided to output

Trigger Trigger trigger impulse train which shall be used to re-sample the signal
NumberOfImpulsesPerRevolution NoIpR determines number of trigger impulses per revolution

MaximumOrder MaxOrder determines maximum order of an afterwards calculated order

spectrum

NumberOfPoints NoP determines number of points containing in the buffer which are
used for the calculation

Overlap Lap defines the overlapping length of the input values in the buffer

NumberOfSpectra NoS determines number of spectra which shall be used by the averag-
ing

NumberOfSpectraOut NoSOut determines the maximal number of output spectra

DelayTime DlyTm delay time which shall be used for compensating filter settling
times

DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Output(s) OutputSpectrum OutSpm receives the order spectrum

OutputReadySpectrum OutRdySpm indicates whether the output data in OutputSpectrum is valid

English
Release 2016-09 81 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.11 TrgCnv

Purpose of the User Function TrgCnv is to convert a speed related synchronic impulse train into a binary im-
pulse train which is required for order and orbit analysis. Typically this impulse train is received from inductive or
other analogue sensors which provide a constant number of voltage drops per revolution according to the num-
ber of reference marks around the shaft. Additional resulting quantities are the scalar speed values in 1/min and
Hz which can be used for further Measuring Tasks or operating state detection.

Figure 91: CM General Signal Analysis – TrgCnv User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 4

Output Data Class Offline

Figure 92: CM General Signal Analysis – TrgCnv Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name ImpulseTrain
Type Impulse Train

Unit V
Length 15 s

English
Release 2016-09 82 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated binary impulse train as
well as the speed values. The time-shift is the result of the anti-aliasing filtering and has not to be taken into
account because all output signals are filtered by an anti-aliasing filter.

Figure 93: CM General Signal Analysis – TrgCnv Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) TriggerSignal TrgSgn trigger impulse train

CompareValue CompVal compare value for impulse train

NumberOfImpulsesPerRevolution NoIpR determines number of impulses per revolution

OutputSelect OutSlct identity number of the output which shall be used for the calcula-
tion of the speed signals

NumberOfPeriods NoPrd determines number of periods which are used for the calculation
of the speed signals

NumberOfPoints NoP determines number of points containing in the buffer which are
used for the timeout

Enable EN enables or disables the internal calculation

Output(s) OutputImpulseGreaterEqual OutGE receives the impulse result of the greater equal detection

OutputImpulseLowerEqual OutLE receives the impulse result of the lower equal detection
Rpm Rpm receives the result of the revolutions per minute calculation

Frequency Frq receives the result of the revolutions per second calculation
OutputReady OutRdy indicates whether the data in Rpm and Frequency are valid

English
Release 2016-09 83 / 102
CMS X-Tools Library – User Manual CMS

4.3.5.12 WFToTrg

Purpose of the User Function WFToTrg is to generate an impulse train according to the calculated period dura-
tion of the given waveform signal. The input signal can be any pre-filtered waveform such as a phase current
signal for instance.

Figure 94: CM General Signal Analysis – WFToTrg User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 1

Output Data Class Offline

Figure 95: CM General Signal Analysis – WFToTrg Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 03 Load Data Current

Name I1
Type Current

Unit A
Length 15 s

English
Release 2016-09 84 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated binary impulse train as
well as the input waveform signal.

Figure 96: CM General Signal Analysis – WFToTrg Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) Waveform WF waveform signal

NumberOfPeriods NoPrd determines number of periods which are used for the calculation
Enable EN enables or disables the internal calculation

Output(s) ImpulseTrain ImpTrn receives the generated impulse train

English
Release 2016-09 85 / 102
CMS X-Tools Library – User Manual CMS

4.3.6 CM Machine Analysis

In this subsection of the CM Library, all User Function Files for Machine Analysis are present. These User
Functions are intended to be applied only to signals received from IEPE (Integrated Electronic Piezo Electric)
vibration acceleration sensors. Resulting scalar and spectral quantities are mainly used to detect developing
faults of single stationary rotating components which leads to an inappropriate behavior of electrical machines
or entire drive trains.
However, it has to be considered that these User Functions produce inappropriate results when applied to sig-
nals received from vibration velocity transducers for instance.

4.3.6.1 CrstFctr

Purpose of the User Function CrstFctr is to calculate the Crest Factor of the given input signal. The resulting
quantity is the ratio of the peak value to the RMS. A typical acceleration signal from a machine with a large im-
balance possesses a Crest Factor similar to 2 but as the bearings begin to wear and impacting begins to
happen, the Crest Factor is much greater than this. Therefore this quantity is very important for evaluating roller
bearings.

Figure 97: CM Machine Analysis – CrstFctr User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 20

Output Data Class Offline

Figure 98: CM Machine Analysis – CrstFctr Analyzing Model

English
Release 2016-09 86 / 102
CMS X-Tools Library – User Manual CMS

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01
Type Acceleration

Unit m/s²
Length 15 s

Based on the given input signal, the next figure shows the correspondingly calculated Crest Factor.

Figure 99: CM Machine Analysis – CrstFctr Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
AccelerationRaw AccRaw acceleration raw signal
LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

NumberOfPoints NoP determines number of points containing in the buffer which are used for
Input(s)
the calculation

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“

Enable EN enables or disables the internal calculation

Crest Crst receives the result of the crest factor calculation
Output(s)
OutputReady OutRdy indicates whether the output data is valid

English
Release 2016-09 87 / 102
CMS X-Tools Library – User Manual CMS

4.3.6.2 FltrVel

Purpose of the User Function FltrVel is to calculate the filtered velocity of the given input signal as a pre-
processing for subsequent order spectrum calculation.

Figure 100: CM Machine Analysis – FltrVel User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 4

Output Data Class Offline

Figure 101: CM Machine Analysis – FltrVel Analyzing Model

English
Release 2016-09 88 / 102
CMS X-Tools Library – User Manual CMS

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01
Type Acceleration

Unit m/s²
Length 15 s

Based on the given input signal, the next figure shows the correspondingly calculated filtered velocity signal and
the speed related synchronic impulse train which is required for order analysis. The impulse train represents
one impulse per revolution.

Figure 102: CM Machine Analysis – FltrVel Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

AccelerationRaw AccRaw acceleration raw signal

CutoffFrequency CutFrq cutoff frequency of the highpass filter

Input(s) LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

Enable EN enables or disables the internal calculation

FilteredVelocity FltrVel receives the result of the filtering
Output(s) FilteredVelocityCF FltrVelCF receives the result of the filtering multiplied by the correction factor
for the windowing

English
Release 2016-09 89 / 102
CMS X-Tools Library – User Manual CMS

4.3.6.3 PkValAcc

Purpose of the User Function PkValAcc is to calculate the accelerating peak values of the given input signal.
Resulting quantities are the peak and the peak-peak value. These quantities can be calculated as auxiliary
quantities to the acceleration RMS in order to detect inappropriate behavior of stationary machine components.

Figure 103: CM Machine Analysis – PkValAcc User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 20

Output Data Class Offline

Figure 104: CM Machine Analysis – PkValAcc Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01
Type Acceleration

Unit m/s²
Length 15 s

English
Release 2016-09 90 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated acceleration peak values.

Figure 105: CM Machine Analysis – PkValAcc Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

AccelerationRaw AccRaw acceleration raw signal

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter
HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter

NumberOfPoints NoP determines number of points containing in the buffer which are used for
Input(s)
the calculation

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Peak Pk receives the result of the peak value calculation

Output(s) PeakPeak PkPk receives the result of the peak-peak value calculation

OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 91 / 102
CMS X-Tools Library – User Manual CMS

4.3.6.4 PkValVel

Purpose of the User Function PkValVel is to calculate the velocity peak values of the given input signal. Result-
ing quantities are the peak and the peak-peak value. These quantities can be calculated as auxiliary quantities
to the velocity RMS in order to detect inappropriate behavior of stationary machine components.

Figure 106: CM Machine Analysis – PkValVel User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters

Calculation Mode Equidistant

Cycle Time [kHz] 2

Output Data Class Offline

Figure 107: CM Machine Analysis – PkValVel Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01
Type Acceleration

Unit m/s²
Length 15 s

English
Release 2016-09 92 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated velocity peak values.

Figure 108: CM Machine Analysis – PkValVel Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
AccelerationRaw AccRaw acceleration raw signal
CutoffFrequency CutFrq cutoff frequency of the highpass filter

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter after integration
HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter after integration
Input(s) NumberOfPoints NoP determines number of points containing in the buffer which are used for
the calculation
DelayTime DlyTm delay time which shall be used for compensating filter settling times

DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation

Peak Pk receives the result of the peak value calculation

Output(s) PeakPeak PkPk receives the result of the peak-peak value calculation

OutputReady OutRdy indicates whether the output data are valid

English
Release 2016-09 93 / 102
CMS X-Tools Library – User Manual CMS

4.3.6.5 RMSVel

Purpose of the User Function RMSVel is to calculate the velocity RMS of the given input signal. The resulting
quantity provides information about the energy content of a vibration. Due to the fact that the RMS is calculated
from the dominant frequency component this quantity provides only information about the general condition of a
machine or component. Therefore it is impossible to detect changing vibration frequencies or new developing
frequency components caused by a beginning damage. The velocity RMS value is a crucial quantity in order to
detect inappropriate behavior of stationary machine components.

Figure 109: CM Machine Analysis – RMSVel User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 2

Output Data Class Offline

Figure 110: CM Machine Analysis – RMSVel Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal

Offline Data Loading Analyzing Script 02 Load Data Vibration

Name Acc01
Type Acceleration

Unit m/s²
Length 15 s

English
Release 2016-09 94 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated velocity RMS value.

Figure 111: CM Machine Analysis – RMSVel Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description

AccelerationRaw AccRaw acceleration raw signal

CutoffFrequency CutFrq cutoff frequency of the highpass filter
LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter after integration

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter after integration
Input(s) NumberOfPoints NoP determines number of points containing in the buffer which are used for
the calculation

DelayTime DlyTm delay time which shall be used for compensating filter settling times
DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“

Enable EN enables or disables the internal calculation

RMS RMS receives the result of the root mean square calculation
Output(s)
OutputReady OutRdy indicates whether the output data is valid

English
Release 2016-09 95 / 102
CMS X-Tools Library – User Manual CMS

4.3.6.6 SpmVel

Purpose of the User Function SpmVel is to calculate the velocity frequency spectrum of the given acceleration
signal. The resulting frequency spectrum can be used to visualize specific passing and meshing frequencies or
any kind of excitation frequencies as well as speed dependent and independent sources of vibrations or for
detecting new growing frequency components representing a possibly developing fault.
However, it has to be considered that the amplitudes above 1500 Hz are attenuated because of the integration.
For high frequency spectra the User Function Spm has to be used.

Figure 112: CM Machine Analysis – SpmVel User Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant

Cycle Time [kHz] 2

Output Data Class Offline

Figure 113: CM Machine Analysis – SpmVel Analyzing Model

The following table shows information about the input signal which have been used for this example.
Input signal
Offline Data Loading Analyzing Script 02 Load Data Vibration
Name Acc01

Type Acceleration
Unit m/s²

Length 15 s

English
Release 2016-09 96 / 102
CMS X-Tools Library – User Manual CMS

Based on the given input signal, the next figure shows the correspondingly calculated velocity frequency spec-
trum.

Figure 114: CM Machine Analysis – SpmVel Monitoring View

In the following table all input / output arguments of the User Function are found.
Full Name Short Name Description
Input(s) AccelerationRaw AccRaw acceleration raw signal

CutoffFrequency CutFrq cutoff frequency of the highpass filter

LowerCutoffFrequency LCutFrq lower cutoff frequency of the bandpass filter after integration

HigherCutoffFrequency HCutFrq higher cutoff frequency of the bandpass filter after integration
NumberOfPoints NoP determines number of points containing in the buffer which are used
for the calculation

Overlap Lap defines the overlapping length of the input values in the buffer
NumberOfSpectra NoS determines number of spectra which shall be used by the averaging

NumberOfSpectraOut NoSOut determines the maximal number of output spectra

DelayTime DlyTm delay time which shall be used for compensating filter settling times

DelaySelected DlySlct enables delay time by „1“ or disables delay time by „0“
Enable EN enables or disables the internal calculation
Output(s) OutputSpectrum OutSpm receives the frequency spectrum

OutputReadySpectrum OutRdySpm indicates whether the output data in OutputSpectrum is valid

English
Release 2016-09 97 / 102
CMS X-Tools Library – User Manual CMS

4.4 Fast Analysis

In order to apply the CM Fast Analysis to a signal, the user has to choose the online or offline signal which is of
interest and subsequently the desired User or Analyzing Function via the context menu. The calculation takes
place in the background and outputs the result either as online or offline data to the MDS again.

Figure 115: CM Fast Analysis – Spm call

English
Release 2016-09 98 / 102
CMS X-Tools Library – User Manual CMS

Figure 116: CM Fast Analysis – Spm calculation results

Figure 117: CM Fast Analysis – Spm Monitoring View

English
Release 2016-09 99 / 102
CMS X-Tools Library – User Manual CMS

5 List of Abbreviations

Abbreviation Description

AME Analyzing Model Editor

AMF Analyzing Model File

ANF Analyzing Function

ANS Analyzing System
ANX Analyzing System Explorer

ASE Analyzing Script Editor

ASF Analyzing Script File

CMM Communication Module

CTN Control Node
DMS Device Management System

DMX Device Management System Explorer

DPE Device Profile Editor

DPF Device Profile File

GOE Global Options Editor

IFM Interface Module

IFN Interface Node
IOM I/O-Module, Input/Output-Module

ION I/O-Node, Input/Output-Node

IPE Interface Profile Editor

IPF Interface Profile File

LPE Loading Profile Editor
LPF Loading Profile File

MDS Master Data System

MDX Master Data System Explorer

MMS Main Management System

MMX Main Management System Explorer
MPE Main Profile Editor

MPF Main Profile File

MTC Monitoring Chart

MTS Monitoring System

MTX Monitoring System Explorer

MVE Monitoring View Editor

MVF Monitoring View File
ODL Offline Data Loader

UAE User Accounts Editor

SLV System Log Viewer

SPE Storage Profile Editor

SPF Storage Profile File
STS Storage System

STX Storage System Explorer

UFE User Function Editor

UFF User Function File

USF User Function
English
Release 2016-09 100 / 102
CMS X-Tools Library – User Manual CMS

UPS Uninterruptible Power Supply

XTC X-Tools Client

XTS X-Tools Server

XTT X-Tools Tray

XTV X-Tools Service

English
Release 2016-09 101 / 102
CMS X-Tools Library – User Manual CMS

6 Contact Information

Should you have any questions concerning the software application, please refer to the Digital Factory Tech-
nical Support.

Department
Siemens AG
Digital Factory
Phone
+49 (0) 911 895 7222 (Monday to Friday, 08:00 am to 04: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 pro-
cessed.

English
Release 2016-09 102 / 102