FieldServer FS-8700-103, Driver Manual

Page 1: ...any APPLICABILITY EFFECTIVITY Effective for all systems manufactured after May 1 2001 Driver Manual Supplement to the FieldServer Instruction Manual FS 8700 103 ATMI TGM Serial Driver Driver Version 1 00 Document Revision 2 ...

Page 2: ...s 9 4 4 2 Driver Related Map Descriptor Parameters 9 4 4 3 Timing Parameters 9 4 4 4 Map Descriptor Example 1 CALR Report 10 4 4 5 Map Descriptor Example 2 QLA Report 11 4 5 Map Descriptor Example 3 QIR Report Malfunctions 12 APPENDIX A TGM TABLES 13 Appendix A 1 Hard Coded Gas Name Table 13 Appendix A 2 Malfunction Table 14 Appendix A 3 Gas Concentration Engineering Units 15 APPENDIX B ADVANCED T...

Page 3: ...orts Gas and sensor readings and Gas alarm warning status The driver reports TGM module malfunctions The driver is a client only driver When reporting port and sensor data the driver reports the gas name by setting a gas name index value The index value is obtained from a list of gas names index values hard coded into the driver The list may be extended and or modified using the configuration by u...

Page 4: ...ale connects to DTE DSR DTR loop FS 8700 103 Driver Manual 2 2 Provided by the Supplier of 3rd Party Equipment 2 2 1 Required 3rd Party Hardware Part Description No specific Hardware requirements other than TGM unit 2 2 2 Required 3rd Party Configuration The FieldServer s serial port must be configured to be used as a Console Port on the TGM device The Console Port is configurable At least one of ...

Page 5: ...rnia 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com 3 Hardware Connections The FieldServer is connected to the TGM device s printer port as shown in connection drawing Configure the TGM device according to manufacturer s instructions ...

Page 6: ...ng this timeout if the DSR is ASSERTED TRUE then the TGM software will begin transmitting data If the DSR hold exceeds the configurable 30 second timeout the TGM will report a malfunction MALFUN PRINTER OFF LINE hh mm dd mmm yy MALFUN REMOTE OFF LINE hh mm dd mmm yy depending upon which port has timed out Restoration of the DSR status as ASSERTED or TRUE will clear the above malfunction s The abov...

Page 7: ... FieldServer for ATMI TGM Serial 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 indica...

Page 8: ...Poll _Delay Time between internal polls 0 32000 seconds 1 second Example Client Side Connections Connections Port Protocol Baud Parity Handshaking Poll_Delay P8 TGM Serial 9600 None None 0 100s 4 3 Client Side Node Descriptors Section Title Nodes Column Title Function Legal Values Node_Name Provide name for node Up to 32 alphanumeric characters Node_ID This parameter is not required for the TGM dr...

Page 9: ...ch data from One of the node names specified in Client Node Descriptor above Data_Type This commonly used driver parameter is not used by the driver Length Length of Map Descriptor The parameter is not used by the driver but is used by the FieldServer Kernel to reserve space in the Data Array Set the Length according to the function QIR Report Length 100 CALR Report Variable Depends on number of g...

Page 10: ...lookup to determine what gas name index value to store Client Side Map Descriptors Map Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name Address Length Scan_Interval TGM_Funtion RD_CALR DA_CALR 0 RDBC Node_A 0 100 600s CALR No need to read this report too often Although not mandatory it is recommended that each MD is given a unique name The node name connects the...

Page 11: ...rays DA_Bit_Name and DA_Byte_Name the driver stores additional information Client Side Map descriptors Map Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function Node_Name Address Length Scan_Interval DA_Byte_Name DA_Bit_Name TGM_Funtion RD_QLA DA_CALR 0 RDBC Node_A 0 300 1 0s DA_GAS_UNITS DA_QLA_GAS QLA Gas concentration value status engineering units index values gas name ind...

Page 12: ...ion has been cleared The position indicates the malfunction number The driver has a list of malfunctions and index numbers stored internally Refer to Appendix A 2 for this list The list can be modified in the configuration CSV file CAUTION When the QIR report is polled it responds with the latest incidents only This means that care should be taken to synchronize the FieldServer and the TGM Read mo...

Page 13: ...a from the QLA report The driver looks the reported gas name up in this table If a match is found then the driver stores the corresponding index value in the Data Array If no match is found the the driver stores a value of 1 The table may be extended modified using the configuration file Refer to Appendix B 4 Gas Name Index Value Error Unknown 1 NONE 1 ASH3 3 B2H6 6 CH4 9 CH4AC 12 CL2 15 DET 18 F1...

Page 14: ...ble see Appendix B 7 Offset Malfunction Return to Normal 20 BASELINE OUT OF RANGE BASELINE BACK TO NORMAL 22 IGNITER SWITCH IS ON IGNITER SWITCH IS OFF 24 FLAME IGNITION DISABLED FLAME IGNITION ENABLED 26 LOW VACUUM VACUUM BACK TO NORMAL 28 FLAMEOUT RESTART FLAMEOUT BACK TO NORMAL 30 LINE LEAK TEST MALFUN LINE LEAK BACK TO NORMAL 32 POWER FAILURE POWER RESTORED 38 FAILED TO LOAD PROGRAM 39 DPM TIM...

