FieldServer FS-8700-52 User Manual

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-52 Notifier AM6000

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after May 1, 2001

Instruction Manual Part Number FS-8700-52

5/22/2002

FS-8700-52 Notifier A M6000 Driver Manual

TABLE OF CONTENTS

1. NOTIFIER AM6000 D ESCRIPTION............................................................................................................................1

2. DRIVER SCOPE OF SUPPLY........................................................................................................................................2

2.1 SUPPLIED BY FIELDSERVER FOR THIS DRIVER...............................................................................................................2

2.2 PROVIDED BY USER .............................................................................................ERROR! BOOKMARK NOT DEFINED.

3. HARDWARE CONNECTIONS......................................................................................................................................3

4. CONFIGURING THE FIELDSERVER AS A NOTIFIER AM6000 CLIENT .................................................4

4.1 DATA ARRAYS....................................................................................................................................................................4

4.2 CLIENT SIDE NODES..........................................................................................................................................................5

4.3 CLIENT SIDE MAP DESCRIPTORS.....................................................................................................................................6

4.3.1 FieldServer Specific Map Descriptor Parameters.............................................................................................6

4.3.2 Driver Specific Map Descriptor Parameters......................................................................................................6

4.3.3 Timing Parameters..................................................................................................................................................7

Map Descriptor Example......................................................................................................................................................8

5. DRIVER NOTES ...............................................................................................................................................................10

5.1 MAP DESCRIPTOR KEYWORDS .......................................................................................................................................10

5.1.1 AM6000_TypeID...................................................................................................................................................10

5.1.2 AM6000_Status......................................................................................................................................................11

5.1.3 AM6000_Ackable ..................................................................................................................................................11

5.1.4 AM6000_Simulation..............................................................................................................................................11

5.2 STATISTICS........................................................................................................................................................................12

5.3 LISTING OF SYSTEM TROUBLE MESSAGES...................................................................................................................15

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262 -2299 fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page Index

FS-8700-52 Notifier A M6000 Driver Manual

1. Notifier AM6000 Description

The Notifier AM6000 driver is a seial driver. It allows the FieldServer to transfer data from a Notifier
AM6000 panel over either RS232 or RS485 using Notifier AM6000 protocol. There are eight RS232 and
two RS485 ports standard on the FieldServer. The FieldServer can only a passive Client.

The driver receives messages intended for a system printer, interprets these messages by filling in data
arrays in the FieldServer. This data is available for other devices or PLC's to read.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 1

FS-8700-52 Notifier A M6000 Driver Manual

2. Driver Scope of Supply

2.1 Supplied by FieldServer for this driver

FieldServer

Technologies

PART #

8915-10 UTP cable (7 foot) for RS232 use

UTP cable (7 foot) for Ethernet connection
8917-02 RJ45 to DB9F Connector adapter
8917-01 RJ45 to DB25M connection adapter

SPA59132 RS485 connection adapter

Driver Manual.

DESCRIPTION

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 2

FS-8700-52 Notifier A M6000 Driver Manual

3. Hardware Connections

Configure the Notifier AM6000 according to manufacturer’s instructions.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 3

FS-8700-52 Notifier A M6000 Driver Manual

4. Configuring the FieldServer as a Notifier AM6000 Client

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 Notifier AM6000 Server.

The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order
to enable the FieldServer for Notifier AM6000 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 Function Legal Values

Data_Array_Name Provide name for Data Array Up to 15 alphanumeric characters
Data_Format Provide data format. Each data array

can only take on one format.

Data_Array_Length Number of Data Objects. Must be larger

than the data storage area required for
the data being placed in this array.

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

FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte, Packed_Byte,
Swapped_Byte

1-10,000

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 4

FS-8700-52 Notifier A M6000 Driver Manual

4.2 Client Side Connections

Section Title

Connections

Column Title Function Legal Values

Port Specify which port the device is

connected to the FieldServer

