Reference Manual

MN912018EN, Version 13

SMP Gateway
Automation Functions
For use with SMP Gateway software version 8.1R2 or later.
All brand and product names appearing in this document are the trademark or registered trademark
of their respective holders.

© 2020 Eaton – All rights reserved.

The information in this document is subject to change without notice.

Eaton’s Energy Automation Solutions

1990 5th Street
Suite 220
Levis, Quebec
Canada G6W 5M6
Phone: +1.418.830-5800
Fax: +1.514.227.5256
Email: [email protected]
Web: http://www.Eaton.com/smartgrid

Technical Support: [email protected]

MN912018EN, Version 13
 EAS-SA QF-MKT-02 Rev.02

Contents
1 Introduction 1
1.1 Document Overview..............................................................................................1
1.2 Getting Assistance .................................................................................................2

2 Functions 3
2.1 Analog Control ......................................................................................................3
2.2 Analog Sampling ...................................................................................................4
2.3 Best-Of ..................................................................................................................5
2.4 Binary Control .......................................................................................................6
2.5 Binary Debouncing ................................................................................................7
2.6 Create ....................................................................................................................7
2.7 Force ......................................................................................................................8
2.8 Grouped Control ....................................................................................................8
2.9 Control Conversion ...............................................................................................9
2.10 Inhibition ............................................................................................................. 10
2.11 Input Latching and Reset ..................................................................................... 11
2.12 Logical ................................................................................................................. 13
2.13 Logic Processor ................................................................................................... 14
2.13.1 Logic Editor .......................................................................................... 16

3 Configuration 17
3.1 Defining an Automation Functions Instance ....................................................... 17
3.2 Defining Logical Data Points .............................................................................. 18
3.3 Defining Automation Functions .......................................................................... 18
3.4 Defining Logic Processor Expressions Using Logic Editor ................................ 19
3.4.1 Editing a Logic Processor Expression ................................................... 21
3.4.2 Changing How Data Points are Grouped Together ............................... 22
3.4.3 Validating and Saving the Expression................................................... 23
3.5 Selecting Data Points Names for Settings ........................................................... 23

4 Appendices 25

Appendix A - General Settings A-1

SMP Gateway Automation Functions Reference Manual ●i

EAS-SA QF-MKT-02 Rev.02

Appendix B - Logical Data Point Settings B-1

Analog Input Settings ..................................................................................................................... B-1
Binary Input Settings ...................................................................................................................... B-2
Analog Output Settings .................................................................................................................. B-3
Binary Output Settings ................................................................................................................... B-5

Appendix C - Function Settings C-1

Analog Control Function Settings .................................................................................................. C-1
Analog Sampling Function Settings ............................................................................................... C-4
Best-Of Function Settings .............................................................................................................. C-6
Binary Control Function Settings ................................................................................................... C-7
Binary Debouncing Function Settings ............................................................................................ C-9
Create Function Settings............................................................................................................... C-10
Force Function Settings ................................................................................................................ C-11
Grouped Control Function Settings .............................................................................................. C-12
Control Conversion Settings......................................................................................................... C-13
Inhibition Function Settings ......................................................................................................... C-15
Input Latching and Reset Function Settings ................................................................................. C-16
Logical Function Settings ............................................................................................................. C-18
Logic Processor Function Settings ............................................................................................... C-20

Appendix D - Logic Editor Reference D-1

Data Point Names in Expressions ................................................................................................... D-1
Comments in Expressions .............................................................................................................. D-1
Conditional Statements................................................................................................................... D-1
Mathematical Functions ................................................................................................................. D-2
Data Point Functions ...................................................................................................................... D-3
Generators ...................................................................................................................................... D-4
Arithmetic Operators ...................................................................................................................... D-4
Binary Operators ............................................................................................................................ D-5
Logical Operators ........................................................................................................................... D-5
Relational Operators ....................................................................................................................... D-6
Constants and Variables ................................................................................................................. D-6

Appendix E - System Data Points E-1

System Binary Inputs ...................................................................................................................... E-1

ii ● Contents
 EAS-SA QF-MKT-02 Rev.02

Figures
Figure 2-1 Analog Control example: Writing a read meter value to a PLC ................................... 3
Figure 2-2 Best-Of example: IED redundancy ............................................................................... 5
Figure 2-3 Binary Control example: Writing a read breaker state to a PLC .................................. 6
Figure 2-4 Binary Debouncing example ........................................................................................ 7
Figure 2-5 Grouped Control example: Operating multiple IEDs via a single control operation .... 9
Figure 2-6 Inhibition example: Preventing control operation on a binary output ........................ 10
Figure 2-7 Input Latching and Reset example ............................................................................. 12

SMP Gateway Automation Functions Reference Manual ● iii

 EAS-SA QF-MKT-02 Rev.02

Tables
Table 2-1 Result point values for each operation type of the Analog Sampling function............. 4
Table 2-3 Logic Editor window panes ........................................................................................ 16
Table A-1 General settings ........................................................................................................A-2
Table B-1 Logical analog input settings .................................................................................... B-2
Table B-2 Logical binary input settings .................................................................................... B-3
Table B-3 Logical analog output settings .................................................................................. B-4
Table B-4 Logical binary output settings .................................................................................. B-5
Table C-1 Analog Control function settings .............................................................................. C-4
Table C-2 Analog Sampling function settings ........................................................................... C-5
Table C-3 Best-Of function settings .......................................................................................... C-6
Table C-4 Binary Control function settings ............................................................................... C-9
Table C-5 Binary Debouncing function settings ..................................................................... C-10
Table C-6 Create function settings .......................................................................................... C-11
Table C-7 Force function settings............................................................................................ C-12
Table C-8 Binary Control function settings ............................................................................. C-13
Table C-9 Control Conversion function settings ..................................................................... C-15
Table C-9 Inhibition function settings ..................................................................................... C-16
Table C-10 Input Latching and Reset function settings ............................................................. C-18
Table C-11 Logical function settings ........................................................................................ C-19
Table C-11 Logical function ...................................................................................................... C-20
Table D-1 Logic Editor conditional statements .........................................................................D-2
Table D-2 Logic Editor mathematical functions ........................................................................D-2
Table D-3 Logic Editor data point functions .............................................................................D-4
Table D-4 Logic Editor input value generators..........................................................................D-4
Table D-5 Logic Editor arithmetic operators .............................................................................D-5
Table D-6 Logic Editor binary operators ...................................................................................D-5
Table D-7 Logic Editor logical operators ..................................................................................D-6
Table D-8 Logic Editor relational operators ..............................................................................D-6
Table D-9 Logic Editor constants and variables ........................................................................D-6
Table E-1 System binary inputs ................................................................................................ E-1

SMP Gateway Automation Functions Reference Manual ●v

 EAS-SA QF-MKT-02 Rev.02

1 Introduction

This reference manual provides all the information required to install and set up an instance of the
Automation Functions component in an SMP Gateway.
You must be familiar with the SMP Gateway environment and the master protocol concepts
before proceeding with this document. You can acquire this information by reading the following
Eaton documents:
 SMP Gateway User Manual, MN912001EN.
 Protocol Common Concepts, MN912003EN.

Note: The SoftPLC optional module is also available on most SMP Gateway models,
and allows the creation of even more advanced automation scripts. For additional
information, refer to the SMP Gateway SoftPLC Reference Manual, MN912020EN, and
the SMP Gateway User Manual,MN912001EN.

1.1 Document Overview

This manual is divided into the following sections:
 This chapter gives an overview of the document content and purpose.
 Chapter 2 describes all automation functions, including the Logic Processor feature, and
introduces the Logic Editor tool that is used to edit Logic Processor expressions.
 Chapter 3 explains how to configure automation functions, define logical data points, and use
Logic Editor to define Logic Processor expressions.
 Chapter 4 lists common problems that can occur using the Automation Functions component,
and gives some clues on how to solve these issues.
 Reference information, such as setting and function descriptions, is available in various
Appendices.

SMP Gateway Automation Functions Reference Manual •1

EAS-SA QF-MKT-02 Rev.02

1.2 Getting Assistance

If you have any question regarding the performance, application or testing of any component of
this Eaton product, do not hesitate to contact us. Our staff will be pleased to assist you.
Technical Support
Eaton’s Energy Automation Solutions

Email: [email protected]
Phone: +1.877.834.0009
Toll Free: +1.800.815.2258

Business hours are from 8 a.m. and 5 p.m. CST, Monday to Friday.

2● Chapter 1: Introduction
 EAS-SA QF-MKT-02 Rev.02

2 Functions

The Automation Functions component is an optional software package designed to extend the
capabilities of existing devices by adding local automation capabilities similar to what could be
implemented using an external PLC. These capabilities are usually not supported by the master
protocol components.
Automation Functions can use any system data point or physical data point owned by a master
protocol; most functions also create logical data points, defined specifically for these functions in
the Automation Functions instance. For example, the Debouncing function uses any physical
binary input as the input point, and creates a new logical data point for the de-bounced point.
This chapter presents the various automation functions that are available, and their implementation
details.
To learn how to configure these functions, refer to Chapter 3.

2.1 Analog Control

The Analog Control function performs a control operation on an analog output point, called the
control point, based on the value change of an analog input point. For example, this function can
be used to read an input value from a meter, in kW, and write this value to a PLC.

READ AI CONTROL AO

Figure 2-1 Analog Control example: Writing a read meter value to a PLC

By default, a control operation is performed on the control point every times the value, quality or
timestamp of the input point changes. Some settings can be specified to operate the control point
only when specific criteria are met.
A Deadband value, in engineering units, can be specified so that only changes that exceed the
deadband value will trigger a control operation.

SMP Gateway Automation Functions Reference Manual •3

EAS-SA QF-MKT-02 Rev.02

A time Filter, in milliseconds, can be applied to value changes of the input point, to prevent
control operations from being triggered on transitions of short duration.
Another filtering setting, Quality Filtering, can be applied to ensure that only “good” transitions
(that are reported as OK, or without the “Communication Failure” quality flag raised) are used to
trigger the control operation.
When the Inhibit Trigger at Init setting is selected, the control point will not be operated by the
input point, even if all other trigger conditions are met, when the input point or the control point
becomes available at startup (when the point’s quality changes from “Unknown” to “OK”) or
following a communication failure (when the point’s quality changes from “Communication Fail”
to “OK”).
The function performs one control operation at a time; that is, the confirmation of a control
operation must be received before another control operation can be triggered.
As for standard control operations, confirmation can be real or simulated. Simulated confirmations
are faster because the corresponding master component replies with the confirmation as soon as it
receives the control operation request. Real confirmations (default behavior) require that the
master component waits for the control operation to complete before it sends the confirmation
message.
Analog Control function settings are fully described in “Appendix C”, page C-1.

2.2 Analog Sampling

The Analog Sampling function can be used to perform calculation over a specific number of
values sampled from a given analog input point, called the input point. These values are not
necessarily transitions; they are sampled from the current value of the point according to a
configured interval. The number of sampled values used is specified at configuration time, or can
be modified dynamically using a data point.
The function is evaluated at the specified sampling interval (Period setting), and the
corresponding result is stored in a result point.
Depending on the configured operation type (Type setting), the result point will take the following
value:

Type Result Point Value

Delay The oldest value of the sample.

Minimum The lower value of the sample.

