FieldServer FS-8700-41 Driver Manual Download

Page: 1 / 48

Driver Version:

1.08

Document Revision: 5

A Sierra Monitor Company

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after December 2009

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-41 Simplex Time Recorder Company - 4100

Computer Port Protocol

Summary of Contents for FS-8700-41

Page 1: ...A Sierra Monitor Company APPLICABILITY EFFECTIVITY Effective for all systems manufactured after December 2009 Driver Manual Supplement to the FieldServer Instruction Manual FS 8700 41 Simplex Time Recorder Company 4100 Computer Port Protocol ...

Page 2: ... 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 ...

Page 3: ... Write Through and Store point status from Unsolicited Messages 29 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 Appendix C Reference 32 Appendix C 1 Simplex Address Formatting Specific Keywords 32 Appendix C...

Page 4: ...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 Sim...

Page 5: ... cable with 25 pin male connector 4100u Panels SPA59132 RS 485 connection adapter 2 2 Provided by Supplier of 3rd Party Equipment 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 add...

Page 6: ...Bits 1 1 or 2 3 2 Sim4100U Panel Setting Default Options Baud Rate 9600 75 110 134 5 300 600 1200 1800 2000 2400 4800 9600 19200 Parity NONE 1 ODD EVEN MARK SPACE NONE Data Bits 8 7 or 8 Stop Bits 1 1 or 2 The following are the Simplex recommended connections to be used in cabling between the 4100 and the FieldServer device For the computer device the standard EIA signal description and the 25 pin...

Page 7: ...269 Toll Free 888 509 1970 email support fieldserver com 3 3 Connection to a Simplex 4020 4100 Panel 3 3 1 Communication Board 3 3 2 Serial Connection 1 4 8 FS 8917 16 FieldServer P1 1 8 Pinouts FS X40 Function From Simplex Panel Terminal Block Rx RJ45 01 XMIT 6 Tx RJ45 08 RCV 8 GND RT45 04 GND 10 Card 4020 RS 232 2120 modem ready assembly Terminal Block Port A 1 5 Port B 6 10 ...

Page 8: ...eb www fieldserver com Tel 408 262 2299 Fax 408 262 2269 Toll Free 888 509 1970 email support fieldserver com 3 4 Connection to a Simplex 4100U Panel FS 8717 07 Port B RS 232 Card Sim4100U Panel FieldServer P1 1 8 8917 07 FieldServer Part 8915 10 UTP cable Port B Port A Front of 4100U Panel Pin 2 White Pin 3 Blue Pin 7 Green ...

Page 9: ...orrect 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 Data_Array_Format Provide data format Each Data Array can only take on one format FLOAT BIT UInt16 SInt16 Packed_Bit Byte Packed_Byte Swapped_Byte Data_Array_Length Number of Data Objects Must be larger than the data storage a...

Page 10: ...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 par...

Page 11: ... Node_Name Provide name for Node Up to 32 alphanumeric characters Node_ID n a This parameter is IGNORED Keywords used to define the card sub point c p s are described in Appendix A 1 Protocol Specify protocol used Sim4100 Port Specify which port the device is connected to the FieldServer P1 P8 R1 R2 PLC_Type 4020 4100 panels with firmware version 9x or earlier 4100U panels with firmware version 10...

Page 12: ... described in section 0 sim4100_func A keyword which controls the function being performed or the type of data being polled written Further notes on these keywords are provided in Appendix C 1 Ackall Setd Disable Restart Clistall Clist Time Ctime Ack Xpoint Seta Super Show Earths Value ClearAll 5 3 3 Card Point Sub Addressing Map Descriptor Parameters The Simplex Time Recorder Company 4100 Compute...

Page 13: ...logies 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 5 3 4 Timing Parameters Column Title Function Legal Values Scan_Interval Rate at which data is polled 0 1s ...

Page 14: ... does not send a write message to the panel Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name sim4100_func Scan_Interval Length Time_Mapdesc DA_TIME 0 Wrbc Node_A CTime 30s 7 Time_Mapdesc DA_TIME 0 Wrbc Node_A Time 30s 7 5 3 7 Map Descriptor Example 3 Panel Revision Information Define the DA_REV_INFO array as format BYTE and if using RUINET to monitor this Data Array change ...

Page 15: ... CONFIGURING THE FIELDSERVER AS A SIMPLEX TIME RECORDER COMPANY 4100 COMPUTER PORT PROTOCOL SERVER 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 Sal...