Page 15: ...om the QLA report The driver looks the reported engineering units up in this table If an matching entry is found then the driver stores the index value If a matching entry cannot be found then the driver stores a value of 1 Note that when 1 is stored in a BYTE or UINT16 formatted Data Aray it will appear as a positive number such as 255 Byte Array or 65535 uint16 Array The table may be extended mo...

Page 16: ...d the driver uses the offset value and sets the corresponding element in the Data Array to 1 If the string MAFUN is not found then the description found in the Event field of the report is used to look up a Return to Normal event in the table provided in Appendix A 2 If a match is found then the corresponding offset in the Data Array is set to zero If the description is not recognized then it it i...

Page 17: ...ap Desc scaling using the parameters Data_Array_Low_Scale Data_Array_High_Scale Node_Low_Scale Node_High_Scale 3 Gas Conc Engineering Units as an index value Stores 1 if units are not recognized Index value is based on lookup table Appendix A 3 4 Gas Status 0 Normal 1 Warn 2 Alarm 4 Error 5 Gas Name index based on CALR report A list of gas names and index values is built when the CALR report is pa...

Page 18: ...M_Units_Index_Value Protocol PPM 20 TGM In the example below the units specified are gpl and they have been assigned an index value of 7 Add a new engineering unit Driver_Table TGM_Units_Name TGM_Units_Index_Value Protocol gpl 7 TGM Appendix B 4 Adding Modifying Hard Coded Gas Names When a gas concentration is reported the driver reports the gas name by looking up the gas name in a list of hard co...

Page 19: ... those in the table provided in Appendix A 2 The table can be modified or extended Add a section to the configuration file which is similar to the text found in the examples below In the example below the gas name specified is DISK NEARLY FULL an entry from the existing list When the driver finds the lines below it will update the index value to 20 Ensure the index value is less than 100 Change in...

Page 20: ...LONGER FULL 20 TGM In the example below the gas name specified is DISK NOT FULL and it has been assigned an index value of 20 It will be added to the table Add a new Return to Normal Event Driver_Table TGM_Event_Normal_Name TGM_Event_Normal_Index Protocol DISK NOT FULL 20 TGM Appendix B 7 Using the TGM s Config dat file to customize malfunctions Copy the TGM s config dat file to the FieldServer as...

Page 21: ... the matching Return to Normal string This process is described in Appendix B 6 Appendix B 8 Synchronizing Malfunctions THE Incident Report QIR only reports events which occurred since the previous poll The following procedure is recommended for synchronizing the FieldServer and the TGM 1 Turn off the FieldServer Clear all events on the TGM and then restart the FieldServer Or 2 With the FieldServe...

Page 22: ...te the evaluation of the problem take a serial communications log ensuring at least one of the errors occurs during the log and then contact Tech Support TGM 5 FYI atmitgm ini being used for malfunctions This message is printed to alert you to the fact that the malfunction list is being based on the contents of a TGM config file Refer to Appendix B 7 If you expect the driver to be using this list ...

Page 23: ... Val has been updated from d to d This message may be ignored It is printed to alert you to the fact that the driver has updated the Malfunction Table so that default values have been modified Ensure that the index value is less than 100 TGM 16 Err No space Reject Malfunction s Index Val d An attempt has been made to extend the Malfunction Table There is insufficient space to add more names Remove...

Page 24: ...x B 6 provide information on how to do this TGM 23 FYI Duplicate Malfunction Number d Text has been updated from s to s TGM 24 Err No space Reject Malfunction s Index Val d TGM 25 FYI User added Malfunction s Index Val d If these messages are produced then the driver processes the TGM config file Read Appendix B 7 for more information TGM 26a Err Malfunction s Index value d 99 The maximum malfunct...

Page 25: ...by the client in response to TGM polling 6 Count of all the messages that were sent to the parse function 8 Count of all the message that were parsed successfully 9 Increments by 1 each time a poll times out 10 When set to 1 the driver dumps the contents of its gas name lookup table to the error log Driver resets to zero after dump 11 When set to 1 the driver dumps the contents of its gas engineer...

Page 26: ...I_TGM_Serial Manual Page 26 of 28 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com ...

Page 27: ...ial channel is to be utilized The possible entries are 0 this channel is forced out of service not implemented etc 1 this channel is a printer device 2 this channel is a remote console There can be more than one printer device max all 3 channels but there can be only one remote console COM1 or COM2 Leave the Acoustic Sensor entry 0 controlled by bvCous PMC BYTE chanUtil 0 0 local parallel printer ...

Page 28: ...al Page 28 of 28 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com THIS PAGE INTENTIONALLY LEFT BLANK ...