Maximum The higher value of the sample.

Average The sum of all sampled values divided by the number of sampled values.

Median The sample value separating the higher half of the sample from the lower half).

Deviation The standard deviation of the sample.

Table 2-1 Result point values for each operation type of the Analog Sampling function

By default, the number of sampled values is defined at configuration time using the Sample Qty
setting. If a Sample Qty Point is defined and its value is smaller than the Sample Qty setting
value, this setting is overridden and the number of sampled values depends on the value of the
Sample Qty Point.

4● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

Note: Use the Create function to create the Sample Qty Point and the logical analog
output point that will be used to change the number of sampled values; and use the
Force function to map these points together.

For additional information, see “Create”, page 7, and “Force”, page 8.

At system startup, the result point is evaluated based on the number of sampled values available,
even if the sample is not complete.
The quality attribute of the result point is calculated by performing an OR operation of the quality
flag (bit) of each sampled value. At system startup, if the Bad Quality if Missing Samples setting
is selected, the “Bad Harware” quality flag will be raised for the result point until the first
complete sample.
The timestamp of the result point is the SMP Gateway time at which the last value was sampled.

Note: The Analog Sampling function is not recommended for analog input points whose
change rate is higher than 2 Hz (i.e. more than 2 changes per second).

Analog Sampling function settings are fully described in “Appendix C”, page C-4.

2.3 Best-Of
The Best-Of function evaluates up to 8 source data points of the same type and provides the exact
replica of the best of these points in a result point, which is the called the best-of point.
A typical application of the Best-Of function is the implementation of A-B protection schemes,
also known as IED redundancy. To implement such redundancy, three data points must be
configured for the same information: one point per master (IED), and a third point storing the
result of the Best-Of function. The control center should then be monitoring this best-of point,
made available through a slave protocol.

INFORMATION FROM
ACQUISITION OVER TWO SECONDARY SOURCE
LINKS TO TWO DEVICES. IS USED

INFORMATION FROM TRYING TO RESTORE INFORMATION FROM

PRIMARY SOURCE IS COMM. WITH PRIMARY PRIMARY SOURCE IS
PREFERRED SOURCE PREFERRED

COMMUNICATION COMMUNICATION
FAILURE RESTORED

Figure 2-2 Best-Of example: IED redundancy

Note: For additional information on how to implement redundant IEDs support using the
Best-Of function, refer to the Redundancy Options with the SMP Gateway
technical note.

The evaluation of the best source point is based on quality, and “exact replica” means that the
value, quality (except for the “Forced” and “Inhibited” quality bit) and timestamp of the best point
are copied to the result point. The result point is created by the function at runtime.

SMP Gateway Automation Functions Reference Manual •5

EAS-SA QF-MKT-02 Rev.02

If multiple points can be considered as the best one, the one with the lowest “index” is always
preferred, that is the one that was specified before the others in SMP Config. For instance, Point 3
will always be preferred over Point 6, if both points are good and the others are bad.
In addition, if the Best-Of function involves output points, control operations performed on the
result point will be forwarded to the best source point.
At system startup, the value of the result point is set to 0, with a timestamp corresponding to the
component initialization time; the “Communication Failure” quality bit is also set and the quality
remains unchanged until one of the source points changes. From then on, the function starts
evaluating the sources points and the best source one is copied to the result point. The first point
has precedence over the others, when multiple points are evaluated as “the best one available”.
Best Of function settings are fully described in “Appendix C”, page C-4.

2.4 Binary Control

The Binary Control function performs a control operation on a binary output point, called the
control point, based on the value change of a binary input point. For example, this function can be
used to read the current state of a breaker, and write this state to a PLC.

READ BI CONTROL BO

Figure 2-3 Binary Control example: Writing a read breaker state to a PLC

Essentially, a control operation, specified by the Control Type setting, is performed on the control
point every times the input point’s quality or timestamp changes, and when the point’s value
changes to the Trigger State setting value. Some settings can be specified to operate the control
point only when specific criteria are met.
A time Filter, in milliseconds, can be applied to value changes of the input point, to prevent
control operations from being triggered on transitions of short duration.
When the Inhibit Trigger at Init setting is selected, the control point will not be operated by the
input point, even if all other trigger conditions are met, when the input point or the control point
becomes available at startup (when the point’s quality changes from “Unknown” to “OK”) or
following a communication failure (when the point’s quality changes from “Communication Fail”
to “OK”).
The function performs one control operation at a time; that is, the confirmation of a control
operation must be received before another control operation can be triggered.
As for standard control operations, confirmation can be real or simulated. Simulated confirmations
are faster because the corresponding master component replies with the confirmation as soon as it
receives the control operation request. Real confirmations (default behavior) require that the
master component waits for the control operation to complete before it sends the confirmation
message.
Binary Control function settings are fully described in “Appendix C”, page C-7.

6● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

2.5 Binary Debouncing

The Binary Debouncing function is the answer to a typical binary signal problem, by filtering
short-term transitions considered as non-significant.
This function produces a debounced binary input point, based on the state of a source point (either
a binary input or output point).
If a zero-to-one transition is observed on the source point, but is followed by a one-to-zero
transition before the end of a Set Delay, the transition is discarded, which means that for the
described period, the value of the source point may have changed from zero to one, then from one
to zero, but the value of the debounced point will remain zero.
The same situation applies to one-to zero transitions that are quickly followed by one-to-zero
transitions, at a pace faster than the Reset Delay: such transitions are recorded in the source point,
but not recorded in the debounced point.

Set Delay

BI

Debounced BI

Reset Delay

Figure 2-4 Binary Debouncing example

Both the Set Delay and Reset Delay setting values are specified in milliseconds.
When a transition is considered valid, its value and quality are recorded in the debounced point.
Regarding the transition timestamp, it depends on the value of the Time Tag setting: it can either
be the time at which the source point has changed, or the time at the end of the set or reset delay.
At system startup, the debounced point is initialized to the value and quality of the source point.
Binary Debouncing function settings are fully described in “Appendix C”, page C-9.

2.6 Create
The Create operation consists in creating a logical analog or binary point acting as a data holder.
The point can then be updated by a Force operation, either through the Force automation function
or by a control operation if the point is an output point.
At system startup, the value attribute of all created data points is set to 0, unless the Persistent
setting is set. The timestamp attribute is based on the Automation Functions component instance
creation time. The quality attribute depends on the value of the Validity Delay setting.
The Validity Delay setting defines a refresh period during which the value of the created point
must be updated (forced) to maintain a valid status; otherwise, the created point’s quality will be
set to “Communication Failure”. A zero value for this setting implies that the created point’s

SMP Gateway Automation Functions Reference Manual •7

EAS-SA QF-MKT-02 Rev.02

quality will always be valid (“OK”); a non-zero value implies that the created point’s quality is
initialized to “Communication Failure” at startup.

The Persistent setting allows persistence of the value, the timestamp and quality attributes of a
created point. This setting can be applied to all point types (AI, BI, AO, BO); it is not set by
default and must be checked in SMP Config to be enabled. The Persistent option can be quite
usefull to be able to keep values between system restarts.
Note that the Force automation function must be used to force input points and control requests
must be sent to force output points.
Upon reception of a close control request, a binary input will take the value 1, and 0 if the control
request is open. When the control request is a pulse, the binary output point will emulate a pulse
(going to 1 and then 0 after the delay specified). If the point is persisted, the pulse request will be
refused.
Create function settings are fully described in “Appendix C”, page C-10.

2.7 Force
The Force function allows forcing an input data point (analog input or binary input) to a given
value, from a control operation on an output data point (analog output or binary output). The input
point is called the forced point; the output point, the force point. An additional optional point -
called the unforce point - can be used to revert the forced point to its former value and quality.
The Force function allows slave-to-slave communications. For example, if two control centers
must communicate data through a single SMP Gateway, it only has to write the data to the force
point, made available by the slave of the control center that transmit the data; this data will be
written to the forced point, before being reported through the second slave, to the second control
center.
The forced point can be an existing physical data point or a system (logical) data point created
using the Create automation function. The Force and Unforce points must be created using the the
Create automation function.
At system startup, the value attribute of all force points and unforce points is set to 0, with a
timestamp corresponding to the component initialization time. Their quality attribute is always set
to “OK” (valid).
The value, timestamp and quality attributes of a forced point are persisted, which means that they
are preserved if the SMP Gateway restarts. The only way to revert a force point to its former value
is to perform a control operation on the unforce point. If the forced point is created using the
Create automation function, make sure to select the Persistent setting; otherwise, the forced value
and quality will not be preserved upon a system restart.
Force function settings are fully described in “Appendix C”, page C-11.

2.8 Grouped Control

The Grouped Control function allows a control center to operate multiple analog or binary output
points through a single control point. For example, a SCADA can trip multiple feeders at once,
using a single control operation.

8● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

CONTROL BO

CONTROL CONTROL CONTROL

BO 1 BO 2 BO 3

Figure 2-5 Grouped Control example: Operating multiple IEDs via a single control operation

The resulting control operations are performed in parallel, although only one control operation can
be performed at a time by a given master. As a result, if the group of controlled points contains
points from the same master, a confirmation of the control operation on one of this master’s point
must be received before a second operation is performed on another point of this master.
The confirmation of the control operation on the control point depends on the value of the Success
If All Succeeded setting: if this setting is selected, the grouped control operation will be
successful only if all underlying control operations succeed; if this setting is not selected, the
grouped control will succeed if at least one underlying control operation succeeds.
Grouped Control function settings are fully described in “Appendix C”, page C-12.

2.9 Control Conversion

The Control Conversion function allows the conversion of a control operation on a binary output
produced by the Automation Functions component to a different control operation that can be
performed on a binary output produced by the system, typically a master protocol component.
This function can be used to address almost any control interoperability issues between a control
center and devices, for any protocol supported by the SMP Gateway.
With the use of the Control Conversion function, all Control Request (Select, Execute, Direct
Execute…) and Control Type (Open, Close, Pulse, Simulated Pulse, etc) conversions are possible
at the SMP Gateway level.
The Control Conversion function also allows to implement binary output pairing if the protocol
does not support it. As you can see on the following screenshot, it is possible to adjust several
settings allowing a maximum of flexibility.

SMP Gateway Automation Functions Reference Manual •9

EAS-SA QF-MKT-02 Rev.02

To increase the flexibility, the user will be able to define many lines for the same “Input Control
Point”. Each of these lines can be designed to implement the expected behavior for a specific
Control Type and Control Request. However, this flexibility allows to configurations that will
prevent the function to work correctly. For example, selecting a Pulse output control type for a
point that does not allow a pulse. For this reason, make sure to test all the required use cases when
commissioning your system.
Control Conversion function settings are fully described in “Appendix C”, page C-13.

2.10 Inhibition
Inhibition is a convenient way of putting a “do not operate” tag on an output point, when multiple
control centers or local HMIs can perform control operations on this point, if such tagging feature
is not already provided through protocol. Inhibition also allows the deactivation of transition
reporting for input points.

CONTROL
INHIBIT BO

CONTROL BO

Figure 2-6 Inhibition example: Preventing control operation on a binary output

