Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-39 EST3 ECP
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after September 2008
Driver Version:
Document Revision:
1.08
5
FS-8700-39 EST3 Driver Manual
Page 3 of 21
1.
EST3 Description
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 #
DESCRIPTION
FS-8915-10
7’ Patch Cable
FS-8917-03
FS-8917-10
RJ45 to DB9M Connector adapter
DB9F to terminal Adapter
FS-8700-39
EST3 ECP Driver Manual
2.2.
Provided By the Supplier of 3rd Party Equipment
Hardware
2.2.1.
PART #
DESCRIPTION
EST3 Gateway
VERSION
2.2.2.
Required 3rd Party Configuration
The EST3 panel has to be set into the “Gateway Mode” using the EST3 Configuration tool (3-
SDU)
Possible Protocols
ECP Type II
Supported
ECP Type II with Text
ECP Type III
Not Supported
Supported
Not Supported
ECP Type III with Text
FS-8700-39 EST3 Driver Manual
Page 4 of 21
3.
Hardware Connections
EST3 ECP
TB2
FS-8915-10
Model 8051
Function
FROM DB9F/M
EST3 ECP
TB2
RX
TX
GND
Pin 2
Pin 3
Pin 5
TX 2
RX 2
COM 2
8917-03
8917-03
FS-8915-10
Connect to one of the RS-232
Ports on the FieldServer
8
1
FieldServer
P1
FS-8700-39 EST3 Driver Manual
Page 5 of 21
4.
Configuring the FieldServer as a EST3 Client
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
Data_Array_Name
Data_Format
Function
Provide name for Data Array
Provides data format
Legal Values
Up to 15 alphanumeric characters
UINT16
Data_Array_Length
Number of Data Objects
1 - 10000
Example
// Data Arrays
Data_Arrays
Data_Array_Name
DA_AI_01
DA_AO_01
DA_DI_01
,Data_Format
,Float
,Float
,Bit
,Bit
,Data_Array_Length
,200
,200
,200
,200
DA_DO_01
FS-8700-39 EST3 Driver Manual
Page 6 of 21
4.2.
Client Side Connection Descriptors
Section Title
Connections
Column Title
Function
Specify which port the device is connected to the
FieldServer
Legal Values
P1-P8, R1-R21
9600, 192002
Port
Baud
Specify baud rate
Parity*
Data_Bits*
Protocol
Specify parity
Specify data bits
Specify protocol to be used by this port
None
8
EST3
Example
// Client Side Connections
Connections
Port
P8
,Baud
,19200
,Parity
,None
,Data_Bits
,8
,Protocol
,EST3
4.3.
Client Side Node Descriptors
Section Title
Nodes
Column Title
Function
Provide name for Node
Legal Values
Up to 32 alphanumeric
characters
Node_Name
Node_ID
Protocol
MAC ID of FieldServer
Specify protocol used
1 – 24 (normally 1)
EST3
Specify which port the device is connected to
the FieldServer
Port
P1-P8, R1-R21
Specify time allowed between poll and
response
Timeout
≥10 seconds
Example
// Client Side Nodes
Nodes
Node_Name
EST_1
,Node_ID
,1
,Protocol
,EST3
,Port
,P8
,Timeout
,10s
1 Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
2 Edwards Recommends 19200-baud minimum in order to prevent buffer overruns in the EST3 panel
FS-8700-39 EST3 Driver Manual
Page 7 of 21
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Column Title
Function
Legal Values
Up to 32 alphanumeric
characters
Map_Descriptor_Name Name of this Map Descriptor
Name of Data Array where data
Data_Array_Name
One of the Data Array names
from “Data Array” section above
0 to maximum specified in “Data
Array” section above
is to be stored in the FieldServer
Data_Array_Offset
Function
Starting location in Data Array
Function of Client Map Descriptor RDBC, WRBC3, WRBX
4.4.2.
Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
Node_Name
Name of Node to fetch data from specified in “Client Node
Descriptor” above
EST_Panel
EST_Card
Address
Panel
Card
0 - 63
0 - 255
0 - 1023
Starting address of read block
For Reads: 1 to 34 For Writes:
1
Length
Length of Map Descriptor
Relay, Led, ServGroup,
GuardPtrl, ChkInGrp,
AltMessage, Reset, PanelSil,
AlarmSil, Drill, GAInhibit,
Reboot, Evacuate, AltSensitiv,
Partition, CmdList, Input, Zone,
Card, AndGroup, Matrix,
TimeCtrl, InstructionText,
AmpPower, AudMsg, CmdList,
MCmsg, SetDate, SetTime
0 - 65535
EST_Object_Type
Object type parameter
EST_Index
Index parameter
EST_Route
Route parameter
0 - 255
EST_Priority
EST_Chan
Pri parameter
Chan parameter
0 - 4 (see note below)
0 - 255
EST_Msg_Index
EST_Account
MsgIndex parameter
Account parameter
0 - 65535
0 - 255
EST_ConfCL
ConfCL parameter
0 - 65535
EST_Panel_Mask_1
EST_Panel_Mask_2
EST_Panel_Mask_3
EST_Panel_Mask_4
EST_Panel_Mask_5
EST_Panel_Mask_6
EST_Panel_Mask_7
EST_Panel_Mask_8
PanelMask(1) parameter (LSB)
PanelMask(2) parameter
PanelMask(3) parameter
PanelMask(4) parameter
PanelMask(5) parameter
PanelMask(6) parameter
PanelMask(7) parameter
PanelMask(8) parameter (MSB)
0 - 255
0 - 255
0 - 255
0 - 255
0 - 255
0 - 255
0 - 255
0 - 255
Data_Array_Low_Scale* Scaling zero in Data Array
-32767 to 32767, 0
Data_Array_High_Scale* Scaling max in Data Array
-32767 to 32767, 100
Node_Low_Scale*
Node_High_Scale*
Scaling zero in Connected Node
Scaling max in Connected Node
-32767 to 32767, 0
-32767 to 32767, 100
3 WRBC is not recommended, as startup values may be invalid
FS-8700-39 EST3 Driver Manual
Page 8 of 21
Column Title
EST_Alarm_DA*
Function
Data Array to store Alarm state4
Data Array to store Trouble
state4
Legal Values
EST_Trouble_DA*
Data Array to store Supervisory
EST_Supervisory_DA*
EST_Monitor_DA*
state4
Data Array to store Monitor state4
Data Array to store state other
than Alarm, Trouble, Supervisory
or Monitor4
Data Array to store the raw value
of the active bit.
EST_Others_DA*
EST_Active_DA
One of the Data Array Names
declared in Data Arrays section
Relay confirmation state. Refer
to Appendix A.5 for more
information.
EST_Relay_Conf_DA
Data Array to hold Types
category. Refer to Appendix
A.5.2
EST_Types_DA
Update the default Types list or
refer to new list. Requires
'EST_Types_DA' parameter to
be defined. Refer to Appendix
A.5.3
EST_Types_Update
-, yes, new list
Acknowledge State. Refer to
Appendix A.5.4
Store information from particular
Report
One of the Data Array Names
declared in Data Arrays section
-, Point I/O Status, Sensitivity,
Date Time
DA_Bit_Name
EST_Report_Type
4 Refer to Appendix A.4 and Section 4.4.4
FS-8700-39 EST3 Driver Manual
Appendix A. Driver Notes
Page 10 of 21
Appendix A.1.
PanelMasks:
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.
FS-8700-39 EST3 Driver Manual
Page 12 of 21
Appendix A.5.
Optional Data Arrays
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:
Preloads
Data_Array_Name
DA_Types
,Preload_Data_Index
,2
,Preload_Data_Value
,4
,Length
,1
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
Alarm
1
2
3
4
5
Supervisory
Trouble
Monitor
Others
Appendix A.5.3.
EST_Types_Update
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.
FS-8700-39 EST3 Driver Manual
Page 14 of 21
Appendix A.6.
Object Types and Required Parameters
The tables below list the fields required for the Map Descriptor implementing each object type.
Object Type
Relay
Required Parameters
Activate and Restore Commands (01h and 11h)
EST_Panel, EST_Card, Address, EST_Priority
EST_Panel, EST_Card, Address, EST_Priority
EST_Index
Led
ServGroup
GuardPtrl
ChkInGrp
AltMessage
AmpPower
AudMsg
Reset
PanelSil
AlarmSil
Drill
GAInhibit
Reboot
Evacuate
AltSensitiv
MCmsg
EST_Index, EST_Route
EST_Index
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel, EST_Card, EST_Priority, EST_Chan
EST_Panel, EST_Card, EST_Msg_Index, EST_Priority, EST_Chan
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel_Mask(1..8) Refer to Appendix A.1
EST_Panel, EST_Card, EST_Priority, EST_Account, EST_ConfCL
EST_Index
Partition
Cmd List
AndGroup
SetDate
SetTime
EST_Index
EST_Index
EST_Object_Type. Refer to Appendix A.7
EST_Object_Type. Refer to Appendix A.7
Enable and Disable Commands (02h and 12h)
EST_Panel, EST_Card, Address
EST_Panel, EST_Card, Address
EST_Panel, EST_Card, Address
EST_Index
Relay
Led
Input
Zone
Card
EST_Panel, EST_Card
ServGroup
AndGroup
Matrix
EST_Index
EST_Index
EST_Index
TimeCtrl
GuardPtrl
ChkInGrp
AmpPower
Partition
Instruction Text
EST_Index
EST_Index, EST_Route
EST_Index
EST_Panel, EST_Card
EST_Panel, EST_Card, Address
EST_Panel, EST_Card, Address
FS-8700-39 EST3 Driver Manual
Page 15 of 21
Appendix A.7.
Set Date and Time To Panel
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
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Function ,Node_Name ,EST_Object_Type ,Length
MD_Set_Date
MD_Set_Time
,DA_Set_Date
,DA_Set_Time
,0
,0
,Wrbx
,Wrbx
,EST_1
,EST_1
,SetDate
,SetTime
,1
,1
The following Map Descriptor will enable the FieldServer to synchronize its clock with the EST panel
clock
Map_Descriptors
Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Function ,Node_Name ,EST_Report_Type ,Length
MD_SLV_TIME
,DA_TIME
,0
,Passive
,EST_1
,Date Time
,6
FS-8700-39 EST3 Driver Manual
Page 16 of 21
Appendix B. Troubleshooting Tips
Appendix B.1.
Multiple Com Errors
To solve multiple com errors, try adding an IC_Timeout parameter to the Client Side connections and
set it to 0.5s.
FS-8700-39 EST3 Driver Manual
Page 17 of 21
Appendix C. EST3 Data Format:
Appendix C.1.
Input data format
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
0
Alarm Trouble Supervisory Monitor Others
Smoke
Pull
Heat
Waterflow
Stageone
Zone
AlarmVerify
PreAlarm
Security
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
Y
Y
Y
Y
Y
Y
1
2
3
4
5
6
7
8
Station
9
Emergency
Supervisory
Valve
GateValve
Tamper
Temperature
Power
Signal
TroubleOpen
TroubleShort
LocalTrouble
MaintAlert
DirtyHead
DeviceComm
GroundFault
InternalTrouble
BadType
BadPersonality
UnexpectedDevice
CommonTrouble
RelayConfirmation
Monitor
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
LocalMonitor
Damper
Fan
Door
Switch
FirePhone
FS-8700-39 EST3 Driver Manual
Type
Page 18 of 21
Encode
Value
38
Alarm Trouble Supervisory Monitor Others
TestEvent
Y
DeviceCompatabilityFault
LogicAnd
LogicMatrix
ServiceGroup
TimeControl
39
40
41
42
43
44
45
46
47
48
49
50
64
65
66
67
68
69
70
71
72
73
74
75
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
Y
Y
Y
Y
Y
Y
Y
Y
Y
GuardPatrol
CheckInGroup
Internal use only
Disabled
Internal use only
Instruction Text
Object Running
Audible
Visual
SupervisedOutput
NonSupervisedOutput
CommonAlarmPutput
CommonTroubleOutput
CommonSupervisoryOutPut
CommonMonitorOutput
LEDOutput
AnalogOutput
AudioMessage
Amplifier
Card
SecurityAlarm
SecurityTrouble
SecurityTamper
SecurityMaintenance
SecurityCommunicationFault
SecurityDisarmed
SecurityExitTimer
SecurityEntryTimer
SecurityBypassed
SecurityStay
SecurityAway
SecurityStayFail
SecurityAwayFail
SecurityClosingTrouble
SecurityNoClose
SecurityPartitionUpdate
Complete
Spare
AccessACFail
AccessLowBattery
AccessStrikeFault
144
145
146
147
Y
Y
Y
Y
FS-8700-39 EST3 Driver Manual
Type
Page 19 of 21
Encode
Value
148
149
150
151
Alarm Trouble Supervisory Monitor Others
AccessReaderFault
AccessInternalFault
AccessCommunicationFault
CmdList
Y
Y
Y
Y
Appendix C.2.
Output data format
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.
Command
Encode Value
Activate / Away
Enable
Restore / Disarm
Disable
01h
02h
11h
12h
The attribute byte must be set for writes to Relay and LED outputs. For Relays, the attribute values
are:
Attribute (Relay)
Encode Value
Enable
Activate
Restore
Disable
2h
101h
11h
12h
For LED’s, the attribute values are:
Attribute (LED)
Encode Value
On
101h
201h
301h
12h
2h
Slow Flash
Fast Flash
Disable
Enable
Off
1h
FS-8700-39 EST3 Driver Manual
Page 20 of 21
Appendix D. EST3 ECP Connection Statistics:
The EST3 ECP protocol has two distinct levels:
•
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
DLL Rx Char
DLL Rx Msg
DLL Tx Char
DLL Tx Msg
DLL Timeouts
DLL IC Timeouts
DLL Streaming
DLL Bad Replies
DLL Link Control
Gateway Type
Data Rx Char
Data Rx Msg
Data Tx Char
Data Tx Msg
Description
Data Link Layer Bytes Received
Data Link Layer Messages Received
Data Link Layer Bytes Transmitted
Data Link Layer Messages Transmitted
Data Link Layer Timeouts
Data Link Layer Inter-Character Timeouts
Data Link Layer Streaming Errors
Data Link Layer Bad Replies
Data Link Layer Link Control Events
ECP Gateway Type I/II/III
Data Bytes Received
Data Messages Received
Data Bytes Transmitted
Data Messages Transmitted
Conn Rx Char
Conn Rx Msg
Conn Tx Char
Conn Tx Msg
Delta Rx Char
Delta Rx Msg
Total Bytes Received on Connection
Total Messages Received on Connection
Total Bytes Transmitted on Connection
Total Messages Transmitted on Connection
Delta Message Bytes Received
Delta Messages Received
FS-8700-39 EST3 Driver Manual
Page 21 of 21
Appendix E. Driver Error Messages
Error Message
Description and Action Required
This message will be displayed once if any Map Descriptor in a configuration
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.
EST3:#01 FYI. For an
Old EST3 Panel, Read
MD length must be even.
EST3:#02 Err. Read MD
length must > 0 and <=
%d
Numbers of addresses to be read per request are limited.
Edit configuration file to set Map Descriptor length within specified range.6
EST3:#03 Err. Write MD
must have length = 1
EST3: #04 Unknown
Escape Sequence 1B
%02X considered as
%02X
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.
|