Configuring the FieldServer as a EST3 Client............................................................................... 5
4.1. Data Arrays..................................................................................................................................... 5
4.2. Client Side Connection Descriptors................................................................................................ 6
4.3. Client Side Node Descriptors .........................................................................................................6
4.4. Client Side Map Descriptors ...........................................................................................................7
4.4.1. FieldServer Related Map Descriptor Parameters ................................................................... 7
4.4.2. Driver Related Map Descriptor Parameters ............................................................................7
4.4.3. Map Descriptor Example 1 ...................................................................................................... 9
4.4.4. Map Descriptor Example 2: ..................................................................................................... 9
The EST3 External Communications Protocol (ECP) driver allows the FieldServer to transfer data to
and from EST devices over RS-232 or RS-485 (with converter) serial ports using the EST3 ECP
protocol. In the EST application the FieldServer always emulates a Client.
The FieldServer makes use of the following ECP Services:
Read Operations:
• Report Service
• Delta Service
Write Operations:
•Command Service
All read points are continually updated using the Report Service; response times are enhanced using
Delta Service broadcasts by the EST3 panel.
The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer.
2. Driver Scope of Supply
2.1. Supplied By FieldServer Technologies for this Driver
FIELDSERVER
TECHNOLOGIES PART #
FS-8915-10 7’ Patch Cable
FS-8917-03 RJ45 to DB9M Connector adapter
FS-8917-10 DB9F to terminal Adapter
FS-8700-39 EST3 ECP Driver Manual
DESCRIPTION
2.2. Provided By the Supplier of 3rd Party Equipment
2.2.1. Hardware
PART # DESCRIPTION VERSION
EST3 Gateway
2.2.2. Required 3rd Party Configuration
The EST3 panel has to be set into the “Gateway Mode” using the EST3 Configuration tool (3SDU)
Possible Protocols
ECP Type II Supported
ECP Type II with Text Not Supported
ECP Type III Supported
ECP Type III with Text
Not Supported
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration
Manual. The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to
communicate with an EST3 Server.
4.1. Data Arrays
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In
order to enable the FieldServer for EST3 communications, the driver independent FieldServer buffers
need to be declared in the “Data Arrays” section, the destination device addresses need to be
declared in the “Client Side Nodes” section, and the data required from the servers needs to be
mapped in the “Client Side Map Descriptors” section. Details on how to do this can be found below.
Note that in the tables, * indicates an optional parameter, with the bold legal value being the default
Section Title
Data_Arrays
Column Title Function Legal Values
Data_Array_Name Provide name for Data Array Up to 15 alphanumeric characters
Data_Format Provides data format UINT16
Data_Array_Length Number of Data Objects 1 - 10000
The 8 PanelMask parameters combine to form a 64-bit field in which each bit denotes an EST panel
in the network. Commands that use the PanelMasks are executed by each panel for which the
corresponding bit is set. The Map Descriptor need only define non-zero bytes in the PanelMask.
Typically this will be EST_Panel_Mask_1 with a value of 1.
Appendix A.2. Setting up Multiple Parameters
The multiple parameters required by a command must be stored in consecutive locations in the Data
Array specified by the Map Descriptor, starting at the specified Data_Array_Offset. All parameters
must be set up before the EST command is executed. This is done using a Block Write (if supported
by the protocol originating the data) – all parameters are set up in a single write operation, and the
EST command is triggered with all values in place.
Appendix A.3. Priority:
The write priority has the possible values of Set, Latch, Low, Medium, and High. These are encoded
as 00h, 01h, 02h, 03h and 04h respectively.
Appendix A.4. Report and Delta Service:
The EST ECP3 Report and Delta services report point status slightly differently. The FieldServer
EST3 driver deals with these differences as follows:
•Report Service (regular polling):
The full 16-bit point status is stored to the Read Map Descriptor’s Data Array. If optional Data
Arrays are configured, then the point status is also interpreted according to its Alarm, Trouble,
Supervisory or Monitor status and the corresponding Data Array is updated. See Appendix A.5
for detail.
•Delta Service (unsolicited messages):
Delta Service messages do not provide the same 16-bit status value as supplied by the Report
Service. For this reason, ONLY the optional Data Arrays will be updated when a Delta message
is received. Delta messages will therefore only have an effect when optional Data Arrays have
been configured. See 0 for detail.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
When optional parameters (EST_Alarm_DA, EST_Trouble_DA, EST_Supervisory_DA, or
EST_Monitor_DA) are used, the driver automatically separates the Alarm Trouble, Supervisory, and
Monitor bit from the incoming EST message and places the bit(s) in these Data Arrays at the same
offset as the incoming message. Other types can be stored in EST_Others_DA Data Array. Only
one Data type will be reported as active at a particular time; i.e. if Alarm is reported Driver will set
Alarm bit and reset corresponding bits from Trouble, Supervisory and Monitor Data Arrays. The Driver
does not correlate Other types with Alarm, Trouble, Supervisory or Monitor types. For different point
types the active bit has a different meaning. If the user is interested in the meaning, the
EST_Supervisory_DA Data Array should be configured. If the user is interested in the raw value of
the Active bit, the data array EST_Active_DA should be configured.
Appendix A.5.1. Relay Confirmation State
The driver can store the relay confirmation state of a point in a Data Array under the parameter
EST_Relay_Conf_DA parameter.
0 - Relay state is not confirmed; 1 – Relay state confirmed.
Appendix A.5.2. EST_Types_DA
If it is necessary to override the default Types and Category list (Appendix C.1) the
EST_Types_DA parameter should be used.
Example:
To put HEAT type into the “Monitor” category where all other defaults remain the same, preload
the data array as follows:
Preload_Data_Index is the type of device and Preload_Data_Value holds the category for the
specified device type. The legal values for Preload_Data_Value are listed below
If this parameter is not defined or is “yes”, the driver will update its internal driver list according
to the parameters preloaded under EST_Types_DA. If the parameter is set to “New List”, the
driver will use ONLY the parameters defined under EST_Types_DA and will not reference or
update the default list at all. The driver will therefore not store any data for types that do not
have preloaded categories.
Appendix A.5.4. DA_Bit_Name
The ”Acknowledge5” state of a point is stored under this Data Array if configured.
0 – Acknowledged or Acknowledge not required.
1 – Point is not Acknowledged yet. To Acknowledge the point change the value to “0”.
5
The EST3 panel is only able to send/accept Acknowledgement when the panel is in Proprietary Mode.
Contact EST (Edwards Systems Technology) for information on configuring the panel.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
The following Map Descriptors are required to set the Date and Time of the EST Panel
// First poke month(1-12) ,day(0-31) and year(yyyy) at offset 1 ,2 and 3 then poke 1 at offset 0 to
issue SetDate command
// First poke hour(0-23) ,min(0-59) and sec (0-59) at offset 1 ,2 and 3 then poke 1 at offset 0 to issue
SetTime command
Each input device is associated with a 16-bit value. The contents of the 16 bits are used to generate
status types as shown in the table below. Each incoming event is allocated to a status type
depending on its device type as shown in the table. It is possible to override this default status type
allocation. Refer to Appendix A.5 for more information.
Type Encode
Value
Smoke 0 Y
Pull 1 Y
Heat 2 Y
Waterflow 3 Y
Stageone 4 Y
Zone 5 Y
AlarmVerify 6
PreAlarm 7
Security 8
Station 9
Emergency 10
Supervisory 11
Valve 12
GateValve 13
Tamper 14
Temperature 15
Power 16
Signal 17
TroubleOpen 18
TroubleShort 19
LocalTrouble 20
MaintAlert 21
DirtyHead 22
DeviceComm 23
GroundFault 24
InternalTrouble 25
BadType 26
BadPersonality 27
UnexpectedDevice 28
CommonTrouble 29
RelayConfirmation 30
Monitor 31
LocalMonitor 32
Damper 33
Fan 34
Door 35
Switch 36
FirePhone 37
Alarm Trouble Supervisory Monitor Others
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Each output device is associated with a 16-bit value. This value consists of two byte fields, the
device type (LSB) and the device state (MSB).
FieldServer Data Array Object (16-bit)
Attribute (8-bit) Command (8-bit)
These values are provided by the EST panel and are described in the EST3 ECP protocol
specification as follows. These values will be put in the Command field.
•A poll-response connection is maintained by the EST panel acting as the master. The bytes
transferred in this process are displayed on the FieldServer as SCADA bytes transmitted and
received.
•The FieldServer acts as a client by inserting requests into its response messages; the EST panel
then inserts the requested data into its subsequent polling messages. The bytes transferred in this
process are displayed on the FieldServer as PLC bytes transmitted and received.
The following statistics are available on the Driver Aspects screen when viewing Connection Details
(select the EST Connection in Connection Overview, and press space repeatedly to page to this
screen):
Statistic Name Description
DLL Rx Char Data Link Layer Bytes Received
DLL Rx Msg Data Link Layer Messages Received
DLL Tx Char Data Link Layer Bytes Transmitted
DLL Tx Msg Data Link Layer Messages Transmitted
DLL Timeouts Data Link Layer Timeouts
DLL IC Timeouts Data Link Layer Inter-Character Timeouts
DLL Streaming Data Link Layer Streaming Errors
DLL Bad Replies Data Link Layer Bad Replies
DLL Link Control Data Link Layer Link Control Events
Gateway Type ECP Gateway Type I/II/III
Data Rx Char Data Bytes Received
Data Rx Msg Data Messages Received
Data Tx Char Data Bytes Transmitted
Data Tx Msg Data Messages Transmitted
Conn Rx Char Total Bytes Received on Connection
Conn Rx Msg Total Messages Received on Connection
Conn Tx Char Total Bytes Transmitted on Connection
Conn Tx Msg Total Messages Transmitted on Connection
Delta Rx Char Delta Message Bytes Received
Delta Rx Msg Delta Messages Received
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
This message will be displayed once if any Map Descriptor in a configuration
EST3:#01 FYI. For an
Old EST3 Panel, Read
MD length must be even.
EST3:#02 Err. Read MD
length must > 0 and <=
%d
EST3:#03 Err. Write MD
must have length = 1
EST3: #04 Unknown
Escape Sequence 1B
%02X considered as
%02X
file has an odd length. Old EST3 Panels (before 2002) simply do not
communicate if length is odd.
This message can be ignored if it is new EST3 panel. But if it is old or
unknown, try making Map Descriptor having even length before contacting
technical support.
Numbers of addresses to be read per request are limited.
Edit configuration file to set Map Descriptor length within specified range.6
One Map Descriptor can write only 1 value. Change length to 16.
This message is printed if the FieldServer receives sequences that are not
specified. Specified sequences are 1B 82, 1B 8D and 1B 9B. This message
is for information only and can be ignored unless the data stored by the
FieldServer is invalid in which case, call Tech support.
6
Download the configuration file, make the necessary changes, upload to the FieldServer and cycle
power to the FieldServer for the changes to take effect.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com