The Inhibition function allows the temporary inhibition of multiple input or output points, when
performing a control operation on a specific binary output called the control point. A system
(logical) binary input point, called the status point, provides the inhibition status overview of the
entire list of I/O points associated to this function instance.
Only execute and direct-execute control operations are supported by the control point.
Additionally, only open and close execution types are supported: a close operation inhibits the
points, and the open operation restores the points to their normal state. Visual T&D can also

10 ● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

inhibit control operations on a specific output point of a SMP Gateway, by putting an “All
Controls Inhibited” tag on the point.
As for other control operations, inhibition control operations must be confirmed by the control
point owner, which in this case is the Automation Function component. The operation can be
refused if: (a) it tries to operate more than one control point at the time; (b) it is of an unsupported
control type (ex. select operation) or execution type (ex. Pulse); or (c) if the inhibition control
point itself is inhibited. If one of the point to inhibit is currently being operated, of if the IED that
owns it is currently performing a control operation, the inhibit operation will likely fail. All
control operations, including inhibition operations, are logged in details in the Control log file of
the SMP Gateway, which can be viewed using the SMP Log tool.
At system startup, the value attribute of inhibition status points is set to 0, with an “OK” quality
(set to 0) and a timestamp corresponding to the component initialization time, if the Inhibition
function is initialized for the first time. The quality attribute of the inhibition status point is
updated as follows:
 An OR operand is applied to each quality flag of all points in the list, except for the
“inhibition” quality flag; the result is stored in the corresponding quality flag of the inhibition
status point.
 An AND operand is applied to the “inhibition” quality flag of all points in the list; the result is
