FieldServer FS-8700-133 Computer Drive User Manual

A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-133 Genisys
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after January 2009
Driver Version:
Document Revision:
1.00
3
FS-8700-133 Genisys Manual
Table of Contents
TABLE OF CONTENTS
1
GENISYS DESCRIPTION ................................................................................................................................... 3
2
DRIVER SCOPE OF SUPPLY .............................................................................................................................. 3
2.1
Supplied by FieldServer Technologies for this driver .....................................................................................3
3
HARDWARE CONNECTIONS ............................................................................................................................ 4
4
CONFIGURING THE FIELDSERVER AS A GENISYS CLIENT ................................................................................. 5
4.1
4.2
4.3
4.4
Data Arrays/Descriptors ................................................................................................................................5
Client Side Connection Descriptions ..............................................................................................................6
Client Side Node Descriptors .........................................................................................................................7
Client Side Map Descriptors...........................................................................................................................8
4.4.1
4.4.2
4.4.3
4.5
4.6
5
FieldServer Related Map Descriptor Parameters ...................................................................................8
Driver Related Map Descriptor Parameters ...........................................................................................8
Timing Parameters .................................................................................................................................8
Map Descriptor Example: Read Indications ...................................................................................................9
Map Descriptor Example: Write Controls ....................................................................................................10
CONFIGURING THE FIELDSERVER AS A GENISYS SERVER .............................................................................. 11
APPENDIX A. ADVANCED TOPICS ......................................................................................................................... 12
Appendix A.1. Storage Structure for Data Type Bit and Byte ..................................................................................12
APPENDIX B. ERROR MESSAGES .......................................................................................................................... 13
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
1
Page 3 of 13
GENISYS DESCRIPTION
The Genisys driver allows the transfer of data to and from devices over RS-232 Genisys protocol. Vital Harmon
Logic Controller (VHLC) supports Genisys protocol. IM-188 VHLC GENISYS SOFTWARE MANUAL 100188-008
AB0.PDF is the basis of the Genisys driver. The FieldServer can be configured as a Client. Limited Server side
functionality has been implemented for FieldServer’s quality assurance requirements only.
Max Nodes Supported
FieldServer Mode
Client
Server
2
Nodes
1
255
Comments
Only 1 virtual client per port allowed on multidrop systems.
Maximum device addresses pollable by Client – protocol limitation.
DRIVER SCOPE OF SUPPLY
2.1
Supplied by FieldServer Technologies for this driver
FieldServer Technologies PART #
FS-8915-10
FS-8917-04
FS-8700-133
Description
UTP cable (7 foot) for RS-232 use
RJ45 to DB25F connector adapter
Driver Manual.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
3
Page 4 of 13
HARDWARE CONNECTIONS
The FieldServer is connected to the VHLC as shown in the following connection drawing.
Port C VHLC RS-232
Interface Module
DB25F
8917-04
Tx
3
7
2
GND
Rx
8
7
6
5
4
3
2
1
FS-8915-10
VHLC
Server
RJ45
FieldServer
Connect to one of the RS-232
Ports on the FieldServer
RJ45
8
FieldServer
1
P1
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
4
Page 5 of 13
CONFIGURING THE FIELDSERVER AS A GENISYS CLIENT
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The
information that follows describes how to expand upon the factory defaults provided in the configuration files
included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate
with a Genisys Server.
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 Genisys 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
Data_Array_Length
Provide data format. Each Data Array can only take on one
format.
Number of Data Objects. Must be larger than the data storage
area required by the Map Descriptors for the data being placed in
this array.
Legal Values
Up
to
15
alphanumeric
characters
Float, Bit, UInt16,
SInt16, Byte,
1-10,000
Example
// Data Arrays
Data_Arrays
Data_Array_Name
DA_8I_01
DA_8O_01
DA_DI_01
DA_DO_01
DA_COS_01
DA_COS_02
,Data_Array_Format
,Byte
,Byte
,Bit
,Bit
,Byte
,Byte
,Data_Array_Length
,32
,32
,256
,256
,1
,1
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
4.2
Page 6 of 13
Client Side Connection Descriptions
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
1
Genisys
300 ,600, 1200, 2400, 4800, 9600 (Vendor
limitation)
None, Even, Odd (Vendor limitation)
8 (Vendor limitation)
1, 2 (Vendor limitation)
None
0-32000 seconds, 0.05 seconds
Example
//
// Client Side Connections
//
Connections
Port ,Baud ,Data_Bits
P1
,9600 ,8
,Stop_Bits
,1
,Parity
,None
,Protocol
,Genisys
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 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
4.3
Page 7 of 13
Client Side Node Descriptors
Section Title
Nodes
Column Title
Function
Node_Name
Provide name for Node
Node_ID
Protocol
VHLC station address of physical Server Node
Specify protocol used
Specify which port the device is connected to the
FieldServer
If OFF, the FieldServer configures VHLC to apply controls
from the FieldServer without verification.
If ON, the FieldServer configures VHLC to verify controls
supplied by the FieldServer before applying.
Specify time, that FieldServer should wait before sending
ACK or Execute message after receiving the last character of
response from VHLC.
Connection
Genisys_Check_Controls*
Genisys_Intra_Poll_Delay*
Legal Values
Up to 32
alphanumeric
characters
1-255
Genisys
P1-P8
1
OFF, ON
0.010s, 0.025s etc
Example
// Client Side Nodes
//
Nodes
Node_Name ,Node_ID
Genisys_01
,1
Genisys_02
,2
,Protocol
,Genisys
,Genisys
,Port
,P1
,P1
,Genisys_Check_Controls
,ON
,-
,Genisys_Intra_Poll_Delay
,0.01s
,0.01s
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
4.4
Page 8 of 13
Client Side Map Descriptors
4.4.1 FieldServer Related Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Data_Array_Name
Function
Name of this Map Descriptor
Name of Data Array where data is to be
stored in the FieldServer
Data_Array_Offset
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
COS_Poller, COS_Read , Wrbx
4.4.2 Driver Related Map Descriptor Parameters
Column
Title
Node_Name
Data_Type*
Address*
Length*
Function
Legal Values
Name of Node to fetch data from
One of the Node names
specified in “Client Node
Descriptor” above
‘Bit’ each byte of Indication statuses will be stored in 8 consecutive
locations in the Data Array. Similarly while writing; Control byte
will be composed from 8 consecutive locations of the Dara Array.
‘Byte’ each byte of Indication statuses will be stored as an 8-Bit
Integer at the specified location. Similarly while writing; Control
byte will be composed from a single location of the Data Array.
Refer to Appendix A.1
Internally used parameter, if used specify value 0
Length of Map Descriptor
Number of indications to store or number of controls to write as
per Data_Type.
Bit, Byte
0
Bit: 1-256, 8
Byte: 1-32, 1
4.4.3 Timing Parameters
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 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
4.5
Page 9 of 13
Map Descriptor Example: Read Indications
The following Map Descriptors will read indication words from physical Server Genisys_01 and Genisys_02 (described in Client Side Node Descriptors section).
The Cos_Poller Map Descriptor polls VHLC for any indication word changes and returned data is stored on the Data Array under the COS_READ Map Descriptor
for the same Node. The rate of polling is determined by the Scan_Interval.
The Cos_Read Map Descriptor also polls VHLC for all indication words irrespective of data change. The rate of polling is determined by the Scan_Interval.
If Data_Type is Byte, any location in Data Array will hold one indication word from VHLC.
If Data_Type is Bit, eight consecutive locations in Data Array will hold one indication word from VHLC. Also see Appendix A.1.
// Client Side Map Descriptors
//
Map_Descriptors
Map_Descriptor_Name ,Scan_Interval
CMD_01
,1.00s
CMD_01a
,50s
,Data_Array_Name
,DA_COS_01
,DA_8I_01
,Data_Array_Offset
,0
,0
,Function
,COS_Poller
,COS_Read
,Node_Name
,Genisys_01
,Genisys_01
,Data_Type
,Byte
,Byte
,Address
,0
,0
,Length
,1
,32
CMD_02
CMD_02a
,DA_COS_02
,DA_DI_01
,0
,0
,COS_Poller
,COS_Read
,Genisys_02
,Genisys_02
,Bit
,Bit
,0
,0
,1
,256
Frequency (in
seconds) to read
Indication Statuses
,1.00s
,50s
Name of one of the Data
Arrays defined in the
Data_Array section.
Indication statuses will be
stored in this Data Array
Starting offset
in Data Array to
st
hold 1
indication
status
One of the Nodes
declared in Node
Section. Indications
will be read from the
station address
belonging to this Node
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
Number of consecutive
locations in the Data array
to be used for storing data
from the Server.
FS-8700-133 Genisys Manual
4.6
Page 10 of 13
Map Descriptor Example: Write Controls
The following Map Descriptor will write controls to physical Server Genisys_01 and Genisys_02 (described in Client Side Node Descriptors section) whenever
any of the control statuses changes/updates. One such Map Descriptor is required per Node.
If Data_Type is Byte, 32 consecutive locations from the Data Array will be written to VHLC. Data at any location would be considered as one control word.
If Data_Type is Bit, 256 consecutive locations from the Data Array will be written to VHLC. Data at 8 consecutive locations would be considered as one control
word.
Also see Appendix A.1.
// Client Side Map Descriptors
//
Map_Descriptors
Map_Descriptor_Name ,Scan_Interval
CMD_01b
,CMD_02
,-
Name of one of
the Data Arrays
defined in
Data_Array
section. This
Data Array holds
control statuses
to be written to
other devices.
,Data_Array_Name
,DA_8O_01
,DA_DO_01
Starting offset
in the Data
Array which
st
holds the 1
control status.
,Data_Array_Offset
,0
,0
,Function
,Wrbx
,Wrbx
Wrbx: send write command
to the Server when the
associated Controls updates
or changes. To write
continuously use Wrbc as the
function and add a
Scan_Interval parameter to
configure how often to write.
,Node_Name
,Genisys_01
,Genisys_02
,Data_Type
,Byte
,Bit
One of the
Nodes declared
in the Node
Section.
Indications will
read from the
station address
belonging to this
Node
,Address
,0
,0
,Length
,32
,256
Number of consecutive
locations in the Data
array to use when
issuing the Write
command.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
5
Page 11 of 13
CONFIGURING THE FIELDSERVER AS A GENISYS SERVER
The Server side has been implemented only for FieldServer’s quality assurance requirements.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
Page 12 of 13
Appendix A. Advanced Topics
Appendix A.1. Storage Structure for Data Type Bit and Byte
st
LSB bit in Indication/Control Byte is the1 status/control value
st
nd
If the Data_Type is ‘Byte’ and only the 1 and 2 indication status values are 1 (out of 8 statuses), all
others being zero, the Driver will store a numeric value of 3 in the Data Array.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com
FS-8700-133 Genisys Manual
Page 13 of 13
Appendix B. Error Messages
Most error messages are associated with errors in parsing an incoming message from the VHLC panel. The most
likely cause is a mismatch in expected message format. The driver will flag one of the following error messages
and continue. In most cases the message currently being processed by the driver will also be printed so that any
problems can be easily diagnosed.
The following Error Messages appear upon the ‘Driver Messages’ Screen
%d means numeric number
%s means string
Messages number 2, 3 and 11 will be displayed just once if generated after rebooting or power cycling the
FieldServer.
Error
Description
If a connection is declared in
section 4.2 without Baud,
Data_Bits, Stop_Bits or Parity, the
displayed parameter values will be
in use.
A Map Descriptor with function
COS_Poller has been declared for
a Node but the COS_Read Map
Descriptor required to store the
data is missing.
Action
GENISYS:#3 FYI. MD(%s)
length required=%d, now
Only %d statuses will be
stored
The COS_Read Map Descriptor is
of insufficient length to store all
indication words from VHLC.
If all indication words need to be stored, edit
the configuration file and change the length of
the Map Descriptor to the reported value.
GENISYS:#4 ERR %dth
word number %d is
invalid
The indication data response from
VHLC contains an invalid word
number.
Valid range is 0-31
No data will be stored.
Call tech support.
GENISYS:#5
FYI.
Indications can not be
written
The FieldServer received an
instruction from a Server device to
write indications to VHLC.
FieldServer can only write controls
to VHLC.
Inspect the configuration file to determine
whether the Data Array under the COS_Poller
or COS_Read Map Descriptor is mapped to
receive write commands from other protocols.
Also check that other devices are not
configured to write data to these Data Arrays.
The Driver is acting as a Server
rather than a Client.
Call tech support.
The Driver is acting as a Server
rather than a Client.
Call tech support.
GENISYS:#1
FYI.
Connection params are
%d %d %d Even
GENISYS:#2
FYI.
MD
required to store data
from Node(%d)
GENISYS:#11FYI. MD(%s)
length required=%d, now
Only %d statuses will be
stored
GENISYS:#12 ERR %dth
word number %d is
invalid
Check if connection parameter matches the
setting at VHLC.
Edit configuration file and add Map Descriptor
with COS_Read function.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldserver.com