You are on page 1of 54

Square D SY/LINK Driver

for FactoryLink

Version 7.2 February 2004


Axisware Square-D SY/LINK Driver for FactoryLink 1

Contents

1 Overview......................................................................................................1
1.1 Software License.....................................................................................................1
1.2 Introduction.............................................................................................................1
1.3 Historical Note........................................................................................................1
1.4 SY/LINK Card Installation.....................................................................................1
1.5 Software Installation...............................................................................................1

2 Factorylink Application Configuration......................................................3


2.1 External Device Definition.....................................................................................3
2.1.1 Logical Port.............................................................................................3
2.1.2 Device Name...........................................................................................3
2.1.3 Function...................................................................................................3
2.1.4 Memory...................................................................................................3
2.1.5 Comment.................................................................................................4
2.2 Axisware SY/LINK Read/Write Control................................................................5
2.2.1 Table Name.............................................................................................5
2.2.2 Unsolicited Read.....................................................................................5
2.2.3 Exception Write......................................................................................5
2.2.4 Block Read Priority.................................................................................6
2.2.5 Block Read Trigger.................................................................................6
2.2.6 Block Read Disable.................................................................................6
2.2.7 Block Read Complete.............................................................................6
2.2.8 Block Read State.....................................................................................6
2.2.9 Block Write Priority................................................................................7
2.2.10 Block Write Trigger..............................................................................7
2.2.11 Block Write Disable..............................................................................7
2.2.12 Block Write Complete..........................................................................7
2.2.13 Block Write State..................................................................................7
2.3 Axisware SY/LINK Read/Write Information Table...............................................8
2.3.1 Tag Name................................................................................................8
2.3.2 Logical Station........................................................................................8
2.3.3 Data Table...............................................................................................8
2.3.4 Data Offset (Address).............................................................................9
2.3.5 Bit # or Length........................................................................................9
2.3.6 Data Type................................................................................................9
2.3.7 Message Priority.....................................................................................9
2.4 Axisware SY/LINK Logical Station Control........................................................10
2.4.1 Logical Port...........................................................................................10
2.4.2 Timeout (Tenths)...................................................................................10
2.4.3 Card Memory Address (Hex)................................................................10
2.4.4 Network Address (Hex)........................................................................10
2.4.5 Maximum Network Size.......................................................................11
2.4.6 Network Baudrate.................................................................................11
2.4.7 RS-422 Port Mode.................................................................................11
2.4.8 RS-422 Port Baudrate...........................................................................11
2.4.9 RS-422 Port Parity................................................................................11
2.4.10 RS-422 Port Data Bits.........................................................................11
2.4.11 Acknowledge Alarms (possible future)..............................................12

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 2

2.4.12 Acknowledge Fault/Alert/Warning Register (possible future)...........12


2.4.13 Unsolicited Message Length...............................................................12
2.4.14 Message Tag........................................................................................12
2.5 Axisware SY/LINK Logical Station Information.................................................13
2.5.1 Error/Status Tag Name..........................................................................13
2.5.2 Logical Station (Decimal).....................................................................13
2.5.3 Device Type..........................................................................................13
2.5.4 Routing Levels......................................................................................14
2.5.5 Routing Drop Id 1 - 7............................................................................14
2.5.6 Comment...............................................................................................14

3 Appendices................................................................................................15
3.1 Appendix A: Installation of SY/LINK Card........................................................15
3.1.1 Sy/Link Segment Memory Addresses:..................................................15
3.1.2 Cable Connections................................................................................15
3.1.3 Network Configuration and Addressing...............................................15
3.2 Appendix B: Software Installation - OS/2...........................................................18
3.2.1 Before Starting Installation (OS/2 version)..........................................18
3.2.2 Driver Installation Instructions (OS/2).................................................19
3.2.3 Modifying the CONFIG.SYS File (OS/2)............................................20
3.2.4Softkey Protection Validation................................................................21
3.3 Appendix C: (Reserved).......................................................................................22
3.4 Appendix D: Software Installation - Windows 95/NT........................................23
3.4.1 Before Starting Installation - (Windows 95/NT version).....................23
3.4.2 Driver Installation Instructions (Windows 95/NT)...............................23
3.4.3 Softkey Protection Validation...............................................................25
3.5 Appendix E: (Reserved).......................................................................................26
3.6 Appendix F: Driver Status Codes........................................................................27
3.6.1 Application startup errors.....................................................................27
3.6.2 Run-time startup errors.........................................................................29
3.6.3 SoftKey protection messages................................................................29
3.6.4 Run-time errors.....................................................................................30
3.6.5 Unsolicited message processing errors.................................................30
3.7 Appendix G: Tables for Network and Alarm Errors...........................................33
3.7.1Network Error Table..............................................................................33
3.7.2Alarm Error Table..................................................................................35
3.8 Appendix H: Data Types and Conversions..........................................................36
3.9 Appendix I: SY/LINK Addressing.......................................................................39
3.9.1Data Tables............................................................................................39
3.9.2 Device Types.........................................................................................40
3.10 Appendix J: Unsolicited Reads..........................................................................41
3.10.1Unsolicited Alarms..............................................................................42
3.10.2Unsolicited Data...................................................................................43
3.11 Appendix K: FactoryLink Version Upgrade Procedures...................................44
3.12 Appendix L: Sample Application......................................................................45

4 Glossary of Terms.....................................................................................46

5 Contact information..................................................................................48

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 1

This document contains proprietary information of Axisware LLC (Axisware).

This document is based on information available at the time of its publication. While efforts have been made
to be accurate, the information contained herein does not purport to cover all details or variations in hardware
or software, nor to provide for every possible contingency in connection with installation, operation, or
maintenance. Features may be described herein which are not present in all hardware and software systems.
Axisware assumes no obligation of notice to holders of this document with respect to changes subsequently
made.

Axisware makes no representation or warranty, expressed, implied, or statutory with respect to, and assumes
no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained
herein. No warranties of merchantability or fitness for purpose shall apply.

All trademarks are the property of their respectve owners. All trademarks acknowledged.

Copyright 1995-1996 NOVA Technologies


Copyright 1997-2000 Bullet Software
Copyright 2000-2004 Axisware LLC
All Rights Reserved

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 2

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 1

1 Overview

1.1 Software License


Axisware LLC grants you a non-exclusive license to use the Software programs and related documentation
for this product on a single processing unit. For each processing unit that executes the Software programs for
this product you must have a unique serial number and Proof of License statement. No one other than a
current Axisware employee or agent is permitted to modify or tamper with in any way the executable
computer files(s) associated with this product. This license applies solely to the software contained in this
product, and does not include any additional software or documentation provided by Axisware or other
parties required for the proper operation of this product.

This product uses a SoftKey protection method. Please consult the SoftKey manual for a discussion of the
procedures to validate the SoftKey for this product.

1.2 Introduction
This manual describes the installation and configuration of the Square D SY/LINK communication driver for
FactoryLink . The installation of the SY/LINK card is also briefly described.

The driver currently supports all standard SY/NET devices. Unsolicited messages, faults, alerts, and warnings
are supported from all SY/MAX PLCs. Register status and force information may also be read from SY/MAX
PLCs.

1.3 Historical Note


This product was previously a Nova Technologies product and is now an Axisware product. The manual is
correct in all technical detail except install instructions, which are detailed in the Utilities manual. Axisware
has assumed all responsibilities for this product; if you see a reference to Nova Technologies consider it a
reference to Axisware.

1.4 SY/LINK Card Installation


The SY/LINK card must be installed in the computer in an open slot. Please consult Appendix A for information
concerning the installation of the card, and also refer to your hardware manuals for complete information.

1.5 Software Installation


If installing over a previous version of this driver, perform a multi-platform save of the FactoryLink
application before the install and restore the application after installation. Please refer to FactoryLink
documentation for details on multi-platform save and restore.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 2

In this document are appendices describing the software installation for this product on specific platforms. Please
read the appropriate appendix before installing this product.

Platform Appendix
OS/2 B
Windows 95/NT D

When the driver software installation is completed, please refer to the SoftKey Manual for the instructions on
running the Validate program. Failure to run Validate by the end of the 15-day grace period will result in a non-
functioning driver.

After this communications driver has been installed, updating to a newer version of FactoryLink may appear to
cause operational problems. Please refer to Appendix K before updating FactoryLink.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 3

2 Factorylink Application Configuration

2.1 External Device Definition

