FS-8700-41 Simplex 4100 Driver Manual
FS-8700-41 Simplex 4100 Driver Manual
FS-8700-41 Simplex 4100 Driver Manual
Driver Manual
(Supplement to the FieldServer Instruction Manual)
TABLE OF CONTENTS
5 Configuring the FieldServer as a Simplex Time Recorder Company - 4100 Computer Port Protocol Client.... 10
5.1 Client Side Connection Parameters .................................................................................................................. 10
5.2 Client Side Node Parameters ............................................................................................................................ 11
5.3 Client Side Map Descriptor Parameters ........................................................................................................... 12
5.3.1 FieldServer Specific Map Descriptor Parameters .................................................................................... 12
5.3.2 Driver Specific Map Descriptor Parameters............................................................................................. 12
5.3.3 Card-Point-Sub Addressing Map Descriptor Parameters........................................................................ 12
5.3.4 Timing Parameters .................................................................................................................................... 13
5.3.5 Map Descriptor Example 1. - Read Panel Time ....................................................................................... 14
5.3.6 Map Descriptor Example 2 - Write Panel Time........................................................................................ 14
5.3.7 Map Descriptor Example 3 - Panel Revision Information ....................................................................... 14
6 Configuring the FieldServer as a Simplex Time Recorder Company - 4100 Computer Port Protocol Server ... 15
Appendix A. Useful Features ........................................................................................................................... 16
Appendix A.1. How to use Data Arrays to map to/from Card-Point-Sub addresses ................................................. 16
Appendix A.1.1. Simplex Point Status Data Format ............................................................................................. 17
Appendix A.2. SHOW Function Attributes and Attribute States ................................................................................. 17
Appendix A.2.1. Table of Attributes recognised by the Driver............................................................................. 18
Appendix A.2.2. Attribute States recognised for Attribute Method 1 ................................................................. 19
Appendix A.3. Extending the List of Show Attributes .................................................................................................. 20
Appendix A.3.1. ShowResponse Attributes Driver Table...................................................................................... 20
Appendix A.3.2. Show Response Attribute States Driver Table ........................................................................... 20
Appendix A.4. Map Descriptor Examples ..................................................................................................................... 21
Appendix A.4.1. ClearAll ........................................................................................................................................ 21
Appendix A.4.2. Read Point Status ........................................................................................................................ 21
Appendix A.4.3. Using unsolicited messages from the Panel to determine point status .................................. 22
Appendix A.4.4. Acknowledge All Points .............................................................................................................. 23
Appendix A.4.5. Acknowledge a specific point ..................................................................................................... 23
Appendix A.4.6. Silence / Reset ............................................................................................................................. 24
Appendix A.4.7. Earths........................................................................................................................................... 24
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex Driver Manual Table of Contents
Appendix B. Troubleshooting.......................................................................................................................... 30
Appendix B.1. Address Errors ........................................................................................................................................ 30
Appendix B.2. Driver Limitations .................................................................................................................................. 30
Appendix B.3. Resolving Network Addresses above 255 ............................................................................................ 30
Appendix B.4. Simulation of the Xpoint command...................................................................................................... 31
Appendix B.5. Simplex Port Vectoring .......................................................................................................................... 31
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 4 of 48
The Simplex Time Recorder Company - 4100 Computer Port Protocol driver allows the FieldServer to transfer data
to and from devices over either RS-232 or RS-485 using Simplex Time Recorder Company - 4100 Computer Port
Protocol.
This driver is designed to connect to a Simplex 4100 panel equipped to support the “4100 Computer Port Protocol”
as defined in Simplex’s document 950-004 Revision E dated 28 July 2000. The implementation provides a selected
subset of protocol functions and subset of functionality for each of these selected functions. It is important to
note the exclusions and limitations described in this document.
The driver is capable of parsing and storing information sent by a panel in the form of unsolicited messages which
are typically generated when there is a state change in the panel or one of the connected devices. The driver is
also capable of polling for point and panel status data and some additional data such as the panel’s time and
revision information. In addition the driver is capable of setting some control points in the panel – acknowledging
and resetting alarms and writing data (where permitted) to some analog and discrete points.
This is a client only driver and is not capable of emulating a Simplex Panel. Server emulation is provided for test
purposes only and is not supported or documented.
The driver has been tested against 4020, 4100 and 4100U panels. There is no difference in the protocol format
between the various panels. The supported function set differs between panel firmware versions.
This driver was primarily tested against a 4020 panel with firmware revision 9.2. Beta testing against a 4100 panel
with a firmware revision 10.x was also performed.
Please refer to the CPP Revision Compatibility Table (avalable from Simplex) to determine the functions supported
by different panel firmware revisions.
The functions described in this manual are supported for firmware revisions 10 or later. For revisions between 9.2
and 10, the ‘Earths’ and ‘Value’ functions described in this driver are not supported by the Simplex Panels.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 5 of 48
To enable the 4100 Protocol, the 4100 system supplied by the user, must have a free RS-232 port dedicated for use
with the computer device. In most cases, this is not included in the base configuration of the product provided by
Simplex Time Recorder Company, and must be added as a sales option. All 4100 systems limit the number of
computer ports active at one time in a system. To determine the limit for the specific product configuration, refer
to the product specifications, or contact a Simplex sales representative.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 6 of 48
3 HARDWARE CONNECTIONS
The FieldServer is connected to the Simplex Device’s RS-232 port of device type "COMPUTER", the following port
attributes may be configured specifically for that particular port:
Ensure that these settings correspond to the settings described in section 4 of this document.
1
Odd or Even parity is recommended (by Simplex) to provide additional error detection at the character level.
2
The driver does not support the Simplex RTS/CTS handshaking model. Therefore deselect the HSHAKE terminal flag or connect CTS to RTS
with a jumper on the 4100 side
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 7 of 48
Card 4020/RS-232/2120
modem ready assembly.
Terminal Block
Port A =1-5, Port B=6-10.
FS-8917-16
8 1
FieldServer
P1
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 8 of 48
Sim4100U Panel
RS-232 Card
Port B
8917-07
FS-8717-07
FieldServer Part #
8915-10
UTP cable
8 1
FieldServer
P1
Pin 7 - Green
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 9 of 48
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.
Section Title
Data_Arrays
Column Title Function Legal Values
Data_Array_Name Provide name for Data Array Up to 15 alphanumeric characters
FLOAT, BIT, UInt16, SInt16,
Provide data format. Each Data Array can only take
Data_Array_Format Packed_Bit, Byte, Packed_Byte,
on one format.
Swapped_Byte
Number of Data Objects. Must be larger than the
Data_Array_Length data storage area required by the Map Descriptors 1-10, 000
for the data being placed in this array.
Example
// Data Arrays
Data_Arrays
Data_Array_Name , Data_Array_Format , Data_Array_Length
DA_AI_01 , UInt16, , 200
DA_AO_01 , UInt16 , 200
DA_DI_01 , Bit , 200
DA_DO_01 , Bit , 200
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 10 of 48
For a detailed discussion on FieldServer configuration, please refer to the relevant instruction manual. The
information that follows describes how to expand upon the factory defaults provided in the configuration files
included with the FieldServer (See “.csv” files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate
with a Simplex Time Recorder Company - 4100 Computer Port Protocol Server.
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable
the FieldServer for Simplex Time Recorder Company - 4100 Computer Port Protocol 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
Connections
Column
Function Legal Values
Title
Specify which port the device is connected to 3
Port P1-P8, R1-R2
the FieldServer
110 – 115200, standard baud rates only.
Baud* Specify baud rate
(Vendor limitation)
Parity* Specify parity Even, Odd, None, Mark, Space
Data_Bits* Specify data bits 7, 8
Stop_Bits* Specify stop bits 1
Protocol Specify protocol used sim4100
Poll Delay* Time between internal polls 0-32000 seconds, 1 second
Example
Connections
Port , Protocol , Baud , Parity , Poll_Delay
P8 , Sim4100 , 9600 , Even , 0.100s
3
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available
on specific hardware.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 11 of 48
Section Title
Nodes
Column Title Function Legal Values
Node_Name Provide name for Node Up to 32 alphanumeric characters
This parameter is IGNORED. Keywords used to define the
Node_ID n/a
card-sub-point (c-p-s) are described in Appendix A.1
Protocol Specify protocol used Sim4100
Specify which port the device is
Port P1-P8, R1-R2
connected to the FieldServer
4020/4100 - panels with firmware
version 9x or earlier.
PLC_Type* 4100, 4020, 4100U
4100U – panels with firmware
version 10x or later.
Example
Nodes
Node_Name , PLC_Type , Protocol , Connection
Device1 , 4100U , Sim4100 , P1
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 12 of 48
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 13 of 48
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 14 of 48
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
The driver contains some server side functionality which has been developed to meet FieldServer’s continuous quality
assurance efforts. However, the server side functions are not documented or supported for customer use. If you have a
strong requirement for this functionality then please contact the Sales and Marketing group of FieldServer.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 16 of 48
Appendix A.1. How to use Data Arrays to map to/from Card-Point-Sub addresses
Some commands derive a c-p-s address by inspecting a FieldServer Data Array. Others receive data from a device and modify
the data in an array based on the c-p-s address. This section explains how to make the connection between an index into a
Data Array and a c-p-s address.
To minimise the required Data Array size the FieldServer uses a mapping algorithm which can be optimized based on the
addresses of the Simplex devices. The map is manipulated by using the sim4100_card/point/sub parameter values.
If there are one sub-point (s) per point (p) then only one array location is required for each p.
If there are two sub-point (s) per point (p) then two array locations are required for each p.
If there are x sub-point (s) per point (p) then x array locations are required for each p.
This is more clearly explained in the table below:
Thus the offset into the Data Array is determined according to the following formula.
Data Array Offset = Offset specified on the Map Descriptor (Data_Array_Offset ) + Calculated Offset
If data is received for point <c>-<p>-<s> = 9-0-0, this data will NOT be processed because the card number does not match
the value of the sim4100-card
If data is received for point <c>-<p>-<s> = 10-20-0, however, the data will be processed.
The array location is derived using the following formula (sim4100_sub is to be read as the “number of sub-points per point”;
sim4100_card’s value will be ignored.)
= 0 + 20 * 10 + 0 = 200
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 17 of 48
The Show command provides an ASCII response formatted for printing. The driver parses these messages and converts the
data to numbers which can be sent to Client devices using another protocol.
On a line by line basis from the left, it searches for an attribute against a table of attribute strings. If an attribute string is
found, processing continues. Otherwise the line is discarded.
The attribute number is used to determine the array location where the attribute state/value will be stored.
Method 1: The driver compares the remainder of the line against a table of attribute states. The value of the
attribute state is stored in the array location determined by the attribute,
Method 2: The driver looks for (up to three) analog values separated by forward slashes.
Method 3: The driver looks for analog values preceded by an equal sign.
The driver stores in the first array location the number of response lines which resulted in attribute data being stored.
This information can be used for troubleshooting.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 18 of 48
Array Array
Attribute Method Attribute Method
Position Position
Not Defined 0 1 ALARM TEMPERATURE SELECTED= 27 2
PRIMARY STATUS 1 1 DETECTOR RELAY 30 1
PHYSICAL STATE 2 1 TOTAL NUMBER OF TROUBLES 31 2
RAW STATE 3 1 NODE MISSING 32 1
ACTIVE STATE 4 1 VERSION CONTROL 33 1
ARMED STATE 5 1 NODE INITIALIZATION IN PROGRESS 34 1
ENABLED STATE 6 1 SIMPLEX SERVICE MODE 35 1
UNVERIFIED 7 2 EARTH GROUND 36 1
CURRENT DEVICE 8 1 AC POWER 37 1
DEVICE 9 1 BATTERY LOW/DISCHARGED 38 1
TEST STATE 10 1 BATTERY CHARGE 39 1
PRESENT SENSITIVITY SELECTED= 11 2 SYSTEM PSEUDO STATUS 40 1
PRESENT SENSITIVITY SELECTED = 11 2 NETWORK CARD STATUS 41 1
AVERAGE VALUE = 14 3 CARD TROUBLE STATUS 42 1
AVERAGE VALUE= 14 3 MISCELLANEOUS STATUS 43 1
AVERAGE = 14 2 RELAY STATUS 44 1
AVERAGE= 14 2 PRIORITY 45 2
AVERAGE 14 2 CONTROL STATUS 46 1
VALUE = 17 2 CURRENT (AMPS) 47 2
VALUE= 17 2 CARD MISSING/FAILED 48 1
PEAK= 20 2 CORRECT CARD 49 1
PEAK = 20 2 RS-232 Interface PORT A 40 1
TROUBLE THRESHOLD 23 1 RS-232 Interface PORT B 41 1
OUTPUT STATE 24 1 2120/RS-232 PORT Broadcast Fail 42 1
OUTPUT STATUS 25 1 CARD MISSING/FAILED 43 1
DETECTOR SOUNDER 26 1
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 19 of 48
Examples:
The Driver recognizes ‘Physical State’ as attribute 2 and uses method 1 to evaluate the rest of the line. The attribute state
SHORT has a value of 8. The number 8 is stored at location 2 in the Data Array.
The Driver recognizes ‘VALUE=’ as attribute 17 and uses method 2 to evaluate the rest of the line. The Dri ver stores the
values; 77, 0 and 1.0 in three consecutive locations starting at location 17. Note that there is a gap between attribute 17 and
the next attribute in the table sufficient for storing up to 3 values. The three values are seperated by slashes .
The Driver recognizes ‘AVERAGE VALUE’ as attribute 14 and uses method 3 to evaluate the rest of the line. The Driver stores
the values; 75 and 145 in two consecutive locations starting at location 14. An equal sign ‘=’ precedes each numeric value.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 20 of 48
The list of attributes and attribute states that the driver recognizes can be extended by modifying the configuration CSV fil e.
The following example adds three attributes and 4 attribute states. If a device reports an attribute of ‘LIGHT STATE’ as
‘BRIGHT’ then the driver will load array element 32 with the value 41.
Attribute Definitions. The Use a digit. The three
name will be stripped of Ensure that unique methods are
Keyword starts a
all spaces between the offsets are described above.
new section of the
last character and the allocated. Protocol must
CSV file.
comma. be defined on
Driver_Table every line.
sim4100_Attr_Name , sim4100_Attr_Offset , sim4100_Attr_Method , Protocol
BROKEN , 30 ,1 , sim4100
FIXED , 31 ,1 , sim4100
LIGHT STATE , 32 ,1 , sim4100
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 21 of 48
If an Xpoint message is received from the Panel for the specified c-p-s with the ClearAll function (or clist is used to poll for the state of the c-p-s) and the state
is U1, this triggers this ClearAll action. The driver sets all array points covered by all Map Descriptor’s with the clearall function to zero, without consideration
of the c-p-s associated with the Map Descriptor.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , sim4100_func , sim4100_card , sim4100_point , sim4100_Sub , Length
Clear_Mapdesc1 , DA_AI ,0 , Passive , Node_A , ClearAll ,1 ,2 ,3 , 100
Clear_Mapdesc1 , DA_2 , 50 , Passive , Node_A , ClearAll ,1 ,2 ,3 , 50
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Length , Scan_Interval , sim4100_func , sim4100_card , sim4100_point , sim4100_sub
A1 , DA_AI3 ,0 , Rdbc , Node_A ,1 ,5 , Clist ,1 ,2 ,3
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
Appendix A.4.3. Using unsolicit ed messages f rom the Pa nel to det ermi ne point stat us
This Map Descriptor can be used to store point status data when the FieldServer receives an unsolicited message from the Panel containing point status
information (Xpoint messages). The panel sends an Xpoint message each time a point’s status changes to a non-normal state. Using these Map Descriptors
will ensure that the FieldServer is constantly updated with the latest panel status information. The Map Descriptor’s are pa ssive so they can be used in a joint
strategy with the clist function (Appendix A.3.1) to keep track of a point’s status.
One Xpoint Map Descriptor is required for storage of Xpoint messages from each card. For a given card, the driver uses a mapping function based on the point-
subpoint address to determine the array location to store the state for the c-p-s.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , sim4100_func , sim4100_card , sim4100_point , sim4100_sub , Length
A1 , DA_AI3 ,0 , Passive , Node_A , xpoint ,1 ,0 , 10 , 1000
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
The 1st element of the Data Array is used to trigger the ack all
2nd – ack A Primary Abnormal State The function is Wrbx, the message is only sent when
the value is updated.
3rd – ack F Fire alarm
4th – ack P Priority 2
5th – ack S Supervisory
6th – ack T Trouble
Set the array element to 1 to initiate the command. The FieldServer clears the value on completion
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Length , Scan_Interval , sim4100_Func , Sim4100_Card , Sim4100_Point , Sim4100_Sub
Ack_mapdesc1 , DA_ACK ,0 , Wrbx , Node_A ,1 , 1.0s , Ack ,1 ,2 ,3
Ack_Mapdesc2 , DA_ACK ,1 , Wrbx , Node_A ,1 , 1.0s , Ack ,1 ,2 ,4
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
If location 0 goes non-zero then a silence message is sent. If location The function is Wrbx, the message is only sent when
1 goes non-zero then a reset message is set. the value is updated.
Driver’s set the trigger back to zero once the message has been set.
Note: When configured as a Server, the driver increments the value in the associated DA element each time a silence/reset is received.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , sim4100_func , sim4100_card , sim4100_point , sim4100_Sub , Length
Clear_Mapdesc1 , DA_I ,0 , passive , Node_A , Ack ,1 ,2 ,3 , 100
Clear_Mapdesc1 , DA_2 ,0 , passive , Node_A , Ack ,1 ,2 ,3 , 100
If, for example, card 3 reports information then the driver uses array elements 6 & 7 to store information for this card. Obtain the array location by multiplying the
card number by two.
If the card reports positive and negative earth data then the driver stores the positive earth data at location 6 and the negative earth data at location 7.
If the card reports earth / ground state information without the keywords ‘Positive’ or ‘Negative’ the driver stores the data at location 6.
The driver stores a value of 1 to report normal and a value of 2 to report abnormal.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Length , Scan_Interval , sim4100_Func , Sim4100_Card
Earth_mapdesc1 , DA_EARTHS ,0 , Rdbc , Node_A , 20 , 1.0s , Earths ,1
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
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Length , Scan_Interval , sim4100_Func , Sim4100_Card , Sim4100_Point , Sim4100_Sub
Show_mapdesc1 , DA_SHOW ,0 , Rdbc , Node_A , 100 , 1.0s , Show ,1 ,2 ,3
By way of example assume that point 1-2-3 is a Heat Detector and the response to the show query is as follows
The driver will load the array DA_SHOW starting at offset zero for up to 100 elements. The following table can be used to determine the values to expect for this
response.
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
Array Filled
Attribute Value Note
Posn In4
The value 10 represents the count of the number of attributes that were extracted from the response. It is not equal to the number of array
0 Not Defined 10 1
locations filled in because some attributes (e.g. Value) result in more than one array location being updated.
1 PRIMARY STATUS 14 (Normal) 1 #
The un-filled-in locations are not updated by the driver when this response is analysed because the attributes corresponding to these
2 PHYSICAL STATE
locations were not reported in the response to the query.
3 RAW STATE
4 ACTIVE STATE
5 ARMED STATE
6 ENABLED STATE 11 (Enabled) 1
7 UNVERIFIED 0 1
4 (Correct
8 CURRENT DEVICE 1
Device)
9 DEVICE 12 (On_Line) 1
3 (Self test
10 TEST STATE 1
normal)
PRESENT SENSITIVITY
11
SELECTED
14 AVERAGE
17 VALUE 0 1
18 -41 1
19 Room for up two three numbers for attributes like value, peak but in this case only two values are relevant for this device
20 PEAK 0 1
21 -41 1
22 Room for up two three numbers for attributes like value, peak but in this case only two values are relevant for this device
6 (Range
23 TROUBLE THRESHOLD 1
Normal)
24 OUTPUT STATE
25 OUTPUT STATUS
26 DETECTOR SOUNDER
ALARM TEMPERATURE
27 135 1
SELECTED=
30 DETECTOR RELAY
4
Locations marked with a 1 are updated when the driver analyses this response
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
Use the Sim4100_func = 'value' to read the values from the analog pseudo points. Refer to Appendix C.4.2 for a list of the analog pseudo points.
// Map Descriptor
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Sim4100_Func , Sim4100_Card , Sim4100_Point , Sim4100_Sub , Protocol , Length
# Fire Alarms , DA_C_144 ,0 , Rdbc , Simplex_01 , value , 144 ,0 ,0 , sim4100 ,1
# Supervisory Alarms , DA_C_144 ,1 , Rdbc , Simplex_01 , value , 144 ,1 ,0 , sim4100 ,1
# Troubles , DA_C_144 ,2 , Rdbc , Simplex_01 , value , 144 ,2 ,0 , sim4100 ,1
Excessively Dirty Sensors , DA_C_144 ,3 , Rdbc , Simplex_01 , value , 144 , 115 ,0 , sim4100 ,1
Dirty Sensors , DA_C_144 ,4 , Rdbc , Simplex_01 , value , 144 , 116 ,0 , sim4100 ,1
Almost Dirty Sensors , DA_C_144 ,5 , Rdbc , Simplex_01 , value , 144 , 117 ,0 , sim4100 ,1
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
If two or more Simplex panels are networked together, the FieldServer can poll the information from both. The
Simplex panels will need network cards installed and programmed by Simplex to pass the points to the panel
connected to the FieldServer. The points from the networked panel(s) will be in the same Card-Point-Subpoint
format (c-p-s) as the main panel. An algorithm is used to ensure that Point Sub point numbers stay the same and
only the network card number changes. A network card with point address of 61, sub point 98, card address 5 will
show up on the panel as as 5-61-98. Network points are numbered as follows: C-1-0 is network point 1, C-1-1 is
point 2, C-1-2 is point 3 and so on up to C-1-255 which is point 256. The sequence then starts again (C-2-0 through
C-2-255 points 257 to 512). Refer also to Appendix B.3.
This way the FieldServer states will always be updated. Polling is slow and in a system with many points it may
take several minutes to update status information for all points. Thus combining this method with the use of
Xpoint Map Descriptors gives the best of both worlds. When a point changes to ‘not’ normal, then the FieldServer
gets the state change from the Xpoint function immediately and at the same time synchronization is assured by
the continuous polling.
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
Downloaded from www.Manualslib.com manuals search engine
FS-8700-41 Simplex 4100 Driver Manual Page 29 of 48
Appendix A.6.2. Using Clist to Write- Throug h and Store point stat us from Unsolicited Messages
This function is only available for panel version 1.05 and above.
A Write-Through occurs when a Data Array value that is normally updated by a read (Rdbc) Map Descriptor is updated by some other driv er or by using the
Ruinet application. The updated value is written through the Rdbc Map Descriptor to the panel. The value is written once only each time that the Data Array
element is updated except when the value is updated by the response to the read or if the point status is updated when an unsolicited message is received
from the panel.
Ensure that the point is not a read only point and the Panel’s access level has been set appropriately.
When an unsolicited message is received from the panel it would normally be stored using a Map Descriptor with the ‘Xpoint’ f unction. (See section Appendix
A.4.3) However, if polling for the status of that point using a ‘Clist’ Map Descriptor with ‘Store_Unsolicited’ set to yes then omit the ‘Xpoint’ Map Descriptor as
the ‘Clist’ Map Descriptor can be used to store the point status when it is updated with an unsolicited message. If both Map Descriptor’s are defined then the
result will be unpredictable.
Even if writing to an analog pseudo point, format 1 is suitable because enabling the point forces it to take its intrinsic va lue. On setting the point off it’s value is
set to zero.
Legal
Column Title Function
Values
Only appropriate when the sim4100_func=clist. Onoff,
sim4100_WriteThru*
Controls the write through behavior of the clist function. value
Control the ability of ‘CLIST’ map descriptors to be used to store data from unsolicited messages. Refer also to
Store_Unsolicited* Yes, No
Appendix A.6.2
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
Appendix B. Troubleshooting
Refer to Appendix A.4.1. and create a Map Descriptor which will save the most recent error in the Data Array
DA_ERRORS.
Alternatively, take a log, open the ASCII version of the log and look for error messages. Error 2 is the response
sent by the panel when it is polled for a point that doesn’t exist. Find the Error #2's n the log. The line which
precedes the error identifies the point being polled. Now you know the c-p-s of the invalid point, edit the
configuration and remove the MD which polls for data at that point.
Other than being able to write through a Map Descriptor where the sim4100_func=’clist’ , write throughs are
not supported by this driver.
The Standard format for addressing a simplex point is c-p-s (Card-Point-Subpoint). Each of these components in
the address supports a maximum value of 255. However, when using an NDU (Network Display Unit), addresses
may be supplied in a Card-Address format where the address value is larger than 255. In these applications it is
necessary to convert the Card-Address format into c-p-s format before configuring the points in the FieldServer.
Example:
Card–Address point supplied = 5-2936 - From this we deduce the card number to be 5.
Break out the last two hex numbers for sub-point portion, and use the rest for point address:
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
The sim4100_func=xpoint keyword is used to parse unsolicited point status change messages sent by Simplex
devices. For simulation purposes, a Wrbc version of this function has been implemented to test the response
parsing ability of the slave portion of the driver.
The 4100 panels do not automatically send event messages ( xpoint messages) to the serial port card. An explicit
procedure called 'Port Vectoring' maps the events to the port.
If a card is moved from one hardware location to another, it maybe necessary to revector the port.
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
Appendix C. Reference
The Simplex Time Recorder Company - 4100 Computer Port Protocol only uses the standard 4100 address format
of <Card>-<Point>-<Sub-point>. Symbolic addressing is not supported. The following table lists keywords which
control the behavior of the FieldServer with respect to connection to a Simplex device and the permissible values
determining the type of data being read/written.
5
This driver function used the Simplex ‘CSHOW c-p-s CVAL’ command. It is only supported by panels with firmware revision numbers greater
than 10
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
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
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
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
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
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
Appendix C.3.1. How the Dri ver counts bytes and messag es received a nd transmitt ed.
"Ack" messages sent/received by the driver in response to read/write messages are NOT counted as messages.
However, the single byte produced by these messages is included in the byte count.
The driver counts bytes at the DLL layer. The byte count includes the bytes that wrap application layer messages,
acks and the port supervision and responses messages.
The driver counts messages at the application layer.. This means that if you use RUINET to monitor the FieldServer
and you view the Map Descriptor’s the byte count stats will always be zero.
Some Map Descriptors require data in the Data Arrays to trigger a write command. An example is the "Ack"
command. The driver does not count one of these messages as being sent until the array actually triggers a poll to
be sent.
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
Take care not to poke any values into the 1st 10 elements of this Data Array (offsets 0 to 9). Doing so will trigger
internal diagnostics and may interfere with normal operation.
A different set of stats is maintained for each connection. Each connection uses 100 elements of the data array.
Ensure the array length is large enough if the port number is large.
Data_Arrays
Data_Array_Name , Data_Format , Data_Array_Length
sim4100-stats , UINT16 , 1000
At revision 1.07a of the driver and earlier, no stats had been exposed.
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
Qualifier:
Enum=0 Qual=F Fire alarm state
Enum=1 Qual=P Priority 2 alarm state
Enum=2 Qual=T Trouble state
Enum=3 Qual=S Supervisory state
Enum=4 Qual=U Utility monitor, digital/analog pseudo state
Enum=5 Qual=C Control state (non pseudo)
Enum=6 Qual=D Disable Trouble state
It is beyond the scope of the driver manual to describe the full functionality of the Simplex Panels. The following
information is not maintained and updated and therefore should be used for reference only.
Pseudo points are points that report states or attributes based on how the Simplex system has been installed,
configured and programmed. They are often programmed to groups, devices, zones or other logic groupings, e.g.
a pseudo point may be programmed to report only if more than one sensor in a particular area is reporting smoke.
Every Simplex system has a number of default pseudo points programmed into the firmware supplied with the
panel. These default points depend only on the firmware revision number and are generally unaffected by the
configuration programmed for a particular site.
Although the 4100 card number can range from 0-250 in theory, only the following ranges are presently used in
the system:
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
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
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
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
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
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
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
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
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