FieldServer FS-8700-103 Computer Drive User Manual
Contents
1. TGM 2 Err TGM_Function not Each Map Descriptor must have the parameter called specified TGM_ Function set See section 4 4 27 TOM 9 ce BS an Aay This message may be ignored For more information read caled lt s gt to expose Appendix C1 diagnostics pp 4a The text string CUR could not be found in the QLA report 4b The text string GAS could not be found in the QLA report 4c The text string STATUS could not be found in the QLA report peste E pile ae If the error is printed rarely and data is being stored data f correctly then the error probably arises from a corrupted message If the error occurs frequently then it is possible that the report format has changed and the driver firmware may require an update To facilitate 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 ignore the message TGM 6 FYI You could have used a TGM config file to define malfunctions Working with hard coded list This message is printed to alert you to the possibility that the TGM config file can be used with this driver Refer to Appendix B2. APPENDIX C DRIVER ERROR MESSAGES cccsscssssseesseeeesseeeesseeeenesennes Appendix C 1 Exposing Driver Operating Statistics nneneennenen reeter APPENDIX D TROUBLESHOOTING TIPS ccceeceessseeeeeeeeeeseeeeeeesseeneeees Appendix D 1 Connection Tips amp Hints cccccceecceeeceeeeeeeeeeeeeeeeeeeeeeneeeeeeees Adding Modifying Gas Concentration Value Engineering Units of Contents rareo ae ia 10 TE 11 EEE EEE 12 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 FS 8700 103_ATMI_TGM_Serial Manual Page 3 of 28 de ATMI TGM Serial Driver Description The ATMI TGM driver allows the FieldServer to transfer data to and from devices over RS 232 using the ATMI TGM printer port protocol This driver connects to an ATMI TGM device using a serial connection One device may be connected per FieldServer port This limitation exists because the protocol is node less that is messages do not contain information about the node and thus messages from different TGM devices could not be distinguished if they were connected on the same port The driver reports 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 nam
3. GAS NAMES TABLE i 1 2 3 4 5 6 8 9 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 FS 8700 103_ ATMI_TGM_Serial Manual Page 27 of 28 Appendix D Troubleshooting tips Appendix D 1 Connection Tips amp Hints The ATMI TGM s serial ports are configured using the TGM s configuration file typically named config dat Search for the following section The port you wish to connect to must be set as a Remote Console the channel utilization array specifies how a parallel or serial channel is to be utilized The possible entries are 4 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 chanUtilJ 0 I 0 local parallel printer 0 1 COM1 serial channel 2 2 COM2 serial channel O 3 Acoustic Sensor serial channel the baudRate table specifies the baud rate for the serial channels can be one of 110 300 600 1200 2400 4800 9600 19200 38400 an entry of 0 in chanUtil overrides t
4. DA_Byte_Name Gas Concentration Engineering Units are stored character for character to a max of 9 characters 0 The name of the Map Desc parameter is confusing The Data Array specified with this parameter can have any format and in fact the BYTE format is reccomended 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 FS 8700 103_ATMI_TGM_Serial Manual Page 18 of 28 Appendix B 3 Adding Modifying Gas Concentration Value Engineering Units The configuration CSV file can be used to modify the table of engineering units that is hard coded into the driver This table is presented in Appendix A 3 Add a section to the configuration file which is similar to the following example In the example below the Units specified is PPM an entry from the existing list When the driver finds the lines below it will update the index value to 20 Change index value of existing unit to 20 Driver_Table TGM_Units_Name TGM_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 iG TGM Appendix B 4 Adding Modifying Hard Coded Gas Names When a gas concentration is re
5. QLA This report contains gas concentration and status for each port and sensor Ten Data array elements are required for each port sensor that is reported The poistion in the array is dependent on the port sensor number Appendix B provides additional information By specifying the extra arrays DA_Bit_Name and DA_Byte_Name the driver stores additional information II 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 QLA GAS QLA Gas concentration value status This parameter may be omitted If specified then the Data Array will be used to store the gas concentration value engineering units in ASCII Storage position is dependent on the port sensor number This parameter may be omitted If Tells the driver specified then the Data Array will to read the QLA be used to store the gas name in report ASCII Storage position is dependent on the port sensor number engineering units index values gas name index values are stored in this Data Array 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 FS 8700 103_ATMI_TGM_Serial Manual 4 5 Pag
6. are then they are considered to be matched If a similar match is made the driver reports this in the error log 16 T02 gt TGM 21 FYI Malfunction Dont recognize lt POWER FAILED gt 17 T02 gt But sounds like lt POWER FAILURE gt 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 FS 8700 103_ATMI_TGM_Serial Manual Page 17 of 28 Appendix B 2 How Gas Data is Stored The QLA reports provides Gas Concentration values for each configured port sensor connected to the TGM The driver stores the data using the Data_Array Name and Data_Array_Offset parameters specified on the Map Descriptor Two additional Data Array s can be specified to tell the driver where to store the gas names and egineering units The position at which data is stored in the array is deprendent on the TGM port sensor number Use the following formula to determine the position For Portx Relative Offset Port_Number 10 For Sensor x Relative Offset 200 Sensor_Number 10 Thus enough room is provided to store data from 20 ports and provided the Array is long enough there is no limit to the maxium sensor number The offset s described here are relative to the offset provided in the Map Descriptor which should be added to the offsets specified here pea Contents In the Dat
7. or 65535 uint16 Array The table may be extended modified using the configuration file Refer to Appendix B 1 Engineering Units Index Value Error Unknown 1 ARU 1 PPM 2 PPB 3 LEL 4 5 PCT 6 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 FS 8700 103_ ATMI_TGM_Serial Manual Page 16 of 28 Appendix B Advanced Topics Appendix B 1 How Malfunctions are determined and stored e The notes below describe how the driver parses incident reports obtained by the QIR poll e The driver starts at the end of the report and works its way to the top line by line e Each line is inspected to see if it contains either of the following strings ALARM RESET ALL MALFUNCTIONS CLEAR e f either is reported then the driver sets all the array elements to zero except those corresponding to lines of the report appearing after and hence later in time one of the above lines that indicates that malfunctions be set in which case those particular malfunctions will be reported as 1 s in the Data Array e When either one of these two events is found the driver stops parsing the report as all prior lines predate the clear event e Each line is inspected for the string MALFUN If it is found then Event field in the report is inspected and the description is
8. storage starts at this Although not mandatory it is recommended that each MD is given a unique name location in the Data Array A list of gas names vs index values is stored in the Data Array specified here In this particular example the list is stored as an ASCII string and hence it makes most sense to ensure that the Data Array s format is BYTE so that it can be viewed as a string when using Ruinet Tells the driver to repeat this Reserve enough Tells the driver read task continuously The space in the Data to read the polling interval is set by the Array to store the Calibration Scan_Interval parameter gas index string report For the CALR report is may also make sense to use the ARS function which gets the driver to read this data once each time the driver restarts No need to read this report too often The node name connects the Map Descriptor to a Node definition which in turn is connected to a port That is how the driver knows which port to use to poll for this data 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 FS 8700 103_ATMI_TGM_Serial Manual Page 11 of 28 4 4 5 Map Descriptor Example 2 QLA Report In this example a Map Descriptor is created to read the Latest Area Report
9. you to the fact that the driver has updated the Gas Name table by adding a new gas name and index value Ensure that index values are unique TGM 12 FYI Duplicate Gas Units lt s gt Value 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 Gas Engineering Unit table so that default values have been modified TGM 13 Err No space Reject Gas Units lt s gt Index Value d An attempt has been made to extend the Fas Engineering Units table There is insufficient space to add more names Remove this entry from the configuration CSV file TGM 14 FYI User added Gas Units lt s gt Index Value d This message may be ignored It is printed to alert you to the fact that the driver has updated the Gas Engineering Units Table by adding a new gas name and index value Ensure that index values are unique TGM 15 FYI Duplicate Malfunction lt s gt Index 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 An attempt has been made to extend the Malfunction Table There is insufficient space to add more names Remove this entry from the configuration CSV file This message may be ignored It is printed t
10. 2 Required 3 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 the two serial ports on the TGM device must be configured to enable the Console Port This is not always the case when the TGM is shipped Notes in Appendix D provide additional information 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 FS 8700 103_ATMI_TGM_Serial Manual Page 5 of 28 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 ATMI TGM ZL LL68 S4 9 PIN MALE D TYPE SERIAL CONNECTOR WIRE LIST FS X40 FUNCTION FROM TO COLOR RX RJ45 01 DB9F 03 GREY GND RJ45 04 DB9F 05 GREEN TX RJ45 08 DB9F 02 BLUE DTR DB9F 04 BLACK DSR DB9F 06 YELLOW CTS DB9F 08 BROWN 408 262 2299 Technologies ATMI TGM CONNECTION DIAGRAM BASE NAME DATE 04 30 04 FILE NAME 128700 103 vsd BY MN 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 FS 8700 103_ATMI_TGM_Seria
11. 7 TGM 7 Err Driver cannot write MD s The Map Descriptor function has been set so that the driver will attempt to write to the TGM Writing is not possible Change the function to a read TGM 8 Err Array s_ too short Act Rqd d d This error is printed when the driver attempts to store data from the QLA report Modify the length of the Data Array as discussed in section 4 1 7 TGM 9 FYI Duplicate Gas Name lt s gt Value has from d to d been updated This message may be safely ignored It is printed to alert you to the fact that the driver has updated the Gas Name table so that default values have been modified Modify the configuration CSV file Download the modified file to the FieldServer and Reset the FieldServer for the changes to take effect 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 FS 8700 103_ATMI_TGM_Serial Manual Page 23 of 28 Message Notes and Corrective Action TGM 10 Err No space Reject Gas Name lt s gt Index Value d An attempt has been made to extend the gas name table There is insufficient space to add more names Remove this entry from the configuration CSV file TGM 11 FYI User added Gas Name lt s gt Index Value d This message may be ignored It is printed to alert
12. FieldServer Technologies A Sierra Monitor Company Driver Manual Supplement to the FieldServer Instruction Manual FS 8700 103 ATMI TGM Serial Driver APPLICABILITY amp EFFECTIVITY Effective for all systems manufactured after May 1 2001 FS 8700 103_ATMI_TGM_Serial Manual Table 1 2 2 1 2 2 2 2 1 Required 3 Party HardWare eccccccececssecssscssssecsscessecescecsrecsseceseresevess ATMI TGM SERIAL DRIVER DESCRIPTION DRIVER SCOPE OF SUPPLY ivcssisicsstuceciiatae aie utaiswteniraiacsticerasaiantantanie TABLE OF CONTENTS Supplied by FieldServer Technologies for this driver 0000 Provided by the Supplier of 3 Party Equipment 0c ccccceceeeeee 2 2 2 Required 3 Party Configuration cccccccsccecesesestsesesestsesesesescsesesssees 3 3 1 4 4 1 4 2 4 3 4 4 4 4 4 4 4 5 4 5 APPENDIX A TGM TABLES Appendix A 1 Hard Coded Gas Name Table cccccccceecceceeceeeeeeeeeeeteees HARDWARE CONNECTIONS cccceccseeeesseeeeeseeeesseneeessneeeseneesnseeneesneennes Hardware Connection Tips Hints ccccceccceccceeeeeeeeeeeeeeeeeeeeeeeeeeneees CONFIGURING THE FIELDSERVER AS A ATMI TGM SERIAL CLIENT Data Arrays DescriptotS srities ina doi roca taligdeues cela decp actully Client Side Connection Descriptions e seeseeeeeeeeeeeeseeeteeeeeeees Client Side Node Descriptors c cesseeeeeeeeeeeeeeeeeeeee
13. LAME TEST OK NOW 54 FAILED RESPONSE TEST RESPONSE TEST OK NOW 56 FAILED BLOCK LEAK CHECK BLOCK LEAK CHECK OK NOW 58 ANALOG SUBSYSTEM FAILURE ANALOG SUBSYSTEM NORMAL 60 ANALOG CHANNEL FAILURE ANALOG CHANNEL NORMAL 62 PRINTER OFF LINE PRINTER BACK TO NORMAL 64 REMOTE OFF LINE REMOTE BACK TO NORMAL 66 DISK READ WRITE ERR DISK BACK TO NORMAL 68 LAN READ WRITE ERROR LAN BACK TO NORMAL 70 DISK FULL DATA LOST DISK NO LONGER FULL 75 HIGH SAMPLE VARIANCE SAMPLE VARIANCE OK NOW 80 COUS SENSOR TIMEOUT COUS TIMEOUT CORRECTED 82 COUS GETTER INOPERATIVE COUS GETTER OK NOW 84 ACOUSTIC SENSOR FAILURE ACOUSTIC SENSOR RECOVERD 86 GETTER TEMPERATURE LOW GETTER TEMPERATUR OK NOW 88 LOW SAMPLE FLOW SAMPLE FLOW OK NOW 90 TGM HYDROGEN LEAK HYDROGEN LEAK REPAIRED 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 FS 8700 103_ATMI_TGM Serial Manual Page 15 of 28 Appendix A 3 Gas Concentration Engineering Units This table is used by the driver when storing data from 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
14. Toll_Free 888 509 1970 email support fieldserver com FS 8700 103_ ATMI_TGM_Serial Manual Page 24 of 28 Message Notes and Corrective Action TGM 21 FYI Dont recognize sounds like lt s gt Malfunction lt s gt But The driver has found a malfunction but could not match it exactly to a malfunction in the Malfunction Table The driver used a soundex function which looks for matches based on a sounds like evaluation As the match is not exact the driver provides the alert To suppress this message in the future note the message and add it to the Malfunction Table Notes in Appendix B 5 provide information on how to do this TGM 22 FYI Return to Normal Don t recognize lt s gt But sounds like lt s gt The driver has found an event description that is being evaluated as a potential Return to Normal message but could not match it exactly to a Return to Normal in the Malfunction Table The driver used a soundex function which looks fro matches based on a sounds like evaluation As the match is not exact the driver provides the alert To suppress this message in the future note the message and add it to the Return to Normal Table Notes in Appendix B 6 provide information on how to do this TGM 23 FYI Duplicate Malfunction Number lt d gt Text has been updated from lt s gt to lt s gt TGM 24 Err No space Reject Malfunction lt s gt I
15. a Array specified by the Data_Array_Name Port Number 1 Set to P for a port Set to S for a sensor Gas concentration Value Can be scaled by applying Map Desc scaling using 2 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 Gas Name index based on CALR report A list of gas names and index values is built when the CALR report is parsed It is not possible to provide a list of index values vs gas names in advance 5 because this is dependent on the TGM configuration To facilitate debugging your application the driver stores the list it builds in a Data Array which can be read by an upstream device or which can be seen by uisng the Ruinet Utility If the gas name is not recognized then the driver stores a value of 1 Gas Name index based on looking up the gas name in the table provided in 6 Appendix A 1 If the gas name is not recognized by the lookup then a value of 1 is stored In the Data Array specified by the DA_Bit_Name Gas Name is stored character for character to a max of 9 characters 0 The name of the Map Desc parameter is confusing The Data Array specified with this parameter can have any format BYTE format is reccomended In the Data Array specified by the
16. aking 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 This parameter is not required for the TGM driver However if you Node_ID intend to use the Node Status 1 255 function with a Data Array then the Node_ID must be specified Protocol Specify protocol used TGM Serial ATMI TGM Serial Specify which port the device is 5 R31 Cornec connected to the FieldServer PIERE RIRE Example Client Side Nodes Nodes Node _Name Node_ID Protocol Connection PLC 1 1 TGM Serial P8 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 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 FS 8700 103_ATMI_TGM_Serial Manual Page 9 of 28 4 4 Client Side Map Descriptors 4 4 1 FieldServer Related Map Descriptor Parameters Column Title Function Legal Values Up to 32 alphanumeric characters Name of Data Array where One of the Data Array Data_Array_Name data is to be stored in the names from Data Array FieldServer section above 0 to maximum specified in Data Array section above Map_Descri
17. ata Packed_Bit Byte DAA Ara Foal Array can only take on one format Packed_Byte Swapped_Byte Number of Data Objects Must be larger than the data storage area Datar AMAY angi required by the Map Descriptors for 1710 000 the data being placed in this array Example Data Arrays Data_Arrays Data_Array_Name Data_Format Data_Array_Length DA_AI_01 Ulnt16 200 DA_AO_01 Ulnt16 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 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 103_ ATMI_TGM_Serial Manual Page 8 of 28 4 2 Client Side Connection Descriptions Section Title Connections Column Title Function Legal Values Specify which port the device is 1 Port connected to the FieldServer PEFEA Protocol Specify protocol used TGM Serial ATMI TGM Serial 2 110 19200 standard baud Baug Seely Dale TAI rates only Vendor limitation Parity Specify parity None Vendor limitation Data_Bits Specify data bits 8 Vendor limitation Stop_Bits Specify stop bits 1 Handshaking Specify hardware handshaking None Poll _Delay Time between internal polls 0 32000 seconds 1 second Example ee Client Side Connections Connections Port Protocol Baud Parity Handsh
18. driver poll for this data as often as possible 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 FS 8700 103_ATMI_TGM_Serial Manual 4 4 4 Page 10 of 28 Map Descriptor Example 1 CALR Report To be useful to the upstream device the driver reports gas concentration values and gas names from the QLA report In reporting the gas names it is most useful when a driver stores an index value which is used to imply the gas names The reason this is most useful is that it is typically easier for automation devices to work with numbers and not text When the driver reads the Calibration report it does two things 1 It stores a string of gas names vs index values in the Data Array This string can be viewed using the Ruinet Utility and may be of help in interpreting the gas name index values stored by the QLA report 2 The data is stored internally by the driver and when a QLA report is parsed the driver looks the gas names up in the CALR report data and uses the lookup to determine what gas name index value to store _ Client Side Map Descriptors Map Descriptors Map_Descriptor Name Data_Array_Name RD_CALR DA_ CALR Data_Array_ Offset 0 Address 0 Function Node_Name Length 100 Scan_Interval 600s TGM_Funtion CALR Data
19. e 12 of 28 Map Descriptor Example 3 QIR Report Malfunctions In this example the Map Descriptor is configured to read the incident report The driver parses the report looking for malfunctions and reports that show a malfunction has been cleared Other incidents events are ignored except for events 19 and 37 which cause all malfunctions to be cleared The Driver updates the array setting values to 1 malfunction or zero when a malfunction 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 more about this in Appendix B 8 Client Side Map Descriptors Map Descriptors Map_Descriptor_Name RD_QIR Data_Array_Name Data_Array_Offset DA_MALFUNC 0 Function RDBC Node Name Address Node_A 0 Length 100 Scan_Interval 2 0s TGM_Funtion Driver sets the Data Array elements to 1 when there is malfunction and sets the value to zero when the malfunction is cleared Position in the array indicates the malfunction number Tells the driver to read the incident report FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www
20. e 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 using appropriate entries in the configuration CSV file The driver reports a second gas name index value based on reading the TGM calibration report When the report is read each gas is allocated an identifier value based on the gas s position in the configuration report The driver does not provide emulation of a TGM device and thus may not be used as a server It is not possible to use this driver to write to the TGM device Max Nodes Supported FieldServer Mode Nodes Comments CLIENT 1 ONLY 1 SERVER NODE ALLOWED PER PORT SERVER 1 Server capability not provided 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 FS 8700 103_ATMI_TGM_Serial Manual Page 4 of 28 2 Driver Scope of Supply 2 1 Supplied by FieldServer Technologies for this driver FieldServer Technologies AR PART Description FS 8917 12 cr 9 pin female connects to DTE DSR DTR FS 8700 103 Driver Manual 2 2 Provided by the Supplier of 3 Party Equipment 2 2 1 Required 3 Party Hardware Part Description No specific Hardware requirements other than TGM unit 2 2
21. eeteeeseeeeeeeeeeees Client Side Map Descriptors cceeeeeeeceeeeeeeeeeeeeeeeeaaeaeaeeaaeeaaeeaes 4 4 1 FieldServer Related Map Descriptor Parameters 1 ccccceeeeeees 4 4 2 Driver Related Map Descriptor Parameters n 4 4 3 Timing Parameters iSisc ct occ his bine cnces dates een ve sans Quanabibebia sess Gaaete cade ostveet ye Map Descriptor Example 1 CALR R pOft ccccccssecceeesseeeeesnees Map Descriptor Example 2 QLA Report cccccccessteeeetenteeeeeesees Map Descriptor Example 3 QIR Report Malfunctions Appendix A 2 Malfunction Table cccccccceccccccccceceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees Appendix A 3 Gas Concentration Engineering Units eeeeeereeees APPENDIX B ADVANCED TOPICS ssasssnnseunsnnunununnnunnnnnnnnunnnunnnnnnnnnnnnnnnnnnnnn nnan Appendix B 1 How Malfunctions are determined and stored 08 Appendix B 2 How Gas Data iS Stored cccccccccccccceceeeeeeeeeeeeeeeeeeeeeeeeeeeeeees Appendix B 3 Appendix B 4 Adding Modifying Hard Coded Gas Names eee Appendix B 5 Adding Modifying Malfunction Strings eeeeeeeeeeeeees Appendix B 6 Adding Modifying Return to Normal Strings eee Appendix B 7 Using the TGM s Config dat file to customize malfunctions Appendix B 8 Synchronizing MalfUnctions ccc eeeeeeeeeeeeeeeeeeeeeeeeeeeeeees
22. extracted and compared to the malfunction list provided in Appendix A 2 If a match is found the driver uses the offset value and sets the corresponding element in the Data Array to 1 e 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 e If the description is not recognized then it it is ignored Example Only the Malfunction COUS SENSOR TIMEOUT would have its Data Array element set to 1 All others will be set to zero The reason is that all events above the ALARM RESET line are considered to be prior to the reset and are thus cleared when the driver sets all the Data Array elements to zero The timeout event occurs later and hence its malfunction is set MALFUN POWER FAILURE 00 00 00 00 POWER RESTORED LOgA2Q G wing OA MALFUN TGM IN DEBUG MODE LOSAQ Ie ine O4 MALFUN FAILED FLAME TEST 10529 16 mis 04 ALARM RESET LOZO 16 iin QA MALFUN COUS SENSOR TIMEOUT 1029 Wo mis Q4 When the driver uses the lookup table to see if it recognizes the event description then it compares the strings looking for an exact match If no exact match is made then the driver uses a so called soundex function to see if the strings are very similar if they
23. fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 103_ ATMI_TGM_Serial Manual Page 13 of 28 Appendix A TGM Tables Appendix A 1 Hard Coded Gas Name Table This table is used by the driver when storing data 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 F123 21 GEH4 24 H2 27 H2AC 30 H2S 33 H2SE 36 HCL 39 HF 42 N20 45 NF3 48 NH3 51 02 54 03 57 PH3 60 POCL 63 POCL3 66 SIHX 69 SIHx 70 TMBP 75 WF6 78 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 FS 8700 103_ ATMI_TGM_Serial Manual Page 14 of 28 Appendix A 2 Malfunction Table When an event is reported in the Incident Report QIR then the driver compares the event description to text in the table below If the text matches an an entry in the Malfunction column and is preceeded by the string MALFUNC then
24. he entry here PMC too slow and wont finish printing in time g WORD baudRate XX 0 9600 1 COM1 9600 2 COM2 9600 3 cous chan 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 FS 8700 103_ATMI_TGM_Serial Manual Page 28 of 28 THIS PAGE INTENTIONALLY LEFT BLANK 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
25. ig file only contains malfunction strings and does not provide the Return to Normal strings Thus if the config file contains a malfunction for which the driver does not have a matching return to 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 FS 8700 103_ATMI_TGM_Serial Manual Page 21 of 28 normal string then you will need to add 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 FieldServer online cause the TGM to send an RESET ALARMS message to the FieldServer 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 FS 8700 103_ ATMI_TGM_Serial Manual Page 22 of 28 Appendix C Driver Error Messages Message Notes and Corrective Action TGM 1 Err Diagnostic 1 If this message is printed an internal diagnostic has been generated Contact FieldServer tech support for help
26. l Free 888 509 1970 email support fieldserver com FS 8700 103_ATMI_TGM_Serial Manual Page 7 of 28 4 Configuring the FieldServer as a ATMI TGM Serial 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 a TGM device 4 1 Data Arrays Descriptors The configuration file tells the FieldServer about its interfaces and the routing of data required In order to enable the 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 indicates an optional parameter with the bold legal value being the default Section Title Data_Arrays Column Title Function Legal Values i Up to 15 alphanumeric Data_Array_Name Provide name for Data Array characters Float Bit Ulnt16 SInt16 Provide data format Each D
27. l Manual Page 6 of 28 3 1 Hardware Connection Tips Hints The following notes are provided from a TGM manual The TGM code constantly checks the status of the DSR input of its serial ports connected to the DTR output of the remote serial ports If the TGM DSR is NOT ASSERTED FALSE then the TGM software will suspend serial data output out of TGM Tx and start a timeout timer the default timeout time 30 seconds as set in CONFIG DAT During 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 above malfunctions will occur if the active TGM serial ports printer or remote are not connected upon bootup with the proper null modem cables to active serial ports with DTR connected to theTGM DSR ASSERTED TRUE The TGM can have the hardware control defeated by jumpering CTS to DTR to DSR on the TGM side of the connector The driver does not provide the hardware handshaking required and assumes the hardware control has been defeated with jumpers FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Tol
28. me specified is DISK NO LONGER 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 index value of existing Return to Normal Event Driver_Table TGM_Event_Normal_Name TGM_Event_Normal_Index Protocol DISK NO 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 a file called atmitgm ini When the driver starts it looks for this file and updates the malfunction table based on the malfunction strings found inside the config file The Ruinet utility is required Ruinet i1 2 3 4 u0 Ic config dat fatmitgm ini Where 1 2 3 4 is the IP address of the FieldServer c config dat is the path of the file to be downloaded from your C driver To stop the driver using the ini file remove it from the FieldServer by deleting it Ruinet i1 2 3 4 zatmitgm ini When the driver inspects the configuration file it searches for the string malfunStat and uses the table that follows to update the malfunction table Note that the conf
29. ndex Val d TGM 25 FYI User added Malfunction lt s gt 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 gt 99 The maximum malfunction index value is 99 Use the procedure in Appendix B 5 to modify the malfunction index value TGM 27 Err Event s_ is Unknown Read manual It is almost impossible for the driver to distinguish between Return to Normal events and those events not associated with a malfunction When a non malfunction event is found that doesn t match the entries in the Return to Normal Table then this message is printed It is printed 20 times and then suppressed Ignore the messages if they clearly are not Return to Normal events that correspond to Malfunctions If however they are obviously associated with Malfunctions then add the description to the Return to Normal Table Notes in Appendix B 6 provide information on how to do this TGM 28 TGM_Function s invalid Err This message is printed during Map Descriptor Validation The function is not recognized Correct the configuration using information found in section 4 4 24 4 Modify the configuration CSV file Download the modified file to the FieldServer and Reset the FieldServer for the changes to take effect FieldServer Technologies 1991 Tarob Court Milpitas Califo
30. o alert you to the fact that the driver has updated the Malfunction Table by adding a new gas name and index value Ensure that index values are unique and that the index value is less than 100 Malfunction lt s gt Index Val d TGM 17 FYI User added Malfunction lt s gt Index Val d TGM 18 FYI Duplicate Normal Event lt s gt Index 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 Return to Normal Table so that default values have been modified Ensure that the index value is less than 100 TGM 19 Err No space Reject An attempt has been made to extend the Return to Normal Table There is insufficient space to add more names Remove this entry from the configuration CSV file Normal Event lt s gt Index Val d TGM 20 FYI User added Normal Event lt s gt Index Val d This message may be ignored It is printed to alert you to the fact that the driver has updated the Return to Normal Table by adding a new gas name and index value Ensure that index values are unique and that the index value is less than 100 Modify the configuration CSV file Download the modified file to the FieldServer and Reset the FieldServer for the changes to take effect FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042
31. ported the driver reports the gas name by looking up the gas name in a list of hard coded gas names When a match is found the driver stores the associated index value The table may be modified extended in the configuration CSV file The table of names and index values is provided in Appendix A 1 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 H2 an entry from the existing list When the driver finds the lines below it will update the index value to 20 Change index value of existing gas to 20 Driver_Table TGM_Gas_ Name TGM_Gas_Index_Value Protocol H2 20 TGM 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 FS 8700 103_ATMI_TGM_Serial Manual Page 19 of 28 In the example below the gas name specified is C2H50OH and it has been assigned an index value of 7 It will be added to the table Add a new gas name Driver_Table TGM_Gas_ Name TGM_Gas_Index_Value Protocol C2H50OH 7 TGM Appendix B 5 Adding Modifying Malfunction Strings When an event is reported the driver compares the MAFLUN events to 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
32. ptor_Name Name of this Map Descriptor Data_Array_ Offset Starting location in Data Array Function of Client Map Function Descriptor The driver cannot RDBC ARS write to the TGM device 4 4 2 Driver Related Map Descriptor Parameters Column F Title Function Legal Values One of the node names specified in Client Node Descriptor above Data_Type This commonly used driver parameter is not used by the driver QIR Report Length 100 Node_Name Name of Node to fetch data from CALR Report Variable Depends on number of gases reported in CALR report Start with a length of 100 and increase if necessary 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 QLA Report Length If the config has no sensors and port x is the max port number then make Set the Length according to the the array x 1 10 elements long function If the config has any sensors and sensor x is the max sensor number then make the array 200 x 1 10 elements long Address This commonly used parameter is ignored by the driver 4 4 3 Timing Parameters Legal Column Title Function Values Rate at which data is polled For CALR report use a long interval 600s as the TGM Scan_Interval configuration seldom changes 20 001s Set the Scan_Interval for the QLA and QIR reports to zero to have the
33. rnia 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com FS 8700 103_ATMI_TGM_Serial Manual Page 25 of 28 Appendix C 1 Exposing Driver Operating Statistics In addition to the standard FieldServer operating statistics the driver exposes certain key stats in a Data Array if required These stats can then be monitored by an upstream device Add the following to your configuration file to activate these stats Expose Driver Operating Stats Data_Arrays Data_Array_Name Data_Format Data_Array_Length ATMI TGM stats UINT16 1000 To calculate the actual offset multiply the port number by 100 and add the relative offset Items marked do not consider the port number in calculating the actual offset Stat Relative Offset Notes Increments each time client sends a poll Total of all the bytes sent to the TGM device Increments each time the client receives a complete response as indicated by the prompt character Increments each time the client receives a CR If pair in a response Count of all the bytes received by the client in response to TGM polling Count of all the messages that were sent to the parse function Count of all the message that were parsed successfully Increments by 1 each time a poll times out gt O CO M OyR IN 0 When set to 1 the driver dumps the contents of its gas name lookup
34. table to the error log Driver resets to zero after dump When set to 1 the driver dumps the contents of its gas engineering units t lookup table to the error log Driver resets to zero after dump 12 When set to 1 the driver dumps the contents of its CALR gas lookup table to the error log Driver resets to zero after dump 1 When set to 1 the driver dumps the contents of its Malfunction Lookup 3 table to the error log Driver resets to zero after dump 14 When set to 1 the driver dumps the contents of its Return to Normal Lookup table to the error log Driver resets to zero after dump 15 When set to 1 the driver does not use the soundex function 16 Increments by 1 each time a response line is too large to fit the connection in buffer 17 Increments by 1 each time a response is too large to fit the in the report buffer To execute a table dump do the following e Connect to the FieldServer using RUINET e Browse to the Array called ATMI TGM stats e Modify the value found at offset by typing Mx 1 lt Enter gt Where x 10 or 11 or 12 or 13 or 14 A typical dump is shown below 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 FS 8700 103_ ATMI_TGM_Serial Manual Page 26 of 28 Command Prompt mb8sim cclient cs System Errors gt
35. the Data Array element at the specified offset is set to 1 If the text matches the Return to Normal text then the malfunction is considered as cleared and the Data Array element is set to zero The Data Array elements are all set to zero when Event 19 reports ALARM RESET or Event 37 reports ALL MALFUNCTIONS CLEAR The Malunction text strings generated by the TGM unit are not the same for all units They can be customized in the TGM s config dat file For this reason this driver allows the strings in the table below to be customized too see Appendix B 5 In addition to allowing this table to be customised in the configuration file the driver can use a config dat file to directly customise the table 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 TIMEOUT DPM BACK TO NORMAL 41 RELAY FILE ERROR OPERATIONS CHECK DONE 45 CHECK I O AND FUSES I O AND FUSES OK NOW 47 TGM IN DEBUG MODE 48 DISK NEARLY FULL ADEQUATE DISK STORAGE NOW 50 FLAMEOUT CONDITION RETURN FROM FLAMEOUT 52 FAILED FLAME TEST F
36. 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 index value of existing malfunction Driver_Table TGM_Malfunction_Name TGM_Malfunction_Index Protocol DISK NEARLY FULL 20 TGM In the example below the gas name specified is DISK IS FULL and it has been assigned an index value of 20 It will be added to the table Add a new malfunction Driver_Table TGM_Malfunction_Name TGM_Malfunction_Index Protocol DISK IS FULL 20 TGM 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 FS 8700 103_ATMI_TGM_Serial Manual Page 20 of 28 Appendix B 6 Adding Modifying Return to Normal Strings When an event is reported the driver compares the description to those in Return to Normal column of 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 The index value allocated should match the malfunction index for the driver to clear the malfunction when the return to normal event is found In the example below the gas na
Download Pdf Manuals
Related Search