Summary of the content on the page No. 1
A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-17 Optomux
APPLICABIL ITY & EFFECTIVITY
Effective for all systems m anufactured after January 1, 1999
Instruction Manual Part Number FS-8700-01
2/18/2004
Rev: 1.2
Summary of the content on the page No. 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
Summary of the content on the page No. 3
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 suppor
Summary of the content on the page No. 4
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 Visit our website: www.fieldserver.com E-mail: support@fieldserver.com Page 2
Summary of the content on the page No. 5
Gnd _ + FG Gnd _ + FG _ 5V 500mA +12V 500 mA _ 12V 500 mA + 5V 1. 5A 0V G nd _ + FG G nd _ + 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 * NEXT OPTOMUX * AC30A/B B1 OR B2 B1 OR B2 * B2 COMMUNICATION CONNECTIONS ARE MADE
Summary of the content on the page No. 6
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 comm
Summary of the content on the page No. 7
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 R1-R2, (FS-X40 Series) connected to the FieldServer R1 (FS-X20 Series) Baud* Specify baud rate 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. Parity* Specify parity Even, Odd, None, Mark, Space Data_Bits* Specify
Summary of the content on the page No. 8
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 One of the Data Array names stored / retrieved in the FieldServer. from “Data Array” section above The use of this array is dependent on the Optomux command used in the map descriptor. For ex
Summary of the content on the page No. 9
FS-8700-17 Optomux Driver Manual Da_Byte_Name* Names a data array that the driver will One of the Data Array names use to store poll/query response status 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 M
Summary of the content on the page No. 10
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_nam
Summary of the content on the page No. 11
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. Opto22_modifier1* A few Opto22_Functions require one ore See Chapter 6. more additional arguments. SET TIME DELAY GENERATE N PULSES READ AND AVERAGE INPUTS Additional information in chapter 6 will indicate the types of
Summary of the content on the page No. 12
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 nd indicate that the 2 position is on and all other positions are off. Map_Descriptor_Name, Da
Summary of the content on the page No. 13
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_
Summary of the content on the page No. 14
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, no
Summary of the content on the page No. 15
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_t
Summary of the content on the page No. 16
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
Summary of the content on the page No. 17
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
Summary of the content on the page No. 18
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 o
Summary of the content on the page No. 19
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 Visit our website: www.fieldserver.com E-mail: support@fieldserver.com Page 17
Summary of the content on the page No. 20
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