Access this table by selecting External Device Definition from the Configuration Manager main menu. This is
one of the five configuration tables that must be configured The other tables are accessed by selecting Axisware
SY/LINK Driver from the Configuration Manager main menu.

This table identifies the computer’s ports and I/O cards through which the devices will communicate with
FactoryLink. In this table identifiers are declared which make the external devices recognizable to FactoryLink.

This panel contains seven fields or five fields depending on FactoryLink version. Here we describe only the
applicable fields, you shuld ignore any fields not described here. Use the Tab key to move among the fields.

2.1.1 Logical Port

Number assigned by the user to indicate a particular communication path. This number must be unique
for each EDI driver used in the application.

Valid entries: 0-999 Physical Card & Physical Port

These fields are not used by this driver.

2.1.2 Device Name

The four-character device name for the EDI driver that will use the related Logical Port.

Valid entry: SYLK

2.1.3 Function

Type of communication used by the EDI driver for the related Logical Port. This field refers to the
different types of EDI communication modes.

Valid entry: SYSPRG

2.1.4 Memory

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 4

The amount of memory in K-bytes used for the block storage size of the read and write information
entered by the user. This entry refers only to the memory used by the driver for data storage for the
related Logical Port.

Valid entries: 4-63

2.1.5 Comment

(Optional) Description for the current Logical Port. Used only for application documentation.

Valid entry: 14 alphabetic or numeric characters

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 5

2.2 Axisware SY/LINK Read/Write Control


This table specifies the tags used to control the reading and writing of the values specified in the Read/Write
Information table (the controlling tags are the Read Trigger, Read Disable, Write Trigger, Write Disable). It
also defines the tags that will report the status of reads and writes (the status tags are the Read Complete,
Read State, Write Complete, Write State). Each line in this table refers to one Read/Write Information
Table.

After these fields have been configured, select "Next" or Ctrl-N to edit the Read/Write Information Table
corresponding to the Control table selected by the cursor.

2.2.1 Table Name

User assigned name of the Read/Write Information Table to be defined or modified.

Valid entry: ASCII string incorporation up to 16 of the following character set:


A-Z,a-z,@,$,_, or 0-9

2.2.2 Unsolicited Read

Allows you to select whether or not the current table will be considered in the processing of an
unsolicited message received from the PLC. Standard addressing is used to correlate the message from
the PLC with the tags configured in the table. Please refer to Appendix N for additional information
and examples.

Valid entries: Descriptions:

Yes Normal write to the real-time database


Force Forced write to the real-time database
No Unsolicited reads are not processed

2.2.3 Exception Write

Option determining whether or not a specific tag in the related Read/Write Information Table is written
to the selected logical station whenever the real-time database value for that tag changes.

Valid entries: Description:

Yes A change of status of any element in the table generates a write of that
element's value.

No No exception processing.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 6

2.2.4 Block Read Priority

Priority influencing the order in which the EDI task handles the queuing of block read requests. If two
requests are received simultaneously by EDI, the request with the highest priority (lowest number) is
processed first.

Valid entries: 1 - 4 (default = 1)

2.2.5 Block Read Trigger

Digital tag whose value, when forced to 1 (ON), initiates a block read of the values specified in the
related Read/Write Information Table. This trigger allows the block read operation to be initiated by
some other task.

Valid entry: FactoryLink digital tag

2.2.6 Block Read Disable

Digital tag used to determine whether or not a block read table will be processed. If the tag value is 0,
the table is permitted to function normally; however, if the value is 1, the table will not respond to the
Block Read Trigger defined above.

Valid entry: FactoryLink digital tag

2.2.7 Block Read Complete

Digital tag whose value is force written to 1 (ON) by the EDI task whenever any block read operation for
this table is completed. If this tag is specified then when the EDI task initializes, its value is force
written to 1 (ON).

Note: Block Read Complete tags are valid only if a different table is used for each logical port.

Valid entry: FactoryLink digital tag

2.2.8 Block Read State

Digital tag whose value is 0 (OFF) when a block read of the tags specified in this table is in progress and
1 (ON) otherwise. If this tag is specified then when the EDI task initializes, its value is force written to 1
(ON).

Note: Block Read State tags are valid only if a different table is used for each logical port.

Valid entry: FactoryLink digital tag

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 7

2.2.9 Block Write Priority

Priority influencing the order in which the EDI task handles the queuing of block write and exception
write requests. If two requests are received simultaneously by EDI, the request with the highest priority
(lowest number) is processed first.

Valid entries: 1-4 (default = 1)

2.2.10 Block Write Trigger

Dgital tag whose value, when forced to 1 (ON), initiates a block write of the values specified in the
related Read/Write Information Table. This trigger allows the block write operation to be initiated by
some other task.

Valid entry: FactoryLink digital tag

2.2.11 Block Write Disable

Dgital tag used to determine whether or not a block write table will be processed. If the tag value is 0,
the table is permitted to function normally; however, if the value is 1, the table will not respond to the
Block Write Trigger defined above.

Valid entry: FactoryLink digital tag

2.2.12 Block Write Complete

Dgital tag whose value is force written to 1 (ON) by the EDI task whenever any block write operation
for this table is completed. If this tag is specified then, when the EDI task initializes, its value is force
written to 1 (ON).

Note: Block Write Complete tags are valid only if a different table is used for each logical port.

Valid entry: FactoryLink digital tag

2.2.13 Block Write State

Dgital tag whose value is 0 (OFF) when a block write of the tags specified in this table is in progress and
1 (ON) otherwise. If this tag is specified then, when the EDI task initializes, its value is force written to
1 (ON).

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 8

Note: Block Write State tags are valid only if a different table is used for each logical port.

Valid entry: FactoryLink digital tag

2.3 Axisware SY/LINK Read/Write Information Table


The Read/Write Information Table links FactoryLink tags to specific addresses in the PLC represented by the
Logical Station. Values are either read into the tags from the device or written from the real-time database tags
to the device.

These tables are sometimes referred to as overlay panels, or ovr panels. Each table has one entry (line) for it
in the Read/Write Control Table.

Note: Please verify that the table name displayed at the bottom of the panel correctly shows the table to be
modified.

After these fields have been completed, select "Next" or Ctrl-N to edit the Logical Station Control Table.

2.3.1 Tag Name

Name of the FactoryLink tag to be updated as a result of the read operation or the tag from which
information is taken to be written to the device.

Valid entry: FactoryLink tag


(DIGITAL, ANALOG, LONGANA, FLOAT, MESSAGE)

2.3.2 Logical Station

Number from the Logical Station Table identifying the particular combination of physical attributes that
will define and govern the data transfer to and from the real-time tag.

Valid entries: 0-999

2.3.3 Data Table

Mnemonic defining the area of device memory to be accessed, or the manner in which the device is to be
addresse

Valid entries: Refer to Appendix I (SY/LINK Addressing).

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 9

2.3.4 Data Offset (Address)

Numeric portion of device address. Specifies word offset or address of data to be accessed.

Valid entries: Refer to Appendix I (SY/LINK Addressing).

2.3.5 Bit # or Length

If a digital tag is used, this field is one based and is used to specify the bit offset in the selected word. If a
message tag is used, the field specifies the number of bytes that are to be transferred between the
message tag and the Logical Station. Please see Appendix I for additional information concerning the
use of bit numbers to access the status bits for a PLC register.

Valid entries: Digital tags 1 - 32


Message tags 1 - 128

2.3.6 Data Type

Data type for information being read/written from/to the Logical Station.

Valid entries: Refer to Appendix H (Data Types and Conversions)

2.3.7 Message Priority

Priority of read or write operation. If an operation is given priority status, the operation will preempt
other normal priority operations on the network.. Care should be taken when using priority messages,
because the overall performance of the network can be adversely affected if too many priority messages
are used.

Valid entry: Descriptions:

NORMAL Normal priority read or write


PRIORITY High priority read or write

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 10

2.4 Axisware SY/LINK Logical Station Control


This table is used to configure each logical port and its associated stations in the Logical Station Information
table. It specifies which specific port is connected to the external device being defined.

After completing these fields, select "Next" or Ctrl-N to edit the Logical Station Information Table
corresponding to the table selected by the cursor.

2.4.1 Logical Port

Number specified in the External Device Definition Table which represents a particular communications
path.

This number must also be referenced in the External Device Definition panel.

Valid entries: 0-999

2.4.2 Timeout (Tenths)

Number of tenths of seconds permitted for the driver to process a request.