Baud* Specify baud rate 2400 (Only baud rate supported by

Parity* Specify parity Even
Data_Bits* Specify data bits 7

Stop_Bits* Specify stop bits
Protocol Specify protocol used AM6000
Handshaking* Specify hardware handshaking

Poll Delay* Time between internal polls 0-32000 seconds

Example

// Client Side Connections

Connections
Port, Baud, Parity, Protocol, Data_bits, Handshaking, Poll_Delay
P8, 2400, Even, AM6000, 7, None, 0.100s

P1-P8, R1-R2

the Notifier port)

1

None
default 1 second

4.3 Client Side Nodes

Section Title

Nodes

Column Title Function Legal Values

Node_Name Provide name for node Up to 32 alphanumeric characters
Node_ID Modbus station address of physical

server node
Protocol Specify protocol used Modbus_RTU, Modbus/TCP, etc.
Port Specify which port the device is

connected to the FieldServer

Example

// Client Side Nodes

Nodes
Node_Name, Protocol, Port
Panel1, AM6000, P8

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 5

1-255

P1-P8, R1-R2

FS-8700-52 Notifier A M6000 Driver Manual

4.4 Client Side Map Descriptors

4.4.1 FieldSe rver 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

Data_Array_Location Starting location in Data Array 0 to maximum specified in “Data

Function Function of Client Map Descriptor Passive

4.4.2 Driver Specific Map Descriptor Parameters

Column Title Function Legal Values

Node_Name Name of Node to fetch data from One of the node names

Data_Type Data type Register, Coil, AI, DI
Length Length of Map Descriptor. This value is important

when a 'Block Ack' message is received as it tells
the driver how much of the data array to zeroise.

Address Loop/Device Address

In the format mmnn where mm is the loop number
and nn is the device number. Together they forma a

composite device number.
AM6000 Driver
specific parameters &

keywords.
Am6000_typeID Used to differentiate between device and system

Am6000_Status Allows direction of alarm or trouble states to

AM6000_Ackable Tells the driver that the data area of this mapdesc

Am6000_simulation Provided for debugging and test purposes only.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

type messages.

different data arrays.

must be Zeroised when a block ack is received.

Tells the driver which debug message to send. This

parameter is for use by FieldServer Technologies

only.

Page 6

One of the Data Array names from
“Data Array” section above

Array” section above

specified in “Client
Node Descriptor” above

1 - 1000

501, 302

Device-only,
System_trbl,
device&type.
system-Styl2,
catch-all

Additional notes are
provided in section 5.1

Any, Alarm, trouble,
erase, on , eraseon

Additional notes are
provided in section 5.2
Additional notes are
provided in section 5.3

FS-8700-52 Notifier A M6000 Driver Manual

4.4.3 Timing Parameters
Column Title Function Legal Values

Scan_Interval Rate at which data is polled >0.1s

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 7

FS-8700-52 Notifier A M6000 Driver Manual

All map

descriptors for the

AM6000 Notifier

passive.

This keyword indicates that

this map descriptor will only

Connects this

map descriptor

whose name is

port.

The range of

determined by this

parameter.

Because address is

devices 500 to 599

Acknowledge

Reset message is received

4.4.4 Map Descriptor Example.

Name of the data
array that will be
updated when this
map descriptor is
used.

Map_block_Name, scan_interval, Data_Array_Name, Data_Array_Offset, Function, node_name, AM6000_TypeID, Address , Length , am6000_Ackable
DEVICES_100_199, 1.0s, DEVICE_STATES_LOOP1, 0, passive, node_a, device-only, 500 , 100 , Yes

The position in the data
array that corresponds to
device whose number is
equal to the Address
Parameter.

In this example device
500's state will be strored
in the 0th element of the
data array called

DEVICE_STATES_LOOP1

driver must be

device address is

500 and length is
100 in this
example all

will be

When a Block

to a node

'node_a' and
thus connects
the map
descriptor to a

be used to process device
state messages. This makes
the address and length
parameters very important.

The device address of the first
device to be processed by this map
descriptor. Devices are allocated to
loops. The device address consists
of a mmnn format where mm is the
loop number and nn is the device
number.

