A Sierra Monitor Company Driver Manual (Supplement to the FieldServer Instruction Manual) FS-8700-103 ATMI-TGM Serial Driver APPLICABILITY & EFFECTIVITY Effective for all systems manufactured after May 1, 2001 Driver Version: 1.
FS-8700-103_ATMI_TGM_Serial Manual Table of Contents TABLE OF CONTENTS 1. 2. ATMI TGM SERIAL DRIVER DESCRIPTION ...................................................................3 DRIVER SCOPE OF SUPPLY...........................................................................................4 2.1. Supplied by FieldServer Technologies for this driver ...................................................4 2.2. Provided by the Supplier of 3rd Party Equipment .................................................
FS-8700-103_ATMI_TGM_Serial Manual 1. Page 3 of 28 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.
FS-8700-103_ATMI_TGM_Serial Manual 2. Page 4 of 28 Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # FS-8917-12 FS-8700-103 Description Connector, 9-pin female: connects to DTE, DSR/DTR loop Driver Manual. Provided by the Supplier of 3rd Party Equipment 2.2. 2.2.1. Required 3rd Party Hardware Part # No specific Hardware requirements other than TGM unit. 2.2.2.
FS-8700-103_ATMI_TGM_Serial Manual 3. Page 5 of 28 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 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.
FS-8700-103_ATMI_TGM_Serial Manual 3.1. Page 6 of 28 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).
FS-8700-103_ATMI_TGM_Serial Manual 4. Page 7 of 28 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).
FS-8700-103_ATMI_TGM_Serial Manual 4.2.
FS-8700-103_ATMI_TGM_Serial Manual 4.4. Page 9 of 28 Client Side Map Descriptors 4.4.1.
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.
FS-8700-103_ATMI_TGM_Serial Manual 4.4.5. Page 11 of 28 Map Descriptor Example #2 – QLA Report. In this example, a Map Descriptor is created to read the Latest Area Report (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.
FS-8700-103_ATMI_TGM_Serial Manual 4.5. Page 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.
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.
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 the Data Array element at the specified offset is set to 1.
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.
FS-8700-103_ATMI_TGM_Serial Manual Page 16 of 28 Appendix B. Advanced Topics Appendix B.1. How Malfunctions are determined and stored • • • • • • • • The notes below describe how the driver parses incident reports obtained by the QIR poll. The driver starts at the end of the report and works its way to the top, line by line.
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.
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.
FS-8700-103_ATMI_TGM_Serial Manual Page 19 of 28 In the example below the gas name specified is ‘C2H5OH’ 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, C2H5OH, TGM_Gas_Index_Value, 7, Protocol 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.
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.
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.
FS-8700-103_ATMI_TGM_Serial Manual Page 22 of 28 Appendix C. Driver Error Messages Notes and Corrective Action∼ If this message is printed an internal diagnostic has been TGM:#1 Err. Diagnostic #1. generated. Contact FieldServer tech support for help. TGM:#2 Err. TGM_Function not Each Map Descriptor must have the parameter called specified. “TGM_Function” set. See section 4.4.22 TGM:#3 FYI. Use an Array This message may be ignored. For more information read called <%s> to expose Appendix C.1 diagnostics.
FS-8700-103_ATMI_TGM_Serial Manual Page 23 of 28 Message Notes and Corrective Action∼ TGM: #10 Err. No space. Reject An attempt has been made to extend the gas name table. Gas Name=<%s> Index There is insufficient space to add more names. Remove this Value=%d entry from the configuration CSV file3. This message may be ignored. It is printed to alert you to TGM: #11 FYI. User added Gas the fact that the driver has updated the Gas Name table by Name=<%s> Index Value=%d adding a new gas name and index value.
FS-8700-103_ATMI_TGM_Serial Manual Message TGM: #21 FYI. Malfunction. Don’t recognize <%s> But sounds like <%s>. TGM: #22 FYI. Return to Normal. Don’t recognize <%s>But sounds like <%s>. Page 24 of 28 Notes and Corrective Action∼ 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.
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.
FS-8700-103_ATMI_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.
FS-8700-103_ATMI_TGM_Serial Manual Page 27 of 28 Appendix D. Troubleshooting tips Appendix D.1. Connection Tips & 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.
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.
