FieldServer FS-8700-17 User Manual

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-17 Optomux

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after January 1, 199 9

Instruction Manual Part Number FS-8700-01

2/18/2004

Rev: 1.2

FS-8700-17 Optomux Driver Manual

TABLE OF CONTENTS

1 Optomux Driver Description...................................................................................................................1

1.1 Operating Methods.........................................................................................................................1

1.2 Statistics and Command Reponses ...............................................................................................1

2 Driver Scope of Supply..........................................................................................................................2

2.1 Supplied by FieldServer Technologies for this driver.....................................................................2

2.2 Provided by user.............................................................................................................................2

3 Hardware Connections ..........................................................................................................................3

4 Configuring the FieldServer as a Optomux Driver Client......................................................................4

4.1 Data Arrays.....................................................................................................................................4

4.2 Client Side Connections.................................................................................................................5

4.3 Client Side Nodes...........................................................................................................................5

4.4 Client Side Map Descriptors...........................................................................................................6

4.4.1 FieldServer Related Map Descriptor Parameters ...................................................................6

4.4.2 Driver Related Map Descriptor Parameters............................................................................7

4.4.3 Timing Parameters..................................................................................................................9

4.4.4 Map Descriptor Example 1 – Read on/off Status..................................................................10

4.4.5 Map Descriptor Example 2 – Read On/Off Status (Data stored differently) .........................11

4.4.6 Map Descriptor Example 3 – Command Response/Completion Status ...............................12

4.4.7 Map Descriptor Example 4 – Triggered Action .....................................................................13

4.4.8 Map Descriptor Example 5 – Using Address and Length to tell the FieldServer which module

positions to access...............................................................................................................................14

4.4.9 Map Descriptor Example 6 – Using a Mask to Address specific module positions .............15

4.4.10 Map Descriptor Example 7 – Specifying Module Positions Dynamically..............................16

5 Configuring the FieldServer as a Optomux Server.............................................................................17

6 Driver Notes.........................................................................................................................................18

6.1 Data_Array_Name, DA_Bit_Name, DA_Byte_Name...................................................................18

6.2 Module Positions ..........................................................................................................................18

6.3 Command Response Status.........................................................................................................18

6.4 Optomux Commands....................................................................................................................19

6.5 Driver Stats...................................................................................................................................25

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

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

Page Index

FS-8700-17 Optomux Driver Manual

1 Optomux Driver Description

The Optomux Driver allows the FieldServer to transfer data to and from devices over either
RS-232 or RS-485 using the Optomux Driver protocol.

The Optomux driver is a client only driver. This means that the driver can poll an
Optomux protocol compliant device but cannot emulate one.

The Optomux protocol provides a large command set. Many of the commands are used for
OPTO22 device configuration. This driver supports the full command set and thus the
driver may be used to configure as well as to poll OPTO22 devices.

1.1 Operating Methods

The Optomux driver provides three methods of operation. Users may use any
combination of methods.

Static Operation

If the hardware configuration is fixed and known then this is a suitable method. The
devices to be polled / commanded are configured using the FieldServer CSV file.

Dynamic Operation

If the hardware configuration may change or if hardware settings may change
dynamically or (more realistically) if you wish to change some aspect of the hardware
configuration such as a delay time or reset a latch without changing the CSV file and
resetting the FieldServer then this operating method is suitable. The commands set can
be configured by changing the values in the FieldServer’s data arrays. This operating
mode may be considered a data driven one.

Triggered Operation

This operating mode allows commands to be triggered by changing the value in the
FieldServer’s data arrays. This operating mode is useful if requiring an action triggered
by a remote device.

1.2 Statistics and Command Reponses

All FieldServer drivers report communication statistics that allow the operation of the
driver to be monitored.

In addition to the standard statistics, this driver exposes the communication statistics for
each port by presenting them in a user specified data array where they can be monitored
by a remote device or HMI system.

The Optomux driver also exposes the response status to each poll and command (if
required) by writing the response statuses to a user specified data array. This useful
feature allows remote devices to check whether a command has been completed
successfully.

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

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

Page 1

FS-8700-17 Optomux Driver Manual

2 Driver Scope of Supply

2.1 Supplied by FieldServer Technologies for this driver

Driver Manual.

2.2 Provided by user

Optomux System

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

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

Page 2

FS-8700-17 Optomux Driver Manual

A

A

A

3 Hardware Connections

The FieldServer is connected to the OPTO22 device as shown below.
Configure the OPTO22 device according to manufacturer’s instructions.

FS-X40

GndFG_

+

R2 R1

RS 485

(Opt o - Isolat ed)

B1 OR B2

Net 1

Et he rn et

10 Base T

COM

- + - + - + - +

FO FH TH TO

GndFG_

+

R2 R1

RS 48 5

(Opto - Isolated)

Gnd_+

- + - + - + - +

