FieldServer Optomux FS-8700-17 Driver Manual

Driver Version:

1.01

Document Revision:

2

A Sierra Monitor Company

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after November 2009

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-17 Opto22

FS-8700-17_Opto22.doc Manual Table of Contents

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

TABLE OF CONTENTS

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

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

1.1.1 Static Operation .......................................................................................................................................... 1

1.1.2 Dynamic Operation ..................................................................................................................................... 1

1.1.3 Triggered Operation .................................................................................................................................... 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 Supplier of 3rd Party Equipment .................................................................................................... 2

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

3.1 Connection Notes ................................................................................................................................................ 3

4 Data Array Parameters ............................................................................................................................. 4

5 Configuring the FieldServer as an Optomux Driver Client ........................................................................... 5

5.1 Client Side Connection Parameters .................................................................................................................... 5

5.2 Client Side Nodes ................................................................................................................................................. 6

5.3 Client Side Map Descriptors................................................................................................................................ 6

5.3.1 FieldServer Related Map Descriptor Parameters ...................................................................................... 6

5.3.2 Driver Related Map Descriptor Parameters............................................................................................... 7

5.3.3 Timing Parameters ...................................................................................................................................... 8

5.3.4 Map Descriptor Example – Read on/off Status ......................................................................................... 9

Appendix A. Useful Features ........................................................................................................................... 10

Appendix A.1. Module Positions ................................................................................................................................... 10

Appendix A.1.1. Static Specification ...................................................................................................................... 10

Appendix A.1.2. Map Descriptor Example - Static Specification Using a Mask to Address specific module
positions 11

Appendix A.1.3. Map Descriptor Example -Specifying Module Positions Dynamically ...................................... 12

Appendix A.1.4. Map Descriptor Example – Triggered Action ............................................................................ 13

Appendix A.2. Store Unpacked Bit Data ....................................................................................................................... 14

Appendix A.3. Expose Command Response/Completion Status ................................................................................ 14

Appendix B. Reference ................................................................................................................................... 15

Appendix B.1. Optomux Commands............................................................................................................................. 15

Appendix B.2. Command Response Status .................................................................................................................. 21

Appendix B.3. Driver Stats ............................................................................................................................................. 21

FS-8700-17_Opto22.doc Manual Page 1 of 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

1 OPTOMUX DRIVER DESCR IPTION

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.

1.1. 1 Static Operation

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

1.1. 2 Dynamic Ope ration

The commands set can be configured by changing the values in the FieldServer’s Data Arrays. This data driven
operating mode is suitable if the hardware configuration may change or if hardware settings may change
dynamically or to change some aspect of the hardware configuration without changing the CSV file and resetting
the FieldServer..

1.1. 3 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.

FS-8700-17_Opto22.doc Manual Page 2 of 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

2 DRIVER SCOPE OF SUPPLY

2.1 Supplied by FieldSer ver Technologies for this dri ver

FieldServer Technologies PART #

Description

FS-8700-17

Driver Manual.

2.2 Provided by Supplier of 3

rd

Party Equipment

Part #

Description

Optomux System

FS-8700-17_Opto22.doc Manual Page 3 of 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

3 HARDWARE CONNECTIONS

The FieldServer is connected to the OPTO22 device as shown below.

Configure the OPTO22 device according to manufacturer’s instructions.

- + - + - + - +

COM

FH TH

PREVIOUS OPTOMUX

- + - + - + - +

COM

AC 30 A/ B

- + - + - + - +

COM

NEXT OPTOMUX

R2 R1

Gnd

_

+

Gnd

FG

_

+

FO TO FH THFO TO

FH THFO TO

FieldServer

B1 or B2

B1 or B2

RS-485

Opto Isolated

3.1 Connection Notes

 B2 Communication connections are made to the rack (PB4AH, PA8AH, PB16AH), not to the brain board.
 COM points must not be connected to Earth Ground.
 Bridging 4-wire RS-422 to get 2-wire RS-485 may not work in certain applications, and in this case it is

recommended that a RS-232 to RS-422 converter is used in between the FieldServer and the OPTO 22 devices .

FS-8700-17_Opto22.doc Manual Page 4 of 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

4 DATA ARRAY PARAMETERS

Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary
to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data.

Section Title

Data_Arrays

Column Title

Function

Legal Values

Data_Array_Name

Provide name for Data Array

Up to 15 alphanumeric characters

Data_Array_Format

Provide data format. Each Data Array can only take on
one format.

Float, BIT, UInt16, SInt16,
Packed_Bit, Byte, Packed_Byte,
Swapped_Byte

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.

1-10, 000

Example

// Data Arrays

Data_Arrays

Data_Array_Name

, Data_Array_Format

, Data_Array_Length

DA_AI_01

, UInt16

, 200

DA_AO_01

, UInt16

, 200

DA_DI_01

, Bit

, 200

DA_DO_01

, Bit

, 200

FS-8700-17_Opto22.doc Manual Page 5 of 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

5 CO NFIGURING THE FI ELDSERVER AS AN 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.

5.1 Client S ide Connection Parameters

Section Title

Connections

Column Title

Function

Legal Values

Port

Specify which port the device is
connected to the FieldServer

R1-R2, (FS-X40 Series)
R1 (FS-X20 Series)

Baud*

Specify baud rate

Standard baud Rates in the range 300-38400. (Vendor
Limitation), 9600

Parity*

Specify parity

Even, Odd, None, Mark, Space

Data_Bits*

Specify data bits

7, 8

Stop_Bits*

Specify stop bits

1 (Vendor Limitation)

Protocol

Specify protocol used

Optomux

Poll Delay*

Time between internal polls

0-32000 seconds, 1 second

Example

// Client Side Connections

Connections

Port

, Baud

, Parity

, Protocol

, Poll_Delay

R1

, 9600

, None

,Opto22

, 0.100s

FS-8700-17_Opto22.doc Manual Page 6 of 24

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

5.2 Client S ide 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

P1-P8 (with convertor), R1-R21

Example

// Client Side Nodes

Nodes

Node_Name

, Node_ID

, Protocol

, Port

Optomux1

, 1

, Optomux

, R1

5.3 Client S ide Map Descriptors

5.3. 1 FieldSer ver Related Map Desc riptor 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.

One of the Data Array
names from Section 4.

Data_Array_Offset

Starting location in Data Array

O to
(Data_Array_Length-1)

Function

Function of Client Map Descriptor

Rdbc, Wrbc, Wrbx

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.