Page 16: ...ained in the table below Subpoints point Calculated Offset Sim4100_sub 0 1 2 3 4 5 6 1 s per p implies s 0 every time c 0 0 c 1 0 c 2 0 c 3 0 c 4 0 c 5 0 c 6 0 2 s per p implies s 0 1 for each p c 0 0 c 0 1 c 1 0 c 1 1 c 2 0 c 2 1 c 3 0 5 s per p implies s 0 1 2 3 4 for each p c 0 0 c 0 1 c 0 2 c 0 3 c 0 4 c 0 5 c 1 0 x s per p implies s 0 1 x 1 c 0 0 c 0 1 c 0 2 c 0 3 c 0 4 c 0 5 c 0 6 Thus the o...

Page 17: ...se messages and converts the data to numbers which can be sent to Client devices using another protocol The driver performs the following tasks in analyzing the response 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...

Page 18: ... 7 2 CURRENT DEVICE 8 1 DEVICE 9 1 TEST STATE 10 1 PRESENT SENSITIVITY SELECTED 11 2 PRESENT SENSITIVITY SELECTED 11 2 AVERAGE VALUE 14 3 AVERAGE VALUE 14 3 AVERAGE 14 2 AVERAGE 14 2 AVERAGE 14 2 VALUE 17 2 VALUE 17 2 PEAK 20 2 PEAK 20 2 TROUBLE THRESHOLD 23 1 OUTPUT STATE 24 1 OUTPUT STATUS 25 1 DETECTOR SOUNDER 26 1 Attribute Array Position Method ALARM TEMPERATURE SELECTED 27 2 DETECTOR RELAY 3...

Page 19: ...r 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 VALUE 77 0 OF ALARM 1 0 SMOKE The Driver recognizes VALUE as attribute 17 and uses method 2 to evaluate the rest of the line The Driver stores the values 77 0 and 1 0 in three consecutive locations starting a...

Page 20: ...ate value for storage in the Data Array 1 2 3 May not be zero Appendix A 3 2 Show Response Attribute States Driver Table Column Title Function Legal Values Protocol Specify protocol used Sim4100 sim4100_Attr_State_Name Use this parameter to extend this list of predefined attribute states Define a state word such as Normal and associate a value using the value parameter sim4100_Attr_State_Value Thi...

Page 21: ...Read Point Status This Map Descriptor can be used to poll for the status of a particular point When the response is obtained the driver sets the value of one Data Array element to a number indicating the point s status The values are described in One Map Descriptor is required for every point polled Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name Length Scan_Interval sim41...

Page 22: ...quired 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 The Data extract...

Page 23: ...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 Appendix A 4 5 Acknowledge a specific point One Map Descriptor is required for each c p s combination requiring specific acknowledgements The driver checks the array location corresponding to the Map Descriptor If the value is non zero...

Page 24: ...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 Positi...

Page 25: ... Map Descriptor by setting the length to 100 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 40 Character Custom Label Mx y 2 HEAT DETEC...

Page 26: ...ponse is analysed because the attributes corresponding to these 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 8 CURRENT DEVICE 4 Correct Device 1 9 DEVICE 12 On_Line 1 10 TEST STATE 3 Self test normal 1 11 PRESENT SENSITIVITY SELECTED 14 AVERAGE 17 VALUE 0 1 18 41 1 19 Room for up two three numbers fo...

Page 27: ...pseudo points Analog Psuedo 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 Dirt...

Page 28: ... 0 through C 2 255 points 257 to 512 Refer also to Appendix B 3 Appendix A 6 Synchronizing the FieldServer with the Panel Appendix A 6 1 Using the Xpoint Function When using the Xpoint function to store point states each time the panel does a warm start it sets all point states to normal and then starts evaluating each one Thus the FieldServer will receive Xpoint messages from the panel for every ...

Page 29: ... 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 function 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 ...

Page 30: ...ons Other than being able to write through a Map Descriptor where the sim4100_func clist write throughs are not supported by this driver Port expansion is not supported Appendix B 3 Resolving Network Addresses above 255 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 Ne...

Page 31: ...m4100_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 Appendix B 5 Simplex Port Vectoring The 4100 panels do not automatically send event messages xpoint messages to the serial port card An explici...

Page 32: ...ptor Ack This command allows the user to acknowledge a single point The specified Data Array is inspected and the value of the single element is used to determine which device state s are ack d Refer to Appendix A 4 5 WRBC Specify c p s in the Map Descriptor Clist This command returns the current point status for one point Refer to Appendix A 6 2 RDBC Specify c p s in the Map Descriptor Earths 5 T...

