FieldServer FS-8700-52 Computer Drive 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 AM6000
Driver Manual
TABLE OF CONTENTS
1.
NOTIFIER AM6000 DESCRIPTION............................................................................................................................1
2.
DRIVER SCOPE OF S UPPLY........................................................................................................................................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 A RRAYS.................................................................................................................................................................... 4
4.2 CLIENT SIDE NODES.......................................................................................................................................................... 5
4.3 CLIENT SIDE M AP 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 M AP 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: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page Index
FS-8700-52 Notifier AM6000
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 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 1
FS-8700-52 Notifier AM6000
Driver Manual
2. Driver Scope of Supply
2.1
Supplied by FieldServer for this driver
FieldServer
Technologies
PART #
8915-10
8917-02
8917-01
SPA59132
DESCRIPTION
UTP cable (7 foot) for RS232 use
UTP cable (7 foot) for Ethernet connection
RJ45 to DB9F Connector adapter
RJ45 to DB25M connection adapter
RS485 connection adapter
Driver Manual.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 2
FS-8700-52 Notifier AM6000
Driver Manual
3. Hardware Connections
Configure the Notifier AM6000 according to manufacturer’s instructions.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 3
FS-8700-52 Notifier AM6000
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
Data_Array_Name
Data_Format
Data_Array_Length
Function
Provide name for Data Array
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 for
the data being placed in this array.
Legal Values
Up to 15 alphanumeric characters
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte, Packed_Byte,
Swapped_Byte
1-10,000
Example
//
Data Arrays
//
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
DA_DO_01,
Data_Format,
UInt16,
UInt16,
Bit,
Bit,
Data_Array_Length
200
200
200
200
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 4
FS-8700-52 Notifier AM6000
4.2
Driver Manual
Client Side Connections
Section Title
Connections
Column Title
Port
Baud*
Function
Specify which port the device is
connected to the FieldServer
Specify baud rate
Parity*
Data_Bits*
Stop_Bits*
Protocol
Handshaking*
Poll Delay*
Specify parity
Specify data bits
Specify stop bits
Specify protocol used
Specify hardware handshaking
Time between internal polls
Legal Values
P1-P8, R1-R2
2400 (Only baud rate supported by
the Notifier port)
Even
7
1
AM6000
None
0-32000 seconds
default 1 second
Example
//
Client Side Connections
Connections
Port, Baud, Parity, Protocol, Data_bits, Handshaking, Poll_Delay
P8,
2400, Even,
AM6000,
7,
None,
0.100s
4.3
Client Side Nodes
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Port
Function
Provide name for node
Modbus station address of physical
server node
Specify protocol used
Specify which port the device is
connected to the FieldServer
Legal Values
Up to 32 alphanumeric characters
1-255
Modbus_RTU, Modbus/TCP, etc.
P1-P8, R1-R2
Example
//
Client Side Nodes
Nodes
Node_Name, Protocol,
Panel1,
AM6000,
Port
P8
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 5
FS-8700-52 Notifier AM6000
4.4
Driver Manual
Client Side Map Descriptors
4.4.1 FieldSe rver Specific Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Data_Array_Name
Data_Array_Location
Function
Name of this Map Descriptor
Name of Data Array where data is
to be stored in the FieldServer
Starting location in Data Array
Function
Function of Client Map Descriptor
Legal Values
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
Passive
4.4.2 Driver Specific Map Descriptor Parameters
Column Title
Node_Name
Function
Name of Node to fetch data from
Data_Type
Length
Data type
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.
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.
Address
AM6000 Driver
specific parameters &
keywords.
Am6000_typeID
Used to differentiate between device and system
type messages.
Legal Values
One of the node names
specified in “Client
Node Descriptor” above
Register, Coil, AI, DI
1 - 1000
501, 302
Device-only,
System_trbl,
device&type.
system-Styl2,
catch-all
Additional notes are
provided in section 5.1
Am6000_Status
AM6000_Ackable
Am6000_simulation
Allows direction of alarm or trouble states to
different data arrays.
Tells the driver that the data area of this mapdesc
must be Zeroised when a block ack is received.
Provided for debugging and test purposes only.
Tells the driver which debug message to send. This
parameter is for use by FieldServer Technologies
only.
Any, Alarm, trouble,
erase, on , eraseon
Additional notes are
provided in section 5.2
Additional notes are
provided in section 5.3
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 6
FS-8700-52 Notifier AM6000
Driver Manual
4.4.3 Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
>0.1s
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 7
FS-8700-52 Notifier AM6000
4.4.4
Driver Manual
Map Descriptor Example.
Name of the data
array that will be
updated when this
map descriptor is
used.
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
All map
descriptors for the
AM6000 Notifier
driver must be
passive.
DEVICE_STATES_LOOP1
The range of
device address is
determined by this
parameter.
Because address is
500 and length is
100 in this
example all
devices 500 to 599
will be
Processed using
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
Connects this
map descriptor
to a node
whose name is
'node_a' and
thus connects
the map
descriptor to a
port.
This keyword indicates that
this map descriptor will only
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.
When a Block
Acknowledge or System
Reset message is received
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 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 8
FS-8700-52 Notifier AM6000
Name of the data
array that will be
updated when this
map descriptor is
used.
Driver Manual
All map
descriptors for the
AM6000 Notifier
driver must be
passive.
When a Block
Acknowledge or System
Reset message is
received the driver will
set the portion of the
data array
DEVICE_STATES_LO
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
System Trouble Messages are
processed using this map
descriptor. Only one map
descriptor like this is necessary for
a whole system.
This indicates Style2 is being used.
Thus when system trouble message
number n is processed the nth
element of data array starting at
location 5 (this example) will be
set to 1.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 9
FS-8700-52 Notifier AM6000
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 systemtrbl (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 at least 50.
Catch-all
The use of this keyword is described in section 5.2
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 10
FS-8700-52 Notifier AM6000
5.1.2
Driver Manual
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 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 11
FS-8700-52 Notifier AM6000
5.2
Driver Manual
Statistics
This driver does not keep statistics for each map descriptor. Statistics are maintained for the
connection to the Am6000 Notifier device.
Count of received messages
and bytes. A complete
received message is 82 bytes
long and thus if all messages
are received correctly the
byte count should be a
multiple of 82.
This indicates the number of
times a 'Block Ack' or
'System Reset' message have
been applied.
If you have 5 'Ackable' map
descriptors and one 'Block
Ack' message was received a
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 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 12
FS-8700-52 Notifier AM6000
Driver Manual
This statistic indicates the number of messages that
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 message 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 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 13
FS-8700-52 Notifier AM6000
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 using 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 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 14
FS-8700-52 Notifier AM6000
5.3
Driver Manual
Listing of System Trouble Messages
Msg Index
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Message
!!! ILLEGAL !!!
MAINS TROUBLE
POWER LOW ON MAIN SUPPLY
POWER LOW ON AUXILIARY SUPPLY
POWER LOW ON BATTERY-CHARGER
POWER OVERVOLTAGE ON MAIN SUPPLY
POWER OVERVOLTAGE ON BATTERY-CHARGER
FAILURE OR OVERLOAD ON MAIN SUPPLY
FAILURE OR OVERLOAD ON AUXIL. SUPPLY
FAILURE ON BATTERY-CHARGER
DISCONNEC. BATT. OR FUSE FAILURE
BATTERY EXHAUSTED
BATTERY CHARGER UNBALANCED
AUX. SUPPLY DISCONNECTED
AUX. SUPPLY USER FUSE
MAIN SUPPLY USER FUSE
SIREN FUSE
EARTH TROUBLE
SIREN SUPERV.LINE INTERRUPTED
BATTERY FAILURE
WIRE CUT ON LINE
SHORT CIRCUIT ON LINE
PRINTER: OFF LINE/BUFFER FULL/PAPER END
COMMUNICATION ERROR ON
LOW VOLTAGE ON LINE
SIDE A OPEN ON LINE
SIDE B OPEN ON LINE
SYSTEM KEYPAD TROUBLE
INTERNAL PROGR.ENABLING JUMPER :ENABLED
SYSTEM START UP
CPU RESET OR WATCH-DOG FAILURE
CRT-TERMINAL : OFF-LINE
FLASH MEMORY ERROR ON
SIREN SUPERV.LINE
LINE
ANNUNC.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Visit our website: www.fieldserver.com
E-mail: support@fieldserver.com
Page 15