FieldServer FS-8700-103 User Manual

-

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

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

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: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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 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: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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
PART #

FS-8917-12

Description

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: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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 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: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

Data_Array_Name Provide name for Data Array

Data_Array_Format

Data_Array_Length

Example

// Data Arrays
Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length
DA_AI_01, UInt16, 200
DA_AO_01, UInt16, 200
DA_DI_01, Bit, 200

DA_DO_01, Bit, 200

Provide data format. Each Data
Array can only take on one format.

Number of Data Objects. Must be
larger than the data storage area
required by the Map Descriptors for
the data being placed in this array.

Up to 15 alphanumeric
characters
Float, Bit, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte

1-10,000

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

Port

Protocol Specify protocol used TGM-Serial, ATMI-TGM-Serial

Baud* Specify baud rate

Parity* Specify parity None (Vendor limitation)
Data_Bits* Specify data bits 8 (Vendor limitation)

Stop_Bits* Specify stop bits
Handshaking* Specify hardware handshaking

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

Specify which port the device is
connected to the FieldServer

P1-P8, R1-R21

110 – 19200, standard baud
rates only (Vendor limitation)

1
None

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

Protocol Specify protocol used TGM-Serial, ATMI-TGM-Serial

Connection

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.

intend to use the Node_Status
function with a Data Array then
the Node_ID must be specified.

Specify which port the device is
connected to the FieldServer

1-255

P1-P8, R1-R21

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

Map_Descriptor_Name Name of this Map Descriptor

Name of Data Array where

Data_Array_Name

Data_Array_Offset Starting location in Data Array

Function

data is to be stored in the
FieldServer

Function of Client Map
Descriptor. The driver cannot
write to the TGM device.

Up to 32 alphanumeric
characters
One of the Data Array
names from “Data Array”
section above
0 to maximum specified in
“Data Array” section above

RDBC, ARS

4.4.2. Driver Related Map Descriptor Parameters

Column

Title

Node_Name Name of Node to fetch data from

Data_Type This commonly used driver parameter is not used by the driver.

Length of Map Descriptor

The parameter is not used by

Length

Address This commonly used parameter is ignored by the driver.

the driver but is used by the
FieldServer Kernel to reserve
space in the Data Array.

Set the Length according to the
function.

Function Legal Values

One of the node names specified in
“Client Node Descriptor” above

QIR Report: Length = 100

CALR Report: Variable. Depends on
number of gases reported in CALR
report. Start with a length of 100 and
increase if necessary.

QLA Report:

If the config has no sensors and port
x is the max port number, then make
the array (x+1) * 10 elements long

If the config has any sensors and
sensor x is the max sensor number
then make the array 200 + (x+1) *
10 elements long

4.4.3. Timing Parameters

Column Title Function

Rate at which data is polled
For CALR report use a long interval (600s) as the TGM

Scan_Interval

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

configuration seldom changes.
Set the Scan_Interval for the QLA and QIR reports to zero
to have the driver poll for this data as often as possible.

Legal

Values

≥0.001s