In this example the address is set to
500 this indicated that the first
device to be processed by this map
desc. Is on loop 5 and is device
zero.

the driver will set the
portion of the data array
DEVICE_STATES_LOO
P1 starting at
Data_Array_Offset for
Length number of
elements to zero.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 8

or System

FS-8700-52 Notifier A M6000 Driver Manual

Name of the data

All ma

p

descriptors for the

AM6000 Notifier

passive.

When a Block

Acknowledge

System Trouble Messages are

for

Thus when system trouble message

array that will be
updated when this
map descriptor is
used.

driver must be

Reset message is
received the driver will
set the portion of the
data array
DEVICE_STATES_LO

or System

OP1 starting at
Data_Array_Offset for
Length number of

elements to zero.

Map_block_Name,scan_interval, Data_Array_Name, Data_Array_Offset, Function, node_name, AM6000_TypeID, Length , am6000_Ackabl
MD1, 1.0s, SYSTEM_TROUBLES2, 5, passive, node_a, system-styl2, 50 , Yes

processed using this map
descriptor. Only one map
descriptor like this is necessary
a whole system.

This indicates Style2 is being used.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

number n is processed the nth
element of data array starting at
location 5 (this example) will be

set to 1.

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 9

FS-8700-52 Notifier A M6000 Driver Manual

5. Driver Notes

5.1 Map Descriptor Keywords

5.1.1 AM6000_TypeID

This keyword sets up a category of messages. If you are interested in device state's use the
keyword device-only. If you are interested in system trouble messages use the keyword system-

trbl (An alternate method for reporting system trouble messages is provided using the keyword
system-styl2. )

device-only

Only device based messages are processed using map descriptors with this keyword. The Address
and Length parameters define the range of devices processed using the map descriptor. A device
address consists of a loop and device number. This driver treats the two parts as a single device
address. Thus loop 5 device 2 becomes address 502 for this driver and a map descriptor with an
address of 500 and a length of 100 would process a message from device 2 on loop 5.

system-trbl
System Trouble messages are processed a numeric value is stored in the first element of the map

descriptor's data array. If a new system trouble message is processed then the value is overwritten
with the new value.

system-styl2
This is an alternate style for processing System Trouble messages. If system trouble message

whose index in the list below is n is received then the nth element of the data array is set to one.
Make sure the length parameter is set to a t least 50.

Catch-all

The use of this keyword is described in section 5.2

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 10

FS-8700-52 Notifier A M6000 Driver Manual

5.1.2 AM6000_Status

Device state messages report a number of different states for the device. These states are refered
to as the device status.

The following are possible values of this parameter. Any, alarm, trouble, on, erase, eraseon.
If you do not use this parameter in a device-only map descriptor then the driver uses the default

value of Any. This means that any device state message will result in the same data array being
updated. Thus a trouble/on/alarm message will result in the array being set to a 1.

If you want to maintain separate array's for each state the you use this parameter. For one device
address range you would have multiple map descriptors, each with a different AM6000_Status
keyword.

You should note that the keyword, erase, results in the data array value being set to zero when a
message reports the device state as 'ERASE'. The keyword eraseon sets the value to one, when
the same message is received.

5.1.3 AM6000_Ackable

This parameter tells the driver that the data array portion associated with this map descriptor can
be set to zero when a Block Acknowledge or System Reset message is received.

You set this parameter to one of the following legal keywords: yes, no.

The Data_Array_Location and Length parameters are used to determine what portion of the
associated data array must be set to zero.

5.1.4 AM6000_Simulation

This keyword is for used by FieldServer Technologies Engineers and is used for testing this
driver.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 11

FS-8700-52 Notifier A M6000 Driver Manual

Count of received messages

received message is 82 bytes

long and thus if all messages

This indicates the number of

System Reset' message have

Ack' message was received a

5.2 Statistics

This driver does not keep statistics for each map descriptor. Statistics are maintained for the
connection to the Am6000 Notifier device.

and bytes. A complete

are received correctly the
byte count should be a

multiple of 82.

times a 'Block Ack' or
'
been applied.