FO FH TH TO * *

PREVIOUS OPTOMUX *

* B2 COMMUNICATION CONNECTIONS ARE MADE TO THE RACK (PB4AH, PA8AH OR
PB16AH), NOT TO THE BRAIN BOARD.
** DO NOT CONNECT ANY "COM" POINT TO EARTH GROUND.

_

_

+

+12V 500m

Power

+

12V 500m

Net 2

5V 500m

5V 1.5A

0V

FG

DC AUX Power

Gnd

_

COM

- + - + - + - +

FO FH TH TO

GRO U ND 5

DTR 6
RTS 7

Tx 8

NEXT OPTOMUX *

B1 OR B2

RS 23 2

1 Rx

18

2 CTS
3 DSR
4 GROUND

AC30A/B

P8 P7 P 6 P5 P4 P3 P2 P1

COM

(408)-262-2299

FIELDSERVER - OPTO22

CONNECTION DIAGRAM

BASE NAME:
FILE NAME: T28700-17.VSD

DATE: 6/27/01
BY: MN

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

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

Page 3

FS-8700-17 Optomux Driver Manual

4 Configuring the FieldServer as a Optomux 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”
files on the driver diskette).

This section documents and describes the parameters necessary for configuring the
FieldServer to communicate with an Optomux Device.

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

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
Data_Format Provide data format. Each data array can

Data_Array_Length Number of Data Objects. Must be larger

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

characters
FLOAT, BIT, UInt16, SInt16,

only take on one format.

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

Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte
1-10,000

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

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

Page 4

FS-8700-17 Optomux 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

Parity* Specify parity Even, Odd, None, Mark, Space
Data_Bits* Specify data bits 7, 8

Stop_Bits* Specify stop bits
Protocol Specify protocol used Optomux
Handshaking* Specify hardware handshaking RTS, RTS/CTS, None

Poll Delay* Time between internal polls 0-32000 seconds

Example

// Client Side Connections

Connections
Port, Baud, Parity, Protocol, Handshaking, Poll_Delay
R1, 9600, None, Opto22 , None , 0.100s

R1-R2, (FS-X40 Series)
R1 (FS-X20 Series)
110 – 115200, standard baud
rates only

At the time of publication of this
manual the OPTO22 device’s
support standard baud Rates in
the range 300-38400.

1

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 OPTO22 device address. 0-255
Protocol Specify protocol used Optomux
Port Specify which port the device is

connected to the FieldServer

Example

// Client Side Nodes

Nodes
Node_Name, Node_ID, Protocol, Port
Optomux1 , 1 , Optomux , R1

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

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

Page 5

R1-R2, (P1-P8 with a

converter)

FS-8700-17 Optomux Driver Manual

4.4 Client Side Map Descriptors

4.4.1 FieldServer Related 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 / retrieved in the FieldServer.
The use of this array is dependent on

the Optomux command used in the map
descriptor.

For example some commands use one
data value for all module positions to be
affected by the command (Driver will
only use one data array element). Other
commands may use one data element
per module position specified. In this
case the FieldServer may use up to 16
data array elements.

To fully understand this, read the notes
in chapter 6.

Da_Bit_Name* This parameter is only required for

dynamic module position specification.
Ie. You intend using a data array to tell
the driver which module positions to
affect by a command. In this case use
this parameter. Up to 16 elements will
be inspected. The first element will
always be used for the first module
position , the 2

nd

element for the 2nd

module position ….
Module positions are specified by setting

the corresponding array element to a
non-zero value. Module positions are left
unspecified by setting the module array
position to zero.

The first element of this array that is
used is determined by the
Data_Array_Offset parameter.

Additional information is provided in
chapter 6.

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

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

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

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

Page 6

FS-8700-17 Optomux Driver Manual

Da_Byte_Name* Names a data array that the driver will

use to store poll/query response status

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

data.
One data element is used per map

descriptor. The element is determined
by the Data_Array_Offset parameter.

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

Array” section above

Function Function of Client Map Descriptor RDBC, WRBC, WRBX

4.4.2 Driver Related Map Descriptor Parameters

Column Title Function Legal Values

Node_Name Name of Node to fetch data

from

Address* This field is only required if the

address/length method of
module position specification is
used.

Length Length of Map Descriptor

Only some commands / queries
use the value of this map
descriptor parameter. This is
indicated in a table provide in
chapter 6.

For those commands and
queries that do use the Length
parameter the driver never uses
more than 16 elements of data
even if the length is set to a
larger number.

Although this driver does not
use the length parameter for
some commands the
FieldServer kernel does use
this parameter to ensure that no
more than one client map
descriptor has control of a
range of array data elements.
For this reason it is best to
always specify the length – in
these cases set it to 1.

One of the node names

specified in “Client Node

Descriptor” above

1..16

Indicating 1

st

to 16th module

position.

1 - 1000

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

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

Page 7