Page 33: ...do point Set the sensitivity of a TrueAlarm sensor Set the rate of rise threshold of a TrueAlarm heat sensor Select the audio channel of a speaker circuit WRBC Specify c p s in the Map Descriptor Xpoint This is an unsolicited message sent automatically by a Simplex device to report a change in point status The card point sub address format is used to calculate an offset into the associated Data Ar...

Page 34: ...in the Map Descriptor Errors Use this keyword to define a Map Descriptor which tells the driver where to store error messages received from the Simplex device The most recent message is stored in the Data Array specified Make sure that the Data Array length is long enough to store enough meaningful information A length of 200 is recommended Passive Do not specify c p s in the Map Descriptor If usi...

Page 35: ...chnologies Sim4100 10 Invalid point status s v a Hex x x x c c c Please report his message to FieldServer Technologies noting the values in braces Sim4100 11 Error Array too short rqd d max d act d MapDesc s Data Abandoned Subsequent msgs suppressed Check the CSV file Data Array lengths Sim4100 12 Error Incoming data is being abandoned Subsequent message supressed Check the CSV file there was no m...

Page 36: ...nt that you mention seeing this message in the Error Buffer when reporting the problem Sim4100 20 FYI Data abandoned Array too short MapDesc s Check the CSV file Data Array lengths Sim4100 21 Error Data abandoned Array too short c p s d d d Check the CSV file Data Array lengths Sim4100 22 FYI Polling Inhibited Polling is disabled until the port supervision message has been received This message ca...

Page 37: ...nologies for additional support Sim4100 48 FYI User added SHOW attr state s value d Sim4100 49 Err No space Driver rejects SHOW attr state s value d No space is available in internal driver table Contact FieldServer Technologies for additional support Sim4100 50 Err Duplicate Driver rejects SHOW attr state s value d Duplicate found in internal driver table Contact FieldServer Technologies for addi...

Page 38: ... of messages and they are not being processed by the driver fast enough A panic is printed immediate after this message The driver will clear the buffer and start capturing new bytes as they arrive Messages may have been lost We advise that you re synch the panel This error has only been seen once It occurred when a panel was connected to the driver with the wrong connection settings Appendix C 3 ...

Page 39: ... store 13 SIM4100_STAT_XPOINT_QUALIFIER The Qualifier from most recent xpoint store 14 SIM4100_STAT_XPOINT_QUALIFIER_AS_ENUM The Qualifier from most recent xpoint store stored as an enumeration See Note1 for bit states 15 SIM4100_STAT_XPOINT_STATE The reported state from most recent xpoint store State value 0 FALSE Normal 1 TRUE Abnormal 16 SIM4100_STAT_XPOINT_ACK_STATE The reported ack state from...

Page 40: ...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 Card...

Page 41: ...GROUP 1 ACTIVE UTILITY 128 25 0 P26 CODING GROUP 2 ACTIVE UTILITY 128 26 0 P27 CODING GROUP 3 ACTIVE UTILITY 128 27 0 P28 CODING GROUP 4 ACTIVE UTILITY 128 28 0 P29 CODING GROUP 5 ACTIVE UTILITY 128 29 0 P30 CODING GROUP 6 ACTIVE UTILITY 128 30 0 P31 CODING GROUP 7 ACTIVE UTILITY 128 31 0 P32 COLD START TROUBLE 128 32 0 P33 WARM START TROUBLE 128 33 0 P34 CITY DISCONNECT TROUBLE 128 34 0 P35 MANUA...

Page 42: ...BLED TROUBLE 128 71 0 P72 WALK TEST GROUP 2 ENABLED TROUBLE 128 72 0 P73 WALK TEST GROUP 3 ENABLED TROUBLE 128 73 0 P74 WALK TEST GROUP 4 ENABLED TROUBLE 128 74 0 P75 WALK TEST GROUP 5 ENABLED TROUBLE 128 75 0 P76 WALK TEST GROUP 6 ENABLED TROUBLE 128 76 0 P77 WALK TEST GROUP 7 ENABLED TROUBLE 128 77 0 P78 ALARM SILENCE ALARM CUTOUT PSEUDO UTILITY 128 78 0 P79 RESET SPKRS WHEN AUDIO CODING COMPLET...

