A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-42 Spectronics
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Version:
1.00
Document Revision: 4
FS-8700-42_Spectronics Driver Manual
Page 3 of 15
1.
Spectronics Description
The Spectronics driver allows the FieldServer to transfer data to and from devices over either
RS-232 or RS-485 using Spectronics protocol. The FieldServer can emulate either a Server or
Client.
The information that follows describes how to expand upon the factory defaults provided in the
configuration files included with the FieldServer.
FS-8700-42_Spectronics Driver Manual
Page 4 of 15
2.
Driver Scope of Supply
2.1. Supplied by FieldServer Technologies for this driver
FieldServer Technologies
PART #
Description
FS-8915-10
7’ Patch Cable
FS-8917-01
FS-8700-01
RJ45 to DB25M connector adapter
Driver Manual
2.2.
Provided by Supplier of 3rd Party Equipment
PART #
DESCRIPTION
Spectronics Device
FS-8700-42_Spectronics Driver Manual
Page 5 of 15
3.
Hardware Connections
It is possible to connect a Spectronics device to any of the existing serial ports on the
FieldServer1. These ports simply need to be configured for Spectronics in the configuration file.
Configure the Spectronics device according to manufacturer’s instructions.
8917-01 WIRE LIST
DB25M
FUNCTION FROM
TO
COLOUR
RX
CTS
DSR
GND
GND
DTR
RTS
TX
RJ45-01 DB25M-03 WHITE
RJ45-02 DB25M-05 BROWN
RJ45-03
YELLOW
RJ45-04 DB25M-07 GREEN
RJ45-05
RJ45-06
RED
BLACK
RJ45-07 DB25M-04 ORANGE
RJ45-08 DB25M-02
BLUE
8917-04 WIRE LIST
DB25F
FUNCTION FROM
TO
COLOUR
RX
CTS
DSR
GND
GND
DTR
RTS
TX
RJ45-01 DB25F-02 WHITE
RJ45-02 DB25F-04 BROWN
Typical DB9/DB25
kit assemblies are
shown here. Refer
to the third party
device literature
for exact
RJ45-03
YELLOW
RJ45-04 DB25F-07 GREEN
RJ45-05
RJ45-06
RED
BLACK
configuration
RJ45-07 DB25F-05 ORANGE
required.
RJ45-08 DB25F-03
BLUE
8917-03 WIRE LIST
FUNCTION FROM
TO
COLOUR
GREY
DB9M
RX
CTS
DSR
GND
GND
DTR
RTS
TX
RJ45-01 DB9M-02
RJ45-02 DB9M08 BROWN
RJ45-03 DB9M-06 YELLOW
RJ45-04 DB9M-05 GREEN
RJ45-05
RJ45-06 DB9M-04
RED
BLACK
RJ45-07 DB9M-07 ORANGE
RJ45-08 DB9M-03
BLUE
8917-02 WIRE LIST
DB9F
FUNCTION FROM
TO
COLOUR
WHITE
GREEN
BLUE
Rx
GND
Tx
RJ45-01 DB9F-03
RJ45-04 DB9F-05
RJ45-08 DB9F-02
RJ45 Connector
OR
(408)-262-2299
FIELDSERVER
MODBUS RTU
CONNECTION DIAGRAM
BASE NAME:
FILE NAME:
DATE: 4/20/04
BY: MC
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.
FS-8700-42_Spectronics Driver Manual
Page 6 of 15
4.
Configuring the FieldServer as a Spectronics 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 FS).
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a Spectronics 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 Spectronics 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
Function
Legal Values
Up to 15 alphanumeric
characters
Data_Array_Name
Provide name for Data Array
Provide data format. Each FLOAT, BIT, UInt16, SInt16,
Data Array can only take on Packed_Bit, Byte,
Data_Array_Format
Data_Array_Length
one format.
Packed_Byte, Swapped_Byte
Number of Data Objects. Must
be larger than the data
storage area required by the 1-10,000
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,
Data_Format,
UInt16,
UInt16,
Bit,
Data_Array_Length
200
200
200
200
DA_DO_01,
Bit,
FS-8700-42_Spectronics Driver Manual
Page 7 of 15
4.2.
Client Side Connection Descriptors
Section Title
Connections
Column Title Function
Legal Values
Specify which port the device is connected
to the FieldServer
Port
P1-P8, R1-R22
110 – 115200, standard baud
rates only
Baud*
Specify baud rate
Parity*
Specify parity
None (Vendor limitation)
Data_Bits*
Specify data bits
Specify stop bits
Specify protocol used
8 (Vendor limitation)
1 (Vendor limitation)
Spectronics
Stop_Bits*
Protocol
Handshaking* Specify hardware handshaking
RTS, RTS/CTS, None
0-32000 s, 1 s
Poll Delay*
Time between internal polls
Example
//
Client Side Connections
Connections
Port,
P8,
Protocol,
Spectronics,
Baud,
9600,
Parity,
None,
Handshaking,
None,
Poll_Delay
0.100s
4.3.
Client Side Node Descriptors
Section Title
Nodes
Column Title
Function
Legal Values
Up to 32 alphanumeric
characters
Node_Name
Provide name for node
Station address of physical server
node
Specify protocol used
Specify which port the device is
connected to the FieldServer
Node_ID
Protocol
Port
1-255
Spectronics
P1-P8, R1-R22
Example:
// Client Side Nodes
Nodes
Node_Name,
Spec_device1,
Node_ID,
1,
Protocol,
Spectronics,
Port
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.
FS-8700-42_Spectronics Driver Manual
Page 8 of 15
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Column Title
Function
Legal Values
Name of this Map
Descriptor
Up to 32 alphanumeric
characters
Map_Descriptor_Name
Name of Data Array
where data is to be
stored in the
One of the Data Array
names from “Data Array”
section above
Data_Array_Name
FieldServer
Starting location in Data 0 to maximum specified in
Data_Array_Offset
Function
Array
“Data Array” section above
Function of Client Map
Descriptor
RDBC
4.4.2.
Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
Name of Node to fetch
data from
Node_Name
Length
Length of Map Descriptor
Starting address of read
block
1-125 (Register,AI)
Address
40001, 30001, etc
-2,147,483,648 to
2,147,483,647, 0
Data_Array_Low_Scale*
Data_Array_High_Scale*
Scaling zero in Data Array
-2,147,483,648 to
2,147,483,647, 100
Scaling max in Data Array
Scaling zero in Connected -2,147,483,648 to
Node 2,147,483,647, 0
Scaling max in Connected -2,147,483,648 to
Node 2,147,483,647, 100
Node_Low_Scale*
Node_High_Scale*
4.4.3.
Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
≥0.001s
FS-8700-42_Spectronics Driver Manual
Page 9 of 15
4.4.4.
Map Descriptor Example.
// Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
CMD_AI_01,
CMD_AO_01,
CMD_DI_01,
CMD_DO_01,
Data_Array_Name,
Data_Array_Offset,
Function, Node_Name,
Address, Length, Scan_Interval
DA_AI_01,
DA_AO_01,
DA_DI_01,
DA_DO_01,
0,
0,
0,
0,
RDBC,
RDBC,
RDBC,
RDBC,
Spec_Device1,
Spec_Device1,
Spec_Device1,
Spec_Device1,
30001,
40001,
10001,
00001,
20,
20,
20,
20,
1.000s
1.000s
1.000s
1.000s
FS-8700-42_Spectronics Driver Manual
Page 10 of 15
5.
Configuring the FieldServer as a Spectronics Server
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 Spectronics Client.
The configuration file tells the FieldServer about its interfaces, and the routing of data required.
In order to enable the FieldServer for Spectronics communications, the driver independent
FieldServer buffers need to be declared in the “Data Arrays” section, the FieldServer virtual
node(s) needs to be declared in the “Server Side Nodes” section, and the data to be provided to
the clients needs to be mapped in the “Server 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.
Server Side Connection Descriptors
Section Title
Connections
Column Title Function
Legal Values
Specify which port the device is connected
to the FieldServer
Port
P1-P8, R1-R23
110 – 115200 standard baud
rates only
Even, Odd, None, Mark,
Space
Baud*
Parity*
Specify baud rate
Specify parity
Data_Bits*
Stop_Bits*
Protocol
Specify data bits
Specify stop bits
7, 8
1 (Vendor limitation)
Spectronics
Specify protocol used
Handshaking* Specify hardware handshaking
RTS, RTS/CTS, None
Example
//
Server Side Connections
Connections
Port,
P1,
Protocol,
Spectronics,
Baud,
9600,
Parity,
None,
Handshaking
None
3 Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction
manual for details of the ports available on specific hardware.
FS-8700-42_Spectronics Driver Manual
Page 11 of 15
5.2.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Node_ID
Function
Legal Values
Up to 32 alphanumeric characters
1 – 255
Spectronics
Provide name for node
Node ID of physical server node
Specify protocol used
Protocol
Example
Nodes
Node_Name,
Spec_Srv_11,
Node_ID,
11,
Protocol
Spectronics
5.3.
5.3.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
of this
Descriptor
Legal Values
Map Up to 32 alphanumeric
characters
Name
Map_Descriptor_Name
Name of Data Array where One of the Data Array
data is to be stored in the names from “Data Array”
Data_Array_Name
FieldServer
section above
Starting location in Data 0 to maximum specified in
Data_Array_Offset
Function
Array
“Data Array” section above
Server
Function of Server Map
Descriptor
5.3.2.
Driver Specific Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Client Node
Descriptor” above
Name of Node to fetch data
from
Node_Name
Data_Type
Length
Data type
Register, Coil, AI, DI
Length of Map Descriptor
Starting address of read
block
1 - 125
Address
40001, 30001, etc
Data_Array_Low_Scale* Scaling zero in Data Array
-32767 to 32767, 0
-32767 to 32767, 100
-32767 to 32767, 0
Data_Array_High_Scale* Scaling max in Data Array
Node_Low_Scale*
Node_High_Scale*
Scaling zero in Connected
Node
Scaling max in Connected
Node
-32767 to 32767, 100
FS-8700-42_Spectronics Driver Manual
Page 12 of 15
5.3.3.
// Server Side Map Descriptors
Map_Descriptors
Map Descriptor Example.
Map_Descriptor_Name,
SMD_AI_01,
SMD_AO_01,
Data_Array_Name,
DA_AI_01,
DA_AO_01,
Data_Array_Offset,
0,
0,
Function,
Server,
Server,
Node_name,
Spec_Srv_11,
Spec_Srv_11,
Address,
30001,
40001,
Length,
200,
200,
Data_Array_Low_Scale,
0,
0,
Data_Array_High_Scale
100,
100,
Node_Low_Scale
0,
0,
Node_High_Scale
10000
10000
Map Descriptors
Map_Descriptor_Name,
SMD_DI_01,
Data_Array_Name,
DA_DI_01,
DA_DO_01,
Data_Array_Offset,
0,
0,
Function,
Server,
Server,
Node_name,
Spec_Srv_11,
Spec_Srv_11,
Address,
10001,
00001,
Length
200
200
SMD_DO_01,
FS-8700-42_Spectronics Driver Manual
Page 13 of 15
Appendix A. Advanced Topics – Spectronics
Appendix A.1. Default Data Types
When a Spectronics address range is specified, a particular Data Type is implied. The
defaults are as follows:
Address range
40001 - 49999
30001 - 39999
10001 - 19999
00001 - 09999
Data_Type
Register
Analog _Input
Digital_Input
Coil
Function Code (Write)
16
n/a.
n/a.
15
Function Code (Read)
3
4
2
1
Appendix A.2. Single Writes
When writing the default data types can be overwritten using the “Single_Coil” and
“Single_Register” settings as part of the Map Descriptor configuration. In that case the
Function codes for writes will be as follows:
Address range Data_Type
Function Code (Write)
40001 - 49999
30001 - 39999
Single_Register 6
Coil
5.
Example: FC 6 = Write Single Register
Add a parameter to the Spectronics client side Map Descriptor called Data_Type.
If you specify the Data_Type as Single_Register and the Function as WRBC or WRBX,
then a Spectronics poll with FC 6 will be generated.
Of course Single_Register implies a length of one, and even if you try to set the length
longer in the csv file, the length is limited to 1 in the driver.
Appendix A.3. Write-Thru Operation
Consider a client Map Descriptor that is configured to read data using a FC 3 (Read Multiple
Register) operation. It is now possible do a write thru operation on the existing Client Map
Descriptor by storing data to the Client Map Descriptors Data Array.
The Write Cache Map Descriptor that is created will use the following function codes
depending on the Cache Map Descriptor Length and the Clients Node Type.
Single Register Write - FC 6 - When the length of the Cache Map Descriptor is one. This will
normally be the case.
Multiple Register Write – FC 16 - When the length of the Cache Map Descriptor is larger
than one or the Node_Type has been set to “Block_Mode”.
FS-8700-42_Spectronics Driver Manual
Page 14 of 15
Appendix A.4. Connection to York Modbus Microgateway
If connecting the FieldServer to a York Modbus Microgateway, the Node_ID of the
Microgateway is defined by the address DIP switches. If switch 4 is set to ‘On’ and the other
switches are set to ‘off’ then Node_ID of the Microgateway is ‘247’, the parity is ‘Even’, and
the stop bits are 1. Other Node_ID combinations can be found in the York Modbus
Microgateway Installation Manual.
FS-8700-42_Spectronics Driver Manual
Page 15 of 15
THIS PAGE INTENTIONALLY LEFT BLANK
|