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, 1999
Instruction Manual Part Number FS-8700-01
2/18/2004
Rev: 1.2
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-2299 fax: (408) 262-9042
Page 1
E-mail: [email protected]
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-2299 fax: (408) 262-9042
Page 2
FS-8700-17 Optomux
Driver Manual
3 Hardware Connections
The FieldServer is connected to the OPTO22 device as shown below.
Configure the OPTO22 device according to manufacturer’s instructions.
COM
COM
COM
- + - + - + - +
- + - + - + - +
- + - + - + - +
FO FH TH TO * *
FO FH TH TO
FO FH TH TO
PREVIOUS OPTOMUX *
B1 OR B2
NEXT OPTOMUX *
B1 OR B2
AC30A/B
*
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.
FS-X40
Power
Net
1
Net
2
P8
P7
P6
P5
P4
P3
P2
P1
RS 232
Et her n et
10 Base T
R2
RS 485
(Opto - Isolated)
R1
GROUND
DTR
5
6
7
8
1
2
3
4
Rx
CTS
8
1
RTS
DSR
Tx
GROUND
DC AUX Power
R2
R1
RS 485
(Opto - Isolated)
(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-2299 fax: (408) 262-9042
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
Data_Array_Name
Function
Provide name for Data Array
Legal Values
Up to 15 alphanumeric
characters
Data_Format
Provide data format. Each data array can FLOAT, BIT, UInt16, SInt16,
only take on one format.
Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte
1-10,000
Data_Array_Length
Number of Data Objects. Must be larger
than the data storage area required 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_Format,
UInt16,
UInt16,
Bit,
Data_Array_Length
200
200
200
200
Bit,
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 4
FS-8700-17 Optomux
Driver Manual
Legal Values
4.2 Client Side Connections
Section Title
Connections
Column Title
Port
Function
Specify which port the device is R1-R2, (FS-X40 Series)
connected to the FieldServer
Specify baud rate
R1 (FS-X20 Series)
110 – 115200, standard baud
rates only
Baud*
At the time of publication of this
manual the OPTO22 device’s
support standard baud Rates in
the range 300-38400.
Parity*
Data_Bits*
Specify parity
Specify data bits
Even, Odd, None, Mark, Space
7, 8
Stop_Bits*
Protocol
Specify stop bits
1
Specify protocol used
Optomux
Handshaking*
Poll Delay*
Specify hardware handshaking
Time between internal polls
RTS, RTS/CTS, None
0-32000 seconds
default 1 second
Example
//
Client Side Connections
Connections
Port, Baud, Parity, Protocol, Handshaking, Poll_Delay
R1, 9600, None, Opto22 , None , 0.100s
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
Protocol
Port
OPTO22 device address.
Specify protocol used
Specify which port the device is R1-R2, (P1-P8 with a
connected to the FieldServer converter)
0-255
Optomux
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-2299 fax: (408) 262-9042
Page 5
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
Up to 32 alphanumeric
characters
Map_Descriptor_Name Name of this Map Descriptor
Data_Array_Name
Name of Data Array where data is to be
stored / retrieved in the FieldServer.
One of the Data Array names
from “Data Array” section above
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 2nd element for the 2nd
module position ….
One of the Data Array names
from “Data Array” section above
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.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
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
data.
One of the Data Array names
from “Data Array” section above
One data element is used per map
descriptor. The element is determined
by the Data_Array_Offset parameter.
Starting location in Data Array
Data_Array_Offset
Function
0 to maximum specified in “Data
Array” section above
RDBC, WRBC, WRBX
Function of Client Map Descriptor
4.4.2 Driver Related Map Descriptor Parameters
Column Title
Node_Name
Function
Name of Node to fetch data
from
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
1..16
Address*
Length
This field is only required if the
address/length method of
module position specification is
used.
Indicating 1st to 16th module
position.
Length of Map Descriptor
1 - 1000
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.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 7
FS-8700-17 Optomux
Driver Manual
Opto22_trigger*
An optional parameter. If used then set the No, Yes
value of this parameter to yes or no and
the da_byte_name parameter must be
specified too.
When this parameter is set to yes then the
Optomux driver processes this map
descriptor differently from a normal wrbc or
rdbc function.
The driver processes the map descriptor at
the scan interval specified. Each time that
it is processed the driver checks the
element of the da_byte_name data array
specified. If the value of the 1st element of
array located at data_array_offset is 1 then
the driver executes the command. If the
value is not equal to one then the driver
ignores the map descriptor.
If the map descriptor is triggered then the
driver will write a response status to the
same data element on completion of the
poll. Thus the value of 1 will be set to zero
for success or some other value indicating
an error.
More information is provided in chapter 6.
This parameter only has meaning when
the function is a read of digital data.
Opto22_format*
Bit, Packed
By default the OPTO22 devices returns 16
position states when digital data is read (
eg. READ STATUS). The Optomux driver
writes the data as one 16 bit unsigned
integer to one data element of the data
array specified. (That is, the data is written
to the data array in packed bit format.)
For example, if the 1st and 5th inputs were
on and all others were off the driver would
write the value 17 to the first element of the
data array.
The driver can be instructed to unpack this
data into separate bit states, writing each
module position’s state to a consecutive
data array element.
When the Bit keyword is used the driver
sets the states of consecutive data array
elements starting at Data_Array_Offset.
The number of elements that are written is
determined by length and a maximum of
16 elements will be written.
Opto22_function
This parameter is specified by using one of See Table 6.1
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 8
FS-8700-17 Optomux
Driver Manual
the functions provided in table 6.1.
The parameter must be spelled and
spaced exactly as provided in the table.
Leading and trailing spaces are not
important but inter-word spaces are very
important. Take care not to use tabs.
A few Opto22_Functions require one ore
more additional arguments.
Opto22_modifier1*
See Chapter 6.
SET TIME DELAY
GENERATE N PULSES
READ AND AVERAGE INPUTS
Additional information in chapter 6 will
indicate the types of values that may be
assigned to this parameter.
Opto22_modifier2*
Opto22_mask*
See Opto_modifier1
The mask specifies the positions (1-16) of
a module that will be affected by a
command.
0-65535
or
The positions can be specified dynamically 0x0000 – 0xffff
using a data array or statically by using this
parameter.
When this parameter is used and its value
is non zero then the driver does not
consider the data contained in the position
defining array even if it is also defined.
The value of the mask may be specified in
hexadecimal or in decimal.
To specify a number in hexadecimal the
number must be prefixed with 0x and have
a maximum of 4 digits.
Examples.
Decimal: 257 -> Indicates the 1st and 9th
positions.
Hexadecimal: 0x0101 -> indicates the 1st
and 9th positions.
4.4.3 Timing Parameters
Column Title
Function
Legal Values
Scan_Interval
Rate at which data is polled
>0.1s
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 9
FS-8700-17 Optomux
Driver Manual
4.4.4 Map Descriptor Example 1 – Read on/off Status
In this example the on/off status of all module positions of the Optomux device are read and stored. They are read continuously (rdbc) every 5 seconds
(Scan_Interval). The Read Status command returns one packed 16 bit value. There is one bit per module position, thus, if the returned value was 2 then this would
indicate that the 2nd position is on and all other positions are off.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Length, Scan_Interval, opto22_function ,
DEVICE77_STAT , DISC_INPUTS , 0
, rdbc , DEV77 , 1
, 5.0s
, READ STATUS ,
Map descriptor
names are often
used in error
messages so it may
be helpful to have
unique names.
This is the name of
The device will
be read
continuously.
This is the name
of the node. The
node must have
previously been
defined in the
Nodes section
of the CSV file.
Its Node_ID
Only one
element of the
data array is
reserved for this
map descriptor.
This is the name
of the Optomux
command /
query that must
be performed.
the data array in
which the data will
be stored.
Ensure that the
Data_Format of the
array is suitable for
storing the data
returned by the
device.
The data will be
stored at offset
zero (First
element) of the
data array.
It must be
spelled and
spaced exactly
as in table 6.1
Dashes, spaces,
upper and lowercase
characters may be
used.
should be set to
77 to reference
the device
addressed as 77.
Chapter 6 provides
details of the type of
data returned by
each command.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 10
FS-8700-17 Optomux
Driver Manual
4.4.5 Map Descriptor Example 2 – Read On/Off Status (Data stored differently)
This example reads the same data as the previous example. The difference is that the data is stored differently. In this example the data is
unpacked and stored in 16 consecutive data array elements – one element per module position.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Length, Scan_Interval, opto22_function , opto22_format
DEVICE77_STAT , DISC_INPUTS , 0
, rdbc , DEV77 , 16
, 5.0s
, READ STATUS , Bit
This is how the
driver is instructed
to unpack the digital
data.
The length has
changed to 16 to
reserve 16 data array
elements for this
map descriptor.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 11
FS-8700-17 Optomux
Driver Manual
4.4.6 Map Descriptor Example 3 – Command Response/Completion Status
We use example 1 to show how it can be modified to get the driver to expose the response / status generated when the command was executed.
The response / status values indicate the success / failure of the command based either on the driver’s ability to complete the command OR on
the ack/nack returned by the device.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Length, Scan_Interval, opto22_function , DA_Byte_Name
DEVICE77_STAT , DISC_INPUTS , 0
, rdbc , DEV77 , 1
, 5.0s
, READ STATUS, RESPONSE_ARR
By virtue of defining the DA_Byte_Name parameter the
driver will now store a response status each time the poll is
executed.
The response / status code will be stored in the data array
called REPONSE_ARR. One element of the array located
at Data_Array_Offset will be used. The data array’s data
format should at least be able to store a byte of data as
response/status codes range from 0-255.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 12
FS-8700-17 Optomux
Driver Manual
4.4.7 Map Descriptor Example 4 – Triggered Action
This example shows the elements necessary to generate a triggered poll. Even though this map descriptor appears to write to the device
continuously the driver recognizes the opto22_trigger parameter and based on its value will only send the poll when the trigger value is set.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Length, Scan_Interval, opto22_function , opto22_trigger, DA_Byte_Name
DEVICE77_STAT , CNTR_POSNS , 0
, wrbc , DEV77 , 16 , 0.2s
, CLEAR COUNTERS , Yes
, COMMAND_ARRAY
This map descriptor
is processed as a
write command and
will be processed
continuously.
The Driver will process this
map descriptor every 0.2
seconds.
This keyword value for the
opto22_trigger parameter
tells the driver only to send
this Optomux command if it
has been triggered.
This is the name of a data array
whose contents will be used to
trigger the command.
In this example, this does not
mean that the command will
be sent to the device every
0.2 seconds. It does mean
that the driver will check to
see if a trigger has been set
every 0.2 seconds.
The driver looks at the element
found at the Data_Array_Offset
and if that value=1 then the
command is sent. On
completion/error the driver will
change this value to some other
number.
When this parameter is used
the DA_Byte_Name
parameter must also be used.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 13
FS-8700-17 Optomux
Driver Manual
4.4.8 Map Descriptor Example 5 – Using Address and Length to tell the FieldServer which module positions to access.
This example shows a map descriptor which reads analog inputs from an Optomux Device. The address and length tell the driver which inputs to
read. Take care to ensure that the data array used for storage has a data format suitable for storing the data type returned by the command. In
this case an unsigned integer at least 16 bits long ( eg UINT16 or FLOAT). Also take care to ensure that you understand the scaling of the data
returned by the Optomux device. There are parameters that you can add to a map descriptor to have the driver scale the value. This is discussed
in the FieldServer Configuration Manual.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Address, Length, Scan_Interval, opto22_function
DEVICE77_STAT , ANA_DATA , 0
, rdbc , DEV77 , 2
, 15 , 1.0s
, READ ANALOG INPUTS
Data read from the
Optomux Device is
placed in this array.
The first module
position that is read
is position 2.
Data from 15
This is the Optomux
Driver function that
must be performed.
module positions
must be read. Thus
starting at 2, the last
module position
read is 16.
Module positions
are numbered 1 to
16.
Starting at this array
position.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 14
FS-8700-17 Optomux
Driver Manual
4.4.9 Map Descriptor Example 6 – Using a Mask to Address specific module positions
There may be occasions when it is not suitable to use address and length. For example if you are attempting to address non-consecutive
Optomux module positions OR when you wish to use a command that affects all module positions. The driver provides an alternate method for
module position specification by allowing you to specify a mask as a parameter in the CSV file. The mask may be specified in decimal or
hexadecimal format.
In this example, module positions 1 and 5 are pulsed.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Length, Scan_Interval, opto22_mask, opto22_function
PULSE77
, TIME_DATA , 0
, wrbc , DEV77 , 1
, 10.0s
, 0x0011
, START ON PULSE
This function turned
on the specified
module positions for
a specified period.
Un specified
Module positions are specified in hexadecimal
in this example.
positions (mask bit
positions equal zero)
are non affected by
the command.
0x0001 = Module Position 1
0x0002 = Module Position 2
0x0003 = Module Positions 1 & 2
…..
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 15
FS-8700-17 Optomux
Driver Manual
4.4.10 Map Descriptor Example 7 – Specifying Module Positions Dynamically
Previous examples addressed module positions statically. This example illustrates how you can use a data array’s value to specify the module position’s to be
affected by a command. As data arrays can have their values changed by remote devices, the module position specification may be changed dynamically. The
CSV file does not require editing. This method can be used all the time or only if you wish to use one of those commands which would typically require dynamic
addressing.
In this example, module positions 1 and 5 are pulsed.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Length, Scan_Interval, DA_Bit_Name , opto22_function
CLRLOW77
, LOW_ARRAY , 0
, wrbc , DEV77 , 16
, 10.0s
, POS_ARR , READ AND CLEAR LOWEST VALUES
In this example, the driver will store 16 lowest values in an array
called LOW_ARR starting at position Data_Array_Offset.
Any number 1 to 16.
This data array will be used by
the driver to determine the
module positions to be affected
by the command.
The driver stops at
16, ignoring larger
values.
The driver uses the length
(max=16) and the
Data_Array_Offset. The first
specified element corresponds to
module position 1. If its value is
non-zero then the position is
specified by the driver.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 16
5 Configuring the FieldServer as a Optomux Server
The FieldServer does not support the emulation of an Optomux server at present.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 17
E-mail: [email protected]
FS-8700-17 Optomux
Driver Manual
6 Driver Notes
6.1 Data_Array_Name, DA_Bit_Name, DA_Byte_Name
These parameters are used to specify data array names. Despite their
names a data array of any Data_Format can be used for any of these
parameters.
This driver uses DA_Byte_Name exclusively as a location for the commands
to trigger map descriptors and in which to store poll response status.
The use of DA_Bit_Name is command sensitive and is used to allow the
values in a data array to determine the module positions to be affected by a
command.
The use of the Data_Array_Name Parameter is typical i.e. Used to store
data that is read or used as a source for data that is written.
6.2 Module Positions
Specify module positions Statically by
•
•
Using Address and Length
or
or
Using the opto22_mask parameter
Specify module positions dynamically by
Using the values of a data array (da_bit_array)
•
What happens if more than one method is used for module position specification ?
The driver evaluates the specification in the order listed above. Thus if address &
length are specified as well as the opto22_mask, the driver will use the address
and length.
6.3 Command Response Status
If a data array is specified using the DA_Byte_Array parameter then the driver
will store a response status code in the array, updating the value each time a
command is executed.
Value
Description
0
1
Command completed successfully.
Used to trigger a command.
All other values indicate error conditions. For Responses 128 to
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 18
FS-8700-17 Optomux
Driver Manual
255 the Optomux literature should be read for additional
information as these are codes returned by the Optomux device.
128
Nak from Optomux Device. Power Up Clear Expected. Command
Ignored.
129
130
131
132
133
134
135
Nak from Optomux Device. Undefined Command
Nak from Optomux Device. Checksum Error
Nak from Optomux Device. Input Buffer Overun
Nak from Optomux Device. Non Printable Ascii character received
Nak from Optomux Device. Data Field Error
Nak from Optomux Device. Communication watchdog timeout
Nak from Optomux Device. Specified limits invalid.
The following codes are generated by the driver. They all indicate
errors.
250
251
An ack with no data was expected. Ack with Data was received.
The driver Complete function returned an error, could be
checksum, bad 1st char ... ie. The message was badly formatted.
Driver Timeout
An ack was received but it was badly formatted
A nak was received but was badly formatted
Message was not acknowledged correctly.
252
253
254
255
6.4 Optomux Commands
The following provides a list of commands supported by the driver. The Command
Name’s provided in the table must be used in providing values for the opto22_function
parameter. The notes provided only apply when module positions are specified
dynamically.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 19
E-mail: [email protected]
FS-8700-17 Optomux
Driver Manual
NOTES
COMMAND NAME
OPTO22_FORMAT MASTER LENGTH
Read/
OPTION
CONSIDERED (See
Notes)
Write/
Both
POWER UP CLEAR
4
4
4
w
w
w
RESET
SET TURN-AROUND DELAY
Uses 1 element of data array. Legal
values are 0,1,2,3
Uses 1 element of data array. Legal
values are 0 to 7
Uses the 1st element of data array for
the timer value.
Uses 1 element of data array. Legal
values are 0,1
SET WATCHDOG DELAY
SET WATCHDOG DELAY (Analog)
SET PROTOCOL
4
3
4
4
w
w
w
r
IDENTIFY Optomux TYPE
Polled data is stored in the 1st
element of the data array.
Delay is found in data array.
SET ENHANCED DIGITAL WATCHDOG
SET ENHANCED ANALOG WATCHDOG
3
1
w
w
Uses up to Length (max=16) array
elements. Module positions specified
get setup for fail values by using the
corresponding positions in data array.
Uses 1 element of data array.
SET TIMER RESOLUTION
w
w
SET TEMPERATURE PROBE TYPE
3
3
Temp probe type is found in first
element of data array
Non-zero module positions get set to
outputs. Zero module positions get
set to inputs
CONFIGURE POSITIONS
w
CONFIGURE AS INPUTS
CONFIGURE AS OUTPUTS
3
3
w
w
Only module positions specified get
affected by command.
Only module positions specified get
affected by command.
READ MODULE CONFIGURATION
WRITE OUTPUTS
4
1
r
w
Uses up to Length (max=16) array
elements. Non-zero elements get
turned on, zero value elements get
turned off.
ACTIVATE OUTPUTS
DEACTIVATE OUTPUTS
READ STATUS
3
3
2
w
w
r
Only module positions specified get
affected by command.
Only module positions specified get
affected by command.
If format=Bit then length is considered
during storage as bits are unpacked
into data array. If format is non equal
to bit then result is written as a single
value into one array element.
1
Retrieved data is stored in data array.
Always affects all module positions.
Cannot be limited by length. Length is
only used when determining which
module positions are specified as
non-zero. Non-zero (Specified)
elements get set on->off, Zero (Non-
SET LATCH EDGES
3
w
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 20
FS-8700-17 Optomux
Driver Manual
NOTES
COMMAND NAME
OPTO22_FORMAT MASTER LENGTH
Read/
OPTION
CONSIDERED (See
Notes)
Write/
Both
Specified) module positions get set
off->on
Only module positions specified get
affected by command.
Only module positions specified get
affected by command.
If format=Bit then length is considered
during storage as bits are unpacked
into data array. If format is non equal
to bit then result is written as a single
value into one array element.
Non-zero (Specified) module
positions get affected (cleared) by
command. But all positions get read.
Read data get stored in data array.
During storage opto22_format is
considered. If format=bit then data is
unpacked and stored otherwise the
result for all 16 positions is stored as
one data element.
SET LATCH OFF TO ON
3
3
2
w
w
r
SET LATCH ON TO OFF
READ LATCHES
1
1
READ AND CLEAR LATCHES
3,2
b
CLEAR LATCHES
3
3
w
w
Only module positions specified get
affected by command.
START/STOP COUNTERS
All positions are affected by
command. Non-zero (specified)
module positions start counting, zero
(unspecified) module positions stop
counting
START COUNTERS
STOP COUNTERS
READ COUNTERS
3
3
1
w
w
r
Only module positions specified get
affected by command.
Only module positions specified get
affected by command.
Data that is read is put into the
corresponding array elements of the
data array based on which module
positions are read.
READ AND CLEAR COUNTERS
1
b
Data that is read is put into the
corresponding array elements of the
data array based on which module
positions are read.
CLEAR COUNTERS
SET TIME DELAY
3
3
w
w
Only module positions specified get
affected by command.
The Modifier is specified in the CSV
file with the opto22_modifier1
parameter. The data (timeout) is
retrieved from the first element of the
data array.
INITIATE SQUARE WAVE
3
3
3
w
w
w
HIGH RESOLUTION SQUARE WAVE
RETRIGGER TIME DELAY
Only module positions specified get
affected by command.
Only specified module positions get
GENERATE N PULSES
3
w
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 21
FS-8700-17 Optomux
Driver Manual
NOTES
COMMAND NAME
OPTO22_FORMAT MASTER LENGTH
Read/
OPTION
CONSIDERED (See
Notes)
Write/
Both
affected. The Modifier (byte 1&2) are
specified in the CSV file with the
opto22_modifier1/2 parameters. The
data (number of pulses) is retrieved
from the 1st element of the data
array.
Only specified module positions get
affected. The data (period of pulses)
is retrieved from the 1st element of
the data array.
Only specified module positions get
affected. The data (period of pulses)
is retrieved from the first element of
the data array.
All Module positions are affected by
this command. Non-zero (Specified)
module positions triggered by on,
zero module positions (un-specified)
elements get triggered by off.
Only module positions specified get
affected by command.
START ON PULSE
3
3
3
w
w
w
START OFF PULSE
SET TRIGGER POLARITY
TRIGGER ON POSITIVE
3
3
2
w
w
r
TRIGGER ON NEGATIVE
READ PULSE COMPLETE BITS
Only module positions specified get
affected by command.
1
If format=Bit then length is considered
during storage as bits are unpacked
into data array. If format is non equal
to bit then result is written as a single
value into one array element.
Retrieved data is stored in standard
data array.
READ DURATION COUNTERS
3
3
r
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
Only specified module positions get
read. Data read gets put in
READ AND CLEAR DURATION
COUNTERS
b
corresponding positions of data array.
Only module positions specified get
affected by command.
Only specified module positions get
written. Data written gets extracted
from corresponding positions of data
array.
CLEAR DURATION COUNTERS
WRITE ANALOG OUTPUTS
3
3
w
w
READ ANALOG OUTPUTS
3
3
r
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
Only specified module positions get
written. Data written gets extracted
from corresponding positions of data
array.
UPDATE ANALOG OUTPUTS
w
READ ANALOG INPUTS
3
r
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 22
FS-8700-17 Optomux
Driver Manual
NOTES
COMMAND NAME
OPTO22_FORMAT MASTER LENGTH
Read/
OPTION
CONSIDERED (See
Notes)
Write/
Both
r
READ AND AVERAGE INPUT
4
Only one module position may be
specified. This position is averaged
and the result is put in the first
element of the data array The number
of samples is specified in modifier1 in
the csv file.
START INPUT AVERAGING
3
2
w
r
Only specified module positions get
affected by command. First element
in data array is sent as the number of
sample to average over.
If format=Bit then length is considered
during storage as bits are unpacked
into data array. If format is non equal
to bit then result is written as a single
value into one array element.
Retrieved data is stored in standard
data array.
READ AVERAGE COMPLETE BITS
1
READ INPUT AVERAGE DATA
READ TEMPERATURE INPUTS
READ AVERAGE TEMPERATURE INPUTS
SET INPUT RANGE
3
3
3
3
r
r
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
Only specified module positions have
their range set to the 2 values found
in the data array. 1st is high limit,
second is lo limit.
r
w
READ OUT-OF-RANGE LATCHES
4
3
r
High limit latches are placed in first
element of data array. Low limit
latches are placed in 2nd element of
data array.
Only specified module positions get
read and cleared. Data read gets put
in corresponding positions of data
array.
READ AND CLEAR RANGE LATCHES
b
CLEAR OUT-OF-RANGE LATCHES
READ LOWEST VALUES
4
3
w
r
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
Only module positions specified get
affected by command.
Only specified module positions get
read and cleared. Data read gets put
in corresponding positions of data
array.
CLEAR LOWEST VALUES
3
3
w
b
READ AND CLEAR LOWEST VALUES
READ PEAK VALUES
CLEAR PEAK VALUES
3
3
r
Only specified module positions get
read. Data read gets put in
corresponding positions of data array.
w
Only module positions specified get
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 23
FS-8700-17 Optomux
Driver Manual
NOTES
COMMAND NAME
OPTO22_FORMAT MASTER LENGTH
Read/
OPTION
CONSIDERED (See
Notes)
Write/
Both
affected by command.
READ AND CLEAR PEAK
3
1
1
1
1
1
1
4
b
Only specified module positions get
read and cleared. Data read gets put
in corresponding positions of data
array.
Only specified module positions get
calculated and read. Data read gets
put in corresponding positions of data
array.
Only specified module positions get
written. Data written gets extracted
from corresponding positions of data
array.
Only specified module positions get
calculated and read. Data read gets
put in corresponding positions of data
array.
Only specified module positions get
calculated and read. Data read gets
put in corresponding positions of data
array.
Only specified module positions get
written. Data written gets extracted
from corresponding positions of data
array.
Only specified module positions get
calculated and read. Data read gets
put in corresponding positions of data
array.
Uses opto22_modifier1/2 from the
CSV file set waveform rates and
types. Only specified positions get
affected. 2 elements of data array
are used.
CALCULATE OFFSETS
r
SET OFFSETS
w
r
CALCULATE AND SET OFFSETS
CALCULATE GAIN COEFFICIENTS
SET GAIN COEFFICIENTS
CALCULATE AND SET GAIN
SET OUTPUT WAVEFORM R
r
w
r
w
IMPROVED OUTPUT WAVEFORMS
4
w
Uses opto22_modifier1/2 from the
CSV file set waveform rates and
types. Only specified positions get
affected. 3 elements of data array
are used.
Notes on how the Length parameter is used in the CSV file.
1. The length parameter is always considered.
2. The length parameter is only considered when the keyword Bit is used in the
opto22_format parameter.
3. The length is only used using the address/length method to specify module
positions or when the dynamic method is used to specify module positions.
4. The length is never considered.
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 24
E-mail: [email protected]
FS-8700-17 Optomux
6.5 Driver Stats
Driver Manual
In addition to the standard FieldServer communication statistics described in the FieldServer
User’s Manual the Optomux Driver can also expose some driver statistics by writing data to
a data array. A special map descriptor is required. The driver recognizes the map
descriptor by its name which must be "opto22-stats" .
The following example shows how this special map descriptor can be configured.
Nodes
Node_name, Node_ID, Protocol
null_node,
0
, Optomux
Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length
OPTO22_STATS , UINT32
, 300
Map_Descriptors
Map_descriptor_Name, Data_Array_Name, Node_name, length
Opto22-stats , OPTO22_STATS , null_node , 300
When the driver sees this map descriptor it uses the data array SK_STATS (in this
example) to store driver specific statistics. Only one of these map descriptors may be
specified per FieldServer.
The driver stores the following data.
Array Element
Contents
OPTO_STAT_BAD_FUNCTION
0
1
The Opto22_Function has a
bad value.
Mask cannot be specified in a
CSV file with a zero value.
OPTO_STAT_DYNAMIC_MASK
2
OPTO_STAT_TIMEOUT
3
4
OPTO_STAT_STREAMING
OPTO_STAT_NAK
5
OPTO_STAT_PROTOCOL
6
7
8
9
10
11
12
12
OPTO_STAT_IC_TIMEOUT
OPTO_STAT_DEVICE_MSG_RECD
OPTO_STAT_DEVICE_BYTES_RECD
OPTO_STAT_DEVICE_FUNCTION
OPTO_STAT_NO_START
OPTO_STAT_MSG_IGNORED
OPTO_STAT_POLL_MSG_SENT
OPTO_STAT_POLL_BYTES_SENT
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 25
FS-8700-17 Optomux
Driver Manual
7 Revision History
Doc.
Rev.
Date
Resp
Format
Driver Ver.
Comment
2/18/04
JD
MF
0
1
Releasing
FieldServer Technologies 1991 Tarob Court, Milpitas, California 95035 (408) 262-2299 fax: (408) 262-9042
Page 26
|