FieldServer FS-8700-39 User Manual

Driver Version:
1.13
Document Revision:
5
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after January 2012
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-39 EST3-ECP
FS-8700-39 EST3 Driver Manual Table of Contents
TABLE OF CONTENTS
1 EST3 Description ............................................................................................................................................ 3
2 Driver Scope of Supply ................................................................................................................................... 4
2.1 Supplied By FieldServer Technologies for this Driver .......................................................................................... 4
2.2 Provided By the Supplier of 3rd Party Equipment ................................................................................................ 4
2.2.1 Hardware ...................................................................................................................................................... 4
2.2.2 Required 3rd Party Configuration .................................................................................................................. 4
3 Hardware Connections ................................................................................................................................... 5
3.1 Pinouts ................................................................................................................................................................. 5
3.2 Connection Notes ................................................................................................................................................ 5
4 Data Array Parameters ................................................................................................................................... 6
5 Configuring the FieldServer as a EST3 Client ................................................................................................... 7
5.1 Client Side Connection Parameters ..................................................................................................................... 7
5.2 Client Side Node Parameters ............................................................................................................................... 8
5.3 Client Side Map Descriptor Parameters .............................................................................................................. 8
5.3.1 FieldServer Related Map Descriptor Parameters .......................................................................................... 8
5.3.2 Driver Related Map Descriptor Parameters .................................................................................................. 9
5.3.3 Map Descriptor Example 1 .......................................................................................................................... 12
5.3.4 Map Descriptor Example 2:......................................................................................................................... 12
5.3.5 Map Descriptor Example 3:......................................................................................................................... 12
Appendix A Useful Features ................................................................................................................................. 13
Appendix A.1. PanelMasks ...................................................................................................................................... 13
Appendix A.2. Setting up Multiple Parameters ....................................................................................................... 13
Appendix A.3. Priority: ............................................................................................................................................. 13
Appendix A.4. Report and Delta Service: ................................................................................................................. 13
Appendix A.4.1. Report Service (regular polling): ................................................................................................ 13
Appendix A.4.2. Delta Service (unsolicited messages): ........................................................................................ 13
Appendix A.4.3. Example Configuration using Delta Mode only ......................................................................... 14
Appendix A.5. Optional Data Arrays ........................................................................................................................ 15
Appendix A.5.1. Relay Confirmation State ........................................................................................................... 15
Appendix A.5.2. EST_Types_DA ........................................................................................................................... 15
Appendix A.5.3. EST_Types_Update .................................................................................................................... 15
Appendix A.5.4. DA_Bit_Name ............................................................................................................................ 16
Appendix A.5.5. EST_Report_Type ....................................................................................................................... 17
Appendix A.6. Object Types and Required Parameters ........................................................................................... 18
Appendix A.7. Set Date and Time To Panel ............................................................................................................. 19
Appendix B Troubleshooting ................................................................................................................................ 20
Appendix B.1. Multiple Com Errors ......................................................................................................................... 20
Appendix C Reference .......................................................................................................................................... 21
Appendix C.1. EST3 Data Format: ............................................................................................................................ 21
Appendix C.1.1. Input data format ...................................................................................................................... 21
Appendix C.1.2. Output data format ................................................................................................................... 24
Appendix C.2. EST3 ECP Connection Statistics: ....................................................................................................... 25
Appendix C.3. Driver Error Messages ...................................................................................................................... 26
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-39 EST3 Driver Manual Page 3 of 26
1 EST3 DESCRIPT I O N
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.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-39 EST3 Driver Manual Page 4 of 26
FieldServer Technologies PART #
Description
FS-8915-10
7-ft Cat5 cable with RJ45 connectors at both ends
FS-8917-16
Cable, EIA232:485 Pigtail RJ45 Port
PART #
Description
EST3 Gateway
3-RS232 Card Rev 5.0
Needs to be installed for PAL chip Rev 1.1.
3-RS232 Card Rev 6.0
Needs to be installed for PAL chip Rev 1.2.
ECP Type II
Supported
ECP Type II with Text
Not Supported
ECP Type III
Supported
ECP Type III with Text
Not Supported
2 DRIVER SCOPE OF SUP P LY
2.1 Sup pli e d By FieldServer T e c h n o l o g i e s f o r this Driver
2.2 Provided By the Supplier of 3
rd
Party Equipment
2.2.1 Hardware
2.2.2 Required 3
The EST3 panel has to be set into the “Gateway Mode” using the EST3 Configuration tool (3-SDU)
Possible Protocols
rd
Party Configuration
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-39 EST3 Driver Manual Page 5 of 26
RJ-45 Pin
From RJ-45
Color
To EST3 ECP TB2
1
RX
Brown
TX 2 8 TX
White/Orange
RX 2
4
COM
Blue/white
COM 2
3 HARDWARE CONNE CTIONS
3.1 Pinouts
3.2 Connection Notes
There is normally only one interface to an EST3 system, even if multiple panels exist. All data for the
entire system is received through this single interface.
The interface on the EST3 panel may be COM1 or COM2, but it needs to be configured in the EST3 panel
as a gateway. Gateway Type III is recommended.
The EST3 panel monitors the quality of communications to the FieldServer and will detect a poor
connection. Poor connections are normally caused by inappropriate selection of gateway type, but can also be related to installation quality.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-39 EST3 Driver Manual Page 6 of 26
Section Title
Data_Arrays
Column Title
Function
Legal Values
Data_Array_Name
Provide name for Data Array
Up to 15 alphanumeric characters
Data_Array_Format
Provide data format. Each Data Array can only take on one format.
Uint16
Data_Array_Length
Number of Data Objects. Must be larger than the data storage area required by the Map Descriptors for the data being placed in this array.
1-10, 000 // Data Arrays
Data_Arrays
Data_Array_Name
, Data_Array_Format
, Data_Array_Length
DA_AI_01
, Float
, 200
DA_AO_01
, Float
, 200
DA_DI_01
, Bit
, 200
DA_DO_01
, Bit
, 200
4 DATA ARR AY PA R A M E TER S
Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary
to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data.
Example
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-39 EST3 Driver Manual Page 7 of 26
Section Title
Connections
Column Title
Function
Legal Values
Port
Specify which port the device is connected to the FieldServer
P1-P8, R1-R21
Baud
Specify baud rate
9600, 192002
Parity*
Specify parity
None
Data_Bits*
Specify data bits
8
Protocol
Specify protocol to be used by this port
EST3
// Client Side Connections
Connections
Port
, Baud
, Parity
, Data_Bits
, Protocol
P1
, 19200
, None
, 8
, EST3
1
2
5 CONFIGURI NG T H E F I E LDSERVER AS A EST3 CLI E N T
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.
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
5.1 Clie nt S ide Connection P arameters
Example
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available
on specific hardware.
Edwards Recommends 19200-baud minimum in order to prevent buffer overruns in the EST3 panel
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-39 EST3 Driver Manual Page 8 of 26
Section Title
Nodes
Column Title
Function
Legal Values
Node_Name
Provide name for Node
Up to 32 alphanumeric characters
Node_ID
MAC ID of Panel
1 – 24 (normally 1)
Protocol
Specify protocol used
EST3
Port
Specify which port the device is connected to the FieldServer
P1-P8, R1-R2
3
Timeout
Specify time allowed between poll and response
10 seconds
IC_Timeout
The Ic_Timeout parameter monitors the time between characters in a response. If the time exceeds the Ic_Timeout, the response is discarded and is considered a Timeout.
0-0.5s, 0.05s, recommended 0.5s
EST_MX_Read_Points*
Specify the maximum number of points that can be polled in single request. Legacy panel firmware (prior to spec version
5.20) supports a maximum of 34, but new firmware supports a maximum of 15
1-34 EST_StatusTime_Format*
Specify the format to store status time in EST_StatusTime_DA Data Array
yyyy, mm, dd, hh, mm, ss
// Client Side Nodes
Nodes
Node_Name
, Node_ID
, Protocol
, Port
, Timeout
, IC_Timeout
, EST_Mx_Read_Points
EST_1
, 1
, EST3
, P1
, 10s
, 0.5s
, 15
Column Title
Function
Legal Values
Map_Descriptor_Name
Name of this Map Descriptor
Up to 32 alphanumeric characters
Data_Array_Name
Name of Data Array where data is to be stored in the FieldServer
One of the Data Array names from Section 4.
Data_Array_Offset
Starting location in Data Array
0 to maximum specified in Section
4.
Function
Function of Client Map Descriptor
RDBC, WRBC4, WRBX
3
4
5.2 Clie nt S ide Node Parameters
Example
5.3 Clie nt S ide Map Descriptor P aram eters
5.3.1 FieldServer Related Map D e s c r i pt o r P ar a m eters
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available
on specific hardware.
WRBC is not recommended, as startup values may be invalid
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
Loading...
+ 18 hidden pages