Valid entries: Actual value in tenths of seconds.


20 to 30 (or 2 - 3 seconds for most applications).

2.4.3 Card Memory Address (Hex)

Address for memory shared by the SY/LINK card and the FactoryLink CPU. This number must match
the address selected by the dip switches on the card.

Valid entries: Hex memory address as selected by key file (D0000 recommended)
CA000, CB000, CC000, CD000, CE000, CF000, D0000,
D1000, D2000, D3000

2.4.4 Network Address (Hex)

Network address for the FactoryLink computer. Must be unique on the network.

Valid entries: 0 - 99 or 0 – 30.


See the next field. (Maximum Network Size)

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 11

2.4.5 Maximum Network Size

Three possible choices for the maximum network size are available, 30, 31, and 100. The default is 30.
All devices on the network must be configured for the same size (number of drops). If less than 30
devices will be used, a significant speed increase can be attained by configuring for only 30 devices.
However, some configurations will require that the maximum size of 100 be used.

Valid entries: 30, 31 or 100

2.4.6 Network Baudrate

The baudrate determines the speed with which data will be transmitted over the network. All devices on
the network must be configured for the same baudrate. Before selecting a baudrate, please note the
guidelines and restrictions indicated in section 4.0 Network Configuration and Connections in the
SY/LINK manual by Square D Company.

Valid entries: 62.5K, 125K, 250K, and 500K

2.4.7 RS-422 Port Mode

This field is used to select the operating mode for the RS-422 port on the SY/LINK card.

Valid entries: SY/MAX, NET2NET

2.4.8 RS-422 Port Baudrate

The baudrate determines the speed data will be transmitted over the RS-422 line. The device connected
to the 422 line must be configured for the same baudrate.

Valid entry: 110, 300, 600, 1200, 2400, 4800, 9600 and 19200

2.4.9 RS-422 Port Parity

The parity selects how the parity bit is used on the RS-422 port. The device connected to the 422 line
must be configured for the same parity.

Valid entry: NONE, ODD, EVEN

2.4.10 RS-422 Port Data Bits

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 12

This field is used to select the number of data bits used on the RS-422 port. The device connected to the
422 line must be configured for the same number of data bits.

Valid entry: 7-BITS, 8-BITS

2.4.11 Acknowledge Alarms (possible future)

Reserved for possible future use.

Valid entry: NO

2.4.12 Acknowledge Fault/Alert/Warning Register (possible future)

Reserved for possible future use.

Valid entry: 1

2.4.13 Unsolicited Message Length

Unsolicited messages received from other PLCs are written directly into register memory on the
SY/LINK card. The driver does not have the capability of determining which device sent the data or how
many words of data were sent. This field allows the user to specify the number of words the driver is to
assume are received with each unsolicited message.

Valid entry: 1 - 128

2.4.14 Message Tag

(Optional) Message tag to which a text string will be written if an error is encountered in the processing
of an EDI request.

Valid entry: FactoryLink message tag

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 13

2.5 Axisware SY/LINK Logical Station Information


This table defines the logical station(s) accessible through a specific logical port defined in the Logical
Station Control Table. Each logical station is tied to its physical station address and device type. This logical
station information structure allows communications to multiple devices on a network using one logical port.

Note: Please verify that the table name displayed at the bottom of the panel is showing the table to be
modified.

After these fields have been completed, "Exit" or F3 will allow you to return to the Configuration Manager
main menu.

2.5.1 Error/Status Tag Name

(Optional) Analog tag to which all error codes for this logical station are to be written.

Valid entries: FactoryLink analog tag

2.5.2 Logical Station (Decimal)

Number entered by user to represent a particular combination of a logical port and physical device. This
number is referenced in the Read/Write Information Table to correlate specific addresses and tags with a
physical device. Please note that this number must be unique for each device name (SYLK).

Valid entries: 0-999

2.5.3 Device Type

Type of device on the SY/NET network with which communications are to be established.

Valid entries: Description:


"SCP_1XX" Series 100 processors
"SCP_3XX" Series 300 processors
"SCP_4XX" Series 400 processors
"SCP_5XXO" Series 500 processors (rev. 1 - 6)
"SCP_5XX" Series 500 processors (rev 7 and up)
"SCP_6XX" Series 600 processors
"SCP_7XX" Series 700 processors
“DLM_110” D-Log Data Controller Module
“DLM_120” D-Log Data Controller Module
“PCM_110” PID Loop Control Module
"SY/LINK" SY/LINK card
GENERIC General device using routing exactly as specified in the next field

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 14

2.5.4 Routing Levels

The number of drop addresses from the seven following fields to be considered as valid. The specified
number of valid addresses will be copied to the routing portion of the SY/LINK card for each transaction
involving the selected Logical Station. Please see page 38 of the SY/LINK manual and Appendix I of
this manual for additional information concerning routing.

Valid entries: 0-7

2.5.5 Routing Drop Id 1 - 7

These seven fields specify the actual route values that will be used to access a device on the network.
Only the number of fields specified above will be actually used. Please see page 38 of the SY/LINK
manual for additional information regarding routing.

Valid entries: 0-254

2.5.6 Comment

(Optional) Description for the current Logical Station. Used only for application documentation.

Valid entry: 31 alphabetic or numeric characters

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 15

3 Appendices

3.1 Appendix A: Installation of SY/LINK Card

The SY/LINK card must be installed in the computer in an open, full length slot. However, Prior to installing the
SY/LINK card, the appropriate memory segment address must be properly set by the dip switches.

The memory segment address is selected by the dip switches on the SY/LINK card. The four dip switches are set
in accordance with pages 14 and 15 of the SY/LINK manual. The following chart illustrates the proper switch
settings for all valid addresses. A segment memory address of D0000 (hex) is recommended.

3.1.1 Sy/Link Segment Memory Addresses:

SW1 SW2 SW3 SW4 ADDRESS


0 0 0 0 CA000
0 0 0 1 CB000
0 0 1 0 CC000
0 0 1 1 CD000
0 1 0 0 CE000
0 1 0 1 CF000
0 1 1 0 D0000
0 1 1 1 D1000
1 0 0 0 D2000
1 0 0 1 D3000
.

3.1.2 Cable Connections


The required communication cabling is discussed on pages 23 through 33 of the SY/LINK manual. The standard
configuration would be to connect the cable shipped with the SY/LINK board (part number S30600-162-50) to a
"Tee" connector (Class 8030 Type CCK-212) on the network cable (Belden 9463 twinaxial cable, Square D
designator: Class 8030 Type CC-201).

3.1.3 Network Configuration and Addressing

The following scenarios show different configurations for connecting the SY/LINK card to PLCs. Note that
the first actual routing level is automatically handled by the driver so only the remaining levels are entered in
the Logical Station Information Table. All addresses used are for example purposes only.

Going out through 422 port and going straight to the PLC:

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 16

SY/LINK Card No NIM is used in this


scenario.
Network Address = 5
The only time SY/MAX
RS-422 Port Mode = SY/MAX mode is used when using
the 422 port is when going
Routing is 005, 105 straight to the PLC.
Use 1 for Routing Levels, 1
Drop ID of 105.

