FieldServer FS-8700-59 Computer Drive User Manual

a Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-59 Canatal Satchnet Driver
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Instruction Manual Part Number FS-8700-59
3/13/03
FS-8700-59 Canatal Sachnet
Driver Manual
TABLE OF CONTENTS
1.
2.
Canatal Satchnet Protocol Driver Description................................................................................................................... 1
Hardware/Software ................................................................................................................................................................. 1
2.1
Supplied by FieldServer Technologies for this driver............................................................................................. 1
2.2
Provided by user............................................................................................................................................................. 1
3. Hardware Connections........................................................................................................................................................... 2
4. Configuring the FieldServer as a Canatal Satchnet Protocol Driver Client.................................................................. 3
4.1
Data Arrays ..................................................................................................................................................................... 3
4.2
Client Side Connections................................................................................................................................................ 4
4.3
Client Side Nodes........................................................................................................................................................... 4
4.4
Client Side Map Descriptors ........................................................................................................................................ 5
4.4.1
FieldServer Specific Map Descriptor Parameters............................................................................................ 5
4.4.2
Driver Specific Map Descriptor Parameters..................................................................................................... 5
4.4.3
Timing Parameters ................................................................................................................................................ 5
4.4.4
Map Descriptor Example ..................................................................................................................................... 6
4.4.5
Map Descriptor Example 2.................................................................................................................................. 7
5. Configuring the FieldServer as a Canatal Satchnet Protocol Driver Server................................................................. 8
5.1
Data Arrays ..................................................................................................................................................................... 8
5.2
Server Side Connections............................................................................................................................................... 9
5.3
Server Side Nodes.......................................................................................................................................................... 9
5.4
Server Side Map Descriptors...................................................................................................................................... 10
5.4.1
FieldServer Specific Map Descriptor Parameters.......................................................................................... 10
5.4.2
Driver Specific Map Descriptor Parameters................................................................................................... 10
5.4.3
Timing Parameters .............................................................................................................................................. 10
5.4.4
Map Descriptor Example ................................................................................................................................... 11
6. Driver Notes........................................................................................................................................................................... 12
6.1
Canatal Device Data Tables ....................................................................................................................................... 12
6.2
Troubleshooting............................................................................................................................................................ 14
7.
Version Control.............................................................................................................................................................. 15
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
Table of Contents
FS-8700-59 Canatal Sachnet
Driver Manual
1. Canatal Satchnet Protocol Driver Description
The Canatal Satchnet Protocol Driver allows the FieldServer to transfer data to and from devices
over either RS-232 or RS-485 using Canatal Satchnet Protocol Driver protocol. The FieldServer
can emulate either a Server or Client.
This driver provides support for the Canatal Corporation implementation of the “Satchwell
Network” protocol.
The Canatal Satchnet Protocol Driver can act as a Master.
• Any Satchnet device on any serial port (P1-P8, R1 & R2 on the FS-B40 Series, serial port
on the FS-B20 series) can be polled.
• Data from Series 2, 4, 5, 6, 9 devices can be polled.
• Data from any 'Table' can be read.
• Data in 'Tables' with write permission can be written by the driver.
• The driver can read/write Bit, Byte, Swapped Integer, Word, BCD and Float Data.
The Canatal Satchnet Protocol Driver can act as a (passive) server.
• The driver can be polled by a Satchnet Master and return data from the FieldServer's data
arrays.
• The driver can emulate Series 2,4,5,6,9 devices.
• All 'Tables' can be read / written.
2. Hardware/Software
2.1 Supplied by FieldServer Technologies for this driver
RS-485 connection adapter
Driver Manual.
2.2 Provided by user
Canatal Device
UTP or similar cable with RJ11 adapter.
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 1
FS-8700-59 Canatal Sachnet
Driver Manual
3. Hardware Connections
The FieldServer is connected to the as shown below.
Configure the Canatal Driver according to manufacturer’s instructions.
FieldServer
SERIAL PORT
CAT 5
ETHERNET CABLE
ORANGE/WHITE
BROWN
BLUE
GREEN
(PIN3)
BLUE (PIN1)
ORANGE/WHITE
(PIN2)
NOTE:
CANATAL
SET JUMPER 16, 17 AND 18 ON THE BOARD TO POSITION 2-3.
Manual Canatal FieldServer Connection
Canatal Corporation Inc. have specified the following data with respect to
interconnecting cables.
Interconnecting Cable Characteristics
The interconnecting cable may be composed of twisted or untwisted pair (flat cable)
possessing the characteristics below. Conductor Size: The interconnecting cable shall be
composed of two wires of a 24 AWG or larger conductor for solid or stranded copper
wires, or for non-copper conductors with sufficient size to yield a DC wire resistance not
to exceed 30 ohms per 1000 feet per conductor.
• Mutual Pair Capacitance: The capacitance between one wire in the pair to the
other wire shall not exceed 20 picofarads per foot and the value shall be
reasonably uniform over the length of the cable.
• Stray Capacitance: The capacitance between one wire in the cable to all others in
the cable sheath, with all others connected to ground shall not exceed 40
picofarads per foot and shall be reasonably uniform over the length of the cable.
• Pair-to-Pair Balanced Crosstalk: The balanced crosstalk from one pair of wire to
any other pair in the same cable sheath shall have a minimum value of 40
decibels of attenuation measured at 150 kilohertz.
•
An interconnecting cable meeting these specifications will result in a transmission line
with a nominal characteristic impedance in the order of 100 ohms to frequencies greater
than 100 kilohertz and a DC series loop resistance not exceeding 240 ohms.
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
FS-8700-59 Canatal Sachnet
Driver Manual
4. Configuring the FieldServer as a Canatal Satchnet Protocol Driver Client
For a detailed discussion on FieldServer configuration, please refer to the Configuration Manual for
the FieldServer. 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 as a
master, configured to communicate with a Canatal Satchnet Protocol Driver Server ( a passive
Canatal device).
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In
order to enable the FieldServer for Canatal Satchnet Protocol 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
Data_Format
Provide data format. Each data array can only
take on one format.
Data_Array_Length
Number of Data Objects. Must be larger than
the data storage area required for the data
being placed in this array.
Legal Values
Up to 15 alphanumeric
characters
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte, Swapped_Byte
1-10,000
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,
Bit,
Data_Array_Length
200
200
200
200
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 3
FS-8700-59 Canatal Sachnet
Driver Manual
4.2 Client Side Connections
Section Title
Connections
Column Title
Port
Baud
Parity
Data_Bits
Function
Specify which port the device is
connected to the FieldServer
Specify baud rate
Specify parity
Specify data bits
Legal Values
FS x40: P1-P8, R1-R2
FS x20: P1-R2
1200
Even
7
Stop_Bits*
Specify stop bits
1
Protocol
Specify protocol used
Canatal, Satchnet
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, Data_bits, Stop_bits,
R1,
1200, Even,
Canatal, 7,
1,
4.3 Client Side Nodes
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Port
Function
Provide name for node
Address of physical server node
(Canatal device address)
Specify protocol used
Specify which port the device is
connected to the FieldServer
Legal Values
Up to 32 alphanumeric characters
1-63
Canatal, Satchnet
FS x40: P1-P8, R1-R2
FS x20: P1-R2
Example
//
Client Side Nodes
Nodes
Node_Name
, Node_ID, Protocol, Port
Conditioner1, 1,
Canatal , R1
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 4
FS-8700-59 Canatal Sachnet
Driver Manual
4.4 Client Side Map Descriptors
4.4.1 FieldServer Specific Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Data_Array_Name
Data_Array_Location
Function
Name of this Map Descriptor
Name of Data Array where data is to be
stored in the FieldServer
Starting location in Data Array
Function
Function of Client Map Descriptor
Legal Values
Up to 32 alphanumeric characters
One of the Data Array names from
“Data Array” section above
0 to maximum specified in “Data
Array” section above
RDBC, WRBC, WRBX
4.4.2 Driver Specific Map Descriptor Parameters
Column Title
Node_Name
Function
Name of Node to fetch data from
Length
Length of Map Descriptor
Address
This term is used to refer to the offset into the
Canatal device data table.
Legal Values
One of the node names specified in
“Client Node Descriptor” above
1 - 1000 ( Maximum value is
dependent on the values of
Cana_Series and Cana_table. For
more information see section 6.1
0,1,2,3 ...
Each table first element is addressed as zero,
the 2nd element as 1 etc.
The address & length must not exceed the
maximum length of he table being addressed.
Protocol Specific
Parameters
Cana_Series
Refers to the Canatal Corporation Inc. device
series number. Although different series of
equipment have similar tables with similar
contents they are not all the same, the
contents may vary and the data formats do
vary.
2,4,5,6,9
Cana_Table
This is the data table in the device you wish
to read.
Cana_Format *
Used to over-ride the default data storage
method the driver assigns to the table. This
paramater may be required when reading data
from a table with midex data formats. See
section 6.1 to identify which table have
mixed data formats and what the default type
the driver allocates to the table.
Non zero integers. Legal values
may be obtained by reading section
6.1.
Bype, BCD, BCD4, Float, Word,
Percent, Swap_int.
4.4.3 Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
>0.1s
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 5
FS-8700-59 Canatal Sachnet
Driver Manual
4.4.4 Map Descriptor Example
In this example two map descriptors are provided. The first reads Device 11 ( a Series 2 device) and obtains the Alarm Table. The second map descriptor reads
Device 23 ( a series 9 device) and reads the Cooling analog output (2nd element of table 10).
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Address, Length, Cana_Series, Cana_table, Scan_Interval
DEV11_ALMS
DEV23_COOL
,ALARMS
,ANA_OUT
Any name that is
meaningful to you.
The driver validates
map descriptors and
reports errors
referring to the map
descriptor name.
,220
,0
, rdbc
, rdbc
The first element
from table 11 will
be placed in element
220 (the 221st
element) of the array
ALARMS.
The data arrays are defined in the
Data_Arrays part of the CSV. Based on
these exampled the array called ALARMS
should be a byte or integer array as
alarms have the value 0,1 or 2 (acked) and
it must be at least 239 (220+19) elements
in size. The array ANA_OUT is probably a
FLOAT and should have at least 1 element
in size.
,DEV11
,DEV23
,0
,1
,19
,1
The node names
point the driver at a
Node definition
which specifies a
port and a device
address.
These map
descriptors generate
read polls on a
continuous basis.
,2
,9
,11
,10
, 1.0s
, 1.0s
The number of items
being read. Not the
number of bytes
being read.
This is the offset
into the table being
polled.
Determine the offset
you should use by
reading the Canatal
International
Corporation Inc.
Product Literature.
The polls will ocur
every second.
You need to know the series
of the device you are polling
and table number of the table
that contains the data of
interest.
Read section 6.1 for more
information or read the
vendor product literature.
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 6
FS-8700-59 Canatal Sachnet
Driver Manual
4.4.5 Map Descriptor Example 2
In this example two map descriptors are provided. They both read table 16 of a series 9 device. You will see though that the 2nd map descriptor has an extra
keyword to override the default format. Read section 6.1 form more information on default data formats.
// Reads elements 1 through 7 from table 5 in a series 9 device. According to the product specification the 8th element is stored using a different format and thus
using this map descriptor to read mixed data type will produce unexpected results.
Map_Descriptors
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Address, Length, Cana_Series, Cana_table, Scan_Interval
TABLE05_1
,TBL05_DATA ,0
, rdbc
, DEV11
,1
,6
,9
,5
, 1.0s
// Reads the Boiler Limit Time (Offset 10) from table 5 in a series 9 device According to the product specification the Boiler Limit Time is stored as a Swapped
Integer. The Default format this driver uses for the table is Byte.
Map_Descriptors
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Address, Length, Cana_Series, Cana_table, Cana_format, Scan_Interval
TABLE05_2
Any name that is
meaningful to you.
The driver validates
map descriptors and
reports errors
referring to the map
descriptor name.
,TBL05_DATA
,0
, rdbc
, DEV11
,7
,1
,9
,5
, swap_int
, 1.0s
This is the offset of the
Boiler Limit Time in Table 5.
With the offset equal to zero the data
is placed in the array element equal to
the address.
This parameter over-rides the
default data type. It is only
required if you need to override the driver's default.
The offset is added to the address
when determining the element of the
data array to be used for storage.
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 7
FS-8700-59 Canatal Sachnet
Driver Manual
5. Configuring the FieldServer as a Canatal Satchnet Protocol Driver Server
For a detailed discussion on FieldServer configuration, please refer to the instruction manual for the
FieldServer. 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 a Canatal Satchnet Protocol Driver Client (Master)
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In
order to enable the FieldServer for Canatal Satchnet Protocol Driver 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 Data Arrays
Section Title
Data_Arrays
Column Title
Data_Array_Name
Function
Provide name for Data Array
Data_Format
Provide data format. Each data array can only
take on one format.
Data_Array_Length
Number of Data Objects. Must be larger than
the data storage area required for the data
being placed in this array.
Legal Values
Up to 15 alphanumeric
characters
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte, Swapped_Byte
1-10,000
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,
Bit,
Data_Array_Length
200
200
200
200
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 8
FS-8700-59 Canatal Sachnet
Driver Manual
5.2 Server Side Connections
Section Title
Connections
Column Title
Port
Baud*
Function
Specify which port the device is
connected to the FieldServer
Specify baud rate
Parity*
Data_Bits*
Specify parity
Specify data bits
Legal Values
FS x40: P1-P8, R1-R2
FS x20: P1-R2
110 – 115200, standard baud rates
only
Even, Odd, None, Mark, Space
7, 8
Stop_Bits*
Specify stop bits
1
Protocol
Specify protocol used
Canatal
Handshaking*
Specify hardware handshaking
RTS, RTS/CTS, None
The FieldServer is capable of handling any of the above connection specification but the Canatal
Corporation Inc. devices are support the specification provided in the example below.
Example
//
Server Side Connections
Connections
Port, Baud, Parity, Protocol, Data_bits, Stop_bits,
R1,
1200, Even,
Canatal, 7,
1,
5.3 Server Side Nodes
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Function
Provide name for node
Address of physical server node
(Canatal device address)
Specify protocol used
Legal Values
Up to 32 alphanumeric characters
1-63
Canatal, Satchnet
Example
//
Server Side Nodes
Nodes
Node_Name, Node_ID, Protocol
FieldServer,
11,
Canatal
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 9
FS-8700-59 Canatal Sachnet
Driver Manual
5.4 Server Side Map Descriptors
5.4.1 FieldServer Specific Map Descriptor Parameters
Column Title
Map_Descriptor_Name
Data_Array_Na me
Data_Array_Location
Function
Name of this Map Descriptor
Name of Data Array where data is to be stored
in the FieldServer
Starting location in Data Array
Function
Function of Server Map Descriptor
Legal Values
Up to 32 alphanumeric characters
One of the Data Array names from
“Data Array” section above
0 to maximum specified in “Data Array”
section above
PASSIVE
5.4.2 Driver Specific Map Descriptor Parameters
Column Title
Node_Name
Function
Name of Node to fetch data from
Length
Length of Map Descriptor
Address
This term is used to refer to the offset into the
Canatal device data table.
Legal Values
One of the node names specified in
“Client Node Descriptor” above
1 - 1000 ( Maximum value is dependent
on the values of Cana_Series and
Cana_table. For more information see
section 6.1
0,1,2,3 ...
Each table first element is addressed as zero, the
2nd element as 1 etc.
The address & length must not exceed the
maximum length of he table being addressed.
Protocol Specific
Parameters
Cana_Series
Cana_Table
Length
Cana_Format *
Refers to the Canatal Corporation Inc. device
series number. Although different series of
equipment have similar tables with similar
contents they are not all the same, the contents
may vary and the data formats do vary.
This is the data table in the device you wish to
read.
Length of Map Descriptor
Used to over-ride the default data storage method
the driver assigns to the table. This paramater
may be required when reading data from a table
with midex data formats. See section 6.1 to
identify which table have mixed data formats and
what the default type the driver allocates to the
table.
2,4,5,6,9
Non zero integers. Legal values may be
obtained by reading section 6.1.
1 - 1000 ( Maximum value is dependent
on the values of Cana_Series and
Cana_table. For more information see
section 6.1
Bype, BCD, BCD4, Float, Word,
Percent, Swap_int.
5.4.3 Timing Parameters
Column Title
Scada_Hold_Timeout
Function
Specifies time server side waits before responding to client
that node is offline on FieldServer client side.
Legal Values
>1.0s
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 10
FS-8700-59 Canatal Sachnet
Driver Manual
5.4.4 Map Descriptor Example
In this example the FieldServer answers queries from a Canatal Satchnet master device. A same map descriptor could be used when the same master wants to
write data to the FieldServer. In this example the FieldServer is emulating a Canatal device addressed as node 11. It is not possible to have the FieldServer
emulate two devices of difefrent series addressed as node 11.
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset, Function, node_name, Address, Length, Cana_Series, Cana_Table
DEV11_TBL5
Server side map
descriptors are
passive. They
respond to read /
write commands
from a Canatal
master.
, DA_AI3,
0,
passive, Node_12,
0,
The node name
connects this map
descriptor to a node
specification.
Corresponds to the offset into the data table being requested.
3,
4
,5
Read section 6.1 for
more information.
The FieldServer
needs to know
which Canatal
device series
number to emulate.
This is the number
of the Canatal
device's data table
you wish the
FieldServer to
emulate.
If the request is for offset 2 (3rd element of the table), then the
FieldServer responds with data from array DA_AI3 element
10(offset into array)+3(3rd element).
If the request was for offset 5 then this map descriptor would
not be cabaple of processing the response. (starts at 0 and is 3
elements long.)
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 11
FS-8700-59 Canatal Sachnet
Driver Manual
6. Driver Notes
6.1 Canatal Device Data Tables
Canatal Devices's have their data organized into data tables. A query requests a number of
elements from a particular data table. The number, length and contents of the data tables is
defined by the Canatal Corporation and is dependent on the series number of the device being
addressed.
You will need to be familiar with the data tables you with to poll usin g this driver.
The following table specifies the series and tables that can be polled / written to / emulated to this
driver.
Series
Table
Data Format
2
2
2
2
2
2
2
2
2
2
2
2
4
5
6
7
8
9
10
11
12
13
14
15
CANA_BCD_CODED
CANA_FLOAT
CANA_FLOAT
CANA_FLOAT
CANA_BYTE
CANA_BYTE
CANA_PERCENT
CANA_BYTE
CANA_BYTE
CANA_BCD_CODED
CANA_BYTE
CANA_BYTE
Max
Elements
6
34
6
3
84
2
6
19
1
7
4
1
Read
Write
R
RW
R
RW
RW
R
R
RW
R
RW
R
RW
Description
FirmWare
Keycode
Sensor Reading
Security
Time Schedule
Switched Output
Analog Outputs
Alarm Status
Control Status
Time
Staged Output Status
Plant Status
4
4
4
4
4
4
4
4
4
4
4
5
6
7
8
9
10
11
12
13
CANA_BCD_CODED
CANA_FLOAT
CANA_FLOAT
CANA_FLOAT
CANA_BYTE
CANA_PERCENT
CANA_BYTE
CANA_BYTE
CANA_BYTE
CANA_BYTE
6
34
6
3
1
5
16
1
4
1
R
RW
R
RW
R
R
RW
R
R
RW
FirmWare
Keycode
Sensor Reading
Security
Switched Output
Analog Outputs
Alarm Status
Control Status
Staged Output Status
Plant Status
5
5
5
5
5
5
4
5
6
7
8
9
CANA_BCD_CODED
CANA_SWAP_INT
CANA_BYTE
CANA_SWAP_INT
CANA_BYTE
CANA_BYTE
6
100
4
3
84
3
R
RW
R
RW
RW
R
FirmWare
Keycode
Sensor Reading
Security
Time Schedule
Switched Output
Notes
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 12
FS-8700-59 Canatal Sachnet
Driver Manual
Series
5
5
5
5
5
5
5
Table
10
11
12
13
14
15
15
Data Format
CANA_PERCENT
CANA_BYTE
CANA_BYTE
CANA_BCD_CODED
CANA_BYTE
CANA_WORD
CANA_BYTE
Max
Read
4
48
3
7
4
17
1
R
RW
R
RW
R
RW
RW
Description
Analog Outputs
Alarm Status
Control Status
Time
Staged Output Status
Accumulating Run Time
Machine Remote Control
6
6
6
6
6
6
6
6
6
6
6
6
6
6
4
5
6
7
8
9
10
11
12
13
14
15
16
17
CANA_BCD_CODED
CANA_BYTE
CANA_SWAP_INT
CANA_BCD_4
CANA_BYTE
CANA_BYTE
CANA_PERCENT
CANA_BYTE
CANA_BYTE
CANA_BCD_CODED
CANA_BYTE
CANA_SWAP_INT
CANA_BYTE
CANA_BYTE
6
75
7
3
84
16
4
241
10
7
4
64
1
7
R
RW
R
RW
RW
R
R
RW
R
RW
R
RW
RW
RW
FirmWare
Keycode
Sensor Reading
Security
Time Schedule
Switched Output
Analog Outputs
Alarm Status
Control Status
Time
Staged Output Status
Accumulating Run Time
Machine Remote Control
KeyCode2
9
9
9
9
9
9
9
9
9
9
9
9
9
9
4
5
6
7
8
9
10
11
12
13
14
15
16
17
CANA_BCD_CODED
CANA_BYTE
CANA_SWAP_INT
CANA_BCD_4
CANA_BYTE
CANA_BYTE
CANA_PERCENT
CANA_BYTE
CANA_BYTE
CANA_BCD_CODED
CANA_BYTE
CANA_SWAP_INT
CANA_BYTE
CANA_BYTE
6
75
7
3
84
16
4
121
10
7
4
64
1
7
R
RW
R
RW
RW
R
R
RW
R
RW
R
RW
RW
RW
FirmWare
Keycode
Sensor Reading
Security
Time Schedule
Switched Output
Analog Outputs
Alarm Status
Control Status
Time
Staged Output Status
Accumulating Run Time
Machine Remote Control
KeyCode2
Notes
Mixed
Mixed
Mixed
Mixed
Mixed Data Formats: The drivers uses the Data Format listed in the above table as the default. If
you wish to poll data of different data types from one table then you will need at least two map
descriptors for that table. Example 2 in section 4.4.4 illustrates this. You will use the
cana_format parameter in the map descriptor to over-ride the default. Read the Canatal product
literature, determine the table storage format of the point(s) of interest and over-ride the default
format in your map descriptor. Note that map descriptors that include a range of points of mixed
data formats will cause unexpected results.
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 13
FS-8700-59 Canatal Sachnet
Driver Manual
The Data formats are used internally in the driver but they do indicate to the user the type of data
array that should be used for storage in the FieldServer.
Data Type
CANA_BCD_CODED
CANA_BYTE
CANA_SWAP_INT
CANA_BCD_4
CANA_WORD
CANA_FLOAT
Suitable Data Array Types
BYTE,UINT16,UINT32,FLOAT
BYTE,UINT16,UINT32,FLOAT
SINT16, SINT32, UINT16,UINT32,FLOAT
BYTE
UINT16,UINT32,FLOAT
FLOAT
6.2 Troubleshooting
The following messages are produced by the driver. Those marked FYI are for the user's
information only and do not require any corrective action. Those marked Error require some
action from the user.
CANA:#1
FYI. Station illegal -Forcing from %d to 59
Valid station numbers are 1-63.
CANA:#2
Error. Series & table numbers are rqd. Correct MapDesc=<%s>
The series and table parameters cana_series and cana_table must be specified in
the map descriptors.
CANA:#3
Error. Illegal Series Number. Correct MapDesc=<%s>
The series number specified cannot be processed by this driver. Read the vendor
documentation and correct the CSV file.
CANA:#4
Error. Illegal Table Number(%d). Correct MapDesc=<%s>
All Canatal equipment series do not have the same number of tables. Read the
vendor documentation and correct the CSV file.
CANA: #5
Error. Series & table numbers are rqd. Empty Table. Correct MapDesc=<%s>
The series & table combination specified are not valid. Read the vendor
documentation and correct the CSV file.
CANA:#6
Error. Start address is beyond end of table. MapDesc=<%s>
The address is the equivalent term to offset in the Vendor literature. Different
tables have different lengths. The lengths may also be different based on the
series number of the equipment. Read the vendor documentation and correct the
CSV file.
CANA:#7
FYI. Requested too many elements from table. MapDesc=<%s>
Changed request from %u to %u
The driver has truncated you data_length so that it does not read/write beyond the
end of a table.
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 14
FS-8700-59 Canatal Sachnet
Driver Manual
Errors 8 - 12 are produced when parsing a response from a Canatal device. They may result from
a corrupted message. If they occur infrequently then they require no attention. Check the
communication stats. In fact, it is more likely that you will be alerted to them by seeing errors in
the communication statistics.
CANA:#8
Error. Poll(%d)/Response(%d) Stns Not Equal
The station polled has response but as a different station. The response will be
abandoned. This may mean that the device's address has been incorrectly set or
that the device is not functioning correctly.
CANA:#9
Error. Poll(%d)/Response(%d) Tables Not Equal
CANA:#10
Error. Response Table=%d Unknown
CANA:#11
Error. Poll(%d)/Response(%d) Address Not Equal
CANA:#12
Error. Response Expected(%d)/Actual(%d) Bytes
CANA:#13
Error. Array is too small for mapDesc=<%s>
Some data will not be stored.
This is regarded as an error as the map descriptor has requested more data than can be stored. The
excess data has been discarded. The user should modify the map descriptor definition or change
the array length in the CSV file and restart the FieldServer.
CANA:#14
Error. Unknown Data method (%d) for mapDesc=<%s>
Report this error to FIELDSERVER TECHNOLOGIES.
CANA:#15
Error. Unknown Data method (%d) for mapDesc=<%s>
Report this error to FIELDSERVER TECHNOLOGIES.
7. Version Control
Date
Driver
Version
1.00a
1.00b
Document
Revision
0
1
5Apr2002 1.00b
2
11/22/02
3/13/03
3
4
1.00b
1.00b
Responsible
Comment
Initial Release
Minor changes in the way offset was described
in the examples in section 4.4.4 and 5.4.4
MF
JD
Driver changes are described in Technical
Bulletin TB0001.
Corrected some table numbers in section 6.1.
Previously table 16 & 17 had been shown as
table 15 & 16.
Formatting changes
Formatting changes
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 15