FieldServer FS-8700-115 Computer Drive User Manual

A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-115 General Purpose ASCII
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Version:
1.00
Document Revision: 4
FS-8705-06 GPA (General Purpose ASCII) Manual
Table of Contents
TABLE OF CONTENTS
1.
2.
GPA (GENERAL PURPOSE ASCII) DRIVER DESCRIPTION .........................................3
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. Required 3rd Party Hardware.....................................................................................4
2.2.2. Required 3rd Party Configuration ...............................................................................4
3.
4.
HARDWARE CONNECTIONS ..........................................................................................5
CONFIGURING THE FIELDSERVER AS AN GPA DRIVER CLIENT..............................6
4.1.
Data Arrays/Descriptors ...............................................................................................6
4.2.
Client Side Connection Descriptions ............................................................................7
4.3.
Client Side Node Descriptors .......................................................................................8
4.4.
Client Side Map Descriptors .........................................................................................9
4.4.1. FieldServer Related Map Descriptor Parameters......................................................9
4.4.2. Driver Related Map Descriptor Parameters ..............................................................9
4.5.
Map Descriptor Example. ...........................................................................................10
5.
CONFIGURING THE FIELDSERVER AS A GPA DRIVER SERVER.............................11
APPENDIX A. ADVANCED TOPICS ......................................................................................12
Appendix A.1. Separating Data Streams. .............................................................................12
Appendix A.2. Interaction with the WebServer Driver...........................................................12
APPENDIX B. TROUBLESHOOTING TIPS............................................................................13
Appendix B.1. Timeouts........................................................................................................13
APPENDIX C.
DRIVER ERROR MESSAGES ........................................................................14
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-8705-06 GPA (General Purpose ASCII) Manual
1.
Page 3 of 15
GPA (General Purpose ASCII) Driver Description
The serial GPA (General Purpose ASCII) Driver allows the FieldServer to accept data from
remote devices which produce an ASCII byte stream. A typical example of such a device is an
electronic scale producing an output similar to the one below.
:weight 0.57 Kg Tare 44.3 Kg 1 2 3 4 -5 -6.7
The driver waits passively for messages. When a message is received the driver converts each
space delimited string of characters/numbers into a number. The numbers so formed are stored
in consecutive elements of a Data Array. Referring to the example above, the driver will store
the value .57 in the 1st element of the Data Array (DA), the value 44.3 in the next element, the
value 1 in the next, the value 2 in the next etc.
The driver can process negative numbers.
This driver has significant limitations:
Only one data stream per connection - if two different streams of string data are sent to the
same port, the data from the one will overwrite data from the other.
The driver can only process numbers that are presented in a simple numeric form.
Hexadecimal, Exponent-mantissa and other complex forms cannot be processed.
Max Nodes Supported
FieldServer Mode
Nodes
Client
1
Server
Comments
Only 1 node per port.
The driver cannot serve data
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-8705-06 GPA (General Purpose ASCII) Manual
2.
Page 4 of 15
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-8705-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
Driver Manual.
Provided by the Supplier of 3rd Party Equipment
2.2.
2.2.1.
Part #
2.2.2.
Required 3rd Party Hardware
Description
None
Required 3rd Party Configuration
Consult your vendor documentation. It is not possible to provide direction here as this
driver can be connected to a huge range of devices.
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-8705-06 GPA (General Purpose ASCII) Manual
3.
Page 5 of 15
Hardware Connections
The FieldServer is connected to the vendor device as shown in connection drawing.
Configure the ASCII Passive Client according to manufacturer’s instructions
Ethernet Network
Connection via std networking
interfaces such as hubs, switches,
routers.
ASCII Data
Source
Eg. Scale
Use 8917-02 or a 3 wire cable
where you connect the remote
device Xmit to RJ45-01, the remote
Receive to RJ45-08 and, the gound
wire to RJ45-04.
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-8705-06 GPA (General Purpose ASCII) Manual
4.
Page 6 of 15
Configuring the FieldServer as an GPA Driver 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 GPA (General Purpose ASCII) Driver 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 GPA (General Purpose ASCII) Driver
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
Data_Array_Name
Data_Array_Format
Data_Array_Length
Function
Legal Values
Up to 15 alphanumeric
Provide name for Data Array
characters
Float, Bit, UInt16, SInt16,
Provide data format. Each Data Packed_Bit,
Byte,
Array can only take on one format.
Packed_Byte,
Swapped_Byte
Number of Data Objects. Must be
larger than the data storage area
1-10,000
required by the Map Descriptors for
the data being placed in this array.
Example
//
Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
DA_DO_01,
Data_Array_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-8705-06 GPA (General Purpose ASCII) Manual
4.2.
Page 7 of 15
Client Side Connection Descriptions
Section Title
Connections
Column Title
Function
Legal Values
Specify which port the device is connected
Port
P1-P8, R1-R21
to the FieldServer
Protocol
Specify protocol used
ASCII
110 – 115200, standard
Baud*
Specify baud rate
baud rates only
Even, Odd, None, Mark,
Parity*
Specify parity
Space
Data_Bits*
Specify data bits
7, 8
Stop_Bits*
Specify stop bits
1
Handshaking* Specify hardware handshaking
RTS, RTS/CTS, None
Example
//
Client Side Connections
Connections
Port,
Protocol,
P8,
ASCII,
Baud,
9600,
Parity,
None,
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-8705-06 GPA (General Purpose ASCII) Manual
4.3.
Page 8 of 15
Client Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Connection
Function
Legal Values
Provide name for node
Up to 32 alphanumeric characters
This commonly used node
descriptor parameter has no
special meaning for this driver.
Incoming messages could come
from any node.
A Node_ID may be allocated and
any value may be used
Specify protocol used
ASCII.
Specify which port the device is
P1-P8, R1-R22
connected to the FieldServer
Example
//
Client Side Nodes
Nodes
Node_Name,
PLC 1,
Node_ID,
1,
Protocol,
ASCII,
Connection
P8
2
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-8705-06 GPA (General Purpose ASCII) Manual
4.4.
Page 9 of 15
Client Side Map Descriptors
4.4.1.
FieldServer Related Map Descriptor Parameters
Column Title
Legal Values
Up
to
32
Map_Descriptor_Name Name of this Map Descriptor
alphanumeric
characters
One of the Data
Name of Data Array where data is to be Array names from
Data_Array_Name
stored in the FieldServer
“Data
Array”
section above
0
to
maximum
specified in “Data
Data_Array_Offset
Starting location in Data Array
Array”
section
above
Function of Client Map Descriptor.
Function
4.4.2.
Column
Title
Node_Name
Data_Type
Length
Address
Function
Refer to the FieldServer configuration
information for more information. Note
Server, passive
that passive client means that the map
descriptor owns the Data Array
elements and no other active Map
Descriptor can address the same data.
Driver Related Map Descriptor Parameters
Function
Name of Node to fetch data from
Data type
Your choice affects how data is stored.
If you use a Digital type then data is
stored only as 1’s or Zero’s. If you use
non Float types the values are truncated.
Thus 0.6 is stored as zero.
Length of Map Descriptor
Specifies the maximum number of string
items that can be converted to numbers
and stored.
Other than ‘using up’ point count, there is
no danger in setting the length to a larger
number than required.
This commonly used parameter is not
used by this driver.
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
Ana_Input , Ana_Output ,
Register
, Float_Reg ,
Dig_Input , Dig_Output
1,2,3…
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-8705-06 GPA (General Purpose ASCII) Manual
4.5.
Page 10 of 15
Map Descriptor Example.
In this example, we provide a map descriptor to capture data from a scale and store it in a Data Array called ‘DA_Scale’. The 1st
element converted from the ASCII steam will be store at offset zero in the Data Array. The driver will convert and store floating point
numbers because the data_type is a floating point type. A maximum of 10 number fields can be processed and stored. The driver
only converts and stores the data when the ASCII stream ends. Read appendix xxxxxx to learn how the driver knows when a stream
has ended and it should process and strore data.
Map_Descriptors
Map_Descriptor_Name,
Store_Weights,
Map
Descriptor
Names do not
need to be unique
but making them
so may facilitate
trouble shooting.
Data_Array_Name,
DA_Scale,
The name of the
Data Array where
the incoming data
should be stored.
Data_Array_Offset,
0,
Driver waits passively
for incoming data.
There is no polling.
st
The 1
element of
converted data will be
stored at this location
in the DA. Subsequent
data is stored in
consecutive locations.
Function,
Passive,
Node_name
Node_A,
Connects this Map
Descriptor to a Node
Descriptor which in
turn points to a
connection descriptor.
Data_Type
Float-Reg
Length
10,
A maximum of
10 value items
will be stored.
When the driver processes the
stream it should (in this case) treat
the data as floating point data.
Ensure that the format of the Data is
suitable to store a floating point
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-8705-06 GPA (General Purpose ASCII) Manual
5.
Page 11 of 15
Configuring the FieldServer as a GPA Driver Server
Driver cannot be used to serve data. Contact the Sales group at FST if you are interested in
this functionality.
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-8705-06 GPA (General Purpose ASCII) Manual
Page 12 of 15
Appendix A. Advanced Topics
Appendix A.1. Separating Data Streams.
The driver processes the ASCII stream and stores the converted data when the stream
ends. By default the driver closes the stream when it receives the CR character (Hex code
= 0x0d Decimal code = 13).
The default end of stream character can be changed using the registry.
The example below is an extract from registry.ini. The Registry group is for port P1. Similar
groups can exist for other ports and a group may have more settings than those shown
below. If you wished to change the end of stream character to a NEW LINE character
(Hex=0x0a Decimal=10) then change the 13’s to 10’s in the example below. The default_
value is used by the registry when it receives a ‘restore defaults’ command.
[FieldServer_P1]
Termination_Char = 13
default_Termination_Char = 13
Appendix A.2. Interaction with the WebServer Driver
This driver is specially configured to watch for registry changes that are initiated from the
WebServer driver. It is possible to configure the connection settings of the port without
changing the configuration file as follows:
• Create web pages to change the registry settings.
• Browse to the web page.
• Change a setting.
• When the WebServer sees that the new settings have been updated it sets a signal for
the ASCII driver to use the new settings.
The html fragment below can be inserted in a Web Page. It will allow a user via a browser to
change the connection settings for P1.
<FST_COMBO
Reg_name
=
List_Items="300;600;1200;2400;4800;9600;19200;38400;115200;">
"FieldServer_P1:Baud"
<FST_TEXT Reg_name = "FieldServer_P1:Data_Bits" >
<FST_TEXT Reg_name = "FieldServer_P1:Stop_Bits" >
<FST_TEXT Reg_name = "FieldServer_P1:Parity" >
You can add a similar field for any parameter in the registry file but note that only some
registry settings are used by this driver and only some drivers (including this one) are
designed to be notified of a change and will work with the changed data.
Using this interface you can deliver a system which a customer can simply use to adjust the
connection settings without learning how to configure a FieldServer. Ensure that registry.ini
is installed on the FieldServer.
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-8705-06 GPA (General Purpose ASCII) Manual
Page 13 of 15
Appendix B. Troubleshooting tips
Appendix B.1. Timeouts
If the end of stream character has not been received in the default timeout period of 0.5
seconds the driver clears the incoming buffer and waits for the beginning of the next stream.
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-8705-06 GPA (General Purpose ASCII) Manual
Page 14 of 15
Appendix C. Driver Error Messages
Error
Description and Corrective Action
ASCII:#1
FYI.
Port
\"%s\"
Connection You can safely ignore this message. It is designed to make you
Parameters Can Be aware of the capability of the driver. Refer to Appendix A.2
Changed Remotely
You can safely ignore this message if the setting reported match
ASCII:#2a/b FYI. Port
your expectations. The driver is reporting that connection settings
\"%s\" Setting Changed
have been changed. The change resulted from a change to the
Remotely. New Setting:
FieldServer registry settings and this driver has been notified to start
%s
working with the new settings.
ASCII:#3a/b FYI. Port
The driver is reporting initial settings for port. The message is for
\"%s\" Initial Setting:%s
your information only and no corrective action is required if it
Start Char 0x%2X
confirms you expectations. If it doesn’t review and correct the
End
Char
0x%02X
configuration file or registry.ini file.
Termination Time %fs
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-8705-06 GPA (General Purpose ASCII) Manual
Page 15 of 15
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