Summary of the content on the page No. 1
-
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.00
Document Revision: 2
Summary of the content on the page No. 2
FS-8700-103_ATMI_TGM_Serial Manual Table of Contents TABLE OF CONTENTS 1. ATMI TGM SERIAL DRIVER DESCRIPTION ...................................................................3 2. DRIVER SCOPE OF SUPPLY...........................................................................................4 2.1. Supplied by FieldServer Technologies for this driver ...................................................4 rd 2.2. Provided by the Supplier of 3 Party Equipment...........................
Summary of the content on the page No. 3
FS-8700-103_ATMI_TGM_Serial Manual Page 3 of 28 1. 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 fro
Summary of the content on the page No. 4
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 Description PART # Connector, 9-pin female: connects to DTE, DSR/DTR FS-8917-12 loop FS-8700-103 Driver Manual. rd 2.2. Provided by the Supplier of 3 Party Equipment rd 2.2.1. Required 3 Party Hardware Part # Description No specific Hardware requirements other than TGM unit. rd 2.2.2. Required 3 Party Configurati
Summary of the content on the page No. 5
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 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
Summary of the content on the page No. 6
FS-8700-103_ATMI_TGM_Serial 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 t
Summary of the content on the page No. 7
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 f
Summary of the content on the page No. 8
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 P1-P8, R1-R2 connected to the FieldServer Protocol Specify protocol used TGM-Serial, ATMI-TGM-Serial 110 – 19200, standard baud Baud* Specify baud rate rates only (Vendor limitation) Parity* Specify parity None (Vendor limitation) Data_Bits* Specify data bits 8 (Vendor limitation) Stop_
Summary of the content on the page No. 9
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 Map_Descriptor_Name Name of this Map Descriptor 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_Offset Starting location in Data Array “Data Array”
Summary of the content on the page No. 10
FS-8700-103_ATMI_TGM_Serial Manual Page 10 of 28 4.4.4. 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 Calibra
Summary of the content on the page No. 11
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 (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
Summary of the content on the page No. 12
FS-8700-103_ATMI_TGM_Serial Manual Page 12 of 28 4.5. 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 malf
Summary of the content on the page No. 13
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
Summary of the content on the page No. 14
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. If the text matches the ‘Return to Normal’ text then the malfunction is considered as cleared and the Data A
Summary of the content on the page No. 15
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 num
Summary of the content on the page No. 16
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. • Each line is inspected to see if it contains either of the following strings “ALARM RESET" "ALL MALFUNCTIONS CLEAR” • If either is reported then the driver sets al
Summary of the content on the page No. 17
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
Summary of the content on the page No. 18
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 bel
Summary of the content on the page No. 19
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, TGM_Gas_Index_Value, Protocol C2H5OH, 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 o
Summary of the content on the page No. 20
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 mal
