Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-70 WS3000 TABS
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Version:
1.01
Document Revision: 6
FS-8700-70 WS3000 Tabs Manual
Page 3 of 14
1.
WS3000 TABS Description
The Serial WS3000 TABS driver allows the FieldServer to transfer data to and from devices
over either RS-232 or RS-422 using WS3000 TABS protocol. The FieldServer can emulate
either a Server or Client.
The WS3000 TABS driver is set up for Alarm Surveillance and Control. The protocol works over
a multidrop RS-422 line or over a RS-232 line and allows only one master and up to 32 slaves
on a serial channel. Slaves are assigned station addresses that range from 0 to 31. The master
does not have a station address. The protocol is strictly command/response with the master
polling the slave devices. Each slave can be configured to hold the data for one to 256
displays. Each display contains 64 alarms status points represented by bits.
This driver only supports short addressing mode, thus allowing for a maximum of 256 displays
per tabs device.
The Server driver fully supports the processing of the following AS&C Remote Control
Commands:
Type 0, 1, 2, 128-255
The Client driver supports the sending of AS&C Remote Control Commands (writes).
FS-8700-70 WS3000 Tabs Manual
Page 4 of 14
2.
Driver Scope of Supply
2.1. Supplied by FieldServer Technologies for this driver
FieldServer Technologies
PART #
Description
25029
FS-8917-03
FS-8700-70
Cable Cat5 10-BASET w/Boot 7' Yelow
Conn, DB9M to DCE, RTS/CTS, DSR/DTR
Driver Manual.
2.2.
Provided by user
The user has to provide a RS-422 cable for connecting the WS3000 to the RS-232 to RS-
422 converter.
FS-8700-70 WS3000 Tabs Manual
Page 5 of 14
3.
Hardware Connections
The FieldServer is connected to the WS3000 as shown below.
Configure the WS3000 according to manufacturer’s instructions.
RS-422 Rx termination strapping
Jumper Pins
Chan
Z2,
Z2,
Z2,
Z1,
Z1,
Z1,
Z1,
2-7
3-6
4-5
4-5
3-6
2-7
1-8
3
4
5
6
7
8
9
Use one of Channels 3-9
WS3000
Chan
3,
4,
5,
6,
Connector no
P11
P3
P10
P8
pins
5, 6, 7, 8,
Rx-Rx+Tx-Tx+
Install a jumper on the
indicated pins
according to the
channel used
7,
8,
P1
P9
9,
P2
Dip Switch Settings
G
H
K
L
Sw
1-4
5
6-7
8
Setting
Down (off)
Up (on)
Down (off)
Up (on)
Meaning
RS-422
Terminated
Unused baud rates
2400 baud
RS-422
485LDRC
B&B Electronics RS-
232 to RS-422
Converter
Power Supply
+
Refer to Datasheet for setting other baud rates
F
+10 to 30V DC
GND
RS-232
pins
GND
C
D
1
8
RJ45 Socket
(408)-262-2299
Use one of RS-232 ports P1-P8
FIELDSERVER
WESTRONIC WS3000
CONNECTION DIAGRAM
FieldServer
BASE NAME:
FILE NAME:
DATE: 4/2/04
BY: MC
FS-8700-70 WS3000 Tabs Manual
Page 6 of 14
4.
Configuring the FieldServer as a WS3000 TABS 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
provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a WS3000 TABS Server. The configuration file tells the FieldServer about
its interfaces, and the routing of data required. In order to enable the FieldServer for WS3000
TABS 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/Descriptors
Section Title
Data_Arrays
Column Title
Function
Legal Values
Up to 15 alphanumeric
characters
Data_Array_Name
Data_Format
Provide name for Data Array
Provide data format. Each Data Array
can only take on one format.
Byte
Number of Data Objects. Must be
larger than the data storage area
required for the data being placed in
this array.
Data_Array_Length
1-10,000
Example
// Data Arrays
//
Data_Arrays
Data_Array_Name,
Points_0,
Data_Format,
byte,
Data_Array_Length
2048
There are 8 bytes per display allowed. Eight bytes will represent the 64 points per display.
A maximum of 256 displays per slave gives 2048 bytes per slave.
FS-8700-70 WS3000 Tabs Manual
Page 7 of 14
4.2.
Client Side Connection Descriptors
Section Title
Connections
Column Title
Function
Specify which port the device is connected to the
FieldServer
Legal Values
P1-P81
Port
1200, 2400, 4800,
9600
Baud*
Specify baud rate
Parity*
Specify parity
Even, Odd, None
Data_Bits*
Specify data bits
Specify stop bits
Specify protocol used
7, 8
Stop_Bits*
Protocol
1, 2
Ws3000_tabs
None
Handshaking* Specify hardware handshaking
NOTE: Refer to the TABS collection port settings on the WS3000 for setting up the serial
communication settings on the FieldServer. Also remember to change the baud rate setting
on the RS-232 to RS-422 converter if necessary.
Example
// Client Side Connections
Connections
Port,
P1,
Baud,
2400,
Parity,
Odd,
Protocol,
ws3000_tabs,
Handshaking
None
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
TABS device station address of
physical Server node
Specify protocol used
Specify which port the device is
connected to the FieldServer
Node_ID
Protocol
Port
0-31
Ws3000_tabs
P1-P81
Example
// Client Side Nodes
Nodes
Node_Name,
Tabs_0,
Node_ID,
0,
Protocol,
ws3000_tabs,
Port
P1
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-70 WS3000 Tabs Manual
Page 8 of 14
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Name of this Map
Descriptor
Legal Values
Up to 32 alphanumeric
characters
Map_Descriptor_Name
Name of Data Array where
data is to be stored in the
FieldServer
One of the Data Array
names from “Data Array”
section above
Data_Array_Name
Starting location in Data
Array
0 to maximum specified in
“Data Array” section above
RDBC
Data_Array_Location
WRBX ( Only for use to
execute remote control
commands. See Map
Descriptor examples. )
Function of Client Map
Descriptor
Function
Length
The length of the Map
Descriptor
1
4.4.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
Parms_DA
Specifies the name of the
Data Array that will hold 0 to 20 alphanumeric
remote control command characters
parameters
Specifies the offset into the
0 to maximum offset for
parameters Data Array
length of the parameter
where the remote control
Data Array
Parms_DA_Offset
parameters start
4.4.3.
Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled >0.1s
Legal Values
FS-8700-70 WS3000 Tabs Manual
Page 9 of 14
4.4.4.
Map Descriptor Example 1
// Client Side Map Descriptors
Map Descriptors
Map_Descriptor_Name, Scan_Interval,
Data_Array_Name,
Points_0,
Data_Array_Offset,
0,
Function,
rdbc,
node_name
Tabs_0
Point_data_0,
1.0s,
This can be any
name but each
name must be
unique. Name will
appear in
FieldServer Map
Descriptor status
information screens.
The rate
at which
the TABS
device will
be polled.
The Data Array name
must be one found
under Data_Arrays. Data
from the scan will be
stored in the array at
Data_Array_Offset.
This
value
Only a read
function
allowed i.e.
Data to be
read from the
TABS device.
Node name must be one
found under Nodes,
Node_name The
node_name identifies
the station address of
the TABS device ( 0-31).
specifies the offset
into the Data Array
where the data
fetched will be
stored.
FS-8700-70 WS3000 Tabs Manual
Page 10 of 14
4.4.5.
Map Descriptor Example 2: Remote Control Commands
// Client Side Map Descriptors
Map Descriptors
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function,
Node_name, Parms_DA,
Parms_DA_Offset, Length
Points_write,
Write_triggers,
0,
wrbx,
Tabs_0,
Write_parms, 0, 1
Parameters arrangement in Parms_DA
Position from Parms_DA_Offset Description
0
Display number 1
1
2
3
Point number 1 ( 0-63 )
Control type 1 ( 0, 1, 2, 128-255)
Display number 2
4
5
..
Point number 2 ( 0-63 )
Control type 2 ( 0, 1, 2, 128-255)
..
57
58
59
Display number 20
Point number 20 ( 0-63 )
Control type 20 ( 0, 1, 2, 128-255)
Note: To trigger the remote control command, load the parameters into the Data Array as shown above and then write the number of
points to control into the Data Array specified by Data_Array_Name at Data_Array_Offset. Valid number of points are 1 to 20.
FS-8700-70 WS3000 Tabs Manual
Page 11 of 14
5.
Configuring the FieldServer as a WS3000 TABS 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” files
provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a WS3000 TABS Client. The configuration file tells the FieldServer about
its interfaces, and the routing of data required. In order to enable the FieldServer for WS3000
TABS 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
Specify which port the device is
connected to the FieldServer
Specify baud rate
Specify parity
Specify data bits
Specify stop bits
Legal Values
Port
P1-P82
Baud*
Parity*
Data_Bits*
1200, 2400, 4800, 9600
Even, Odd, None
7, 8
Stop_Bits*
Protocol
1, 2
Specify protocol used
Ws3000_tabs
None
Handshaking*
Specify hardware handshaking
Time Server waits before
responding to a poll
Turnaround_delay*
0.01s, or >= 0
NOTE: Refer to the TABS collection port settings on the WS3000 for setting up the serial
communication settings on the FieldServer. Also remember to change the baud rate
setting on the RS-232 to RS-422 converter if necessary.
Example
// Server Side Connections
Connections
Port,
P1,
Baud,
2400,
Parity,
Odd,
Protocol,
ws3000_tabs, None,
Handshaking, Turnaround_delay
0.01s
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-70 WS3000 Tabs Manual
Page 12 of 14
5.2.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Function
Legal Values
Up to 32 alphanumeric
characters
Node_Name
Node_ID
Provide name for node
TABS device station address
of physical Server node
Specify protocol used
0-31
Protocol
Port
Ws3000_tabs
Port this node is connected to P1-P83
Example
// Server Side Nodes
Nodes
Node_Name,
Tabs_0,
Node_ID,
0,
Protocol,
ws3000_tabs,
Port
P1
5.3.
5.3.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Name of this Map
Descriptor
Legal Values
Up to 32 alphanumeric
characters
Map_Descriptor_Name
Name of Data Array where
data is to be stored in the
FieldServer
One of the Data Array
names from “Data Array”
section above
Data_Array_Name
Starting location in Data
Array
Function of Server Map
Descriptor
0 to maximum specified in
“Data Array” section above
Data_Array_Location
Function
Passive
5.3.2.
Driver Specific Map Descriptor Parameters
Column Title
Function
Legal Values
One of the node names
specified in “Server Node
Descriptor” above
The TABS address of this
node
Node_Name
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-70 WS3000 Tabs Manual
Page 13 of 14
5.3.3.
Map Descriptor Example.
// Server side Map Descriptors
Map Descriptors
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name
Point_data_0,
Points_0,
0,
passive,
Tabs_0
This value
This can be
The Data
Function may
The TABS
device’s
station
address (0 –
31).
specifies the
offset into the
Data Array
where the
data will be
stored for
any name but
each name
must be
unique. Name
will appear in
FieldServer
Map
Descriptor
status
information
screens.
Array name
must be one
found under
Data_Arrays
Data will be
sent from
this array to
the device
polling this
TABS
not be read or
write since it
implements a
Server.
Function may
only be
testing with
scripts.
passive.
device.
FS-8700-70 WS3000 Tabs Manual
Page 14 of 14
THIS PAGE INTENTIONALLY LEFT BLANK
|