A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-64 ATMI ACM
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
FS-8700-64 ATMI ACM
Page 2 of 22
1. ATMI ACM Description
The ATMI ACM driver allows the FieldServer to transfer data to and from devices over
either RS-232 or RS-485 using ATMI ACM protocol. There are eight RS-232 and two
RS-485 ports standard on the FieldServer. The FieldServer can emulate a passive
client. ( A passive client is one that that consumes messages produced by an remote
device.)
2. Driver Scope of Supply
2.1 Supplied by FieldServer for this driver
FieldServer
Technologies
PART #
DESCRIPTION
FS-8915-10
FS-8915-10
FS-8917-02
FS-8917-01
SPA59132
UTP cable (7 foot) for RS-232 use
UTP cable (7 foot) for Ethernet connection
RJ45 to DB9F Connector adapter
RJ45 to DB25M connection adapter
RS-485 connection adapter
Driver Manual.
2.2 Provided by user
FS-8700-64 ATMI ACM
Page 3 of 22
3. Hardware Connections
The FieldServer is connected to the ATMI ACM Panel as shown below.
Configure the ATMI ACM Panel according to manufacturer’s instructions
ATMI ACM PANEL
COM 2
8917-02
RJ45 CAT 5 Cable
Connect to
RS232 port P1-P8
P1 P2
P3
P4
P5
P6
P7
P8
R1
R2
N1 N2
RS485
10 Base T
ETHERNET
RS232
P1
P2
P3
P4
P5
P6
P7
P8
Rx Tx
R1
Rx Tx
R2
Rx Tx
Net
1
Net
2
Rx Tx Rx Tx Rx Tx Rx Tx Rx Tx Rx Tx Rx Tx
Tx Rx Con Tx Rx Con
FieldServer
8917-02 WIRE LIST
FIELDSERVER
FUNCTION
FROM
TO
COLOR
RX
GND
TX
RJ45-01
RJ45-04
RJ45-08
DB9F-03
DB9F-05
DB9F-02
WHITE
GREEN
BLUE
(408)-262-2299
ATMI - ACM
CONNECTION DIAGRAM
BASE NAME:
FILE NAME: FS-T28700-64 .VSD
DATE: 1/21/02
BY: MN
FS-8700-64 ATMI ACM
Page 4 of 22
4. Configuring the FieldServer as a ATMI ACM Client
The ATMI ACM driver is a passive client driver. This means that it processes unsolicited
incoming data. It cannot poll for data.
For a detailed discussion on FieldServer configuration, please refer to the instruction manual for
the FieldServer. The information that follows describes how to expand upon the factory defaults
provided in the configuration files included with the FieldServer (See “.csv” files on the driver
diskette).
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a ATMI ACM Server.
The configuration file tells the FieldServer about its interfaces, and the routing of data required.
In order to enable the FieldServer for ATMI ACM 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.
4.1 Data Arrays
Section Title
Data_Arrays
Column Title
Data_Array_Name
Function
Provide name for Data Array
Legal Values
Up to 15 alphanumeric
characters
Data_Format
Provide data format. Each data
array can only take on one format.
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte, INT32
Packed_Byte, Swapped_Byte
Gas values should only be
stored in INT32 or FLOAT
arrays.
Data_Array_Length
Number of Data Objects. Must be
larger than the data storage area
required for the data being placed
in this array.
1-10,000
Ensure that the arrays are 16 *
81 elements big.
Data from one ACM can be stored
in multiple data arrays. Position in
the array is dependent on gas
number area number. Further
details are provided in section 6.1
FS-8700-64 ATMI ACM
Example
Page 5 of 22
// Data Arrays
//
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
Data_Format, Data_Array_Length
UInt16,
UInt16,
Bit,
200
200
200
200
DA_DO_01,
Bit,
4.2 Client Side Connections
Section Title
Connections
Column Title
Function
Legal Values
P1-P8, R1-R2
Port
Specify which port the device is
connected to the FieldServer
Specify baud rate
Baud*
110 – 115200, standard baud
rates only
Parity*
Data_Bits*
Specify parity
Specify data bits
Even, Odd, None, Mark, Space
7, 8
Stop_Bits*
Protocol
Specify stop bits
1
Specify protocol used
ATMI
Handshaking*
Poll Delay*
Specify hardware handshaking
Time between internal polls
RTS, RTS/CTS, None
0-32000 seconds
default 1 second
Timeout
Specifies the amount of time that This value should provide a
may pass between complete margin over the time configured
data screens. If this time expires between samples in the
a timeout error is produced but
the processing of data is not
affected. The port is not cleared
and gas data is not reset.
CONFIG.DAT profile of the
ACM unit.
IC_Timeout
This parameter is used in a way This value (specified in
that is different to most
seconds) should be set allow a
FieldServer driver applications.
In this case of this driver it
specifies the maximum amount
of time that may pass between
the driver receiving an incoming
character. If the time is
margin between time stamp
messages from the ACM unit.
exceeded then an error is
produced but note that the error
has no other effect on the driver.
The port is not cleared and gas
data is not reset.
FS-8700-64 ATMI ACM
Page 6 of 22
Example
The following FieldServer settings are suitable for default ACM settings.
// Client Side Connections
Connections
Port, Baud, Parity, Protocol, Handshaking, Poll_Delay
P8, 9600, None, ATMI , None, 0.100s
4.3 Client Side Nodes
Section Title
Nodes
Column Title
Node_Name
Function
Provide name for node
Legal Values
Up to 32 alphanumeric
characters
Node_ID
ACM units do not have a
node ID contained in the
serial data. This field s not
used in the ATMI ACM
driver.
Protocol
Port
Specify protocol used
Specify which port the
device is connected to the
FieldServer
ATMI
P1-P8, R1-R2
Example
// Client Side Nodes
Nodes
Node_Name, Protocol, Port
ACM-1 , ATMI , P8
4.4 Client Side Map Descriptors
4.4.1 FieldServer Specific Map Descriptor Parameters
Column Title
Function
Legal Values
Map_Descriptor_Name
Name of this Map Descriptor Up to 32 alphanumeric
characters
Data_Array_Name
Name of Data Array where
data is to be stored in the
FieldServer
One of the Data Array
names from “Data Array”
section above
Data_Array_Location
Function
Starting location in Data
Array
Function of Client Map
Descriptor
0 to maximum specified in
“Data Array” section above
PASSIVE
FS-8700-64 ATMI ACM
Page 7 of 22
4.4.2 Driver Specific Map Descriptor Parameters
Column Title
Node_Name
Function
Name of Node to fetch data
from
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
0, 1 , 2 , 3
Data_Array_Offset
Length
Position in the data array to
which data should start being
written.
Length of Map Descriptor. The
length is required to help the
driver validate the CSV file.
1 – 1280
Set the length to a multiple of
16. The multiple should be the
maximum area number.
Address
Starting address of read block
0
Driver specific keywords
The following parameters apply only to the AMI ACM driver.
ATMI_Data*
Used to specify which
component of the gas data
structure to store.
Slot-alarm,
Slot-warning,
Slot-combo
Slot-values
You will need one map
descriptor for each
component that you are
interested in storing.
Port-alarm,
Port-warning,
Port-combo
Gas-value, (== Port-values)
Current-Port
Current-Slot
See section 6.9 for more
info.
Malfunctions
4.4.3 Timing Parameters
Column Title
Function
Legal Values
Scan_Interval
Rate at which data is polled
>0.1s
FS-8700-64 ATMI ACM
Page 8 of 22
4.4.4 Map Descriptor Example 1- Gas Values, Alarms & Warnings for all slots/ports.
This example illustrates the map descriptors required to complete store ACM data for 80 areas. Each map descriptor tells the ATMI ACM driver
where to store each component of ACM data. The gas number & area number determine the position in the array. Read section 6.1 for more
information
Map_blocks
Map_block_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Address, Length, protocol, atmi_data
MAP1
MAP2
MAP3
MAP4
MAP5
MAP6
MAP7
MAP8
, DATA1_1
, DATA1_2
, DATA1_3
, DATA1_4
, DATA1_5
, DATA1_6
, DATA1_7
, DATA1_8
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, passive , ACM1
, passive , ACM1
, passive , ACM1
, passive , ACM1
, passive , ACM1
, passive , ACM1
, passive , ACM1
, passive , ACM1
, 0,
, 0,
, 0,
, 0,
, 0,
, 0,
, 0,
, 0,
1280
1280
1280
1280
1280
1280
1280
1280
, ATMI , port-values
, ATMI , port-alarm
, ATMI , port-warning
, ATMI , slot-alarm
, ATMI , slot-warning
, ATMI , slot-combo
, ATMI , port-combo
, ATMI , slot-values
These keywords tell the driver which component of the
ACM data should be
Stored using each map descriptor.
This node name will
connect this map
descriptor to a node
which in turn is
connected to a port.
Hence the map
A different array is
used for each
atmi_data
component being
stored.
This is a passive
client driver so the
function must be
passive.
If you were only interested in the current value then
you would only use one map descriptor and set the
atmi_data parameter equal to gas-value
descriptor is
connected to a port.
The gas value array
would typically be
an array of FLOATs
and the alarms and
warnings could be
any data type
The “…-combo” types store a 1 for an alarm OR
warning and a zero when neither conditionis present.
including bit arrays.
FS-8700-64 ATMI ACM
Page 9 of 22
4.4.5 Map Descriptor Example2 – Gas values for the current (most recent) port sample.
This example illustrates a map descriptors used to store the data from the most recent port sample. The map descriptor stores the following
information :-
1. Port Number
2. Up to 16 gas values (The gas name is not provided) The position in the array is based on the Gas Number.
For example. A port may sample two gasses. The first is Gas #4 and the second may be Gas #2, The driver stores the value of Gas#4 in
array location 4 and stores the value of Gas#2 at array location 2.
The following additional information may also be stored if the DA_Bit_Name & DA_Byte_Name parameters are specified.
3. A bit indicating the number of the port
4. The Alarm/Warning States for each gas
Map_blocks
Map_block_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, protocol, timeout, atmi_data , da_bit_name, da_byte_name
Current_Port_MD, DA_CURR_PORT, 0
, passive , ACM1
, ATMI ,120.0s , current-port, DA_PORT , DA_PORT_ALA
The current port
This keyword tells
If x is the number of the current
port (port most recently
sampled) then the data array
position corresponding to x is
set to 1 and all other elements
are set to zero.
Alarm / Warning Status for each gas is
indicated in this array.
number and up to 16
gas values are stored
in this data array.
the driver to use this
map descriptor to
store the current
If gas x is in alarm then x is used as the
index into the array. E.g. If Gas #1 is in
alarm then the 2nd element of the array
(index=1) is set non-zero.
port’s sample data..
The 1st element
stored is the port
number. The next
16 values stored are
the gas values
(multiplied by 100).
The location is
based on the Gas
Number and not the
row number.
E.g. If Port 1 is the current port
then the 2nd element of the
array (index=1) is set non-zero.
The value of each element indicates
alarm/warning. If the Value is 1 then the
gas in alarm. If the value is two then the
gas is at a warning level.
The array can be any data
format.
If the DA_Bit_Name parameter
is omitted then this data is not
The array format should be capable of
storing a value. If a Bit/Packed_Bit format
is used then you will not be able to
distinguish between an alarm/warning.
If the DA_Byte_Name parameter is
omitted then this data is not stored.
FS-8700-64 ATMI ACM
Page 10 of 22
4.4.6 Map Descriptor Example3 – Storing Malfunction Data
This example illustrates a map descriptor used to store malfunction data reported by the ACM unit. When a malfunction is cleared then 100
elements of the array are set to zero. When a Malfunction is present the 1st element contains the malfunction’s major type, the 2nd element
contains the minor type and element x (x=major*10+minor) is set to a value of 1. Additional information is provided in section 6.7
Map_blocks
Map_block_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, timeout, atmi_data
, length
Malfucntion_MD , DA_MALFNS
, 0
, passive , ACM1
, 120.0s , malfunctions, 100
This keyword tells
the driver to use
this map
descriptor to
malfunction data.
One map
One hundred
elements of this
data array are used
to store
malfunction data.
descriptor is
required per node.
FS-8700-64 ATMI ACM
Page 11 of 22
4.4.7 Map Descriptor Example4 – Gas values for the current (most recent) slot sample.
This example illustrates a map descriptors used to store the data from the most recent slot sample. The map descriptor stores the following
information :-
5. Slot Number
6. Up to 16 gas values (The gas name is not provided) The position in the array is based on the Gas Number.
For example. A slot may sample two gasses. The first is Gas #4 and the second may be Gas #2, The driver stores the value of Gas#4 in
array location 4 and stores the value of Gas#2 at array location 2.
The following additional information may also be stored if the DA_Bit_Name & DA_Byte_Name parameters are specified.
7. A bit indicating the number of the slot
8. The Alarm/Warning States for each gas
Map_blocks
Map_block_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, protocol, timeout, atmi_data , da_bit_name, da_byte_name
Current_Port_MD, DA_CURR_SLOT, 0
, passive , ACM1
, ATMI ,120.0s , current-slot, DA_SLOT , DA_SLOT_ALA
This keyword tells
The current slot
If x is the number of the current
slot (slot most recently
sampled) then the data array
position corresponding to x is
set to 1 and all other elements
are set to zero.
Alarm / Warning Status for each gas is
indicated in this array.
the driver to use this
map descriptor to
store the current
number and up to 16
gas values are stored
in this data array.
If gas x is in alarm then x is used as the
index into the array. E.g. If Gas #1 is in
alarm then the 2nd element of the array
(index=1) is set non-zero.
slot’s sample data..
The 1st element
stored is the slot
number. The next
16 values stored are
the gas values
(multiplied by 100).
The location is
based on the Gas
Number and not the
row number.
E.g. If Slot 1 is the current slot
then the 2nd element of the
array (index=1) is set non-zero.
The value of each element indicates
alarm/warning. If the Value is 1 then the
gas in alarm. If the value is two then the
gas is at a warning level.
The array can be any data
format.
If the DA_Bit_Name parameter
is omitted then this data is not
The array format should be capable of
storing a value. If a Bit/Packed_Bit format
is used then you will not be able to
distinguish between an alarm/warning.
If the DA_Byte_Name parameter is
omitted then this data is not stored.
FS-8700-64 ATMI ACM
Page 12 of 22
5. Configuring the FieldServer as a ATMI ACM Server
The ATMI ACM driver cannot be used as a server.
6. Driver Notes
6.1 Data position in the Data Arrays
To understand how the driver stores data for the current port, read the notes provided with map-
descriptor example 2 as the following notes do not apply.
To understand how the driver stores data for malfunctions, read the notes provided with map-
descriptor example 3 as the following notes do not apply.
For each component stored the values are stored as a one-dimensional array. Data storage is
zero referenced. This means that the first area or first gas is stored in the first location, which
has an index of zero. To find the element of interest use the following formula.
Port Alarm / Warnings / Gas Values Data Array locations
Port_Index = (Gas_number-1) + 16 * ( Area_Number – 1 )
‘Area’ and ‘Port’ are synonyms.
Example. If you wish to know the Data Array index for gas #7 of area 11
Index = (7-1) + 16 * ( 10 – 1 ) = 166
Example. If you wish to know the Data Array index for the 7th gas of area
11
Index = 7 + 16 * ( 10 – 1 ) = 167.
Slot Alarm / Warnings / Values Data Array locations
Slot_Index = (Gas_number-1) + 16 * ( Slot_Number – 1 )
Example. The Data Array location for gas #12 of Slot 4
Index = (12-1) + ( 4 – 1 ) * 16 = 59
FS-8700-64 ATMI ACM
6.2 Driver Stats
Page 13 of 22
The ATMI ACM Driver counts all incoming bytes as the ‘PLC Byte Received’ statistic. This can
be viewed on the connection detail and overview screen. Typically this count will increase by
approx 2500 bytes per full screen of area data.
IN addition the driver reports one count of ‘PLC READ MSG RECD’ statistic for each map
descriptor used to store information from a complete message. Typically this count will increase
by 5 if you are storing l slot & port alarms & warnings and the gas value.
If a complete message is received but no map descriptor is found to store any of the data the
data then the MSG IGNORED statistic will be incremented by one.
6.3 Exposing Driver Stats
IN addition to the normal FieldServer statistics this driver can expose some statistics and
diagnotic information in a data rray so that it may be read or reset by a remote device.
A special map descriptor is required. The driver recognizes the map descriptor by its name
which must be "ATMI-stats" .
The following example shows how this special map descriptor can be configured.
Nodes
Node_name, Protocol
null_node, ATMI
Data_Arrays
Data_Array_Name , Data_Format, Data_Array_Length
STAT-DATA
, UINT32 , 400
Map_blocks
Map_block_Name, Data_Array_Name, Node_name
ATMI-stats , STAT_DATA , null_node
When the driver sees this map descriptor it uses the data array STAT_DATA (in this example)
to store driver specific statistics. Only one of these map descriptors may be specified per
FieldServer.
The array position is dependent on the port number. The offset is calculated by multiply the port
number by 30. Thus port 2 data will start at element 60.
FS-8700-64 ATMI ACM
Page 14 of 22
The driver stores the following data.
Array
Contents
Element
(offset
dependent
on port
number)
0
Not Used
1
2
ATMI_STAT_SCAN1
FieldServer Tech Support diagnostic.
FieldServer Tech Support diagnostic.
Screen decoding abandoned because
the area number was unintelligible (>
80)
Driver has found an end-of-screen
identifier.
FieldServer Tech Support diagnostic.
The line number was unintelligible ( >
25 ).
FieldServer Tech Support diagnostic.
The collection function returned an
error. Row or Column were inconsistent.
FieldServer Tech Support diagnostic. A
start-of-screen identifier was found
before whilst processing screen data.
Equivalent to the error light on the ATMI
ZD80 processor.
A start of screen identifier has been
found.
A new line of screen data has been
identified.
ATMI_STAT_DECODE1
ATMI_STAT_FINIS
3
4
ATMI_STAT_COLLECT1
ATMI_STAT_COLLECT2
5
6
ATMI_STAT_COLLECT3
ATMI_STAT_ERRORLIGHT
ATMI_STAT_START
ATMI_STAT_LF
7
8
9
10
FieldServer Tech Support diagnostic.
The collection function returned an
error. Row was inconsistent.
FieldServer Tech Support diagnostic.
The collection function returned an
error. Column was inconsistent.
A time greater than the port timeout has
elapsed since the last complete screen
full of data.
A time greater than the port’s inter
character timeout (ic_timeout) has
passed since the driver last received a
new character from the ACM unit.
The number of ACM data byte
processed
ATMI_STAT_ERRORLIGHT1
ATMI_STAT_ERRORLIGHT2
ATMI_STAT_TIMEOUT
11
12
13
ATMI_STAT_ICTIMEOUT
ATMI_STAT_BYTECOUNT
ATMI_STAT_STREAMING
14
15
16
The number of streaming (buffer
overflow) errors.
When processing the most recent
message, at least one map descriptor
was found with which to store data.
ATMI_STAT_STORE_LASTMAPDESCP
FS-8700-64 ATMI ACM
Page 15 of 22
17
When processing the most recent
message, no map descriptors were
found to tell the driver how to store the
incoming data.
ATMI_STAT_STORE_NO_MAP
18
Increment’s once for each time data is
stored. Ie will increase by 5 for one
screen full of data stored using 5 map
descriptors.
ATMI_STAT_STORE
19
20
21
22
Will increase by one for each screen full
of data processed in which at least one
gas value was non-zero.
Count of the number of times that a
malfunction’s major type could not be
ATMI_STAT_STORE_NONZERO
ATMI_STAT_MALFN_BAD_MAJOR recognized.
Count of the number of times that a
malfunction’s minor type could not be
recognized.
Count of the number of times that the
buffer overflowed when analyzing
malfunction data. Each time this
happens the malfunction is not stored.
ATMI_STAT_MALFN_BAD_MINOR
ATMI_STAT_MALFN_STREAMING
6.4 Driver Error Messages
The following error messages should be reported to FieldServer Technologies.
ATMI:#4 Error. atmi_chan_init() Init with null chan.
The following errors indicate a driver, connection or remote device problem if they occur
frequently.
ATMI:#8 Error. Discard because area=%d max=%d
Incoming data has been discarded because the driver could not resolve a valid area number.
The following error messages or warning arise from problems that can normally be
resolved by users without support from FieldServer Technologies.
ATMI:#7 Error. No read/writes permitted. Mapdesc=<%s>
Edit the CSV file. Change the map descriptor function to passive. Reset the FieldServer.
ATMI:#1 FYI. Some data is being abandoned. Mapdesc too short. <%s>
Edit the CSV file. Increase the map descriptor’s length to allow the driver to process the
maximum data area. Not each data area requires 16 storage elements. Reset the FieldServer.
This message is only printed once even if the error occurs more than once.
ATMI:#2 FYI. Some data is being abandoned. Array too short. <%s>
Edit the CSV file. Increase the Map Descriptor’s data array length. Reset the FieldServer. This
message is only printed once even if the error occurs more than once.
FS-8700-64 ATMI ACM
Page 16 of 22
ATMI:#3 Error. Incoming data on port=%d is being abandoned. MapDesc rqd.
No map descriptors were found on the indicated port with which the driver could store the
incoming data. Change the CSV file and reset the FieldServer. This message is only printed
once even if the error occurs more than once.
ATMI:#6 FYI. The mapDesc called <%s> is too short.
Edit the CSV file. Increase the length of the map desc and reset the FieldServer.
ATMI:#5 FYI. You could have used a mapDesc called <%s> to expose diagnostic info.
No action I s required. Read section 6.3 for more information..
*ATMI:#9 Err. Mapdesc=<%s> data array=<%s> too short
The data array associated with the map descriptor being used to store ‘current port‘ data is too
short. Increase the length of the data array (not the length of the map descriptor) to at least 17.
For malfunction map descriptors set the length to at least 100. Edit the CSV file, make the
change and then reset the bridge.
*ATMI:#10 Err. Mapdesc=<%s> data array=<%s> too short
The data array defined by the DA_Bit_Name parameter associated with the map descriptor
being used to store ‘current port‘ data is too short. Increase the length of the data array (not the
length of the map descriptor) to at least 90. Edit the CSV file, make the change and then reset
the bridge.
*ATMI:#11 Err. Mapdesc=<%s> data array=<%s> too short
The data array defined by the DA_Byte_Name parameter associated with the map descriptor
being used to store ‘current port‘ data is too short. Increase the length of the data array (not the
length of the map descriptor) to at least 90. Edit the CSV file, make the change and then reset
the bridge.
2Mapdesc=<%s> Gas#=%d. Too big.The driver is trying to store the the current port’s gas data.
A Gas number larger than 16 has been found. It cannot be stored and has been discarded.
Your ACM may need re-configuring. Changing the driver configuration will not correct this
problem. Report this error to ATMI.*These messages are produce once only and then
suppressed so that they do not fill the error log every by being re-printed every time a new
message is processed. A consequence of this, is that, if the error occurs more than once in a
configuration, the second and subsequent occurrences will not be revealed until the first has
been corrected.
*ATMI:#13 Error. Illegal Map Descriptor length - defaulting to 1
FS-8700-64 ATMI ACM
Page 17 of 22
6.5 Timeouts
See section 4.2 for information on how timeouts should be specified.
Occasional timeouts may be expected when there are noisy messages or if the ACM device has
been locked. Timeouts do not stop the driver processing the next valid screen of data.
6.6 Demand & Lock Scan
The driver can process data from demand and locked scans. Incoming data is processed in the
same way as normal scans and stored using the same map descriptors.
6.7 Malfunctions
The driver can process malfunctions reported by the ACM unit.
When a malfunction is cleared then the driver sets all (1st 100) of the malfunction data array
elements to zero A malfunction is considered cleared when a normal scan is processed.
When a malfunction is recognized the driver stores data in the following locations.
1st Element : Major type of the malfunction ( as a number )
2nd Element : Minor type of the malfunction. (as a number )
And
Element x :
Value set to 1.
X = major * 10 + minor
This additional data element is provided so that relays / indicating lamps in a downstream
device can be set without additional logic.
The driver uses the keyword ‘MALFUNCTION’ to recognize ACM malfunctions. If the ACM
firmware is changed and this keyword is no longer produced then the driver will no longer
recognize malfunctions.
If the driver recognizes that there is a malfunction but cannot interpret the malfunction type then
the major and/or minor types are set to a value of 99 and element x is not set at all.
The table below shows malfunction’s major and minor types.
FS-8700-64 ATMI ACM
Page 18 of 22
Malfunction Major Type
Mafunction Minor Type
1. INADEQUATE BYPASS FLOW 0.
1.TEMP_LOW
2. TEMP_HIGH
3. LOSS_OF_NH3_FLOW
2. EMERGENCY SWITCH
CLOSURE
3. FAILED LEAK CHECK
0.
4. DSP FAILURE in module
5. FAILURE to get interferogram
0.
1. Bench timeout
2. Bench short scan
3. Zero ZPD value or address
4. Bench reports Bad Scan
5. Bench DREQ stuck TRUE
6. Energy (ZPD) address out of
range
7. energy (ZPD) value too high
8. energy (ZPD) value too low
9. DSP reports bad scan
6.8 Gas Values & Scaling
The driver stores all gas values after multiplying them by 100. This allows the driver to store
values in arrays with formats other than floats without losing the precision provided by the ACM
unit. This is done because some downstream devices’ and protocols cannot handle floating
point numbers. This may not suite you in which case you will need to use scaling.
These parameter keywords should be added to each CSV Map Descriptor definition.
…..Data_Array_Low_Scale,
Device_High_Scale…….
Data_Array_High_Scale,
Device_Low_Scale,
To store the actual values reported by the ACM unit you should use the following values :
…..Data_Array_Low_Scale,
Device_High_Scale…….
…..0
Data_Array_High_Scale,
, 0
Device_Low_Scale,
, 100…..
, 1
6.9 Alarms and/or Warnings
The following list are valid entries in specifying the ATMI_Data parameter in the csv file.
Slot-alarm,
Slot-warning,
Slot-combo
Port-alarm,
Port-warning,
Port-combo
FS-8700-64 ATMI ACM
Page 19 of 22
When you use a “…-alarm” keyword then the driver stores a 1 when the gas is in an alarm
condition and a zero when it is not in alarm condition. This means a zero is stored even if the
gas in a warning condition.
When you use a “…-warning” keyword then the driver stores a 1 when the gas is in a warning
condition and a zero when it is not in warning condition. This means a zero is stored even if the
gas in an alarm condition as well as when the gas is in a normal condition.
When you use a “….-combo” keyword then the driver stores a 1 whether the gas is in an alarm
OR warning condition and the driver stores a zero when the gas is in neither an an alarm or
warning state.
6.10 Current Slot
Current slot information is the same as current port information. On a Normal Scan, a single
slot is referenced. The gas values/warnings/alarms will be stored to the current slot data arrays
every time slot information is stored. Note, this only occurs once during any Normal Slot Scan
image.
6.11 Composite Validation Scan vs Normal Slot Scan
On a Normal Slot Scan Image, gas data is stored to the "slot" value/warning/alarm data arrays
and the "port" value/warning/alarm data arrays. If more than one port (area) is referenced in the
image, then the same value/warning/alarm gas data is copied to each section of the area "data
array". For example, if Areas 2 and 39 were referenced, then the gas data values and
warning/alarm status would be copied twice to the data array offset for Area 2 and the offset for
Area 39.
On a Composite Validation Image, only one area (port) should be referenced. The gas
values/warnings/alarms for the particular area referenced will be updated. As well the current
port data values will also be updated. Note, on Composite Validation Images, slot information is
not updated.
FS-8700-64 ATMI ACM
7. Revision Control
Page 20 of 22
Date
Rev
Resp
Description
1.01a Rev1 PMC
This revision and all previous revisions did not have a
revision control section.
1.01a Rev
2
PMC
This issue of the manual corresponds to the release of
driver version 1.01a in which functionality was added to
store the current port sample’s data separately.
The following sections of this manual have been
amended.
•
Section 1.
client /server.
Driver previously described as
•
•
•
•
•
Section 4.4.2 New keyword
Section 4.4.4 Title Changed
Section 4.4.5 New example
Section 6.1
Section 6.4
Amended
Error messages 9,10,11 added.
1.01b Rev
0
•
•
•
•
•
•
Section 4.4.2 New keyword
Section 4.4.6 New example
Section 6.1
Section 6.3
Section 6.4
Section 6.7
Amended
New stats 20-22
Amended notes for msg #9.
New Section
101c Rev0
102a Rev0
Section 4.4.5
Corrections and additional notes to
describe storage of gas values
based on sample number.
New notes on scaling. Prior to revision
Section 6.8
1.01c of the driver this feature did not operate and all
values were stored 100 times too large.
Section 4.4.2
New valid keywords for ATMI_Data
parameter. “port-combo” and “slot-
combo”
Section 4.4.4
Section 6.9
Modified example to illustrate use
of “…-combo” keywords.
New section on ATMI_Data parameter.
FS-8700-64 ATMI ACM
Page 21 of 22
10Feb03
1.03a Rev
0
PMC
Section 4.4.2
New keywords. Added slot-values and port-
values (as synonym for gas-values)
Section 6.1
Calculation of Data Array offsets
Section 7
Consolidated the revision information into a
table.
TOC
Updated Table of Contents
9Apr03
1.04aRev 0 DNC
Section 4.4.2
Added new key word "Current-Slot"
Section 4.4.7
Added Current-Slot example
Section 6.10
Added section discussing current slot
information
Section 6.11
Added section discussing Composite
Validation Scan handling, and Normal Scan
Driver Enhancement:
1. On normal scan, driver will save
values/warns/alarms for up to 4 ports per screen
2. On a decomposed screens port data will be updated
for port that was referenced, no changed to slot info
3. Current slot info implemented. Data references last
update to slot info.
10Apr03
21July03
1.04aRev1 DNC
1.04Rev1 JDM
-updated error numbers
Releasing
|