If you have 5 'Ackable' map
descriptors and one 'Block

count of 5 would be
reported. (One message
applied 5 times).

You will need to count the
number of 'ackable' map
descriptors to use this

statistic meaningfully.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 12

FS-8700-52 Notifier A M6000 Driver Manual

This statistic indicates the number of messages th

at

were received but were ignored by the driver.
Messages are ignored for one of two reasons. Firstly,
the driver might not understand the message and
secondly because the driver doesn't know what to do

with the data from the message.

Ignored Messages

Ignored messages are very important since they do not result in the data arrays being updated.
Messages are ignored for one of two reasons.

Firstly, the driver might not understand the message and secondly because the driver doesn't
know what to do with the data from the message. The messa ge t may contain a keyword or be
formatted in a way that cannot be understood.. It may be the case that the equipment
manufacturer adds new features to the protocol. FieldServer Technologies needs to be informed
of any such messages so that this driver can be updated.

Secondly, you may have omitted to define a map descriptor which tells the driver what to do with
the data from an incoming message. For example, say a map descriptor is defined for address 501
with a length of 50 but a message is received from device 575. Clearly the map descriptor's
device address range does not extend ass far as 575 and thus the driver doesn't know where to
store device 575's data.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 13

FS-8700-52 Notifier A M6000 Driver Manual

Catching Ignored Messages

To assist you catch and monitor ignored messages the driver provides a special map descriptor
keyword.

Make a map descriptor and set the parameter AM6000_TypeID 's value to Catch-All. Make sure
that this is the last map descriptor in the csv file. The map descriptor requires a data length of at
least 82 and when us ing RUI_Debug you should view the data array in <S>tring mode.

The driver will place any ignored messages in this buffer. You will be able to read the message in
<S>tring mode an make a decision on the necessary corrective action. If there are multiple
messages being ignored the buffer will be overwritten.

You could use your PLC / control device / Scada to monitor the first byte of this data array and
generate an alarm if the value is non-zero. Thus, even though a message has been ignored you
system will know about it.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 14

FS-8700-52 Notifier A M6000 Driver Manual

5.3 Listing of System Trouble Messages

Msg Index Message

0 !!! ILLEGAL !!!
1 MAINS TROUBLE
2 POWER LOW ON MAIN SUPPLY
3 POWER LOW ON AUXILIARY SUPPLY
4 POWER LOW ON BATTERY -CHARGER
5 POWER OVERVOLTAGE ON MAIN SU PPLY
6 POWER OVERVOLTAGE ON BATTERY -CHARGER
7 FAILURE OR OVERLOAD ON MAIN SUPPLY
8 FAILURE OR OVERLOAD ON AUXIL. SUPPLY

9 FAILURE ON BATTERY -CHARGER
10 DISCONNEC. BATT. OR FUSE FAILURE
11 BATTERY EXHAUSTED
12 BATTERY CHARGER UNBALANCED
13 AUX. SUPPLY DISCONNECTED
14 AUX. SUPPLY USER FUSE
15 MAIN SUPPLY USER FUSE
16 SIREN FUSE
17 EARTH TROUBLE
18 SIREN SUPERV.LINE INTERRUPTED
19 BATTERY FAILURE
20 WIRE CUT ON LINE
21 SHORT CIRCUIT ON LINE
22 PRINTER: OFF LINE/BUFFER FULL/PAPER END
23 COMMUNICATION ERROR ON
24 LOW VOLTAGE ON LINE
25 SIDE A OPEN ON LINE
26 SIDE B OPEN ON LINE
27 SYSTEM KEYPAD TROUBLE
28 INTERNAL PROGR.ENABLING JUMPER :ENABLED
29 SYSTEM START UP
30 CPU RESET OR WATCH -DOG FAILURE
31 CRT-TERMINAL : OFF-LINE
32 FLASH MEMORY ERROR ON
33 SIREN SUPERV.LINE
34 LINE
35 ANNUNC.

FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 [phone] fax: [phone]

Visit our website: www.fieldserver.com E-mail: [e-mail]

Page 15