stored in the “inhibition” quality flag of the inhibition status point.
In other words, for the inhibition status point to have the “inhibited” quality, all points in the list
must be inhibited. However, for all other quality flags (for example, “Communications Failure” or
“Bad Hardware”, the quality attribute of the inhibition status point will inherits the quality flag
even if it only applies to one point of the list.
Like forced points, inhibited points are persisted, which means that points inhibited prior to a
restart of the SMP Gateway will also be inhibited upon completion of the restart process. If the
SMP Gateway does not manage to preserve the inhibition state of a point, an entry is added to the
Startup log; as a result, it is a good practice to take a look at the Startup log using SMP Log, if the
SMP Gateway has to restart, to ensure that all inhibited points were properly restored.
Inhibition function settings are fully described in “Appendix C”, page C-13.

2.11 Input Latching and Reset

Some IED protocols only report events – transitions from 0 to 1 - for binary input points. In the
SMP Gateway, these protocols usually store these events as two transitions, from 0 to 1 and from
1 to 0, with timestamps separated by only few milliseconds. This behavior is acceptable when the
values are also reported to the control center using an event-based protocol. However, if the
control center used a polling-based protocol, these transitions may not be reported. This issue can
be circumvented by delaying the return-to-zero transition, using the Input Latching and Reset
functions
The Input Latching function consists in the replication of an event that occurs on a physical
(analog or binary) input point, on a logical input point called the latched point. The Reset function
provides an additional binary output point called the reset point; when a control operation is
performed on the reset point, the corresponding latched point resets to zero and can then be
latched again. A final feature of the Input Latching and Reset functions allows the mapping of the
reset point to an existing binary output point, so a control operation is performed on this point
when the reset point is operated.
In addition to the definition of a reset point, the Reset Timeout setting can be used to specify the
time to wait, in milliseconds, before resetting the latched point to 0. This timeout can also be
deactivated, by specifying a zero value for this setting, if a reset point is specified. The Reset
Behavior setting defines how the reset operation affects the value of the latched point.

SMP Gateway Automation Functions Reference Manual • 11

EAS-SA QF-MKT-02 Rev.02

BI

Latched BI

Reset by Reset Point Reset following

timer expiration

Figure 2-7 Input Latching and Reset example

For a binary input point, an event occurs when the point’s value goes from 0 to 1 (false to true).
For an analog input point, an event is any change of value from 0.0. When an event occurs on the
input point, it is copied to the latched point, which keeps this value until it is reset. As a result, if a
second event occurs before the expiration of the reset timer or the operation of the reset point, the
latched point remains unchanged.
At system startup, the value attribute of latched points is set to 0, a timestamp corresponding to the
component initialization time. The quality attribute is set to “Communication failure”, if the
corresponding input point is sponsored by a master protocol; otherwise, the quality is set to
“Unknown”. Afterwards, the value and quality attribute of the input point is copied to the latched
point’s quality every time an event is detected on the input point. However, the timestamp
attribute of the latched point is not copied directly from the input point and does not reflect the
time of the event at the IED level: it is the timestamp of the latch operation (i.e. the time at which
the event is detected by the Automation functions component) and is set based on the time
information provided by the SMP Gateway clock.
Also at system startup, the value attribute of reset points is set to 0, with a timestamp
corresponding to the component initialization time. Their quality attribute is always set to “OK”
(valid).
When an operation is performed on the reset point, the corresponding latched point is modified
according to the value of the Reset Behavior setting. By default, it is set back to 0, and its
timestamp is set to the time of the reset operation, also based on the time information provided by
the SMP Gateway clock. Only execute and direct-execute control operations are supported for the
reset point, but all execution types are supported (open, close, trip and pulse).
As for other control operations, reset point operations must be confirmed by the reset point owner,
which in this case is the Automation Function component. The operation can be refused if: (a) it
tries to operate more than one control point at the time; (b) it is of an unsupported control type (ex.
select operation); or (c) if a control operation is currently being performed on the control point
mapped to the reset point. In all other situations, the reset operation will succeed, indicating that
the latched point was successfully reset. For additional information about the success or failure of
any control operation, view the SMP Gateway’s Control log, using the SMP Log tool.
If a control point is specified, all control operations performed on the reset point are also
automatically performed on the control point. The control operation will likely be accepted by the
master protocol that “owns” the point, except if another control operation is in progress.
Regardless of the success or failure of this operation, no confirmation is issued. It is the
responsibility of the original control operation initiator to ensure that the operation was a success,
either by polling the control point’s state or by looking at the SMP Gateway’s Control log, using
SMP Log.
If no reset timeout is specified for a given latched point, it will be persisted, which means that the
value, quality and timestamp of the latched point will be preserved if the SMP Gateway restarts. If

12 ● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

the SMP Gateway does not manage to preserve the latched value of a point, an entry is added to
the Startup log; as a result, it is a best practice to take a look at the Startup log using SMP Log, if
the SMP Gateway has to restart, to ensure that latched points were properly restored.
Input Latching and Reset function settings are fully described in “Appendix C”, page C-16.

2.12 Logical
The Logical function dynamically computes an AND or OR logical operation on up to 8 existing
binary input points. The result of this operation is stored in a logical binary input point called the
result point.

Note: You can compute an AND or OR logical operation on up to 64 points by defining

8 Logical function instances that share the same result point.

At system startup, the value attribute of all result points is set to 0, with a timestamp
corresponding to the component initialization time. The quality attribute is set to “Communication
Failure”.
From then on, the value of each result point will be calculated every times one of the source point
changes. For an AND operation, the value is set to 1 (true) if the value of all source points are set
to 1; otherwise, the value is set to 0 (false). For an OR operation, the value is set to 1 as soon as
the value of one of the source points equals to 1 (true); it is set to 0 when the value of all source
points equals 0.
The quality attribute of the result point depends on the value of the Quality setting specified for
this function:
 If set to Use all points quality, the quality attribute is calculated by a performing an OR
operation of each quality flag (bit) of all source points, excluding the “forced” and “inhibited”
quality flags.
 If set to Force good if result is certain, the quality attribute is forced to Good (0) if the value
of the result point is certain, even if the quality of some of the input points is uncertain or bad.

For example, for an AND operation, as soon as one input point is set to 0, the result will be 0,
even if the value of the other input points is uncertain.
 If set to Force good, the quality attribute will always be forced to Good (0), regardless of the
quality of the input points.
The timestamp of the result point takes the timestamp of the input point that triggered the result
point’s value. For an OR operation, it takes the timestamp of the first input point that turned to 1,
or of the last input point that turned to 0. For an AND operation, it takes the timestamp of the last
input point that turned to 1, and of the first input point that turned to 0.
The Logical function can be used in a redundant SMP Gateway configuration, as it works on
standby SMP Gateway if the Execute on standby general setting is selected. For additional
information on this settings, see “General Settings”, page A-1.
Logical function settings are fully described in “Appendix C”, page C-18.

SMP Gateway Automation Functions Reference Manual • 13

EAS-SA QF-MKT-02 Rev.02

2.13 Logic Processor

The Logic Processor is a more elaborated version of the Logical function. It allows the creation of
logical data points whose values are based on expressions that use the value of physical data
points or other calculated points. These expressions may contain conditional statements,
mathematical and electrical functions, value generators, and various operators.
For example, it is possible to calculate the phase imbalance of a given electrical signal, using the
analog input points providing the current measured on each phase and the Imbalance function
taking these points as inputs.
Each Logic Processor expression can be evaluated in one of two following ways:
 By exception.
The expression is evaluated when a transition occurs on any data point included in the
expression. The evaluation can also be performed when the value of a specific data point
changes.
 Periodically.
The expression is evaluated every X milliseconds.
An expression can also be configured to be evaluated both by exception and periodically. A final
option is to choose neither evaluation method: in this case, the expression will be evaluated only
once, at the SMP Gateway startup.
Logic Processor expression can resolve or not. When an expression resolves, this means
that the execution flow reaches an assignment line. In the following example, the
expression resolves when MB_AI1 is bigger than 5; otherwise, the expression is
unresolved.
if "MB_AI1" > 5 then

"MB_AI1" + 10

endif

In this second example, the expression has no unresolved path; the expression will always
resolve.
if "MB_AI1" > 5 then

"MB_AI1" + 10

else

"MB_AI1" - 10

endif

The Logic Processor function has an Update condition parameter which is set to
Always when resolved only by default. Selecting this mode will always generate a
transition in the system when the expression resolves. Selecting Upon value or quality
change will generate a transition in the system only upon change in the value and/or the
quality, only when the expression resolves. Selecting Always will always generate a
transition in the system, whether or not the equation resolves. This parameter applies to
both time-based and/or by exception triggers.

14 ● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

The Persistent setting allows persistence of the value, the timestamp and quality attributes of the
point produced by a logic expression. Following a system restart, the persisted point’s data is
recovered and updated in the RTDX before the first evaluation of the logic expression related to
the produced point.
Each logic expression is evaluated at system startup following the receipt of the initial value of
dependent points or when the time has expired for expressions based on time. This evaluation
results in an update of the produced point, thus replacing the initial persisted and recovered value.
An exception to this is when a logic expression is not resolved.
For example, the following expression is not resolved when the value of the point MB_AI1 is not
5.
If "MB_AI1" = 5 Then
"MB_AI1"
Endif

An unresolved logic expression is a typical use case for using the Persistent option, otherwise the
persisted value is overwritten each time the expression resolved, including at startup.

Note: Enabling the Persistence option will impact on system performance. The update
value will be reported to the real-time database (RTDX) following a successful
persistence operation. This feature should be used only with logic expression that will
not resolve most of the time, like the example above.

Logic Processor expressions can be used in a redundant SMP Gateway configuration, as it works
on standby SMP Gateway if the Execute on standby general setting is selected. For additional
information on this settings, see “General Settings”, page A-1.

SMP Gateway Automation Functions Reference Manual • 15

EAS-SA QF-MKT-02 Rev.02

2.13.1 Logic Editor

The Logic Editor is the SMP Config feature that is used to define Logic Processor expressions. Its
window is divided into several panes, allowing the user to set the attributes of the calculated data
point and assisting him in the expression definition process.

The toolbar located at the top of the window allows users to validate, to save and close the
expression, or to undo the last change made to the expression.
The table below describes the various panes of the Logic Editor window:

Pane Description
Properties Used to specify the different attributes of the calculated data point.

Data Points Used to select and enter existing data points in the expression. Analog points are
listed using a green tag, while binary points are listed using a blue tag.

Functions Displays the list of all the functions that can be inserted in the expression.

Operators Displays the list of all the operators, constants and variables that can be inserted
in the expression. Double-click on an item to insert it at the cursor location in
the expression window. The various operators are described in the sections
below.

Expression Used to enter and edit the expression to be evaluated. The result of the
evaluation of the expression is assigned as the value of the calculated data point.

Table 2-2 Logic Editor window panes

16 ● Chapter 2: Functions
 EAS-SA QF-MKT-02 Rev.02

3 Configuration

Like most SMP Gateway software features, Automation Functions are configured using
SMP Config.
In this chapter, the reader will learn how to perform the following Automation Functions
configuration tasks:
 Define an Automation Functions component instance.
 Define logical data points.
 Define an automation function and specify its settings.
 Define Logic Processor expressions using Logic Editor.

3.1 Defining an Automation Functions Instance

Automation functions are defined in instances of the Automation Functions component. Although
it is possible to define all automation functions in a single instance, it is recommended to use a
separate instance for each group of functions that apply to a given IED and its corresponding data
points.
Using separate instances simplifies the design and maintenance, but also makes it easier to
understand for users. It also allows the use of prefixes that are similar to those of the
corresponding master protocols.

To define an Automation Functions instance:

 In the left pane of SMP Config, under the System branch, click Automation Functions.
 In the right pane, assign a name to the new instance, and then press ENTER.

The new instance appears in the left pane.

 Expand the new instance branch, and then click General.
 In the Device Prefix cell, type the prefix that will be added before the name of all logical data
points of this instance.
 If transitions must be processed in chronological order by the Automation Functions
component instance, specify, in the Transition Sort Delay cell, how long (in seconds) the
component should delay and sort transitions.

For additional information on the Transition Sort feature and the corresponding setting, see
“Appendix A - General Settings”, page A-1.

SMP Gateway Automation Functions Reference Manual • 17

EAS-SA QF-MKT-02 Rev.02

 If the instance is intended to run on a standby SMP Gateway, in a redundant gateway

configuration, select Execute on Standby.

For additional information about this feature, see “Appendix A - General Settings”, page A-1.
The instance is now ready to be configured.

3.2 Defining Logical Data Points

Most automation functions create their own data points, called logical data points, as opposed to
physical data points that provide from master protocols. Like master data points, these logical
points must first be defined before they can be used as the functions’ settings.

To define a logical data point:

 Under the Automation Functions instance branch, select the branch corresponding to the type
of point to define. For example, to define a logical analog input, expand the Analog Inputs
branch, and then click Logical Inputs.

 In the right pane, click in the Name cell of the first empty row.
 Type the name of the logical point.

Note: The full name of the point will be preceded by the Automation Functions instance
prefix, like master point names that are preceded by a device prefix.

 (Optional) In the Description cell, type some indications about the purpose of this point or
the function that creates and uses it.
 Edit other point settings as required. For additional information about these settings,
see “Logical Data Point Settings”, page B-1.

3.3 Defining Automation Functions

All automation functions, except Logic Processor expressions, are defined and specified in the
same manner. Of course, most function settings are specific to each function.
The procedure that follows does not cover every single setting of each function, but gives a good
overview of this definition process.
For a complete description of the functions’ settings, see “Appendix C”, page C-1.

To define an automation function:

 Under the Automation Functions instance branch, expand the Functions branch, and then
select the branch of the type of function to define.

Note: To define a Logic Process expression, see “Defining Logic Processor

Expressions Using Logic Editor”, below.

 In the first empty row, click in the Name cell.

18 ● Chapter 3: Configuration
 EAS-SA QF-MKT-02 Rev.02

 Type a unique name for the function. This name will appear in the various logs and traces, to
reference this function.
 (Optional) In the Description cell, type some indications about the purpose of this function.
 Edit the function settings, which may include: physical and logical data points reference;
control confirmation options; timer durations; etc.
 Once the settings are completely specified, choose Validate All from the Validate menu.

Take a look at the Messages pane, which is located in the lower right of the SMP Config
window. Correct all listed errors. Pay also attention to warning messages. In most situations, a
properly defined automation function definition will not generate any error or warning
message.

3.4 Defining Logic Processor Expressions Using

Logic Editor
Logic Processor expressions are also defined in SMP Config, using the Logic Editor.

To define a Logic Processor expression:

 In SMP Config, define a new Automation Functions component instance, as described in
“Defining an Automation Functions Instance”, page 17.

Note: A Logic Processor expression can also be defined in an existing Automation

Functions instance.

 Define the calculated point, a logical data point which will result from the expression, as
described in “Defining Logical Data Points”, page 18.
 Under the Automation Functions instance branch, expand the Functions branch, and then
click Logic Processor.
 From the Tools menu, choose Logic Editor.

SMP Gateway Automation Functions Reference Manual • 19

EAS-SA QF-MKT-02 Rev.02

 In the Produced point cell, select the logical data point that will hold the result of the
expression: this is the calculated point.

By default, if no expression was defined yet, Logic Editor selects the first logical data point
available, as the calculated point of the expression.

Note: A single Automation Functions component instance can hold any number of
Logic Processor expressions; however, only one expression is allowed per logical
(calculated) data point.

 Specify the calculated point’s properties:

 In the Name cell, type a name for the expression; this name will be used to reference this
expression, in the list of Logic Processor expressions displayed in the Logic Processor
branch of the main window of SMP Config.
 In the Description cell, type a short description of the expression that will be evaluated
for this point; this description will also be displayed in the list of Logic Processor
expressions.
 In the Timestamp cell, specify how the timestamp of calculated data point values will be
determined:
 To apply the date and time at which the expression is evaluated to calculated point
values, select System: in this case, the date and time information is based on the
SMP Gateway system time.
 Otherwise, if the evaluation is triggered by a data point update, you can
select Triggered point to apply the timestamp of the point to the calculated point
value. This is the default value for this setting.

20 ● Chapter 3: Configuration
 EAS-SA QF-MKT-02 Rev.02

 In the Quality cell, specify how the quality of calculated point values will be evaluated
for this point:
 If the quality should always be OK (good), select Force good.
 Otherwise, select Use source quality: the combination of the quality of all data
points used in the expression will determine the calculated point value’s quality. This
is the default value for this setting.

Note: The quality is a bit string of quality flags (conditions); if no flag is set, the quality is
OK. The combination mentioned above is obtained by performing an OR operation of
the quality attribute of each source point, which means that as soon as a quality flag is
set for a source point, it will also be set for the calculated data point.

 In the Update condition cell, specify whether or not the calculated value will generate a
transition in the system upon specific conditions. Refer to Table 2-2, pageErreur !
Signet non défini. for details.
 Select Always when resolved only (default) to generate a transition in the system
upon change in value, quality or timestamp for a resolved expression only. This
means that an unresolved expression will not generate a transition in the system.
 Select Always to generate a transition in the system upon each evaluation of the
expression, even when the expression is unresolved.
 Select Upon value or quality if you want to generate a transition in the system only
when the value and/or the quality has changed. The expression must resolve to
generate a transition.
 If the expression needs to be evaluated on a regular basis:
 In the Time-Based cell, select Yes.
 In the Time Interval (ms) cell, type the number of milliseconds to wait between two
evaluations of the expression.
 Otherwise, if the expression must only be evaluated by exception, select No in the Time-
Based cell. This is the default setting.
 If the expression needs to be evaluated when some points of the expression changes:
 In the By Exception cell, select Yes. This is the default setting.
 To trigger the evaluation of the expression when any point of the expression changes,
select No in the Specific Trigger cell.
 Otherwise, select Yes in the Specific Trigger cell, and then select the trigger point in
the Triggered by cell.
 To deactivate by-exception triggering, select No in the By Exception cell.
The final step is to edit the expression itself.

3.4.1 Editing a Logic Processor Expression

The expression is edited in the Expression pane, which is the unnamed area that occupies the
lowest part of the Logic Editor window.
There is no single procedure to follow to write or edit a Logic Processor expression. You can type
the expression directly; however, this technique requires a good knowledge of the various
functions, operators, and data point names. The easiest way to proceed is to select these operands
through the various panes, by double-clicking the items from the lists.

SMP Gateway Automation Functions Reference Manual • 21

EAS-SA QF-MKT-02 Rev.02

For example, to select a given data point, expand the Data Points branch and browse through the
list to find the desired point; then, double-click on the desired point, whose name will appear in
the Expression pane at the cursor location. The same applies to Functions and Operators.
To use the value of the calculated data point, use the CurrentPoint variable, which is
available from the Operators list.
For a complete description of the various functions and operators, see “Appendix D - Logic Editor
Reference”, page D-1.

3.4.2 Changing How Data Points are Grouped Together

By default, the Data Points list displays all available data points as a single, flat list. These points
can be grouped into folders, based on specific criteria.

To change how data points are grouped together:

 In the Logic Editor window, click the folder icon in the toolbar.

 If you want to hide the binary points, clear the Include binary points check box.
 Select Group data points.
 Under Group together names, select With a common beginning to group points according
to a given prefix, or With a common ending to group points according to a given suffix.
 To use a fixed length for the prefix/suffix:
 Under Group names, select Have a fixed length of <X> characters.
 Specify the <X> number of characters.
 To use a delimiter character for the prefix/suffix:
 Under Group names, select Are delimited by the occurrence <X> of character <Y>.
 Specify which occurrence of the <Y> character should be used as the delimiter. For
example, if the ‘_’ character appears twice in the prefix of the points, type 2.
 Type the character to use as the delimiter.
 Make sure the grouping settings are as expected, by looking at the Preview box.

22 ● Chapter 3: Configuration
 EAS-SA QF-MKT-02 Rev.02

3.4.3 Validating and Saving the Expression

The Logic Editor allows validation at configuration time, preventing most errors before testing the
expression at runtime.

To validate the expression:

 In the Logic Editor window, click the icon in the toolbar.

 Correct any error signaled by the editor, if any.

To save the expression:

 Click the icon in the toolbar.

Logic Editor validates the expression and saves it to the configuration file if it is valid. If
some errors are detected, fix the expression before trying to save again.
 Close the Logic Editor window.
The expression should now be visible in the Logic Processor expression list, which can be viewed
by clicking the Logic Processor branch of the corresponding Automation Functions component
instance.

3.5 Selecting Data Points Names for Settings

Instead of typing the name of an existing data point in a setting cell, users can select the point
from a list.

To select a data point name as a setting:

 Click in the cell where the point name must be entered.
 From the Tools menu, choose Select Points.

 In the Select Points window, expand the branch of the instance that produced this data point.
 Click on the point’s name to select it.
 Click Paste.

The name of the point is copied to the previously selected cell.

SMP Gateway Automation Functions Reference Manual • 23

 EAS-SA QF-MKT-02 Rev.02

4 Appendices

SMP Gateway Automation Functions Reference Manual • 25

 EAS-SA QF-MKT-02 Rev.02

Appendix A - General Settings

General settings specify the general behavior of an Automation Functions component instance.
The following table presents these settings.

Setting Description
Device Prefix A string used as a prefix for all logical data points created by this
Automation Functions component instance. This prefix must be unique,
along all components that also create data points, to ensure that all point
names in the system are unique.
Range: 1 to 67 ASCII characters.

Enabled Indicates if this Automation Functions component instance is currently

enabled. Clear this checkmark to temporarily deactivate the execution of this
instance’s functions.
Range: checkmark / no checkmark
Default value: checkmark (enabled)

SMP Gateway Automation Functions Reference Manual • A-1

EAS-SA QF-MKT-02 Rev.02

Setting Description
Transition Sort Delay Indicates how long transitions are delayed to ensure they are processed by
the Automation Functions component instance in chronological order.
This feature is called Transition Sort. It is required in situations where the
various input points of a given function are provided by different masters
(IEDs); by default, the Automation Functions component instance processed
data point transitions in the order it receives them from RTDX. By delaying
the transitions, the component can sort them and put them in chronological
order, before processing them.
The Transition Sort feature only works properly if the clocks of the
SMP Gateway and the IEDs are synchronized.

Note: Transitions that are too old (per the Transition Sort
Delay setting), or whose timestamp is set “in the future”
(more than one second ahead of the current time of the
SMP Gateway), are not delayed and are automatically
processed by the Automation Functions component instance.

Two system binary inputs can be activated to monitor transition sort:

 ___OutOfSequence
 ___QueueOverflow.
These system data points are presented in details in the “System Binary
Inputs” section, page E-1.
Range: 0 to 59 seconds
Default value: 0 (transitions are processed in the order they are received)

Execute on standby A checkmark enables the execution of this Automation Functions

component instance on a standby SMP Gateway. This setting applies only
when two SMP Gateways are grouped together in a redundant configuration;
for the moment, only the Logical automation function and Logic Processor
expressions run while on standby.
Range: checkmark / no checkmark
Default value: no checkmark

Table A-1 General settings

A-2 ● Appendix A - General Settings

 EAS-SA QF-MKT-02 Rev.02

Appendix B - Logical Data Point Settings

Logical data points are created by Automation Functions component instances. Although the
functions are responsible for the creation of these points, the latter must first be defined in the
corresponding point branches that appear right under the Automation Functions instance branch,
in SMP Config.
This appendix presents the settings that must be specified for logical data points of all types.

Analog Input Settings

The following table presents the settings that are specific to logical analog inputs of the
Automation Functions component.

Setting Description
Name The name associated with an analog input point. Each point monitored by a
specific automation function must have a unique name. This name is
preceded by the Device Prefix, as specified in the general settings. The
device prefix, coupled with the name, ensures that every point managed by
the system has a unique name.
The following characters cannot be used as part of the name: the comma (,),
the quotation mark ("), the semicolon (;) and the grave accent (`).
Range: 1 to 131 ASCII characters (including the prefix).

Disabled When this setting contains a checkmark, the point is ignored by the
Automation Functions component instance.
This flag can be used, for example, to temporarily remove points having
hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Scale Scaling factor used to convert 32-bit values (raw) to significant engineering
units (floating point) and vice versa. The conversion depends on the format
of the value, as provided by the parent function. The following equation is
used:
Floating-point value = (raw value * scale) + offset
Range: –3.4E38 to 3.4E38, not 0.0
Default value: 1.0

SMP Gateway Automation Functions Reference Manual • B-1

EAS-SA QF-MKT-02 Rev.02

Setting Description
Offset Offset value used to convert 32-bit values (raw) to significant engineering
units (floating point) and vice versa. See the Scale setting above.
Range: –3.4E38 to 3.4E38
Default value: 0.0

SMP Deadband Only floating-point value changes greater than the deadband value are
reported, unless the value itself is smaller than the deadband. This ensures
that small variations around 0 are reported so that, for example, reported
values do not remain fixed at .01 when they are, in fact, 0. A value of 0 for
this setting implies that all variations, no matter how small, are reported.
Range: 0.0 to 3.4E38
Default value: 0.0

Units Units that are displayed with this point’s values in the various SMP Tools,
or through the SMP Gateway web server.
Allowed values: As shown in the drop-down list
Default value: ** Undefined **

Description An optional point description, which is displayed in the various SMP Tools,
or through the SMP Gateway web server, to provide additional information
about this point at runtime.
Range: 1 to 63 ASCII characters.

Table B-1 Logical analog input settings

Binary Input Settings

The following table presents the settings that are specific to logical binary inputs of the
Automation Functions component.

Setting Description
Name The name associated with a binary input point. Each point monitored by a
specific automation function must have a unique name. This name is
preceded by the Device Prefix, as specified in the general settings. The
device prefix, coupled with the name, ensures that every point managed by
the system has a unique name.
The following characters cannot be used as part of the name: the comma (,),
the quotation mark ("), the semicolon (;) and the grave accent (`).
Range: 1 to 131 ASCII characters (including the prefix).

Disabled A checkmark indicates that the point is ignored by the Automation Functions
component instance.
This flag can be used, for example, to temporarily remove points having
hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

B-2 ● Appendix B - Logical Data Point Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Inverted Pol. Put a checkmark to have the protocol component invert the logic of the
binary input before proceeding with any reporting.
Range: checkmark / no checkmark
Default value: no checkmark

Description An optional point description, which is displayed in the various SMP Tools,
or through the SMP Gateway web server, to provide additional information
about this point at runtime.
Range: 1 to 63 ASCII characters.

Table B-2 Logical binary input settings

Analog Output Settings

Each automation function may contain several analog output points. Analog output settings tell the
component how to control the device. The following table shows the analog output settings that
are specific to the Automation Functions component.

Setting Description
Name The name associated with an analog output point. Each point monitored by a
specific automation function must have a unique name. This name is
preceded by the Device Prefix, as specified in the general settings. The
device prefix, coupled with the name, ensures that every point managed by
the system has a unique name.
The following characters cannot be used as part of the name: the comma (,),
the quotation mark ("), the semicolon (;) and the grave accent (`).
Range: 1 to 131 ASCII characters (including the prefix).

Disabled A checkmark indicates that the point is ignored by the Automation Functions
component instance.
This flag can be used, for example, to temporarily remove points having
hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Scale Scaling factor used to convert 32-bit values (raw) to significant engineering
units (floating point) and vice versa. The conversion depends on the format
of the value, as provided by the parent function. The following equation is
used:
Floating-point value = (raw value * scale) + offset
Range: –3.4E38 to 3.4E38, not 0.0
Default value: 1.0

Offset Offset value used to convert 32-bit values (raw) to significant engineering
units (floating point) and vice versa. See the Scale setting above.
Range: –3.4E38 to 3.4E38
Default value: 0.0

SMP Gateway Automation Functions Reference Manual • B-3

EAS-SA QF-MKT-02 Rev.02

Setting Description
SMP Deadband Only floating-point value changes greater than the deadband value are
reported, unless the value itself is smaller than the deadband. This ensures
that small variations around 0 are reported so that, for example, reported
values do not remain fixed at .01 when they are, in fact, 0. A value of 0 for
this setting implies that all variations, no matter how small, are reported.
Range: 0.0 to 3.4E38
Default value: 0.0

Control Low Limit The value entered in this field is used to set the minimum value allowed for
the logical analog output in a control operation initiated from the SMP
Gateway HMI’s Single-Line Diagram page. A control operation is not
allowed when the control value is out of range.
When the Control Low Limit and the Control High Limit values are both
set to zero, this limitation feature is disabled, thus eliminating the verification
on the control operation value.
Range: –3.4E38 to 3.4E38
Default value: 0

Control High Limit The value entered in this field is used to set the maximum value allowed for
the logical analog output in a control operation initiated from the SMP
Gateway HMI’s Single-Line Diagram page. A control operation is not
allowed when the control value is out of range.
When the Control Low Limit and the Control High Limit values are both
set to zero, this limitation feature is disabled, thus eliminating the verification
on the control operation value.
Range: –3.4E38 to 3.4E38
Default value: 0

Units Units that are displayed with this point’s values in the various SMP Tools, or
through the SMP Gateway web server.
Allowed values: As shown in the drop-down list
Default value: ** Undefined **

Description An optional point description, which is displayed in the various SMP Tools,
or through the SMP Gateway web server, to provide additional information
about this point at runtime.
Range: 1 to 63 ASCII characters.

Table B-3 Logical analog output settings

B-4 ● Appendix B - Logical Data Point Settings

 EAS-SA QF-MKT-02 Rev.02

Binary Output Settings

Each automation function may contain several binary output points. Binary output settings tell the
component how to control the device. The following table shows the binary output settings that
are specific to the Automation Functions component.

Setting Description
Name The name associated with a binary output point. Each point monitored by a
specific automation function must have a unique name. This name is
preceded by the Device Prefix, as specified in the general settings. The
device prefix, coupled with the name, ensures that every point managed by
the system has a unique name.
The following characters cannot be used as part of the name: the comma (,),
the quotation mark ("), the semicolon (;) and the grave accent (`).
Range: 1 to 131 ASCII characters (including the prefix).

Disabled A checkmark indicates that the point is ignored by the Automation Functions
component instance.
This flag can be used, for example, to temporarily remove points having
hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Description An optional point description, which is displayed in the various SMP Tools,
or through the SMP Gateway web server, to provide additional information
about this point at runtime.
Range: 1 to 63 ASCII characters.

Table B-4 Logical binary output settings

SMP Gateway Automation Functions Reference Manual • B-5

 EAS-SA QF-MKT-02 Rev.02

Appendix C - Function Settings

This appendix presents in details the settings of all automation functions, as they must be specified
in SMP Config.

Analog Control Function Settings

The following table shows the settings that are specific to the Analog Control automation function.
For a complete description of this function, see “Analog Control”, page 3.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 131 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Input Point The name of an existing analog input point, whose changes will trigger
a control operation on the Control Point.

Note: See “Selecting Data Points Names for Settings”,

page 23, to learn how to select the point name from a
list, rather than having to type it.

Range: 1 to 131 ASCII characters.

SMP Gateway Automation Functions Reference Manual • C-1

EAS-SA QF-MKT-02 Rev.02

Setting Description
Filter The amount of time, in milliseconds, during which the Input Point
value must remain the same, following a transition, to trigger a control
operation on the Control Point.
This setting prevents control operations from being triggered by
transitions of short duration.

Note: First, the Quality Filtering setting is used to

determine if the value is valid; the Deadband setting is
then evaluated, to determine if the change is large
enough to trigger the control operation; the Filter setting
is then considered to ensure that the value change is
significant over time.

Range: 0 to 2,147,483,647 milliseconds

Default value: 0 milliseconds

Deadband Only floating-point value changes greater than the deadband value are
taken into account, unless the value itself is smaller than the deadband,
in which case all value changes are considered. A value of 0 for this
setting implies that all variations, no matter how small, are reported.

Note: First, the Quality Filtering setting is used to

determine if the value is valid; the Deadband setting is
then evaluated, to determine if the change is large
enough to trigger the control operation; the Filter setting
is then considered to ensure that the value change is
significant over time.

Range: 0.0 to 1.0E29

Default value: 0.0

Control Point The name of an existing analog output point, on which a control
operation will be performed if the value of the Input Point changes
significantly (according to the Quality Filtering, Deadband and Filter
settings).

Note: See “Selecting Data Points Names for Settings”,

page 23, to learn how to select the point name from a list,
rather than having to type it.

Range: 1 to 131ASCII characters.

Default value: none

C-2 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Simulated Control This setting determines whether the confirmation is real or simulated.
Confirmation
A checkmark indicates that the confirmation will be simulated;
otherwise, it will be real.
Simulated confirmations are faster because the master component
replies with the confirmation as soon as it receives the control
operation query. A real confirmation forces the master to wait until the
control operation has completed before sending the confirmation
message.
Range: checkmark / no checkmark
Default value: no checkmark

Force Processing This setting allows analog control to be executed, even if the Input
Point value does not change.
A checkmark indicates that all Input Point updates will result in
control operations on the Control Point.
Range: checkmark / no checkmark
Default value: no checkmark

Use Float A checkmark indicates that the control operation will use the
engineered (floating point) value of the Input Point, instead of the raw
value.
Range: checkmark / no checkmark
Default value: checkmark

Quality Filtering This setting allows this function to ignore Input Point transitions
based on the point’s quality attribute.
By default, all transitions tagged with the “Communication Failure”
quality are ignored, which means that they do not trigger a control
operation on the Control Point, regardless of the Deadband and
Filter settings. Other options are to refuse transitions when any quality
flag is raised, or to ignore the quality flags.

Note: First, the Quality Filtering setting is used to

determine if the value is valid; the Deadband setting is
then evaluated, to determine if the change is large
enough to trigger the control operation; the Filter setting
is then considered to ensure that the value change is
significant over time.

Allowed values: Comm. Failure

All Bad Quality
No Filtering
Default value: Comm. Failure

Inhibit Trigger on Init A checkmark indicates that the Control Point will not be operated by
the Input Point, even if all other trigger conditions are met, when the
Input Point or the Control Point becomes available at startup (when
the point’s quality changes from “Unknown” to “OK”) or following a
communication failure (when the point’s quality changes from
“Communication Fail” to “OK”).

SMP Gateway Automation Functions Reference Manual • C-3

EAS-SA QF-MKT-02 Rev.02

Setting Description
Description This field is used to store additional information about this function,
for reference purposes.
Range: 1 to 63 ASCII characters.

Table C-1 Analog Control function settings

Analog Sampling Function Settings

The following table shows the settings that are specific to the Analog Sampling automation
function. For a complete description of this function, see “Analog Sampling”, page 4.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 131 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Input Point The name of an existing analog input point whose values will be
sampled for calculation purposes; the result will be stored in the Result
Point.
Note: See “Selecting Data Points Names for Settings”, page 23, to learn how to
select the point name from a list, rather than having to type it.
Range: 1 to 131 ASCII characters.

Result Point A logical analog input, which will record the result of the calculation
performed on the sample at the specified sampling interval (as defined
by the Period setting).
Allowed values: A logical data point of this component instance.
Default value: None

Period The sampling interval, in milliseconds, rounded to the lowest multiple

of 50 milliseconds.
Range: 250 to 60,000 milliseconds (1 minute)
Default value: 500 milliseconds

Type The type of operation that will be performed on the sampled values.
Allowed values: Average
Delay
Deviation
Maximum
Median
Minimum
Default value: Average

C-4 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Sample Qty The number of sampled values that will be considered in the
calculation; as a new value is sampled every ‘x’ milliseconds (as
defined by the Period setting), the Sample Qty setting can also be
considered as the size of the moving sample window.

Note: The number of sampled values can be overridden

at runtime using the Sample Qty Point, if such a point
was designated at runtime. However, if the Sample Qty
Point value exceeds the value of the Sample Qty setting
value, the point value will be ignored.

Range: 1 to 120
Default value: 30

Sample Qty Point The name of a logical analog input, which can be used to override the
Sample Qty setting at runtime. However, if the Sample Qty Point
value exceeds the value of the Sample Qty setting value, the point
value will be ignored.
This setting is optional.

Note: Use the Create function to create the Sample

Qty Point and the logical analog output point that will
be used to change the number of sampled values; and
use the Force function to map these points together.

Allowed values: A logical data point of this component instance.

Default value: None

Use Float A checkmark indicates that the float value of the Input Point will be
sampled, instead of the raw value.
Range: checkmark / no checkmark
Default value: checkmark (float value is sampled)

Bad Quality if Missing A checkmark indicates that the quality attribute of the Result Point will
Samples be set to “Bad” if there is not enough sampled values at startup.
Range: checkmark / no checkmark
Default value: no checkmark (quality is good at startup)

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-2 Analog Sampling function settings

SMP Gateway Automation Functions Reference Manual • C-5

EAS-SA QF-MKT-02 Rev.02

Best-Of Function Settings

The following table shows the settings that are specific to the Best-Of automation function. For a
complete description of this function, see “Best-Of”, page 5.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 131 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Result Point A logical data point of any type, which will record the value and quality
of the best point available, when any source data point changes.
Allowed values: A logical data point of this component instance.
Default value: None

Point 1 The name of each source data point to consider when evaluating the
Point 2 best of these points. Up to 8 points can be used, and they must be of the
Point 3 same type as the Result Point.
Point 4
Point 5 If multiple points can be considered as the best one, the one with the
Point 6 lowest “index” is always preferred. For instance, Point 3 will always be
Point 7 preferred over Point 6, if both points are good and the others are bad.
Point 8
Note: See “Selecting Data Points Names for Settings”,
page 23, to learn how to select the point name from a list,
rather than having to type it.

Range: 1 to 131 ASCII characters.

Default value: none

Use Float A checkmark indicates that the scale and offset of the Result Point is
computed from the source point engineered (float) value. Otherwise, it
is computed from the source point raw (integer) value.
Range: checkmark / no checkmark
Default value: checkmark

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-3 Best-Of function settings

C-6 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Binary Control Function Settings

The following table shows the settings that are specific to the Binary Control automation function.
For a complete description of this function, see “Binary Control”, page 6.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Input Point The name of an existing binary input point, whose changes will trigger
a control operation on the Control Point.
Note: See “Selecting Data Points Names for Settings”, page 23, to learn how to
select the point name from a list, rather than having to type it.
Range: 1 to 131 ASCII characters.

Trigger State This setting defines which transitions on the Input Point will trigger a
control operation on the Control Point.
If set to 0, only transitions from 1 to 0 will be considered; if set to 1,
only transitions from 0 to 1 will be considered.
Allowed values: 0
1
Default value: 0

Filter The amount of time, in milliseconds, during which the Input Point
value must remain the same, following a transition, to trigger a control
operation on the Control Point.
This setting prevents control operations from being triggered by
transitions of short duration.
Range: 0 to 2,147,483,647 milliseconds
Default value: 0 milliseconds

Control Point The name of an existing analog output point, on which a control
operation will be performed if the value of the Input Point changes
(according to the Trigger State and Filter settings).

Note: See “Selecting Data Points Names for Settings”,

page 23, to learn how to select the point name from a list,
rather than having to type it.

Range: 1 to 131 ASCII characters.

Default value: none

SMP Gateway Automation Functions Reference Manual • C-7

EAS-SA QF-MKT-02 Rev.02

Setting Description
Control Type The execution type of the control operation to perform on the Control
Point, when a significant transition occurs on the Input Point
(according to the Trigger State and Filter settings).
Note: The Control Type setting is independent of the Trigger State; this
means that a Trigger State value of 0 can result in a Close control
operation, and vice-versa.
Allowed values: Open
Close
Pulse
Default value: Open

Simulated Control This setting determines whether the confirmation is real or simulated.
Confirmation
A checkmark indicates that the confirmation will be simulated;
otherwise, it will be real.
Simulated confirmations are faster because the master component
replies with the confirmation as soon as it receives the control operation
query. A real confirmation forces the master to wait until the control
operation has completed before sending the confirmation message.
Range: checkmark / no checkmark
Default value: no checkmark

Quality Filtering This setting allows this function to ignore Input Point transitions based
on the point’s quality attribute.
By default, all transitions tagged with the “Communication Failure”
quality are ignored, which means that they do not trigger a control
operation on the Control Point, regardless of the Deadband and Filter
settings. Other options are to refuse transitions when any quality flag is
raised, or to ignore the quality flags.

Note: First, the Quality Filtering setting is used to

determine if the value is valid; the Deadband setting is
then evaluated, to determine if the change is large
enough to trigger the control operation; the Filter setting
is then considered to ensure that the value change is
significant over time.

Allowed values: Comm. Failure

All Bad Quality
No Filtering
Default value: Comm. Failure

Inhibit Trigger on Init A checkmark indicates that the Control Point will not be operated by
the Input Point, even if all other trigger conditions are met, when the
Input Point or the Control Point becomes available at startup (when
the point’s quality changes from “Unknown” to “OK”) or following a
communication failure (when the point’s quality changes from
“Communication Fail” to “OK”).

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

C-8 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Table C-4 Binary Control function settings

Binary Debouncing Function Settings

The following table shows the settings that are specific to the Binary Debouncing automation
function. For a complete description of this function, see “Binary Debouncing”, page 7.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 131 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Input Point The name of the existing binary input/output point, for which
transitions need to be filtered.
Note: See “Selecting Data Points Names for Settings”, page 23, to learn how to
select the point name from a list, rather than having to type it.
Range: 1 to 131 ASCII characters.

Debounced Point A logical binary input point that will store the filtered (debounced)
values of the Input Point.
Allowed values: A logical binary input of this component instance.

Set Delay The amount of time to wait, in milliseconds, following a transition from
zero to one on the Input Point, before recording this transition in the
Debounced Point; if this transition is followed by a one to zero
transition before the end of this delay, none of these two transitions will
be recorded to the Debounced Point.
Range: 0 to 2,147,483,647 milliseconds
Default value: 1000 milliseconds

Reset Delay The amount of time to wait, in milliseconds, following a transition from
one to zero on the Input Point, before recording this transition in the
Debounced Point; if this transition is followed by a zero to one
transition before the end of this delay, none of these two transitions will
be recorded to the Debounced Point.
Range: 0 to 2,147,483,647 milliseconds
Default value: 1000 milliseconds

SMP Gateway Automation Functions Reference Manual • C-9

EAS-SA QF-MKT-02 Rev.02

Setting Description
Time Tag Determines how the timestamp of the Debounced Point is set. It can
either be the time at which the initial transition occurred (Use input
point), or the time at which the transition was recorded in the
Debounced Point (Add set and reset delay).
Allowed values: Use input point
Add set and reset delay
Default values Use input point

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-5 Binary Debouncing function settings

Create Function Settings

The following table shows the settings that are specific to the Create automation function. For a
complete description of this function, see “Create”, page 7.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Created Point The logical data point to create.

Allowed values: A logical data point of this component instance.
Default value: None

C-10 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Validity Delay The maximum amount of time to wait, in milliseconds, for the point to
be updated, before setting this point’s quality attribute to
“Communication Failure”. This setting apply to all point types.
This delay is calculated relative to the absolute timetag. So, if the point
is persistent, the delay will be calculated correctly even after a system
restart.
If set to 0, the Created Point’s quality attribute will always be OK (0).
If set > 0, the Created Point’s quality attribute will be created at
startup with COMFAIL status (if the point is not persistent). If the point
is persistent, the startup quality will be calculated based on the persited
timestamp of the point.

Range: 0 to 2,147,483,647 milliseconds

Default value: 0 milliseconds

Persistent A checkmark indicates that the forced value, timestamp and quality
attributes of the Created Point will be persisted following a restart of
the SMP Gateway. This setting applies to all point types.
For analog and binary input points, the persistence will be applied only
if the value of the point is forced via the Force automation function.
For analog and binary ouput points, the persistence will be applied only
when a control request is received on the point. The control request
will work in a similar manner as for a Force automation function.

Range: checkmark / no checkmark

Default value: no checkmark

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-6 Create function settings

Force Function Settings

The following table shows the settings that are specific to the Force automation function. For a
complete description of this function, see “Force”, page 8.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

SMP Gateway Automation Functions Reference Manual • C-11

EAS-SA QF-MKT-02 Rev.02

Setting Description
Disabled A checkmark indicates that the specific function is ignored by the
Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Forced Point The name of the existing analog or binary input to force to a given
value.
Note: See “Selecting Data Points Names for Settings”, page 23, to learn how to
select the point name from a list, rather than having to type it.
Range: 1 to 131 ASCII characters.

Force Point A logical analog or binary output point, on which a control operation is
performed to set the value of the Forced Point.
Allowed values: An existing analog or binary output point.
Default value: None

Unforce Point A logical binary output point, on which a control operation is

performed to reset (unforce) the value of the Forced Point.
Allowed values: An existing binary output point.
Default value: None

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-7 Force function settings

Grouped Control Function Settings

The following table shows the settings that are specific to the Grouped Control automation
function. For a complete description of this function, see “Grouped Control”, page 8.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

C-12 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Control Point A logical analog or binary output point whose changes are reflected to
the corresponding controlled points. If a control operation is performed
on the Control Point, the same control operation will be performed on
each controlled point. Similarly, a change of value on this point will
also cause a change of value on the controlled point.
Allowed values: A logical output point of this component instance.
Default value: None

Success If All Succeeded A checkmark indicates that a control operation performed on the
Control Point will only be considered as successful if the resulting
control operations on all controlled points also succeed.
No checkmark indicates that the control operation will succeed if at
least one resulting control operation on any of the corresponding
controlled point succeeds.
Range: checkmark / no checkmark
Default value: checkmark

Point 1 The name of an existing analog or binary output point that will be
Point 2 controlled by the Control Point. Up to 8 points can be specified, they
Point 3 must be of the same type of the Control Point.
Point 4
Note: See “Selecting Data Points Names for Settings”, page 23, to learn how to
Point 5 select the point name from a list, rather than having to type it.
Point 6
Point 7 Range: 1 to 131 ASCII characters.
Point 8 Default value: none

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-8 Binary Control function settings

Control Conversion Settings

The following table shows the settings that are specific to the Control Conversion automation
function. For a complete description of this function, see “Control Conversion”, page 9.

Setting Description
Input Control Point The name of an existing binary input point, whose Control Type will
be converted.
Allowed values: An output point listed in the drop-down list.
Default value: None

SMP Gateway Automation Functions Reference Manual • C-13

EAS-SA QF-MKT-02 Rev.02

Setting Description
Input Control Type Output control operation received as input for the conversion of its
control type, i.e., operations that will be converted to the control type
selected in the Output Control Type setting. See the “Protocol Common
Concept” document for more information about each control type.
Allowed values: Open
Close
Open/Close
Pulse
Any
Default value: Any

Output Control Point The name of a subscribed binary output point, on which the converted
control operation will be performed.
Range: 1 to 131 ASCII characters.
Default value: none

Output Control Request This is the operation request transmitted via the Output Control Point.
See the “Protocol Common Concept” for more information about each
control request.
Allowed values: Select
Select Logical
Recall
Execute
Execute Logical
Direct Execute
Direct Execute Logical
Input Control Request
Default value: Input Control Request

Output Control Type Output control operation converted from the Input Control Type to the
desired type. This control operation will be sent to the device via the
Output Control Point. See the document “Protocol Common Concept”
document for more information about each control type.
The Simulated Pulse (Close + Open) allows the simulation of pulse by
sending close and open control requests, based on the On-Time, Off-
Time and Repeat Count settings.
The Simulated Pulse Train allows the simulation of pulse train by
sending pulse control requests, based on the On-Time, Off-Time and
Repeat Count settings.
Allowed values: None
Open
Close
Pulse
Simulated Pulse (Close+Open)
Simulated Pulse Train
Default value: Pulse

Keep Input Control Timings Indicates whether or not the Input Control Timing should be used.
When this setting is not selected, the override timing values are used
(On-Time, Off-Time and Repeat Count settings).
Range: checkmark / no checkmark
Default value: checkmark

C-14 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
On-Time This setting specifies the control duration, in milliseconds, to use when
Input Control Timing is ignored.
Range: 0 to 30 000 milliseconds
Default value: 500 milliseconds

Off-Time This setting specifies the off-time duration, in milliseconds, to use

when Input Control Timing is ignored.
Range: 0 to 30 000 milliseconds
Default value: 100 milliseconds

Repeat Count This setting specifies the repeat count to use, in milliseconds, when
Input Control Timing is ignored.
Range: 0 to 50 milliseconds
Default value: 1 milliseconds

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-9 Control Conversion function settings

Inhibition Function Settings

The following table shows the settings that are specific to the Inhibition automation function. For
a complete description of this function, see “Inhibition”, page 10.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Control Point A logical binary output point that controls the inhibition status of all the
controlled points. A CLOSE control operation on this point will cause
the controlled points to become inhibited, while an OPEN control
operation will reset them to their normal state.
Allowed values: A logical binary output of this component instance.
Default value: None

SMP Gateway Automation Functions Reference Manual • C-15

EAS-SA QF-MKT-02 Rev.02

Setting Description
Status Point A logical binary input point that indicates the global inhibition status of
all controlled points. If all these points are inhibited, the Status Point is
set to 1; otherwise, if at least one of these points is not inhibited, the
Status Point is set to 0.
Allowed values: A logical binary input of this component instance.
Default value: None

Point 1 The name of an existing point of any type, whose inhibition status is
Point 2 determined by the Control Point. Up to 8 points can be controlled by a
Point 3 single Control Point.
Point 4
Point 5
Point 6 Note: See “Selecting Data Points Names for Settings”,
Point 7 page 23, to learn how to select the point name from a list,
Point 8 rather than having to type it.

Range: 1 to 131 ASCII characters.

Default value: none

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-10 Inhibition function settings

Input Latching and Reset Function Settings

The following table shows the settings that are specific to the Input Latching and Reset automation
function. For a complete description of this function, see “Input Latching and Reset”, page 11.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

C-16 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Input Point The name of an existing physical input point that triggers the latch
operation. When a transition occurs on this point, the transition value is
recorded in the Latched Point.

Note: See “Selecting Data Points Names for Settings”,

page 23, to learn how to select the point name from a list,
rather than having to type it.

Range: 1 to 131 ASCII characters.

Default value: none

Latched Point A logical input point whose value is controlled by the Input Point and
the Reset Point.
When a transition is detected on the Input Point, the transition value is
recorded in the Latched Point, which retains this value until a control
operation is performed on the Reset Point, resetting the value to 0. If
no Reset Point is specified, the Reset Timeout setting allows an
automatic reset of the value after a certain amount of time.
Allowed values: A logical input point of this component instance.
Default value: None

Reset Point An optional logical binary output point that resets the value of the
Latched Point to 0 when a control operation is performed on it.
If no Reset Point is specified, the Reset Timeout setting must be
different than 0.
Allowed values: A logical binary output of this component instance.
Default value: None

Reset Timeout The time to wait, in milliseconds, before resetting the value of a
Latched Point to 0.
To deactivate this automatic reset feature, use a timeout value of 0 and
specify a Reset Point.
Range: 0 to 2,147,483,647 milliseconds
Default value: 3000 milliseconds

Reset Behavior This setting defines how the reset operation affects the value of the
Latched Point.
Available options include the reset and the non-reset of the latched
point regardless of the input point’s state, and a reset-and-relatch
combination.
Allowed values: Reset normally
Do nothing (stay latched)
Reset and relatch
Default value: Reset normally

SMP Gateway Automation Functions Reference Manual • C-17

EAS-SA QF-MKT-02 Rev.02

Setting Description
Control Point The name of an existing physical binary output point on which all
control operations performed on the Reset Point are also performed.

Note: See “Selecting Data Points Names for Settings”,

page 23, to learn how to select the point name from a list,
rather than having to type it.

Range: 1 to 131 ASCII characters.

Default value: none

Use Float A checkmark indicates that the control operation will use the
engineered (floating point) value of the Input Point, instead of the raw
value.
Range: checkmark / no checkmark
Default value: checkmark

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-11 Input Latching and Reset function settings

Logical Function Settings

The following table shows the settings that are specific to the Logical automation function. For a
complete description of this function, see “Logical”, page 13.

Note: As stated previously in the Logical function description, you can use up to 64
input points by defining additional Logical function instances with the
same Result Point setting.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

C-18 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Setting Description
Operator The logical operation performed on the associated corresponding input
points.
Allowed values: AND
OR
Default value: AND

Quality This setting determines how the quality attribute of the Result Point
will be set:
Allowed values: Use all points quality
Force good if result is certain
Force good
Default value: Force good if result is certain

Result Point A logical binary input point that stores the result of the logical
operation, which is performed every times one of the source point
changes.
The logical operation is performed both on the value and the quality of
the input points.

Note: The “inhibited” and “forced” quality flags are not

considered by the Logical function; as a result, these
quality flags are always set to 0 in the Result Point.

Allowed values: A logical binary input of this component instance.

Default value: None

Point 1 The name of an existing binary input point to be considered as an

Point 2 operand in the logical operation. Up to 8 points can be specified per
Point 3 Logical function instance.
Point 4
Note: See “Selecting Data Points Names for Settings”, page 23, to learn how to
Point 5 select the point name from a list, rather than having to type it.
Point 6
Point 7 Range: 1 to 131 ASCII characters.
Point 8 Default value: none

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-12 Logical function settings

SMP Gateway Automation Functions Reference Manual • C-19

EAS-SA QF-MKT-02 Rev.02

Logic Processor Function Settings

The following table shows the settings that are specific to the Logic Processor automation
function. For a complete description of this function, see “Logic Processor”, page 14.

Setting Description
Name The name of this function instance. All functions must have a unique
name.
Range: 1 to 39 ASCII characters.

Disabled A checkmark indicates that the specific function is ignored by the

Automation Functions component instance.
This flag can be used, for example, to temporarily eliminate functions
associated with points having hardware problems.
Range: checkmark / no checkmark
Default value: no checkmark

Result Point A logical binary input point that stores the result of the Logic Processor
operation, which is performed according to the evaluation method
selected (regular basis or exception).
The logical operation is performed both on the value and the quality of
the input points.

Note: The “inhibited” and “forced” quality flags are not

considered by the Logic Processor function; as a result,
these quality flags are always set to 0 in the Result
Point.

Allowed values: A logical binary input of this component instance.

Default value: None

Persistent The Persistent setting allows persistence of the value, the timestamp
and quality attributes of each update of the point produced by a logic
expression. Following a system restart, the persisted point’s data is
recovered and updated in the RTDX before the first evaluation of the
logic expression related to the produced point.
Range: checkmark / no checkmark
Default value: no checkmark

Description This field is used to store additional information about this function, for
reference purposes.
Range: 1 to 63 ASCII characters.

Table C-13 Logical function

C-20 ● Appendix C - Function Settings

 EAS-SA QF-MKT-02 Rev.02

Appendix D - Logic Editor Reference

This appendix contains exhaustive reference information about the Logic Editor, notably the
definition of each function, operator, constant and variable that is available to create Logic
Processor expressions.

Data Point Names in Expressions

To use a data point in an expression, type the name of the data point. Make sure to include the
prefix, if applicable.
A data point name used in an expression must adhere to the following Visual Basic-like notation:
 It must begin with a letter.
 It can include alphanumeric characters (A-Z, a-z, 0-9).
 It can include the underscore separator ( _ ) and other special characters, such as a period;
however, it must then be surrounded by straight double quotes (").

For example, a physical data point name of T5.APHA must be declared as "T5.APHA".
Here are some examples of valid expressions:
 120 + ( CurrentPoint * 0.02 * ( Rand() - 1 ) )
 ( 0.85 "T5.APHA" * "T5.KVAB" ) / 1000
 "1B17.MA" AND ("120-1.MA" AND NOT "120-1.MB" ) AND "1B1.MA"
 Imbalance("T5.APHA", "T5.APHB", "T5.APHC")

Comments in Expressions
Expressions can span several lines. To insert a comment into an expression, put a single quote at
the beginning of the line.
For instance:
' Calculates the imbalance of transformer #5
Imbalance("T5.APHA", "T5.APHB", "T5.APHC")

Conditional Statements
The following table presents the conditional statements that can be used in Logic Processor
expressions:

SMP Gateway Automation Functions Reference Manual • D-1

EAS-SA QF-MKT-02 Rev.02

Statement Description
If <condition> Then Evaluates the specified expression if the logical condition is true.
<expression>
Endif

If <condition> Then Evaluates the expression specified after the Then if the logical condition
<true expression> is true, or evaluates the expression specified after the Else if the logical
Else condition is false.
<false expression>
Endif Note that the expression can contain several embedded If and Else
statements, in which case each Else statement is associated with the If
statement closest to it.

Table D-1 Logic Editor conditional statements

If the Quality property of the calculated data point is set to Use Source Quality, only the quality
of the data points used in the executed statement is considered, in addition to the quality of the
data points used in the condition statement.
For example, if one source point is used in the Else statement, but not in the Then statement, the
quality of this point will be considered only if the Else statement is executed.

Mathematical Functions
The following table presents the mathematical functions that can be used in Logic Processor
expressions:

Function Description
Abs( x ) Calculates the absolute value of x.

Pow( x, y ) Calculates the value of x to the power of y.

Sqrt( x ) Calculates the square root of x.

Exp( x ) Calculates the value of e raised to the power of x.

Log( x ) Calculates the logarithm of x to the base 10.

Sin( x ) Calculates the sine of angle x, expressed in radians.

Cos( x ) Calculates the cosine of angle x, expressed in radians.

Tan( x ) Calculates the tangent of angle x, expressed in radians.

ArcSin( x ) Calculates the arcsine of angle x.

ArcCos( x ) Calculates the arccosine of angle x.

ArcTan( x ) Calculates the arctangent of angle x.

Min( x, y ) Compares the values of x and y, and retains the lesser of the two.

Max( x, y ) Compares the values of x and y, and retains the greater of the two.

Table D-2 Logic Editor mathematical functions

D-2 ● Appendix D - Logic Editor Reference

 EAS-SA QF-MKT-02 Rev.02

Data Point Functions

The following table presents the data point functions that can be used in Logic Processor
expressions.

Function Description
Imbalance( point A, Calculates the imbalance among three phases, for the current
point B, represented by the three data point names.
point C )
The calculation is defined as follows for a three-phase current:
((Imax - Imin) / Iavg) * 100
where:
Iavg = (AI + AB + IC) / 3
Imax = max (IA, IB, IC)
Imin = min (IA, IB, IC)

IsControlStatus( This function verifies if the actual control status of an AO or BO

point, point is the one specified. The control status is used to indicate the
status ) different phases of a control request. See the “Protocol Common
Concept” document for details on the meaning of each status.
A use case example for this function is to set a value based on the
control status of an output point. In the example below, the logical
processor equation will assign the value of the
af_AO_LOCAL_SETTING_SET to the result point only if the
control status is set to “EXECUTING”.
The expression is defined as follow for an analog output:
If
(IsControlStatus("af_AO_LOCAL_SETTING_SET",
CTRL_STATUS_EXECUTING)) Then
"af_AO_LOCAL_SETTING_SET"
Else
(...)
Endif

IsEqual( point1, Compares point1 and point2, to the nearest precision

point2, significant digits.
precision
) The expression evaluates to TRUE or FALSE, depending on
whether or not point1 = point2.

IsTrigger( point ) Evaluates to TRUE if the specified point causes the expression to
be reevaluated.

QualityOf( point ) Evaluates to TRUE if the value of the specified data point is valid.

TimestampOf( point ) Returns the timestamp of a point, as a number of milliseconds that

have elapsed since an internal reference date and time. Use this
function for the sole purpose of comparing timestamps that were
obtained via a previous call to the TimestampOf() function.

SMP Gateway Automation Functions Reference Manual • D-3

EAS-SA QF-MKT-02 Rev.02

PtsType(point,type) Allow to define a point type (AI, BI, AO or BO) to ensure that the
type of the point is precisely the one that is expected.
This function is useful to validate that a point used in an
expression is really of an expected type. It is useful only in rare
situations.

BAD_QUALITY Sets the quality of a data point to BAD, which means that the
value of the data point cannot be assumed as valid.

Table D-3 Logic Editor data point functions

Generators
Generators are used to mathematically generate input values for data points. The following value
generator can be used in Logic Processor expressions.

Generator Description
Sine( amplitude, Calculates the value of a sinusoid with the specified
frequency, amplitude, frequency (in hertz), and an initial phase (in
phase ) degrees). The phase argument is optional, and set to 0 if left
unspecified.

Pulse( amplitude, Calculates the value of a pulse stream with the specified
frequency, amplitude, frequency (in hertz), duty cycle (in
duty cycle, percent), and delay (in milliseconds). The delay argument is
delay ) optional, and set to 0 if left unspecified.

Saw( amplitude, Calculates the value of a sawtooth wave with the specified
frequency, amplitude, frequency (in hertz), and delay (in
delay ) milliseconds). The delay argument is optional, and set to 0 if
left unspecified.

Randn( mean, variance ) Calculates a random value with a normal distribution that has the
specified mean value and a var variance.

Rand() Calculates a random value with a uniform distribution ranging

between 0.0 and 1.0.

Table D-4 Logic Editor input value generators

Arithmetic Operators
The following table presents the arithmetic operators that can be used in Logic Processor
expressions.

Operator Description
+ Calculates the sum of the left and right operands.

- Calculates the difference between the left and right operands.

* Calculates the product of the left and right operands.

/ Divides the left operand by the right operand.

D-4 ● Appendix D - Logic Editor Reference

 EAS-SA QF-MKT-02 Rev.02

Operator Description
% Obtains the remainder of the division of the left operand by the right operand.

( Expressions are evaluated according to standard operator precedence. Parentheses are

) used to group sub-expressions and control the order in which expressions are
evaluated.
1 + 2 * 3 evaluates to 7
(1 + 2) * 3 evaluates to 9

Table D-5 Logic Editor arithmetic operators

Binary Operators
Binary operators are used to manipulate individual bits of data point and expression values.
The following table presents the binary operators that can be used in Logic Processor expressions.

Operator Description
BAND Calculates a bitwise AND between the left and right operands.
For instance, 12 BAND 5 evaluates to 4 (1100 BAND 0101 is 0100).

BOR Calculates a bitwise OR between the left and right operands.

For instance, 12 BOR 5 evaluates to 13 (1100 BAND 0101 is 1101).

BNOT Calculates a bitwise NOT of the value to the right.

For instance, BNOT 0 evaluates to -1 (BNOT …0000 is …1111).

BXOR Calculates a bitwise XOR between the left and right operands.
For instance, 12 BXOR 5 evaluates to 9 (1100 BXOR 0101 is 1001).

BEQV Calculates a bitwise EQV between the left and right operands.
For instance, 12 BEQV 9 evaluates to 6 (1100 BEQV 0101 is 0110).

Table D-6 Logic Editor binary operators

Logical Operators
Logical operators are used to combine the results of logical expressions, such as comparisons.
The following table presents the logical operators that can be used in Logic Processor expressions.

Operator Description
AND Evaluates to TRUE if the left and right operands are both TRUE.

OR Evaluates to TRUE if either the left or right operand is TRUE.

NOT Evaluates to TRUE if the value to the right is FALSE.

XOR Evaluates to TRUE if the left and right operands have different values.

EQV Evaluates to TRUE if the left and right operands have the same value.

SMP Gateway Automation Functions Reference Manual • D-5

EAS-SA QF-MKT-02 Rev.02

Table D-7 Logic Editor logical operators

Relational Operators
The following table presents the relational operators that can be used in Logic Processor
expressions.

Operator Description
< Evaluates to TRUE if the left operand is less than the right operand.

> Evaluates to TRUE if the left operand is greater than the right operand.

<= Evaluates to TRUE if the left operand is less than or equal to the right operand.

>= Evaluates to TRUE if the left operand is greater than or equal to the right operand.

= Evaluates to TRUE if the left operand is equal to the right operand.

!= Evaluates to TRUE if the left operand is different from the right operand.

Table D-8 Logic Editor relational operators

Constants and Variables

The following table presents the constants and variables that can be used in Logic Processor
expressions.

Constant / Variable Description

CurrentPoint Represents the current value, i.e., the value of the logical point being
edited, just prior to its evaluation.

Table D-9 Logic Editor constants and variables

D-6 ● Appendix D - Logic Editor Reference

 EAS-SA QF-MKT-02 Rev.02

Appendix E - System Data Points

This appendix presents the system data points that are available for each Automation Functions
component instance.

System Binary Inputs

The following table presents the system binary inputs that are available for each Automation
Functions component instance. By default, these points are deactivated; to activate them, clear the
corresponding Disabled check boxes in the Binary Inputs \ System Inputs branch.

Name Description
___OutOfSequence A transition could not be processed in chronological order.
When this point is asserted (set to 1), the timestamp of the out-of-
sequence transition is assigned to this system point.

Note: This point is used by the Transition Sort feature.

Refer to the description of the Transition Sort Delay
general setting (page A-1) for additional details.

___QueueOverflow Transition sort queue was cleared following an overflow.

Note: This point is used by the Transition Sort feature. Refer to the description
of the Transition Sort Delay general setting (page A-1) for additional
details.

Table E-1 System binary inputs

SMP Gateway Automation Functions Reference Manual • E-1