FieldServer FS-8700-103 Driver Manual

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

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: [email protected] 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 2.2. Provided by the Supplier of 3rd Party Equipment..........................................................4 2.2.1. Required 3rd Party Hardware.....................................................................................4 2.2.2. Required 3rd Party Configuration...............................................................................4 3. HARDWARE CONNECTIONS ..........................................................................................5 3.1. Hardware Connection Tips / Hints................................................................................6 4. CONFIGURING THE FIELDSERVER AS A ATMI TGM SERIAL CLIENT.......................7 4.1. Data Arrays/Descriptors ...............................................................................................7 4.2. Client Side Connection Descriptions ............................................................................8 4.3. Client Side Node Descriptors .......................................................................................8 4.4. Client Side Map Descriptors .........................................................................................9 4.4.1. FieldServer Related Map Descriptor Parameters......................................................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 TOPICS ......................................................................................16 Appendix B.1. How Malfunctions are determined and stored...............................................16 Appendix B.2. How Gas Data is Stored................................................................................17 Appendix B.3. Adding/Modifying Gas Concentration Value Engineering Units ....................18 Appendix B.4. Adding / Modifying Hard Coded Gas Names ................................................18 Appendix B.5. Adding / Modifying Malfunction Strings .........................................................19 Appendix B.6. Adding / Modifying ‘Return to Normal’ Strings...............................................20 Appendix B.7. Using the TGM’s Config.dat file to customize malfunctions ..........................20 Appendix B.8. Synchronizing Malfunctions...........................................................................21 APPENDIX C. DRIVER ERROR MESSAGES ........................................................................22 Appendix C.1. Exposing Driver Operating Statistics.............................................................25 APPENDIX D. TROUBLESHOOTING TIPS............................................................................27 Appendix D.1. Connection Tips & Hints................................................................................27

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: [email protected] 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 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 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 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: [email protected] 2. Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # Description FS-8917-12 Connector, 9-pin female: 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 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: [email protected] 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