-
A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-127 Hanning & Kahl
HCS-R
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Version:
1.00
Document Revision: 9
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 3 of 17
1.
Hanning & Kahl HCS-R Description
The Hanning & Kahl HCS-R driver allows the transfer of data from devices over RS-232 HCS-R
protocol. Data is read from HCS-R and current data stored in a specified memory area. The
driver can store the data with its loop data status distinct memory areas depending on wheter
the data is on loop or from loop. The driver is based on section 10.5 of Hanning & Kahl - part
number 40801121. The FieldServer can act as a Client or Server.
Max Nodes Supported
FieldServer Mode
Nodes
Comments
Client
1
Only 1 virtual client per port allowed on multidrop systems,
Server
1
This is a protocol limit, maximum devices can be polled by Client
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 4 of 17
2.
Driver Scope of Supply
2.1. Supplied by FieldServer Technologies for this driver
FieldServer Technologies
PART #
Description
FS-8915-10
FS-8700-127
UTP cable (7 foot) for RS-232 use
Driver Manual.
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 5 of 17
3.
Hardware Connections
The FieldServer is connected to the Hanning & Kahl HCS-R as shown in connection drawing.
Configure the HCS-R according to manufacturer’s instructions
HCS-R
(Hanning Communication System)
RS-232
FS-8917-02
8917-02 WIRE LIST
FUNCTION
Rx
GND
Tx
FROM
TO
RJ45-01
RJ45-04
RJ45-08
DB9F-03
DB9F-05
DB9F-02
DB9F-07
DB9F-08
RTS
CTS
RJ45 CAT 5 Cable
(408)-262-2299
FIELDSERVER
HANNING KAHL
CONNECTION DIAGRAM
BASE NAME:
FILE NAME:
FS-8700-127
DATE: 2/12/08
BY: MC
3.1.
Hardware Connection Tips / Hints
1. Loop back RTS CTS if it is required by the other device.
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 6 of 17
4.
Configuring the FieldServer as a HCS-R 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 FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a HCS-R 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 HCS-R 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 Data Array can Float, Bit, UInt16, SInt16,
Data_Array_Format
Data_Array_Length
only take on one format.
Byte,
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,
DA_CURRENT,
DI_FromLoop01,
DI_OnLoop01,
DI_FromLoop02,
DI_OnLoop02,
DI_FromLoop03,
DI_OnLoop03,
DI_FromLoop014
DI_OnLoop04,
Data_Array_Format,
Uint16,
Bit,
Bit,
Bit,
Bit,
Bit,
Bit,
Bit,
Data_Array_Length
22
22
22
22
22
22
22
22
22
Bit,
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 7 of 17
4.2.
Client Side Connection Descriptions
Section Title
Connections
Column Title
Function
Legal Values
Specify which port the device is
connected to the FieldServer
Port
P1-P81
HCS-R
HCSR
Protocol
Specify protocol used
H&K HCS-R
Baud*
Parity*
Data_Bits*
Stop_Bits*
Handshaking*
Poll_Delay*
Specify baud rate
Specify parity
Specify data bits
Specify stop bits
Specify hardware handshaking
Time between internal polls
9600 (Vendor limitation)
None (Vendor limitation)
8 (Vendor limitation)
1 (Vendor limitation)
None (Vendor limitation)
0-32000 seconds, 0.05 seconds
Example
// Client Side Connections
Connections
Port,
P8,
Protocol,
HCS-R,
Baud,
9600,
Parity,
None,
Handshaking,
None,
Poll_Delay
0.100s
4.3.
Client Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Function
Provide name for Node
HCS-R station address of physical
server Node
Legal Values
Up to 32 alphanumeric characters
Node_ID
240 (Protocol limit)
HCS-R
Protocol
Specify protocol used
HCSR
H&K HCS-R
Specify which port the device is
connected to the FieldServer
Connection
P1-P81
Example
// Client Side Nodes
Nodes
Node_Name,
PLC 1,
Node_ID,
240,
Protocol,
HCS-R,
Connection
P8
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-127 Hanning & Kahl HCS-R Manual
Page 8 of 17
4.4.
4.4.1.
Client Side Map Descriptors
FieldServer Related Map Descriptor Parameters
Column Title
Function
Legal Values
to 32 alphanumeric
Up
characters
Map_Descriptor_Name
Name of this Map Descriptor
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
0 to maximum specified in
“Data Array” section above
Data_Array_Offset
Function
Starting location in Data Array
Function
of
Client
Map
RDBC, Passive_Client
Descriptor
4.4.2.
Driver Related Map Descriptor Parameters
Column Title
Function
Legal Values
One of the Node Names
specified in “Client Node
Descriptor” above
Node_Name
HCSR_OnFrom
HCSR_Loop
Name of Node to fetch data from
For Passive_Client Map Descriptor
specify whether data From Loop or On, From, OnFrom
On Loop should be stored.
For Passive_Client Map Descriptor
specify loop number for which data 1,2,3,4
should be stored.
Length of Map Descriptor
22 (min) for RDBC Map Descriptor:
24 if data_type is Dig_Input
21
Descriptor.
It also
for
Passive_Client
Map
Length
22 or 24, 21
depends
upon
HCSR_Data_Stages parameter
Refer to Appendix A
Specify how data will be stored. Ana_Input
Refer to Appendix A
Data_Type*
Digi_Input2
Specify the number of stages to
keep history of data changes.
0 and 1 means no history
HCSR_Data_Stages*
0,1,2,3
4.4.3.
Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
≥0.001s
2 Default for Digi_Input
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 11 of 17
5.
Configuring the FieldServer as a HCS-R 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 Hanning & Kahl HCS-R Client.
The configuration file tells the FieldServer about its interfaces, and the routing of data required.
In order to enable the FieldServer for HCS-R 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-P83
HCS-R
HCSR
Protocol
Specify protocol used
H&K HCS-R
Baud*
Parity*
Specify baud rate
Specify parity
9600 (Vendor Limitation)
None (Vendor Limitation)
Data_Bits*
Specify data bits
8 (Vendor Limitation)
Stop_Bits*
Specify stop bits
1
Handshaking*
Specify hardware handshaking
None (Vendor Limitation)
Specifies the time that the FieldServer
will reserve the Server side connection
Server_Hold_Timeout*
while waiting for the Client side to >1.0s, 2.0s
update
data
in
Data_Array
(if
necessary)
Example
// Server Side Connections
Connections
Port,
P8,
Protocol,
HCS-R,
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-127 Hanning & Kahl HCS-R Manual
Page 12 of 17
5.2.
Server Side Node Descriptors
Section Title
Nodes
Column Title
Function
Legal Values
to 32 alphanumeric
characters
Up
Node_Name
Node_ID
Provide name for Node
Station address of physical server
Node
240
HCS-R
HCSR
Protocol
Specify protocol used
H&K HCS-R
Specifies the time that the
FieldServer will reserve the Server
Server_Hold_Timeout*
side connection while waiting for >1.0s, 2.0s
the Client side to update data in
Data_Array (if necessary)
Example
// Server Side Nodes
Nodes
Node_Name,
HCSR_01,
Node_ID,
240,
Protocol
HCS-R
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 13 of 17
5.3.
5.3.1.
Server Side Map Descriptors
FieldServer Specific Map Descriptor Parameters
Column Title
Function
Legal Values
to 32 alphanumeric
Up
characters
Map_Descriptor_Name
Name of this Map Descriptor
Name of Data Array where One of the Data Array names
data is to be stored in the from “Data Array” section
Data_Array_Name
FieldServer
above
0 to maximum specified in
“Data Array” section above
Data_Array_Offset
Function
Starting location in Data Array
Function of Server Map
Descriptor
Server
Specifies the time that the
FieldServer will reserve the
Server side connection while
waiting for the Client side to
update data in Data_Array (if
necessary)
Server_Hold_Timeout*
>1.0s, 2.0s
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
Length
Length of Map Descriptor
Specify format of the data to
serve.
22
Digi_Input
Ana_Input
Data_Type*
Refer to Appendix A
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 15 of 17
Appendix A. Advanced Topics
Appendix A.1. 1. How Client Stores Data:
The HCS will be polled by an RDBC Map Descriptor and data will be stored in the
DA_Current Data Array in the following fashion if parameter HCSR_Data_Stages >1:
•
•
New data is stored as current data.
If data is changed, last current data is moved to 2nd Stage, 2nd Stage data is moved
to 3rd stage and 3rd stage data is lost.
Appendix A.1.1.
Data_Type is Ana_Input or not specified
Data Array Offset
Description
Current Data
0 - 18
Data bits ( 0 - 1 )
19
20
21
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Loop Number (1,2,3,4) as integer
2nd (Previous) Data
24 – 42
43
44
Data bits ( 0 – 1 )
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Loop Number (1,2,3,4) as integer
45
3rd (Prior to previous) Data
48 – 66
67
68
Data bits ( 0 – 1 )
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Loop Number (1,2,3,4) as integer
69
Appendix A.1.2.
Data_Type is Digi_Input
Data Array Offset (Say 0)
Description
Current Data
0 - 18
Data bits ( 0 - 1 )
19
20
21,22,23
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
3 bits for Loop Number
Offsets
21 22 23
1
0
1
0
0
1
1
0
0 –Loop 1
0 –Loop 2
0 –Loop 3
1 –Loop 4
2nd (Previous) Data
24 – 42
Data bits ( 0 – 1 )
43
44
45
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Loop Number (1,2,3,4) in 3 bits as above
3rd (Prior to previous) Data
48 – 66
67
68
Data bits ( 0 – 1 )
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Loop Number (1,2,3,4) in 3 bits as above
69
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 16 of 17
The same data will be stored in a Loop based Data Array which will then have the last
known data for each loop
Data Array Offset
Description
Current Data
0 - 18
Data bits ( 0 – 1)
19
20
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
2nd (Previous) Data
21 – 39
Data bits ( 0 – 1)
40
41
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
3rd (Prior to previous) Data
42 – 60
61
62
Data bits ( 0 – 1)
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Appendix A.2. 2. How Server expects Data:
The Server expects data in the following format in order to constitute its response to HCS-R
Clients.
Appendix A.2.1.
Data_Type is Ana_Input or not specified
Data Array Offset
Description
0 - 18
19
20
Data bits ( 0 - 1 )
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
Loop Number (0,1,2,3)
21
Appendix A.2.2.
Data_Type is Digi_Input
Data Array Offset (say 0)
0 - 18
19
Description
Data bits ( 0 - 1 )
Receipt ok ( 0 ), Disturbance ( 1 )
From Loop ( 0 ), On Loop ( 1 )
2 bits for Loop Number
Offsets
20
21 22
21,22
0
1
0
1
0
0
1
1
–Loop 1
–Loop 2
–Loop 3
–Loop 4
.
FS-8700-127 Hanning & Kahl HCS-R Manual
Page 17 of 17
THIS PAGE INTENTIONALLY LEFT BLANK
|