Protocol Driver Manual - SMC 5000 8700-96

A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-96 SMC5000
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Version:
1.00
Document Revision: 2
FS-8700-96_SMC5000 Driver Manual
Table of Contents
TABLE OF CONTENTS
1.
SMC5000 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. Hardware...................................................................................................................4
3.
Hardware Connections .....................................................................................................5
3.1.
4.
Hardware Connection Tips / Hints ................................................................................5
Configuring the FieldServer as a SMC5000 Client.........................................................6
4.1.
Data Arrays/Descriptors ...............................................................................................6
4.2.
Client Side Connection Descriptors ..............................................................................7
4.3.
Client Side Node Descriptors .......................................................................................7
4.4.
Client Side Map Descriptors .........................................................................................8
4.4.1. FieldServer Related Map Descriptor Parameters......................................................8
4.4.2. Driver Related Map Descriptor Parameters ..............................................................8
4.4.3. Timing Parameters ....................................................................................................8
4.4.4. Map Descriptor Example. ..........................................................................................9
5.
Configuring the FieldServer as a SMC5000 Server......................................................10
5.1.
Server Side Connection Descriptors...........................................................................10
5.2.
Server Side Node Descriptors ....................................................................................11
5.3.
Server Side Map Descriptors......................................................................................12
5.3.1. FieldServer Specific Map Descriptor Parameters ...................................................12
5.3.2. Driver Specific Map Descriptor Parameters ............................................................12
5.3.3. Map Descriptor Example. ........................................................................................13
Appendix A.
Appendix A.1.
Appendix A.2.
Appendix A.3.
Advanced Topics ............................................................................................14
Poller_Client Map Descriptor Data Array ......................................................14
SMC_Functions – Client Application .............................................................15
SMC_Functions – Server Application............................................................15
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
1.
Page 3 of 16
SMC5000 Description
The SMC5000 driver allows the FieldServer to transfer data to and from devices over either RS232 or RS-485 using SMC5000 protocol. The FieldServer can emulate either a Server or Client,
although the SMC5000 driver is only available in a Client configuration. Any Server drivers are
for FieldServer testing purposes only.
Max Nodes Supported
FieldServer
Nodes Comments
Mode
Client
1
Only 1 Client node allowed on multidrop systems
A maximum of 255 nodes can be connected on a multidrop network,
Server
255
although performance declines as more nodes are added. In nonmultidrop systems only 1 Server node is allowed.
The SMC5000 protocol is used to provide report-by-exception (RBE) capability when
communicating with the Sierra Monitor’s Model 5000 Sentry. The Sentry always acts as a
SMC5000 Server node. Changes of critical Sentry registers (e.g. concentrations, alarms, etc.)
are thus sent to the Client at a higher frequency than normal registers.
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
2.
Page 4 of 16
Driver Scope of Supply
2.1.
Supplied by FieldServer Technologies for this driver
FieldServer Technologies PART #
FS-8915-10
FS-8915-10
FS-8917-02
FS-8917-01
FS-8917-21
FS-8700-96
Description
UTP cable (7 foot) for Ethernet connection
UTP cable (7 foot) for RS-232 use
RJ45 to DB9F connector adapter
RJ45 to DB25M connection adapter
RS-485 connection adapter
Driver Manual.
Provided by the Supplier of 3rd Party Equipment
2.2.
2.2.1.
Part #
Hardware
Description
Sierra Monitor Model 5000 Sentry
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
3.
Page 5 of 16
Hardware Connections
The FieldServer is connected to the Model 5000 Sentry as shown in the connection drawing.
Configure the Model 5000 Sentry according to manufacturer’s instructions
3.1.
Hardware Connection Tips / Hints
When using the X40 model, make sure you connect the FieldServer to the network using
one or both of the RS-485 ports marked R1 and R2. If more ports are required, P1 – P8
may be used in conjunction with an RS-232-to-RS-485 converter.
When using the X20 model, make sure the serial port is configured as a RS-485 port. Refer
to ENOTE0017 - Setting FS-B20 up for RS-485.
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
4.
Page 6 of 16
Configuring the FieldServer as a SMC5000 Client
For a detailed discussion on FieldServer configuration, please refer to the FieldServer
instruction 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 SMC5000 Server. The FieldServer should always be configured as a
Client driver when the user wants it to communicate directly with one or more Model 5000
Sentry devices.
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 SMC5000 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
Data_Array_Name
Provide name for Data Array
Data_Array_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 by the Map Descriptors 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 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
4.2.
Page 7 of 16
Client Side Connection Descriptors
Section Title
Connections
Column Title
Protocol
Function
Specify which port the device is
connected to the FieldServer
Specify protocol used
Baud*
Specify baud rate
Parity*
Data_Bits*
Stop_Bits*
Handshaking*
Poll _Delay*
Specify parity
Specify data bits
Specify stop bits
Specify hardware handshaking
Time between internal polls
Port
Legal Values
P1-P8, R1-R21
SMC5000
1200 or 110 – 115200, standard
baud rates only
Even, Odd, None, Mark, Space
7, 8
1
RTS, RTS/CTS, None
0-32000 seconds, 1 second
Example
//
Client Side Connections
Connections
Port,
Protocol,
P8,
SMC5000,
4.3.
Baud,
1200,
Parity,
None,
Handshaking,
None,
Poll_Delay
0.050s
Client Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Connection
Function
Provide name for node
Modbus station address of
physical Server node (Sentry)
Specify protocol used
Specify which port the device is
connected to the FieldServer
Legal Values
Up to 32 alphanumeric characters
1-255
SMC5000
P1-P8, R1-R21
Example
//
Client Side Nodes
Nodes
Node_Name,
SENTRY_1,
Node_ID,
1,
Protocol,
SMC5000,
Connection
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.
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
4.4.
Page 8 of 16
Client Side Map Descriptors
4.4.1.
FieldServer Related Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Name of this Map
Map_Descriptor_Name
Descriptor
Name of Data Array where
Data_Array_Name
data is to be stored in the
FieldServer
Starting location in Data
Data_Array_Offset
Array
Function of Client Map
Descriptor
Function
4.4.2.
Driver Related Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
SMC_Function
Function
Additional field describing the
Function or Task to be
performed.
Node_Name
Name of Node to fetch data from
Length
Length of Map Descriptor
Address
Starting address of read block
4.4.3.
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
COS_POLLER, RDBC,
PASSIVE, SERVER,
COS_READ, WRBX
Legal Values
Poller_Client,
Passive_Client (See Driver
Notes)
One of the node names
specified in “Client Node
Descriptor” above
1-500
40001-49999 (See also
SMC5000/Modbus Address
Map of Sentry)
Timing Parameters
Section Title
Map Descriptors
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
≥0.001s
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
4.4.4.
//
Page 9 of 16
Map Descriptor Example.
Client Side Map Descriptors
Map Descriptors
Map_Descriptor_Name,
A_Poller,
A1,
A2,
A3,
When a
Passive_Client
is set as
COS_READ, it
enables it to be
Quick-loaded at
FieldServer
startup or when
the node comes
back on-line.
Data_Array_Name,
A_STATUS,
DA_AI1,
DA_AI2,
DA_AI3,
When a
Passive_Client
is set as WRBX,
it enables it to
send a write
message to the
Server when the
data in its Data
Array has
changed. This
will cause the
relevant data on
the Server to be
updated to the
changed data.
Data_Array_Offset,
0,
0,
0,
0,
Function,
COS_POLLER,
COS_READ,
PASSIVE,
WRBX,
Client Side Map
Descriptors should
always start with a
Poller_Client Map
Descriptor as
shown here. It is
mapped to a Data
Array that will
provide an
overview of the
types of messages
received. See
Appendix A.1.
SMC_Function
Poller_Client,
Passive_Client,
Passive_Client,
Passive_Client,
Following the
Poller_Client
Map Descriptor
are the
Passive_Client
Map Descriptors
for that node,
which will fill
their respective
Data Arrays with
the data
received from
the Servers.
Node_name
Node_A,
Node_A,
Node_A,
Node_A,
Address
42001,
42001,
40635,
40634,
These
Addresses
together with the
lengths
corresponds to
SMC5000 or
Modbus
Addresses on
the Server
Length
5,
100,
16,
1,
Scan_Interval
0.1
-
The Polling
speed is set by
this value.
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
5.
Page 10 of 16
Configuring the FieldServer as a SMC5000 Server
For a detailed discussion on FieldServer configuration, please refer to the FieldServer
instruction manual. The information that follows describes how to expand upon the factory
defaults provided in the configuration files included with the FieldServer (See “.csv” files
provided with the FieldServer.)
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a SMC5000 Client. The FieldServer should be configured as a Server
when it must emulate one or more Model 5000 Sentry devices.
The configuration file tells the FieldServer about its interfaces, and the routing of data required.
In order to enable the FieldServer for SMC5000 communications, the driver independent
FieldServer buffers need to be declared in the “Data Arrays” section, the FieldServer virtual
node(s) needs to be declared in the “Server Side Nodes” section, and the data to be provided to
the Clients needs to be mapped in the “Server 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.
5.1.
Server Side Connection Descriptors
Section Title
Connections
Column Title
Protocol
Function
Specify which port the device is connected
to the FieldServer
Specify protocol used
Baud*
Specify baud rate
Parity*
Specify parity
Data_Bits*
Stop_Bits*
Specify data bits
Specify stop bits
Handshaking*
Specify hardware handshaking
Port
Legal Values
P1-P8, R1-R2
SMC5000
1200 or 110 –
115200, standard
baud rates only
Even, Odd, None,
Mark, Space
7, 8
1
RTS, RTS/CTS,
None
Specifies time FieldServer will reserve
Server side connection while waiting for the
Server_Hold_Timeout*
Client side to update data in Data_Array (if
necessary)
>1.0s
Example
//
Server Side Connections
Connections
Port,
P8,
Protocol,
SMC5000,
Baud,
1200,
Parity,
None,
Handshaking
None
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
5.2.
Page 11 of 16
Server Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Function
Provide name for node
SMC5000/Modbus station address of
physical Server node
Protocol
Specify protocol used
Specifies time FieldServer will reserve Server
side connection while waiting for the Client
Server_Hold_Timeout*
side to update data in Data_Array (if
necessary)
Node_ID
Legal Values
Up to 32
alphanumeric
characters
1-255
SMC5000
>1.0s
Example
//
Server Side Nodes
Nodes
Node_Name,
SENTRY_1,
Node_ID,
1,
Protocol
SMC5000
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
5.3.
Page 12 of 16
Server Side Map Descriptors
5.3.1.
FieldServer Specific Map Descriptor Parameters
Section Title
Map Descriptors
Column Title
Function
Map_Descriptor_Name Name of this Map Descriptor
Data_Array_Name
Name of Data Array where data is to
be stored in the FieldServer
Data_Array_Offset
Starting location in Data Array
Function
Function of Server Map Descriptor
Specifies time FieldServer will
reserve Server side connection while
waiting for the Client side to update
data in Data_Array (if necessary)
Server_Hold_Timeout*
5.3.2.
SMC_Function
Length
Address
>1.0s
Driver Specific Map Descriptor Parameters
Section Title
Map
Descriptors
Column Title
Node_Name
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
SERVER, WRBX
Function
Legal Values
LCD_SERVER, IDLE_SERVER,
Additional Field for defining the COS_SERVER.
function of the Map Descriptor. (SeeError! Reference source not
found.)
Name of Node to fetch data
One of the node names specified in
from
“Client Node Descriptor” above
Length of Map Descriptor
1 – 1000
40001-49999 (See also
Starting address of read block SMC5000/Modbus Address Map of
Sentry)
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
5.3.3.
//
Page 13 of 16
Map Descriptor Example.
Server Side Map Descriptors
Map Descriptors
Map_Descriptor_Name,
A_IDLE,
A_LCD_TRIGGER,
A_LCD_DISPLAY,
A_COS1,
A_COS2,
The IDLE_SERVER
Map Descriptors
define the data and
their addresses that
would be sent to the
Client at a low
priority and
frequency. Their
function fields have
to be set to
SERVER.
Data_Array_Name,
DA_IDLE,
DA_KEYPRESS,
DA_LCD,
DA_COS,
DA_COS,
Data_Array_Offset,
0,
0,
0,
0,
1,
A LCD_SERVER
defined as SERVER
function will mark
the Remote
Keypress register
that will activate the
LCD COS
responses. These
responses will cease
when no new
Keypress was
received a minute
after the previous
Function,
SERVER,
SERVER,
WRBX,
WRBX,
WRBX,
SMC_Function,
IDLE_SERVER,
LCD_SERVER,
LCD_SERVER,
COS_SERVER,
COS_SERVER,
A LCD_SERVER
defined as WRBX
function will mark
the LCD registers.
For a minute after a
Remote Keypress
the contents and
addressses of these
registers will be sent
to the Client each
time its contents
change.
Node_name
Node_A,
Node_A,
Node_A,
Node_A,
Node_A,
Address
42001,
40634,
40635,
42001,
42002,
Each Change-ofState (COS) register
needs to be defined
in its own
COS_SERVER Map
Descriptor and
needs its Function
field to be set to
WRBX
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: support@fieldServer.com
Length
500,
1,
16,
1,
1,
FS-8700-96_SMC5000 Driver Manual
Page 14 of 16
Appendix A. Advanced Topics
Appendix A.1. Poller_Client Map Descriptor Data Array
On the SMC5000 Client the Poller_Client Map Descriptor is mapped to a UINT16 Data Array
that will provide an overview of the types of messages received from the Server. The five
registers in the Data Array are defined as follows:
1
COS Messages
Received
Register
COS Messages
Received
IDLE Messages
Received
LCD-COS
Messages
Received
2
IDLE Messages
Received
3
LCD-COS
Messages
Received
4
COS Queue
Overruns
Received
5
Synchronize
Status
Description
This register will keep count of the Change-of-State (COS) responses
received from the Server node or Sentry device.
This register will keep count of the Idle responses received from the
Server node.
This register will keep count of the LCD Change-of-State COS
responses received from the Server node.
This register will keep count of the COS overrun responses received
COS
Queue from the Server node. Change-of-State events are stored in the
Overrun
Server’s COS queue until the Client has successfully received all these
Messages
events. Should this COS Queue overrun for some reason, it would
Received
indicate that an COS events might have been lost. See next paragraph
for more information.
After FieldServer start-up or after a COS queue overrun message has
been received from the Server, the synchronize status will be zero until
Synchronize
Status
all the COS and Idle registers have been read at least once from the
Server, at which point this register will contain a value of 1.
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
Page 15 of 16
Appendix A.2. SMC_Functions – Client Application
Map Descriptors pertaining to a specific node require a Poller_Client at the top, followed by
sufficient Passive_Client Map Descriptors to adequately cover all the possible Register
Addresses found on the Server or Sentry device. See the SMC5000/Modbus Address Map
for the relevant information.
The Poller_Client Map Descriptor Function field must be set to COS_POLLER or RDBC.
The Passive_Client’s Function field can be set to either SERVER, PASSIVE, COS_READ or
WRBX. The differences are described in the following table:
Function
Description
This is the most basic functionality. This Map Descriptor would only
SERVER (or
specify the Data Array locations to store the data received from the Server
PASSIVE)
falling within its address range.
COS_READ Map Descriptors are the same as the SERVER types
described above, with the added functionality of Quickloads. A Quickload
COS_READ
is when all data for the Map Descriptor is read from the Server in a single
message. A Quickload would be done when the FieldServer is started or
when a node comes back on-line.
When the Passive_Client Map Descriptor has been set as a WRBX
function it will still perform as a SERVER type previously described, but
with the added functionality of being able to send data in a write message
WRBX
to the Server. A write would be issued only when its Data Array’s contents
had changed. The result of the write will be that the relevant registers on
the Server would be updated with the data sent.
Appendix A.3. SMC_Functions – Server Application
SMC5000 Server Map Descriptors are divided into COS_SERVER, IDLE_SERVER and
LCD_SERVER as follows:
Function
Description
COS or change-of-state Server Map Descriptors are used to monitor
COS_SERVER high-priority data such as alarms and concentrations on the Sentry. The
Function field must be set to WRBX.
Idle Server Map Descriptors are used to monitor the low priority
IDLE_SERVER registers/data such as set points on the Sentry which will be sent to the
Client at a much lower frequency. Function field must be set to SERVER.
LCD Server Map Descriptors will define the registers/data eligible for
change-of-state monitoring specific to the Sentry’s front panel LCD
display. These LCD data responses are enabled only when a write to the
LCD_SERVER Remote Keypress register is received on the Server and disabled when
no write to this register is received for 1 minute. The Remote Keypress
register must be defined in the Function field as a SERVER, while the
actual LCD data is defined with a WRBX function (refer to 5.3.3)
The SMC5000/Modbus Address Map provides the register addresses together with their
descriptions for the Model 5000 Sentry device.
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: support@fieldServer.com
FS-8700-96_SMC5000 Driver Manual
Page 16 of 16
THIS PAGE INTENTIONALLY LEFT BLANK
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: support@fieldServer.com