(Note: The first routing is put


in automatically by the driver.
Therefore the station needs
only 1 Drop ID.

Going out through 422 port and through the NIM to the PLC:

SY/LINK Card

Network Address = 5

RS-422 Port Mode = Address wheel must be 5


NET2NET 0 (matching the Network
5 Address) if NET2NET
Routing is 005, 105, 005. mode is used.

Routing Levels = 2 -- Set to SY/MAX


2 Drop IDs of 105, 005 are
used.
-- Set to Net2Net
(The driver automatically
provides the first level.)

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 17

Going out through 422 port and through two NIMs to a PLC:

SY/LINK Card

Network Address = 5

RS-422 Port Mode =


NET2NET 0 0
5 7
Routing is 005, 105, 007.

Routing Levels = 2 -- Set to SY/MAX -- Set to SY/MAX


2 Drop IDs of 105 and 007
are used.
-- Set to Net2Net

Going out through network port to NIMs and PLCs on a network:


Out
Network A B
Port

SY/LINK Card

Network Address = 05

RS-422 Port Mode = (no entry


required) 0 0
7 8
To the first PLC (A) the
routing is 005, 007.
Routing Levels = 1 -- Set to SY/MAX
1 Drop ID of 007 .

To the second PLC (B) the -- Set to SY/MAX


routing is 005, 108.
Routing Levels = 1
1 Drop ID of 108.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 18

3.2 Appendix B: Software Installation - OS/2

3.2.1 Before Starting Installation (OS/2 version)

Updating From A Previous Version:

If the driver software is an update from an older version of the Axisware driver, the following procedures must
be followed for the software to be properly installed. First, the operator must exit from both the Run Manager
and the Configuration Manager. Second, a multiplatform save file should be created. Third, the driver should be
installed as described below. Fourth, restore the multiplatform save file created in step 2. Fifth, update the
Configuration Manager tables for the Axisware driver (Logical Station Information).

The install command file relies upon the environment variable $FLINK to complete the installation process.
($FLINK is used to refer to the environment variable “FLINK”, which points to the FactoryLink directory.)
Before starting the install program you may want to manually set $FLINK if you want to have the files
copied to a directory other than the default of C:\FLOS2.

If $FLINK has not been defined when the install is started, you will be requested to exit and assign a value
to $FLINK, and then restart the install program. $FLINK can be assigned a parameter by using the SET
command (example: set flink=d:\flos2). Be sure to include the drive letter.

During the installation, two ASCII text files will be modified by the installation program. The original
copies of both files will be copied to a file with the same filename but a .NVA extension. The first file to be
modified is $FLINK\AC\TITLES (where $FLINK is the FactoryLink directory). This file is used by the
Configuration Manager to determine which tasks to list and also the order in which they are to be listed. The
following line will be added to the TITLES file. (The line may be different, depending on your FactoryLink
version.)

sylk.ac EDI NOVA SY/LINK Driver

If you have a backup file named $FLINK\AC\TITLES.NVA (possibly created by a previous install), the
program will warn you during the install that it is about to be overwritten and will ask you if you want to exit,
and manually save the .NVA file.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 19

The second file to be modified is $FLINK\CTGEN\CTLIST. This file is used by the CTGEN utility in the
creation of the binary CT (configuration table) files used at run-time by FactoryLink. The following line will
be added to the CTLIST file.

sylk: sylkshdr sylksovr sylk_hdr sylk_ovr

If you have a backup file named $FLINK\CTGEN\CTLIST.NVA (possibly created by a previous install), the
program will ask you during the install if you wish to exit, and manually save a copy of this .NVA file before
it is overwritten

3.2.2 Driver Installation Instructions (OS/2)

It is important that you have followed the hardware installation procedures described in Appendix A
before proceeding with the driver installation instructions.

The driver software is loaded by inserting the driver diskette in drive A or B. At the OS/2 command prompt,
make the drive containing the diskette the current working drive, type INSTALL and then press Enter.

Note: A source other than drive A or B can be used; e.g., from a directory on a hard drive, or across a
network.

If a message is displayed stating that the INSTALL program is having difficulty finding the directory
containing the FactoryLink program files, press a key to exit and use the set command to reset the $FLINK
environment variable. The problem may be resolved by clearly stating the drive letter. At the OS/2 command
prompt type set FLINK= followed by the drive letter (a-z), a colon (:), a backslash (\) and the directory name
(s) giving the path to the FactoryLink program files. Examples:
set FLINK=d:\work1\flos2 or set FLINK=t:\sect2\factory. Make sure that the only space in this command
is between “set” and “FLINK”.

After the “Axisware” screen appears the FactoryLink Path and FactoryLink Release Version are displayed.
Press y and then the Enter (Return) key if the information is correct.

The driver Serial Number and Release Type are then displayed. Press y and then the Enter (Return) key to
continue.

The following message will appear

Copying configuration files to hard disk . . .

followed by a message relevant to obtaining authorization for the product, if required.

The install program checks for a backup file named $FLINK\AC\TITLES.NVA. If found, the following
message is displayed:

This install program will update your file named


$FLINK\AC\TITLES

$FLINK\AC\TITLES.NVA (a backup file) already exists.


To overwrite it, press y followed by Enter (Return).

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 20

By pressing n, you may Exit, manually save


your .NVA backup file, and restart this program..

Enter either y or n followed by the Enter (Return) key ==>

The install program will then go through the same procedure before updating the file
$FLINK\CTGEN\CTLIST. The install program checks for a backup file named
$FLINK\CTGEN\CTLIST.NVA. If found, this message appears:

This install program will update your file named


$FLINK\CTGEN\CTLIST

$FLINK\CTGEN\CTLIST.NVA (a backup file) already exists.


To overwrite it, press y followed by Enter (Return).

By pressing n, you may Exit, manually save your


.NVA backup file, and restart this program.

Enter either y or n followed by the Enter (Return) key ==>

The messages

Updating listing of driver names. . .


and
Updating CTLIST . . .

will be displayed while the backup (.NVA) versions are being created and the $FLINK\AC\TITLES and
$FLINK\CTGEN\CTLIST files are updated.

If one of the following error messages appear:

!!!! Unable to update $FLINK\AC\TITLES file


or
!!!! Unable to update $FLINK\CTGEN\CTLIST file

the lines to be added to these files can be typed in manually using a text editor. Refer to the section “Before
Starting” (above) for the specific lines and where they are to be added.

Please notice any additional messages displayed on the screen. When all of the necessary files have been
copied the following message will appear:
.....NOVA Installation Program Completed.

3.2.3 Modifying the CONFIG.SYS File (OS/2)

This portion of the manual should only be consulted after the general installation has been completed. The device
driver NOVAMEM.SYS must be loaded into memory when your system boots for the FactoryLink SY/LINK
driver to function properly. After the Axisware installation diskette's INSTALL program is run, the
CONFIG.SYS file must be modified manually, using a text editor, such as OS/2's System Editor "e".

The following line (or one similar to it) must be added to the OS/2 CONFIG.SYS file. A directory that will
contain the device driver NOVAMEM.SYS is automatically created when the software is installed from the

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 21

Axisware installation diskette. Assuming that $FLINK is set to c:\flos2, the line to be added to the CONFIG.SYS
would be:

DEVICE=C:\FLOS2\EDI\SYLK\NOVAMEM.SYS

It is very important that only ONE reference to this device driver be made in the CONFIG.SYS file.

Note: The changes you make to your CONFIG.SYS file will not take effect until you reboot your system.

3.2.4Softkey Protection Validation

Please refer to the SoftKey Manual and run the program Validate to ensure that your product does not
expire at the end of the 15-day grace period. Specific steps are included in the Softkey Manual.

Warning: The installation of this product is not complete until the Validate program is run.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 22

3.3 Appendix C: (Reserved)

This appendix is reserved for future use.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 23

3.4 Appendix D: Software Installation - Windows 95/NT

3.4.1 Before Starting Installation - (Windows 95/NT version)

Updating From A Previous Version:

If the driver software is an update from an older version of the Axisware driver, the following procedures must
be followed for the software to be properly installed. First, the operator must exit from both the Run Manager
and the Configuration Manager. Second, a multiplatform save file should be created. Third, the driver should be
installed as described below. Fourth, restore the multiplatform save file created in step 2. Fifth, update the
Configuration Manager tables for the Axisware driver (Logical Station Information).

The install command file relies upon the environment variable $FLINK to complete the installation process.
($FLINK is used to refer to the environment variable “FLINK”, which points to the FactoryLink directory.)
Before starting the install program you may want to manually set $FLINK if you want to have the files
copied to a directory other than the default of C:\FLNT.

If $FLINK has not been defined when the install is started, you will be requested to exit and assign a value
to $FLINK, and then restart the install program. $FLINK can be assigned a parameter by using the SET
command (example: set flink=d:\flnt). Be sure to include the drive letter.

During the installation, two ASCII text files will be modified by the installation program. The original copies
of both files will be copied to a file with the same filename but a .NVA extension. The first file to be modified
is $FLINK\AC\TITLES (where $FLINK is the FactoryLink directory). This file is used by the Configuration
Manager to determine which tasks to list and also the order in which they are to be listed. The following line
will be added to the TITLES file. (The line may be different, depending on your FactoryLink version.)

sylk.ac EDI Axisware SY/LINK Driver

If you have a backup file named $FLINK\AC\TITLES.NVA (possibly created by a previous install), the
program will warn you during the install that it is about to be overwritten and will ask you if you want to exit,
and manually save the .NVA file.

The second file to be modified is $FLINK\CTGEN\CTLIST. This file is used by the CTGEN utility in the
creation of the binary CT (configuration table) files used at run-time by FactoryLink. The following line will
be added to the CTLIST file.

sylk: sylkshdr sylksovr sylk_hdr sylk_ovr

If you have a backup file named $FLINK\CTGEN\CTLIST.NVA (possibly created by a previous install), the
program will ask you during the install if you wish to exit, and manually save a copy of this .NVA file before
it is overwritten.

3.4.2 Driver Installation Instructions (Windows 95/NT)

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 24

It is important that you have followed the hardware installation procedures described in Appendix A
before proceeding with the driver installation instructions.

The driver software is loaded by inserting the driver diskette in drive A or B. After making the drive
containing the diskette the current working drive, type INSTALL and then press Enter. (Do not use File…
Run…from Windows NT's Program Manager or File Manager.)

Note: A source other than drive A or B can be used; e.g., from a directory on a hard drive, or across a
network.

If the $FLINK environment entry is not defined, you will be asked if you want to accept a default setting for
it. Press y to accept this default setting. If n is pressed, the program exits, and you may use the command
required by your platform to specify the location of the FactoryLink program files (example: set
FLINK=f:\flnt), and then restart.

If a message is displayed stating that the INSTALL program is having difficulty finding the directory
containing the FactoryLink program files, press a key to exit and use the set command to reset the $FLINK
environment variable. The problem may be resolved by clearly stating the drive letter. At the command
prompt type set FLINK= followed by the drive letter (a-z), a colon (:), a backslash (\) and the directory name
(s) giving the path to the FactoryLink program files. Examples:
set FLINK=d:\work1\flnt or set FLINK=t:\sect2\factory. Make sure that the only space in this command
is between “set” and “FLINK”.

After the “Axisware” screen appears the FactoryLink Path and FactoryLink Release Version are displayed.
Press y and then the Enter (Return) key if the information is correct.

The driver Serial Number and Release Type are then displayed. Press y and then the Enter (Return) key to
continue.

The following message will appear

Copying configuration files to hard disk . . .

followed by a message relevant to obtaining authorization for the product, if required.

The install program checks for a backup file named $FLINK\AC\TITLES.NVA. If found, the following
message is displayed:

This install program will update your file named


$FLINK\AC\TITLES

$FLINK\AC\TITLES.NVA (a backup file) already exists.


To overwrite it, press y.

By pressing n, you may Exit, manually save


your .NVA backup file, and restart this program.

Enter either y or n followed by the Enter (Return) key ==>

The install program will then go through the same procedure before updating the file
$FLINK\CTGEN\CTLIST. The install program checks for a backup file named
$FLINK\CTGEN\CTLIST.NVA. If found, this message appears:

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 25

This install program will update your file named


$FLINK\CTGEN\CTLIST

$FLINK\CTGEN\CTLIST.NVA (a backup file) already exists.


To overwrite it, press y followed by Enter (Return).

By pressing n, you may Exit, manually save your


.NVA backup file, and restart this program.

Enter either y or n followed by the Enter (Return) key ==>

The messages

Updating listing of driver names. . .


and
Updating CTLIST . . .

will be displayed while the backup (.NVA) versions are being created and the $FLINK\AC\TITLES and
$FLINK\CTGEN\CTLIST files are updated.

If one of the following error messages appear:

!!!! Unable to update $FLINK\AC\TITLES file


or
!!!! Unable to update $FLINK\CTGEN\CTLIST file

the lines to be added to these files can be typed in manually using a text editor. Refer to the section “Before
Starting” (above) for the specific lines and where they are to be added.

Please notice any additional messages displayed on the screen. When all of the necessary files have been
copied the following message will appear:

.....NOVA Installation Program Completed.

Be sure to restart your computer to ensure that the proper changes have been made.

3.4.3 Softkey Protection Validation

Please refer to the SoftKey Manual and run the program Validate to ensure that your product does not
expire at the end of the 15-day grace period. Specific steps are included in the Softkey Manual.

Warning: The installation of this product is not complete until the Validate program is run.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 26

3.5 Appendix E: (Reserved)

This appendix is reserved for future use.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 27

3.6 Appendix F: Driver Status Codes

3.6.1 Application startup errors

The following error codes (alphabetized) may be reported to FactoryLink while the SY/LINK Driver tables are
being processed at startup. These messages will appear within the Run-Time Manager window during the startup
of the application. Messages that scroll off the screen may be redirected to an output file by opening an OS/2 or
DOS window and, at the prompt, typing edistart -r -v > edi.out followed by the Enter (Return) key. When the
process has completed, edit the file edi.out to view the error codes generated by FactoryLink

Bitwise data anomaly


Duplicate binary address encountered.

Data anomaly
Indicates that addresses and data types specify overlapping elements.

DIGITAL tags may not be used with numerical types


DIGITAL tags may only be used to read or write discretes.

Invalid bit number specified


The bit number must normally be between 1 and 16. If the register data table is used, a bit
number between 17 and 32 may be used to specify status bits for that register.

Invalid data table specified


An invalid data table was selected for the indicated device type. Consult the key file in the
Configuration Manager for a list of valid data tables.

Invalid data type encountered


See Appendix H for list of valid data types.

Invalid device type specified


The data file is corrupted and contains a device not recognized by the driver. Delete the
indicated record and type in the record again, selecting a valid device type.

Invalid string length


If a message tag is used, the Bit #/Length field in the Read/Write Information Table
represents the length (in bytes) of the message used in the transaction. This number must be
between 1 and 255.

High priority, digital writes are invalid


Digital writes are completed with a maskable write operation. Only normal priority is
permitted with this write function.

Logical station X, invalid routing


The logical station X which was specified in the current Read/Write Information Table
contains invalid routing information. Check page 38 of the SY/LINK manual for additional
information about routing.

Logical station X not found

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 28

The logical station X was specified in the current Read/Write Information Table, but this
logical station number was never defined in the Logical Station Information Table.

Maximum element length exceeded


Based on the PLC type and the specified operation, there is a defined maximum length for each
element. This error will only occur when priority operations are used in conjunction with
messages tags longer than 16 words.

MESSAGE tags may not be used with numerical types


Only the ASC data type may be used with MESSAGE tags.

No tag given
The indicated line of the Read/Write Information Table currently being processed does not
contain a valid FactoryLink tag name.

No tags, read/write packet not made


The current Read/Write Information Table contained entries that caused a portion of the table
to generate an error and consequently no DCT information was output.

Only DIGITAL tags may be used with BIN


Binary data may only be accessed with DIGITAL tags.

Only MESSAGE tags may be used with ASC


ASCII strings may only be read into MESSAGE tags.

Ordering anomaly
Indicates that the Read/Write Information Table currently being processed contains addresses
such that the driver is unable to properly arrange all the entries.

Out of Memory
The driver was unable to internally allocate all the necessary memory. Allocate more memory
in the External Device Definition Table.

Positive word address required


The word address specified in the Configuration Manager must be one or greater.

Selected data table only valid for reads


Register status and forcing information may only be read from the PLC. Any attempts to
write this information will result in a network error. If, due to a special configuration, it is
necessary to perform this write operation, the actual register may be specified with a register
data table.

Selected data table only valid for unsolicited


Faults, alerts, and warnings may only be accessed from unsolicited tables. Please consult
Appendix J for additional information concerning unsolicited messages.

Word address exceeded range


The maximum word address for all data tables other than registers is 8192.

Word address exceeded range for alarm

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 29

The maximum word address for all alarm data tables is 16. Consult Appendix J for a more complete
discussion of alarms (Faults, Alerts, and Warnings)

The following errors may be reported when the EDI task is started after all tables have been processed. All the
following errors are immediately fatal. Check separately enclosed manual for all errors reported
concerning the security key.

3.6.2 Run-time startup errors

The following errors may be reported when the EDI task is started after all tables have been processed. All the
following errors are immediately fatal. Check separately enclosed manual for all errors reported concerning
the security key.

Cannot open device (error: X) [OS/2 only]


Unable to open the OS/2 device driver NOVAMEM.SYS. Check that this file is specified in
the CONFIG.SYS file as indicated in Appendix B.

Cannot get pointer from card driver (error : X) [OS/2 only]


System call failed to return card pointer. Check that this file is specified in the CONFIG.SYS
file as indicated in Appendix B.

Failed to initialize SY/LINK card


The SY/LINK card did not initialize as expected. Check all parameters specified on the
Logical Station Control Table. The selected memory address is most likely the problem. The
operator must verify that no other device or process is attempting to utilize the same memory
segment as the SY/LINK card.

Invalid card memory address


Verify that the card memory address entered on the Logical Station Control Table is a valid
selection from the key file.

Invalid custom data length in Logical Port Def, Exiting

Software key violation, Exiting


SoftKey protectiono SoftKey protection may appear after the driver has been initialized by the EDI
task. Please refer to the SoftKey manual if they appear. If SoftKey does not detect a problem the
following message will be displayed.

3.6.3 SoftKey protection messages

Messages relating to SoftKey protection may appear after the driver has been initialized by the EDI task.
Please refer to the SoftKey manual if they appear. If SoftKey does not detect a problem the following
message will be displayed.

Serial #: XXXXXXX Single Processor Run Time License


This is a normal informational message displaying the product name and your Serial
Number.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 30

3.6.4 Run-time errors

The following errors may be reported while the driver is processing the EDI requests. The text represents the
error message returned to the message tag defined in the Logical Station Control Table. The number in
parentheses is returned to the analog tag defined in the Logical Station Information Table. While the following
errors are not immediately fatal, recurring errors should be evaluated and eradicated to maintain the integrity of
the network.

(-10) Device failed to respond, routing: X


The indicated device did not respond when polled. Check cabling, the device address, and
the routing parameters X.

(-11) Zero length buffer error


A request has been made to the CPT module with a zero byte transaction length. This error
should not occur, please contact Axisware.

(-12) Buffer manipulation error


Internal communication error between DSF and CPT module. Please contact Axisware if
error persists.

(-13) Module communication timeout


Communication failure between modules. Increase timeout allowed in Logical Station
Control Table. If error persists, contact Axisware.

(-14) XXXX sylkdsf dsf_read()/dsf_write() error returned from dsf_t_q_mail()


Internal queue handling error encountered. Contact Axisware with error.

(Y) Network error returned Y, routing: X


The error Y was returned when the specified transaction was attempted. Check that the desired
operation is valid and that the routing X is valid. For error descriptions, please refer to the
Network Error Table in this manual.

3.6.5 Unsolicited message processing errors

The following errors may be reported while the driver is attempting to process unsolicited message requests. The
text represents the error message returned to the message tag defined in the Logical Station Control Table. While
the following errors are not immediately fatal, recurring errors should be evaluated and eradicated to maintain the
integrity of the network

EDI DSF pointer error


Software error; contact Axisware with error message.

General failure clearing alarm - error X


Error X occurred when the driver was attempting to clear the alarm that had been received by
the SY/LINK card. For error descriptions, please refer to the Alarm Error Table in this
manual.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 31

General failure retrieving alarm - error X


Error X occurred when the driver was attempting to process the alarm that had been received
by the SY/LINK card. For error descriptions, please refer to the Alarm Error Table in this
manual.

Invalid tag type for unsolicited message


Internal software error. Please contact Axisware with error.

Linked list error


Internal software error. Please contact Axisware with error.

Maximum number of unsolicited reads exceeded


A maximum number of 32,000 unsolicited reads may be configured. However, the practical
limitation due to memory is about 6500. If this limit is reached, please contact Axisware.

No unsolicited reads have been defined


An unsolicited message has been received over the Genius network; however, no unsolicited
messages were defined in the Configuration Manager. If unsolicited messages are to be used,
at least one line on the Read/Write Control Table must specify unsolicited message support.

Timeout clearing alarm


The driver was attempting to clear a received alarm from the SY/LINK card. A timeout
occurred during this operation. Increase the timeout value specified in the Logical Station
Control Table. If the error persists, contact Axisware with the problem.

Timeout retrieving alarm


The driver was attempting to read a received alarm from the SY/LINK card. A timeout
occurred during this operation. Increase the timeout value specified in the Logical Station
Control Table. If the error persists, contact Axisware with the problem.

Unable to allocate memory for all unsolicited messages


Allocate more memory to EDI task. Please note that the current driver limits the number of
unsolicited messages configured to about 6500 due to the segment size. If this limit is
reached, please contact Axisware.

Unable to establish unsolicited index


Internal software error, contact Axisware.

Unable to evaluate unsolicited message


An unsolicited message was received over the network with an unexpected format. Check
Appendix J for details concerning the processing of unsolicited messages.

Undefined unsolicited message


An unsolicited message directed toward the SY/LINK card was received. The address has
not been configured as an unsolicited message in the Configuration Manager.

Unsolicited message processing error X


While an unsolicited message was being transferred from the SY/LINK card, error X was
returned by the card. Attempt the same operation again. Verify all settings on the Logical
Station Control Table. If the error persists, contact Axisware with the problem. For error
descriptions, please refer to the Network Error Table in this manual.

Unsolicited message processing timeout

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 32

Unsolicited messages must be read from the card after they are received. After having
received a message, the request to the card for the message was refused. Increase the timeout
permitted in the Logical Station Control Table. Contact Axisware if the error persists.

Unsolicited queue overflow


Appendix G: Tables for Network and Alarm Errors

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 33

3.7 Appendix G: Tables for Network and Alarm Errors


When errors occur during certain operations the SY/LINK board stores a code that indicates the cause of the
error. Errors that occur during communication operations are stored in location 21H-22H ("Error Flag"). These
codes are listed in the Network Error Table. Errors caused by faulty parameters used to access alarm messages
are presented in location 241H-242H. These codes are listed in the Alarm Error Table.

User programs should be designed to check for error codes in these locations and to either alert the operator or
perform other appropriate actions.

3.7.1Network Error Table

Code Description
001 Illegal protocol opcode
002 Illegal intermediate code
003 Illegal address attempted
004 Illegal rack address attempted
005 Instruction attempted which is not allowed
006 Item being searched for cannot be found
007 Attempt to alter data in a protected register
008 Attempt to alter data in protected memory
009 Attempt to alter data in a read-only register
010 Attempt to exceed memory limitations
011 Communications overflow
012 Illegal CPU rack addressing
013 Communications error
014 The operation attempted is not allowed in run
015 Communication overflow
016 Register count too large for the processor
017 Remote device inactive
018 The rung number used is not allowed
019 Illegal read parameter
020 Illegal channel number
021 Trying to change a forced bit
022 Forcing function is inhibited
023 Attempt to alter data in a forced register
024 Attempt to force a non-forcible register
025 CPU error, check register 8175
026 Rack addressing and user memory overlap
027 Memory error - clear all operation required
028 Illegal baud rate selected
029 Attempt to send message with illegal route
030 Attempt to alter protected memory - inhibit coil
031 End of file encountered
032 Operation not allowed in protected memory
033 Data error
034 UVPROM memory error
035 Write protected
036 Replace not allowed - use delete and insert
037 Attempt to skip or read a file past last file
038 Data view protected - cannot read
039 Alarm already set

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 34

040 Hardware memory security in effect


041 Illegal register write
042 Illegal file number
043 Illegal operation attempted
044 File not found
045 Operation not allowed - D-LOG tape operation in progress
046 Protected file
047 Operation not allowed due to keyswitch position
048 Programming MCR in subroutine area not allowed
049 I/O, register or channel safeguarded
050 Rack address not alterable while forcing active
051 Missing module
053 Illegal media format - erase track/clear memory required
054 Illegal mark number
055 File operation aborted
060 Illegal mark number for GOTO or GOSUB
061 Mark St. Sub cannot be inserted - append only
062 Return rungs not allowed in ladder area
063 Mark number previously used
064 Operation not allowed in run - cannot delete return
065 Operation not allowed - cannot delete mark St. Sub
066 Operation not allowed - cannot delete mark having return
067 Operation not allowed - return must have mark
068 Operation not allowed - only one return per mark
069 Operation not allowed in run - Gosub with no return
070 Operation not allowed in run - Goto to mark with return
071 Operation not allowed in run - cannot delete mark
072 Operation not allowed in run - unused mark number
079 Operation not allowed in run with programmable interrupt
080 Insufficient data
081 Unrecognized command
082 Illegal parameter
083 Illegal source parameter
084 Illegal destination parameter
085 Invalid filespec
086 Invalid input channel
087 Invalid output channel
088 Device not available
089 Serial link not established
090 Hardware read fault
091 Hardware write fault
092 Read error
093 Write error
094 Directory read error
095 Directory write error
096 Directory space full
097 Device space full
098 File not found
099 File access denied
100 File already exists
101 File already open
102 File format error

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 35

103 File wrong type


104 Open attempt to open file
105 I/O attempt to unopen file
106 Write attempt to read only file
107 Record out of range
108 Too many open files
109 Operation aborted by user
110 Source filespec required
111 Destination filespec required
112 Maximum open count for file
113 Incompatible source device/file type
114 Incompatible destination device/file type
115 Device timeout
116 Protected file
117 Illegal file type
118 Illegal device
119 File type required
120 Device required
121 Channel required
122 Route required
123 Filename required
124 Illegal offset
125 Illegal count
126 Source/destination cannot be same device
127 Duplicate label
128 File mismatch
129 Invalid register address
130 Invalid file name
131 Write data error
133 Insufficient data for write
135 Invalid read parameter

3.7.2Alarm Error Table

Code Description
001 Invalid opcode
002 Invalid fault count
003 Invalid alert count
004 Invalid warning count
005 Invalid fault acknowledgment register
006 Invalid alert acknowledgment register
007 Invalid warning acknowledgment register

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 36

3.8 Appendix H: Data Types and Conversions

The driver supports the following FactoryLink tag types:

DIGITAL
ANALOG
LONG ANALOG
FLOATING POINT
MESSAGE

The driver also supports the following PLC data types:

BIN (single data bit),


INT2 (16 bit signed integer),
INT4 (32 bit signed integer),
BCD4 (16 bit, 4 digit BCD),
BCD8 (32 bit, 8 digit BCD),
FLT4 (32 bit floating point - single precision), and
FLT8 (64 bit floating point - double precision).
ASC (ASCII strings)

DIGITAL

BIN
DIGITAL tags may only be converted to and from the BIN data type. If the requested binary PLC data
type is on, the DIGITAL tag will be set to one. If the binary element is off, the DIGITAL tag will be set
to zero.

ANALOG

INT2
The ANALOG tag is a 16 bit signed integer; therefore, no conversion is needed.

INT4
The lowest 16 bits of the INT4 data type correspond directly with the 16 bits comprising the ANALOG
tag.

BCD4
After being read from the PLC, the BCD4 value is converted into a 16 bit integer. The value is then
directly transferred without conversion into the ANALOG tag.

BCD8
After being read from the PLC, the BCD8 value is converted into a 32 bit integer. The value is then
handled as the INT4 data type above.

FLT4

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 37

The whole number portion of the floating point number is transferred to the ANALOG tag. This
conversion is accurate only if the whole number value is between -32767 and +32767. When converting
back to a FLT4, a fractional portion of zero is assumed.

FLT8
The whole number portion of the floating point number is transferred to the ANALOG tag. This
conversion is accurate only if the whole number value is between -32767 and +32767. When converting
back to a FLT8, a fractional portion of zero is assumed.

LONG ANALOG

INT2
The LONG ANALOG is a 32 bit signed integer; therefore, the 16 bits of the INT2 data type correspond
to the lowest 16 bits of the LONG ANALOG tag.

INT4
No conversion necessary; all 32 bits transfer directly.

BCD4
After being read from the PLC, the BCD4 value is converted into a 16 bit integer. The value is then
handled as the INT2 data type above.

BCD8
After being read from the PLC, the BCD8 value is converted into a 32 bit integer. The value is then
handled as the INT4 data type above.

FLT4
The whole number portion of the floating point number is transferred to the LONG ANALOG tag. This
conversion is accurate only if the whole number value is between
-4.3e09 and +4.3e09. When converting back to a FLT4, a fractional portion of zero is assumed.

FLT8
The whole number portion of the floating point number is transferred to the LONG ANALOG tag. This
conversion is accurate only if the whole number value is between
-4.3e09 and +4.3e09. When converting back to a FLT8, a fractional portion of zero is assumed.

FLOATING POINT

INT2
The INT2 value is converted into a standard IEEE 64 bit floating point value and then transferred
directly into the FLOATING POINT tag. The fractional portion of the number is assumed to be zero.

INT4
The INT4 value is converted into a standard IEEE 64 bit floating point value and then transferred
directly into the FLOATING POINT tag. The fractional portion of the number is assumed to be zero.

BCD4
After being read from the PLC, the BCD4 value is converted into a 16 bit integer. The value is then
handled as the INT2 data type above.

BCD8

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 38

After being read from the PLC, the BCD8 value is converted into a 32 bit integer. The value is then
handled as the INT4 data type above.

FLT4
The FLT4 value is converted from a standard IEEE 32 floating point number into a standard IEEE 64 bit
floating point number. This value is then transferred directly into the FLOATING POINT tag.

FLT8
The data is transferred directly; no conversion is necessary.

MESSAGE

ASC
All data is read directly into the message tag from the specified device address. No conversion of any
kind is employed.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 39

3.9 Appendix I: SY/LINK Addressing


All addressing for the SY/LINK driver is word based. The driver supports three basic device types and four data
tables for standard read/write operations. Each data table will be discussed first, followed by a brief discussion of
the special considerations for each device type. Please consult page 38 of the SY/LINK manual for additional
routing information if required.

3.9.1Data Tables

REGISTER
The register data table is the primary area of device memory that is accessed by the driver. SY/MAX
devices consist of a maximum of 32767 words of addressable memory. Not all devices use all this
memory; therefore, it is the responsibility of the operator to ensure that the memory map entered in the
Configuration Manager is valid. The register memory is divided into 4 equal areas: general purpose
registers (1 - 8192), status registers (8193 - 16384), force enable registers (16385 - 24576), and force
status registers (24577 - 32767). Write and unsolicited read operations are only to be directed toward the
general purpose registers; all other areas are read only.

Example:
Data Table: Offset: Bit Description:
REGISTER 100 0 General purpose register 100
REGISTER 101 0 General purpose register 101
REGISTER 8193 0 Status for register 1
REGISTER 24577 0 Force status for register 1
REGISTER 102 4 General purpose register 102 bit 4

In addition to the above word operations, the status bits for a register may also be addressed as follows:

Example:
Data Table: Offset: Bit: Description:
REGISTER 100 17 Bit 1 of status for register 100
REGISTER 101 32 Bit 16 of status for register 101

STATUS
The status data table contains status information for each of the general purpose registers. This data table
only supports read operations. Write and unsolicited read operations are not allowed. The range of
addressable offsets is 1 - 8192.

Example:
Data Table: Offset: Description:
STATUS 100 Status for general purpose register 100
STATUS 101 Status for general purpose register 101
STATUS 424 Status for general purpose register 424
STATUS 1000 Status for general purpose register 1000

FRC_ENBL

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 40

The force enable table contains forcing information for each of the general purpose registers. If a bit in
the force enable table is on (a one), that bit is either forced on or off depending on the value of that bit in
the force status table. These registers are read only. Write and unsolicited read operations are not
allowed. The range of addressable offsets is 1 - 8192. The highest addressable bit is 16.

Example:
Data Table: Offset: Bit: Description:
FRC_ENBL 100 10 Force enable bit 10 of register 100
FRC_ENBL 101 12 Force enable bit 12 of register 101

FRC_STAT
The force status table contains forcing information for each of the general purpose registers. If a bit in
the force status table is on (a one), that bit is forced on if the corresponding bit in the force enable table
is also on. If a bit in the force status table is off (a zero), that bit is forced off if the corresponding bit in
the force enable table is on. These registers are read only. Write and unsolicited read operations are not
allowed. The range of addressable offsets is 1 - 8192. The highest addressable bit is 16.

Example:
Data Table: Offset: Bit: Description:
FRC_STAT 100 10 Force status bit 10 of register 100
FRC_STAT 101 12 Force status bit 12 of register 101

3.9.2 Device Types

SCP-XXX
This is a general mnemonic for all the PLCs supported by the driver. This device type should be used for
all block reads from and all writes to network devices that are PLCs or functionally equivalent to a PLC.
The only difference between the PLC types as far as the driver is concerned is the number of words that
can be transferred for priority operations. These limitations are listed on page 59 and page 66 of the
SY/LINK manual. If a device is used that is addressed in a fashion similar to a PLC, a device type of
SCP-4XX or SCP-6XX could be used for a general form of interface. The first level of routing used
when addressing these device types is the address assigned to FactoryLink on the Logical Station
Control Table. The remaining routing levels are copied from the Logical Station Information Table;
therefore, at least one level of routing must be specified in the Logical Station Information Table.

SY/LINK
This device type is used to directly address the SY/LINK card. The card has 512 registers that can be
accessed by read or write operations just as any other PLC registers. However, any writes to these
registers (even FactoryLink) will be flagged by the SY/LINK card as an unsolicited message. If
unsolicited messages, other than alarms, are to be processed by the driver, a Logical Station must be
configured with a device type of SY/LINK. Each message received will then be evaluated based on the
records that are defined in unsolicited tables with that Logical Station. No routing levels should be
specified in the Logical Station Information Table for this device type.

GENERIC
This device type assumes a maximum priority operation size of 128 words (the maximum). The primary
difference for this device type is the way routing is handled. All routing levels are copied directly from
the Logical Station Information Table. No routing information is taken from the Logical Station Control
Table as it is for the PLC types. This allows for special routing if required by the application.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 41

3.10 Appendix J: Unsolicited Reads

Unsolicited messages can be configured to allow a PLC to send data to the FactoryLink real-time database
without the PLC being polled by the EDI driver. This can be useful for logging PLC data that is not generated at
predefined intervals such as alarm reporting or data that changes infrequently. Two different types of unsolicited
messages can be received by FactoryLink: alarms and register data.. Several simple steps are required to
configure the system to receive either type of unsolicited message.

The first step is to set the column titled Unsolicited Read in the NOVA SY/LINK Read/Write Control Table to
either "Forced" or "Yes". This will allow that specific table to be included in the driver's search for tags with
which to associate the incoming data. The table for which unsolicited reads have been enabled may now be
edited to associate FactoryLink real-time database elements to addresses in the PLC. The same addressing rules
should be followed for unsolicited read tables as for the standard read or write tables.

Note: The number of tags that are configured as unsolicited read tags directly affects the time that is required
to process incoming requests; therefore, if speed is critical, only include the unsolicited read tags that
are essential to the application.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 42

3.10.1Unsolicited Alarms

The following section briefly describe the steps necessary to configure FactoryLink to receive alarms transmitted
by a SCP-400.

The NOVA SY/LINK Read/Write Information Table must be completed with a data table of either FAULT,
ALERT, or WARNING. The data offset must be set to a number between 1 and 16. A data offset of 1 will return
the alarm code, while larger numbers will index further into the returned data.

Example:
Data Table Data Offset Description
ALERT 1 Alarm code from any alert from related Logical Station
WARNING 3 Third word from any warning from related Logical Station

One of the two following lines of logic must also be added to the PLC. The write command permits more
flexibility, while the alarm command is more straight forward.

WRITE COMMAND
ROUTE ROUTE STAT LOCAL REMOTE
COUNT
TWRTE2 15 10 S0300 S0100 S8201 5

STANDARD ALARM
ROUTE ROUTE STAT REMOTE CODE
TALRM2 15 10 S0300 S8201 00162

Both commands will write out of CPU port 2 to a NIM with a network address of 15. The final destination
would be a FactoryLink terminal defined as device number 10.

As a result of the first command, five words of data will be written from CPU registers starting at S0100 to the
Alert registers (S8201+) on the SY/LINK card.

As a result of the second command, an alarm code of 162 will be written from the CPU to the Alert register
(S8201) on the SY/LINK card.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 43

3.10.2Unsolicited Data

The following section briefly describes the steps necessary to configure FactoryLink to receive data transmitted
by a SCP-400.

The NOVA SY/LINK Read/Write Information Table must be completed with a data table of REGISTER and a
data offset between 1 and 512. All other data tables are invalid for unsolicited read operations. The device type
for the associated Logical Station, configured within the NOVA SY/LINK Logical Station Information Table,
must have a device type of SY/LINK. A write from another PLC will flag the SY/LINK card that a write has
occurred and also the first register involved in the write, but information concerning the device sending the data
and the number of words transmitted is not available; therefore, the user must also configure the Logical Station
Control Table so the Unsolicited Msg Length field indicates the number of words that the driver is to assume
will be received with each unsolicited message.

Example:
Data Table: Data Offset: Description:
REGISTER 1 Register 1 of the SY/LINK memory
REGISTER 15 Register 15 of the SY/LINK memory

The following line of logic must also be added to the PLC.

WRITE COMMAND
ROUTE ROUTE STAT LOCAL REMOTE
COUNT
TWRTE2 15 10 S0300 S0100 S0001 15

The command will write out of CPU port 2 to a NIM with a network address of 15. The final destination would
be a FactoryLink terminal defined as device number 10.

As a result of the command, fifteen words of data will be written from CPU registers starting at S0100 to the
SY/LINK registers starting at S0001. The FactoryLink tag associated with the first line of the example will be
set equal to S0100 of the PLC. If the Unsolicited Msg Length parameter is greater than 15, the tag associated
with the second line of the example will be set equal to S0114 of the PLC. However, if the Unsolicited Msg
Length is less than 15, the first tag will still receive a value; but the second tag will be left unchanged.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 44

3.11 Appendix K: FactoryLink Version Upgrade Procedures

After installing this communications driver, upgrading to a newer version of FactoryLink may appear to
cause operational problems. This is due to the modifications to certain text files made by installing this
product being overwritten during the install of the new FactoryLink version. However, these files can be
reconfigured using a text editor.

Before installing the FactoryLink upgrade it is important to do a multiplatform save of your


application.

After installing the FactoryLink upgrade, the following steps should be done before restoring the
multiplatform save file of your application:

Where $FLINK indicates the FactoryLink directory (example: FLINK=C:\FLWIN):

1. Edit the file $FLINK\AC\TITLES and add the following line:

sylk.ac EDI NOVA SY/LINK Driver

2. Open the file $FLINK\CTGEN\CTLIST and add the following line:

sylk: sylkshdr sylksovr sylk_hdr sylk_ovr

3. Please refer to the appropriate appendix for your platform for further information on modifications needed
in the CONFIG.SYS or SYSTEM.INI files.

The SAMPLE directory of the install cd-rom includes compressed multiplatform save files of a sample
application for this driver. The sample application can be used to test communications, as well as serve as an
example of how to prepare a FactoryLink application to use the driver. The sample application has examples of
block reads, block writes, exception writes and unsolicited reads from a single PLC. Please refer to the
"README.TXT" file in the SAMPLE directory for instructions on how to use the application.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 45

3.12 Appendix L: Sample Application

The SAMPLE directory of the install cd-rom includes compressed multiplatform save files of a sample
application for this driver. The sample application can be used to test communications, as well as serve as an
example of how to prepare a FactoryLink application to use the driver. The sample application has examples of
block reads, block writes, exception writes and unsolicited reads from a single PLC. Please refer to the
"README.TXT" file in the SAMPLE directory for instructions on how to use the application.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 46

4 Glossary of Terms

configuration tables
Where you establish the communication path and specify elements in the database. These tables work
together to allow FactoryLink to exchange information from the database with the device.

External Device Definition Table


Configuration table that tells the application what type of devices are connected to the computer's ports and
assigns them a logical port number.

logical port
Number entered by the user to represent a particular combination of a logical port and a physical device
(PLC). Correlates specific addresses and tags with a physical device (PLC).

logical station
Number entered by the user to represent a particular combination of a logical port and a physical device
(PLC). Correlates specific addresses and tags with a physical device (PLC).

Logical Station Control Table


Table used to configure each logical port and its associated stations in the Logical Station Information table.
The Logical Station Control table specifies which specific port is connected to the external device being
defined.

Logical Station Information table


Table which defines the logical station(s) accessible through a specific logical port defined in the Logical
Station Control table. Each logical station is tied to its physical station address and device type.

Proof of License
An 8 1/2 by 11 certificate that must accompany the software indicated by its unique serial number when that
product is sold or transferred to another company or entity.

Read/Write Control Table


Table used to configure each logical port and its associated stations in the Logical Station Information table.
Each line in this table refers to one Read/Write Information table.

Read/Write Information Table


Configuration table that links FactoryLink tags to specific addresses in the PLC represented by the Logical
Station.

SoftKey
Axisware' software protection system where no hardware key (dongle) is required.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 47

Validate
The program run after the software is installed that checks for improper use of the product and enables the
software to function past the grace period.

Axisware LLC support@axisware.com www.axisware.com


Axisware Square-D SY/LINK Driver for FactoryLink 48

5 Contact information

Axisware LLC

support@axisware.com
http://www.axisware.com

3213 Peppertree Pl.


Plano, TX 75074, USA

T: 1-(214)-764-1876
F: 1-(214)-764-1878

Axisware LLC support@axisware.com www.axisware.com