Page 43: ...P122 ALL SPEAKERS CHANNEL 3 LED UTILITY 128 122 0 P123 LOCAL SPEAKER EVAC ON UTILITY 128 123 0 P124 LOCAL SPEAKER EVAC OFF UTILITY 128 124 0 P125 LOCAL SPEAKER EVAC LED UTILITY 128 125 0 P126 LOCAL SPEAKER ALERT ON UTILITY 128 126 0 P127 LOCAL SPEAKER ALERT OFF UTILITY 128 127 0 P128 LOCAL SPEAKER ALERT LED UTILITY 128 128 0 P129 ALL SPEAKERS TALK ON UTILITY 128 129 0 P130 ALL SPEAKERS TALK OFF UT...

Page 44: ...G WHEN MICROPHONE KEYED UTILITY 128 167 0 P168 MICROPHONE TO EVAC IN EFFECT UTILITY 128 168 0 P169 MICROPHONE TO ALERT IN EFFECT UTILITY 128 169 0 P170 MICROPHONE TO TALK CHANNEL 3 IN EFFECT UTILITY 128 170 0 P171 BACKGROUND MUSIC RELAY CHANNEL 1 UTILITY 128 171 0 P172 BACKGROUND MUSIC RELAY CHANNEL 2 UTILITY 128 172 0 P173 BACKGROUND MUSIC RELAY CHANNEL 3 UTILITY 128 173 0 P174 VTG 1 CODE S PRECO...

Page 45: ...RITY 2 ALARM DETECT UTILITY 128 215 0 P216 PRIORITY 2 ALARM RESET REQUEST UTILITY 128 216 0 P217 NETWORK SIGNAL SILENCE UTILITY 128 217 0 P218 UNACKNOWLEDGED PRIORITY 2 ALARM EXISTS UTILITY 128 218 0 P219 MASTER PRIORITY 2 ALARM ACK KEY UTILITY 128 219 0 P220 NETWORK PRIORITY 2 RESET UTILITY 128 220 0 P221 SIGNALS ACTIVE OFF ON SILENCE UTILITY 128 221 0 P222 REMOTE DOWNLOAD ENABLED TROUBLE 128 222...

Page 46: ...OG 144 23 0 A24 FIRE ALARM CUTOUT TIMER TIMER 144 24 0 A25 FIRE ALARM CUTOUT TIMER SETPOINT ANALOG 144 25 0 A26 FIRE ALARM CUTOUT SILENCE PULSE TIMER TIMER 144 26 0 A27 TROUBLE REMINDER CYCLE TIMER TIMER 144 27 0 A28 TROUBLE REMINDER OFF TIME SETPOINT ANALOG 144 28 0 A29 TROUBLE REMINDER ON TIME SETPOINT ANALOG 144 29 0 A30 DOOR HOLDER ALARM DROP TIMER TIMER 144 30 0 A31 DOOR HOLDER ALARM DROP TIM...

Page 47: ...2 ROUTING PRIORITY ANALOG 144 71 0 A72 CHANNEL 3 ROUTING PRIORITY ANALOG 144 72 0 A73 LOCAL SPEAKER ROUTING PRIORITY ANALOG 144 73 0 A74 AUDIO SUPERVISION PULSE TIMER VTG1 TIMER 144 74 0 A75 AUDIO SUPERVISION PULSE TIMER VTG2 TIMER 144 75 0 A76 ENABLE DISABLE STATISTIC GROUP ANALOG 144 76 0 A77 ENABLE DISABLE STATISTIC OUTPUT PORT ANALOG 144 77 0 A78 5 SEC TIMER FOR REMOTE MASTER PHONES TIMER 144 ...

Page 48: ...E SETPOINT ANALOG 144 111 0 A112 GROUND TROUBLE COUNTER COUNTER 144 112 0 A113 PAGING CHANNEL ANALOG 144 113 0 A114 TRUEALARM MODIFICATION COUNTER COUNTER 144 114 0 A115 EXCESSIVELY DIRTY OUT OF RANGE ANALOG 144 115 0 A116 DIRTY SENSOR COUNTER COUNTER 144 116 0 A117 ALMOST DIRTY COUNTER COUNTER 144 117 0 A118 ALARMS SILENCED DELAY TIMER TIMER 144 118 0 A119 NUMBER OF LOCAL SYSTEM POINTS TROUBLES C...

Search results

Summary of Contents for FS-8700-41

Reviews:

Related manuals for FS-8700-41

Brands by name

Popular brands

FieldServer FS-8700-41, Driver Manual

Search results

Summary of Contents for FS-8700-41

Reviews:

Related manuals for FS-8700-41

Brands by name

Popular brands