axisware abei manual: factorylink driver for allen-bradley ethernet plc-5/xxes & slc-5/05

Allen-Bradley Ethernet Interfacefor FactoryLink

Version 7.2October 12, 2000February, 2004

Axisware, L.L.CPlano, TX 75074, USA

http://[email protected]

+1-(214)-764-1876 (Phone)+1-(214)-764-1876 (Fax)

http://www.axisware.com/

Axisware Allen-Bradley Ethernet Interface

This document contains proprietary information of Axisware, L.L.C and is based oninformation available at the time of its publication. While efforts have been made tobe accurate, the information contained herein does not purport to cover all details orvariations in hardware or software, or to provide for every possible contingency inconnection with installation, operation, or maintenance. Features may be describedherein which are not present in all hardware and software systems. Axisware, L.L.C.assumes no obligation of notice to holders of this document with respect to changessubsequently made.

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

All Trademarks Acknowledged

Copyright 2000-2004Axisware, L.L.C, Plano, TX, USA

All Rights Reserved

i


Software LicensePlease carefully read the following licensing agreement. By using this Axisware,L.L.C. product, you are thereby indicating your acceptance of and agreement with allthe terms specified and your commitment to abide by them.

Product Use

Axisware, L.L.C. grants to you a non-exclusive license to use the Software programsand related documentation in this package on a single processing unit. No one otherthan a current Axisware, L.L.C. employee is permitted to modify or tamper with inany way the executable computer files(s) associated with this license. This licenseapplies solely to Axisware, L.L.C. software and documentation contained in thispackage, and does not apply to any software or documentation provided by otherparties which may be required for the proper operation of this product. You shouldcheck the license conditions provided by the originators of software supplied byothers.

Warranty

Except as modified by an in-force written agreement executed by an authorizedofficer of Axisware, L.L.C., Axisware, L.L.C. expressly disclaims any and allwarranties, conditions or representations, either expressed or implied, with respect tosoftware, other products and any part thereof delivered to Customer hereunder,including any and all implied warranties or conditions of title, non-infringement,merchantability or fitness or suitability for any purpose (whether or not Axisware,L.L.C. knows, has reason to know, has been advised or is otherwise in fact aware ofany such purpose), whether alleged to arise by law, by reason of custom or usage inthe trade or by course of dealing. In addition, Axisware, L.L.C. expressly disclaimsany warranty or representation to any person other than Customer with respect tothe software or any part thereof. No written or oral information or advice given byAxisware, L.L.C., its agents or employees shall create any warranty or in any wayincrease the scope of the limited warranty set forth in such license agreement andCustomer may not rely on any such information or advice.

Customer's sole and exclusive remedy for any breach of this Agreement, includingany breach of warranty, shall be, to the exclusion of all other remedies therefor, incontract, tort or otherwise, at Axisware, L.L.C. sole option, either the return of theprice paid for or the correction or replacement of any product that does not meet thelimited warranty, if any, set forth in a written agreement signed by an authorizedofficer of Axisware, L.L.C. that is returned to Axisware, L.L.C.. In no event shallAxisware, L.L.C. be liable to Customer (nor to any person claiming rights derivedfrom Customer's rights) for incidental, consequential, special, punitive or exemplarydamages of any kind, including without limitation lost profits, loss of business orother economic damage and further including injury to property, as a result of abreach of this agreement, including any breach of warranty, regardless of whetherAxisware, L.L.C. was advised, had other reason to know or in fact knew of thepossibility thereof. In no event shall Axisware, L.L.C. aggregate liability to Customer(including liability to any person or persons whose claim or claims are based on orderived from a right or rights claimed by Customer), with respect to any and allclaims at any and all times arising from or related to this Agreement, in contract, tortor otherwise, exceed the aggregate amounts paid to Axisware, L.L.C. by Customer.

ii


Table of Contents1. Overview...................................................................................................................1

2. Definitions.................................................................................................................1

3. Differences from FactoryLink EDI Interfaces............................................................3

4. Application Configuration..........................................................................................4

System Configuration Information Table....................................................................4Allen-Bradley Ethernet Interface: Device Definitions..................................................5Allen-Bradley Ethernet Interface: Read/Write Control..............................................10Allen-Bradley Ethernet Interface: Read/Write Information.......................................15

5. Details of Solicited Operation..................................................................................17

6. ABEI Program Arguments.......................................................................................20

System Configuration Information Table..................................................................20Environment String..................................................................................................20Task Command Line from Command Prompt..........................................................20Task Sleep Period...................................................................................................20Device Packet Retry Count......................................................................................21Solicited Packets in Single Time Slice.....................................................................21Unsolicited Packets in Single Time Slice.................................................................21Maximum Number of Messages in Log File.............................................................21

7. Allen-Bradley Data Table Address Strings..............................................................22

PLC-5 I/O Data Tables............................................................................................22All Other PLC-5 Data Tables...................................................................................23SLC I/O Data Tables................................................................................................30All Other SLC Data Tables.......................................................................................31

8. ABEI Error Codes and Extended Error Codes........................................................35

Extended Code: 35 – WSAEWOULDBLOCK..........................................................35Extended Code: 36 – WSAEINPROGRESS............................................................35Extended Code: 38 – WSAENOTSOCK..................................................................35Extended Code: 45 – WSAEOPNOTSUPP.............................................................35Extended Code: 50 – WSAENETDOWN.................................................................35Extended Code: 51 – WSAENETUNREACH...........................................................36Extended Code: 53 – WSAECONNABORTED........................................................36Extended Code: 54 – WSAECONNRESET.............................................................36Extended Code: 57 – WSAENOTCONN..................................................................36Extended Code: 61 – WSAECONNREFUSED........................................................36Extended Code: 64 – WSAEHOSTDOWN..............................................................36Extended Code: 65 – WSAEHOSTUNREACH........................................................36Extended Code: 1....................................................................................................37Extended Code: 2....................................................................................................37Extended Code: 3....................................................................................................37Extended Code: 4....................................................................................................37Extended Code: 5....................................................................................................37Extended Code: 6....................................................................................................37Extended Code: 7....................................................................................................37Extended Code: 8....................................................................................................37Extended Code: 16..................................................................................................37

iii


Extended Code: 32..................................................................................................37Extended Code: 48..................................................................................................37Extended Code: 64..................................................................................................38Extended Code: 80..................................................................................................38Extended Code: 96..................................................................................................38Extended Code: 112................................................................................................38Extended Code: 128................................................................................................38Extended Code: 144................................................................................................38Extended Code: 160................................................................................................38Extended Code: 176................................................................................................38Extended Code: 192................................................................................................38Extended Code: 208................................................................................................38Extended Code: 224................................................................................................38Extended Code: 1....................................................................................................38Extended Code: 2....................................................................................................39Extended Code: 3....................................................................................................39Extended Code: 4....................................................................................................39Extended Code: 5....................................................................................................39Extended Code: 6....................................................................................................39Extended Code: 7....................................................................................................39Extended Code: 8....................................................................................................39Extended Code: 9....................................................................................................39Extended Code: 10..................................................................................................39Extended Code: 11..................................................................................................39Extended Code: 12..................................................................................................39Extended Code: 13..................................................................................................39Extended Code: 14..................................................................................................40Extended Code: 15..................................................................................................40Extended Code: 16..................................................................................................40Extended Code: 17..................................................................................................40Extended Code: 18..................................................................................................40Extended Code: 19..................................................................................................40Extended Code: 20..................................................................................................40Extended Code: 21..................................................................................................40Extended Code: 22..................................................................................................40Extended Code: 23..................................................................................................40Extended Code: 24..................................................................................................40Extended Code: 25..................................................................................................40Extended Code: 26..................................................................................................40Extended Code: 27..................................................................................................40

9. ABEI Messages.......................................................................................................42

10. ABEI Message Logging.........................................................................................44

iv


1. OverviewThis manual describes the configuration of the Axisware Allen-Bradley EthernetInterface Task. The task enables FactoryLink to communicate with Allen-BradleyPLC-5/xxEs or SLC-5/05 controllers connected with the FactoryLink station via thecontroller's Ethernet Interface. This task provides an application interface similar toFactoryLink EDI drivers and supports solicited and unsolicited operations.

2. DefinitionsThe following terms are used throughout this manual:

A-B Controller

The term A-B Controller is used to refer to an Allen-Bradley PLC-5/xxE or SLC 5/05controller connected to the FactoryLink station via the controller's Ethernet Interface.

ABEI Task

The term ABEI task refers to the Axisware Allen-Bradley Ethernet Interface Task (theproduct described in this manual).

Block Read

A method of exchanging data between a FactoryLink application and an A-B Con-troller. In this method the task will monitor a trigger tag. On detecting the trigger thetask will send the necessary “read” commands to the A-B Controllers required tosample the A-B Controllers' data table values and set those values into RTDB tags.

Block Write

A method of exchanging data between a FactoryLink application and an A-B Con-troller. In this method the task will monitor a trigger tag. On detecting the trigger thetask will send the necessary “write” commands to the A-B Controllers required to"write" the A-B Controllers' data table values to those values in the RTDB tags.

Device

The ABEI task represents an A-B Controller with a device. Read/write Information ta-ble entries are grouped by devices. Each device is independent of other devices.Each device has it's own set of address, status, disable, error count and error codeswhich can be accessed via RTDB tags. Each device establishes it's own separatesolicited and/or unsolicited sessions with an A-B Controller. In its basic form there isone device for each A-B Controller accessed by the ABEI task. The A-B Controlleraccessed by a device can be fixed in the configuration by using a literal string in thedevice's TCP/IP Host Address field. Alternatively by specifying a message tag forthis field the application can control which A-B Controller the device is communicat-ing with while the application is running. A device can only communicate with one A-B Controller at a time.

Disable Tag

A tag that when specified can be used by the application to either disable or enableeither a solicited data exchange or a device. While the tag is true (non-zero) thedata exchange or device is disabled. While the tag is false (zero) the data exchangeor device is enabled. If the tag is not specified the data exchange or device is en-abled.

1


Exception Write

A method of exchanging data between a FactoryLink application and an A-B Con-troller. In this method the ABEI task will individually monitor the RTDB tags listed in aRead/Write information table for a changed state on that tag. When a change is de-tected the task will initiate a write of that individual tag’s value to the A-B Controllerto the address specified in the Read/Write Information table.

RTDB

FactoryLink Real-time Database.

Solicited

Solicited operations are data exchanges that are initiated by the FactoryLink task.The task will monitor a tag for a trigger condition and upon detection of the triggercondition initiate a data exchange. There are three types of solicited operationsBlock Read, Block Write and Exception Write.

Tag

A value in the FactoryLink Real-time Database.

Unsolicited Read

A method of exchanging data between a FactoryLink application and an A-B Con-troller. In this method this task will wait to receive a write command from the A-BController and define tags into the RTDB based on the contents of that command.Using this method allows the A-B Controller to write application tags based on theladder logic in the A-B Controller. This task uses the term "Unsolicited Read" tomatch the FactoryLink EDI term for this function, the direction of data transfer is thesame as a Block Read, data is "read" from the A-B Controller into the RTDB.

2


3. Differences from FactoryLink EDI InterfacesThe application interface for the Allen-Bradley Ethernet Interface task is looselybased on the FactoryLink EDI Application interface. This section lists differences be-tween this task and FactoryLink EDI interfaces.

• This task does not have an equivalent to an EDI Logical Port. Since this taskuses an Ethernet Interface each device contains it’s own port or channel.

• This task uses “Devices” in the place of the EDI Logical Station.

• Additional triggers for an individual progressing (active) solicited operation(Block Read/Block Write on a single Read/Write Information table, orException Write of a single row (Tag) in a single Read/Write InformationTable) are not queued. If a trigger is detected for a progressing (in processof reading or writing due to a previously detected trigger) single solicitedoperation the additional trigger is ignored.

• Values read from A-B Controllers within an individual Block Read table arewritten in a singe write to the RTDB. The ABEI task updates the RTDB only ifno errors were detected in the individual Block Read.

• The ABEI task is designed to allow for the same tag to be in both a BlockRead Table and an Exception Write Table without the block read of a tagtriggering the exception write of that tag. This has a side effect that the ABEItask will not recognize a change in any tag in a Block Read Table due to theBlock Read being performed. This applies only to a change in the tag due tothe Block Read, a change in the tag will be recognized by the ABEI task ifchanged elsewhere in the application.

• There are separate fields to enter priority queue number and disable tag forexception writes and block writes.

• The ABEI task can process multiple solicited operations simultaneously. Atany point when the task is running multiple solicited operations may be atdifferent stages of processing.

• Complete and state tags function differently than those for EDI tasks.Analog or long analog tag types can be used to detect whether the solicitedblock operation has been performed, and if performed whether or not theblock operation completed with or without errors.

3


4. Application Configuration

FactoryLink driver tasks are configured by entering data into configuration tables,thus specifying communication parameters, and defining the data to be read/writtento/from an external device or multiple devices.

Data is entered into configuration tables by accessing one or more screen displayswithin the FactoryLink Configuration Manager and/or Application Editor, whichprovide entry fields for information required by the table. For a description of thegeneral principles governing the entry of data in FactoryLink configuration tables,consult the FactoryLink user documentation.

FactoryLink Configuration Tables

System Configuration Information Table

The “System Configuration Information” table is where different FactoryLink tasksare configured to run in an application. This section gives suggested entries for“required” fields in this table for the Allen-Bradley Ethernet Interface task. Pleaserefer to FactoryLink documentation for more detailed information on all the fields inthis table.

Flags

The following entries for this field are suggested:F Run task in foreground.

R Start program when application starts S Task has its own system console (text window for messages)

Task Name

Enter “ABEI” in this field

Description

Enter “Axisware Allen-Bradley Ethernet Interface” in this field

Executable File

Enter “bin\abei” in this field.

Program Arguments

Please see the “ABEI Program Arguments” section below for a description ofthe contents of this field.

4


ABEI Task Tables

The following Three configuration tables are provided with this task.

Allen-Bradley Ethernet Interface: Device Definition s

This table is used to define the devices used by the ABEI task. Entries in this tabledefine the device’s type, address and other operational characteristics.

For the purposes of this interface task a device represents either an A-B PLC-5/xxEor an A-B SLC 5/05 controller. Normally there would be a single device for each A-BController; however, it is possible to have multiple devices represent the same A-BController, or have a single device access multiple A-B Controllers.

Device Name

Identifies the device defined by this entry. Up to 16 ASCII displayable characters, casespecific unique identification string. The entry in the Read/Write Information Table"Device Name" field are matched to the device via this field.

Device Type

Identifies whether the A-B Controller referenced by the device defined in this entry is aPLC-5/xxE or SLC 5/04.

TCP/IP Address Host Name

This field specifies either the TCP/IP (dot) address or "host alias name" for the A-BController accessed by the device defined by this entry. This field may either be aconstant string entered into the field (preceded with a single quote (‘) ) or a messagetag name. Either the constant string or the content of the message tag is used as the A-B Controller's address when the device attempts to connect.

If a message tag is specified when the value in the tag changes the ABEI task will actas if the device was disabled and enabled via its Disable tag. Any pending commandsin the device will be aborted and the device will attempt to connect to the new addresson the first detected "new" operation.

Note: Using a message tag for this field allows the application to control which A-BController is addressed. To maximize throughput the task prepares thecommands when starting and not when a trigger is detected. Setting a deviceconfigured as a PLC-5 to the address of a SLC or a device configured as aSLC to the address of a PLC-5 will result in an illegal command being sent tothe A-B Controller.

Packet Timeout

This value specifies the amount of time (in tenths of seconds) the task will wait for aresponse to a command from the A-B Controller.

Note: A value of zero instructs the task to never timeout (device will wait forever for aresponse).

5


Inactive Timeout

This value specifies the amount of time (in tenths of seconds) the task will leave thedevice's solicited connection active without any solicited operations on the device. Ifthe specified amount of time elapses before there is a data exchange with the A-BController the solicited connection is terminated. The solicited connection isreestablished when a new operation is detected for the device.

This field provides a way for the ABEI task to clean up open solicited connections whenthose connections are no longer being used. Each open connection uses system, A-BController, and task resources that should be released if no longer required. The "best"value to use depends on numerous factors dependent on the application and theenvironment the application is running in. In general if the device is being usedconstantly by the application this value should be large enough to assure that theconnection will be kept open. If the application uses the device occasionally the valueshould be small enough to assure that the connection will be closed when theoccasional use has finished.

Note: A value of zero instructs the task to never timeout (device will not bedisconnected due to inactivity).

Note: The device's unsolicited connection is generally controlled by the A-BController; however, disabling the device via its Disable Tag will close all openconnections for the device.

Reconnect Timeout

To avoid constant reconnection attempts to an A-B Controller when some componentin that connection may have failed. The task will wait for the time period specified in thisfield before attempting to reconnect this device to the A-B Controller it addresses. Thistime period is used when the connection fails or a connection attempt fails. The effectis similar to a "slow poll".

Note: A value of zero instructs the task to never timeout (device will not attempt toreconnect after error in connection or failure to reconnect).

Note: The device will break out of this "wait state" if the device is enabled via itsDisable Tag, or the message tag specified in the TCP/IP Address Host Namefield changes.

Max Concurrent Packets

An A-B Controller can handle (queue) simultaneous commands from multiple sources.This entry limits the number of simultaneous commands sent to an A-B Controller bythis device. Higher values for this field may result in higher throughput though thisdevice. If the A-B Controller's load is high and/or there are other entities communicatingwith the A-B Controller, then lowering this number may provide better overallperformance. If the controller is not an Allen-Bradley controller than set this limit to nomore then the controller's queue capacity.

Valid entries:Decimal number 1 through 63.

6


Disable Tag Name

If specified this field defines a tag that will be monitored by the task to controlwhether this device is enabled or disabled. If no tag is specified then the device isenabled.

When a device is disabled the device's connections are closed. Disabled devicesabort any pending or new solicited operations with a device disabled error code.Operations that are in progress may have some commands that were completed bythe device before the disabled value was detected in this tag. When a device isenabled the device will attempt to connect to the associated A-B Controller on thenext detected solicited operation on this device.

Valid entries: FactoryLink digital, analog or long analog tag

Tag Values:False (zero) Device is enabledTrue (non-zero) Device is disabled.

Solicited Status Tag Name

Specifies a tag to indicate the status of the solicited connection for this device.

Valid entries: FactoryLink analog or long analog tag

Tag Values:0 Device is inactive and disabled (disable tag true) 1 Device is inactive and waiting for the reconnect timeout

period 2 Device is idle (waiting for an operation to connect)3 Device is connecting4 Device is active

Unsolicited Status Tag Name

Specifies a tag to indicate the status of the unsolicited connection for this device.

Valid entries: FactoryLink analog or long analog tag

Tag Values:0 Device is inactive and disabled (disable tag true) 1 Unused for unsolicited connection2 Device is idle (waiting to receive connection from A-B

Controller)3 Device is connecting4 Device is active

Error Count Tag Name

Specifies a tag to indicate the number of errors detected on communications in thisdevice. If specified the tag is set to zero on task startup and incremented upon eacherror detected by the device. The value will not exceed the normal positive range for thetype tag selected (1 for digital, 32767 for analog, and 2147483647 for long analog).

Valid entries: FactoryLink digital, analog or long analog tag

7


Error Code Tag Name

Specifies a tag to contain a code that represents the last error detected by this device.If defined the task will set this tag to zero (no error) on startup and then to the code forany error detected.

Valid entries: FactoryLink digital, analog, or long analog tag

Tag Values:For digital tags0 No Error1 Some Error

For analog and long analog tagszero No Errornon-zero Contains code for the detected error, refer to the

ABEI Error Codes and Extended Error Codessection in this manual for information on specificcodes and extended codes.

Extended Error Code Tag Name

Specifies a tag to contain additional information for some of the error codes in theError code Tag field described above.

Valid entries: FactoryLink digital, analog, or long analog tag

Tag Values:For digital tags0 No Error1 Some Error

For analog and long analog tagszero No Errornon-zero Refer to the ABEI Error Codes and Extended

Error Codes section in this manual for information on specific extended error codes.

Comment

Optional application documentation field.

Valid entry: 31 alphabetic or numeric characters

Sample Allen-Bradley Ethernet Interface: Device Definitions entries are shownbelow. These screen-shots are taken from the sample application provided with theAllen-Bradley Ethernet Interface for FactoryLink.

8


9


Allen-Bradley Ethernet Interface: Read/Write Contro l

This table is used to control the manner in which each Read/Write Information Tableis processed at runtime. Each entry in this table specifies the operation(s) of itsassociated Read/Write Information table.

Note: This section describes the Read/Write control table and it's individual fields.Please see the section in this manual entitled "Details of SolicitedOperations" for further information on how the ABEI task processes SolicitedOperations

Table Name

Name of the Read/Write Information Table controlled by this entry.

Valid entry: ASCII string containing up to 16 of the following character set: A-Z, a-z, @, $, _, or 0-9.

Unsolicited Read

Field which specifies whether or not the entries in the associated Read/WriteInformation table will be used to interpret write commands received from A-BControllers.

Valid entry:No: Table is not to be used to receive unsolicited valuesYes: Table is to be used to receive unsolicited values and

when received are written to the RTDB using the“normal” RTDB write command.

Force: Table is to be used to receive unsolicited values andwhen received are written to the RTDB using the “force”RTDB write command.

Exception Write

Field that specifies whether or not the entries in the associated Read/Write Informationtable will be used for exception writes.

Valid entry:No: Table is not to be used for exception writes. Yes: Table is to be used for exception writes.

Exception Write Priority

Field that specifies the priority queue number on which to queue exception writes ineach device. The lower the priority queue number the higher the priority level.

Valid entry: Numeric entry of queue number (1 – 4, 1 highest priority)

Exception Write Disable Tag

Specifies a tag to control the enabling and disabling of exception writes for theassociated read/write information table. If no tag is specified then exception writes, ifused, are enabled.

10


Valid entry: Any valid digital, analog or long analog tag name

Tag Values:True (non-zero): Exception writes are disabledFalse (zero): Exception writes are enabled

Block Read Trigger Tag

Specifies a tag to be used as the trigger for block reads of the associated Read/WriteInformation table. If a tag is not specified the table will not be processed for BlockReads.

Valid entry: Any valid digital, analog, long analog tag name

Block Read Priority

Field that specifies the priority queue number on which to queue Block Reads ineach device. The lower the priority queue number the higher the priority level.


Block Read Complete

Specifies a tag to be used as the complete tag for block reads of the associatedRead/Write Information table.


Tag Values: For Digital Tags 1 Trigger for Block Read has been processed.

For Analog and Long Analog Tags1 Block Read has finished without errors

2 Block Read has finished with one or more errors 3 Trigger for Block Read was ignored.

Block Read State

Specifies a tag to be used as the state tag for block reads of the associatedRead/Write Information table.


Tag Values: For Digital Tags 0 Block Read is in progress (active) 1 Block Read is idle (inactive)

For Analog and Long Analog Tags 0 Block Read is in progress (active)

1 Block Read is idle (last completion without error) 2 Block Read is idle (last completion with error(s)). 3 Block Read is idle (change in tag not due to block read having been performed).

11


Block Read Disable Tag

Specifies a tag to control the enabling and disabling of block reads for the associatedread/write information table. If no tag is specified then block reads, if used, are enabled.


Tag Values:False (zero): Block Reads are enabled.True (non-zero): Block Reads are disabled.

Block Write Trigger Tag

Specifies a tag to be used as the trigger for block writes of the associated Read/WriteInformation table. If a tag is not specified the table will not be processed for BlockWrites.


Block Write Priority

Field that specifies the priority queue number on which to queue Block Writes ineach device. The lower the priority queue number the higher the priority level.


Block Write Complete

Specifies a tag to be used as the complete tag for block writes of the associatedRead/Write Information table.


Tag Values: For Digital Tags 1 Trigger for Block Write has been processed.

For Analog and Long Analog Tags1 Block Write has finished without errors

2 Block Write has finished with one or more errors 3 Trigger for Block Write was ignored.

Block Write State

Specifies a tag to be used as the state tag for block writes of the associatedRead/Write Information table.


Tag Values: For Digital Tags 0 Block Write is in progress (active) 1 Block Write is idle (inactive)

For Analog and Long Analog Tags 0 Block Write is in progress

1 Block Write is idle (last completion without error)

12


2 Block Write is idle (last completion with error(s)). 3 Block Write is idle (false finish indication).

Block Write Disable Tag

Specifies a tag to control the enabling and disabling of block writes for the associatedread/write information table. If no tag is specified then block writes, if used, are enabled.


Tag Values:False (zero): Block Writes are enabled.True (non-zero): Block Writes are disabled.

Comment



Sample Allen-Bradley Ethernet Interface: Read/Write Control entries are shownbelow. These screen-shots are taken from the sample application provided with theAllen-Bradley Ethernet Interface for FactoryLink.

13


14


Allen-Bradley Ethernet Interface: Read/Write Inform ation

This table is used to map data tags to a specific data table file and element in an A-BController.

Tag Name

The name of the data tag to be mapped to a data region in an A-B Controller.

Valid entries: Digital, Analog, Long Analog, Float, or Message Tag

Device Name

Identifies the device to use when exchanging data. This field must match exactly(case sensitive) the "Device Name" field in the Device Definitions table.

Address

20 character ASCII string that specifies the address in the A-B Controller's datatable.

Valid entries: Up to 20-character address string. Please refer to theaddressing section that follows for more information on the content of thisstring.

Data Type

Defines the type of the data in the A-B Controller.

Valid entries:DEF: Default based on the tag type

Digital: BITAnalog: INT2Long Analog: INT4Float: FLT4Message: LOHI

BIT: A single binary digit INT2: Two byte signed integer INT4: Four byte signed integerBCD4: Two byte unsigned BCD number with four digitsUBCD: Two byte unsigned BCD number with three digitsFLT4: Four byte (normal) A-B Floating pointFLT8: Eight byte (non-standard) Floating pointLOHI: Array of bytes as stored in the deviceHILO: Array of bytes with the bytes in each word swapped from as

stored in the A-B ControllerST: Element of a String (ST) file

Comment



15


Sample Allen-Bradley Ethernet Interface: Read/Write Information entries are shownbelow. These screen-shots are taken from the sample application provided with theAllen-Bradley Ethernet Interface for FactoryLink.

16


5. Details of Solicited Operation

Detection and Execution of Trigger

In solicited operations the ABEI task monitors a RTDB tag for each solicitedoperation, interpreting a changed indication on the tag as a request to initiate thesolicited operation. For Exception Writes the ABEI task monitors each data tag is theassociated Read/Write information table as the trigger for the individual solicitedwrite operation. For Block Reads and Block Writes the ABEI task monitors the tagspecified (if so) in the corresponding Trigger Tag field in the Read/Write ControlTable.

The existence of a changed state on the monitored trigger tag does not necessaryinitiate the solicited operation. There are three conditions where the task will ignorethe changed state on the trigger and not initiate the solicited operation.

1. If the operation is a Block Read or Block Write and the trigger tag isdigital, the value of the digital tag must be true (non-zero) for theoperation to be initiated. This does not apply to Exception Writes.

2. If a disable tag is specified for the operation and the value of the disabletag is true (non-zero), disabling the operation, the task will not initiate theoperation.

3. If the operation is progressing, in process of being performed due to aprevious trigger, the task will not initiate a new operation.

Flow of Solicited Operations

When the task starts the configuration for the task is examined, solicited operationsare divided into separate commands (packets) and buffer space allocated for eachsolicited operation.

When the solicited operation is initiated the commands are queued into theassociated devices for processing. When the device has processed a command theresults of that command are passed back to the solicited operation buffer where it iscombined with the results of the other commands in the operation. Once the resultsfrom all the commands in the solicited operation have been collected, the taskfinishes the operation.

The components in this process operate independently of each other. At any pointwhile the task is running it is possible to have multiple solicited operations atdifferent phases in this process, the order that solicited operations are initiated doesnot necessarily determine the order is which they are finished.

Priority

Each device has four queues for individual commands of solicited operations to beprocessed by the device. Each queue is associated with a priority level, 1 through 4where 1 is the highest priority. When the device is ready to send a command to theA-B Controller, it samples these queues to determine the next command to send.The higher the priority the more often the associated queue is sampled for a pendingcommand. In order to ensure that any command regardless of priority will eventuallybe sent a command may be sent before one of a higher priority. Block Read, BlockWrite, and Exception Write are queued on the same four queues in each device.

Note: The priority queues are in each separate device and operate independentlyof any priority queues in any other devices.

17


Complete and State Tags

The ABEI task can provide information on the current status of Block Read andBlock Write operations via the use of either the Complete or State tags for that blockoperation. The information provided by these tags is similar. The principledifferences are when and how they are written to by the ABEI task. Thesedifferences are to facilitate the use of Self-Triggered and Daisy Changed Blockoperations. Please see the descriptions in this section of the manual for adescription of these methods.

Care should be taken if either of these tags is used by other FactoryLink tasks toindicate that a block operation has finished. There are conditions when either type oftag will indicate a false "finished" condition. For example the state tags are updatedby the ABEI task upon startup which would, if the other FactoryLink tasks wereunaware that the ABEI task has just started, be incorrectly interpreted by the othertasks as if the block operation has completed. Digital, analog, or long analog tagscan be used for these fields. If analog or long analog tags are used the ABEI taskwill provide information in the value of the tag to indicate that the block operationwas or was not performed and if performed whether the block operation completedwith or without errors.

The complete tag is force written to true (non-zero) by the ABEI task whenever theABEI task has finished handling a change detected in the trigger for the blockoperation. Normally this is when the block operation completes; however, not allchanges in the trigger initiate the block operation. For example if a disable tag isspecified for the block operation and the disable tags value is true (non-zero),disabling the block operation, then the trigger will have changed but the blockoperation will not be performed. Complete tags facilitate a "Daisy Chain" of blockoperations as described later in this section.

When the ABEI task is running the state tag reflects the "inactive" state of the blockoperation regardless of changes to the trigger tag for the block operation. When theblock operation is progressing (active), in the act of being preformed, the state tagwill be false (zero). When the block operation is not being performed (inactive), thestate tag will be true (non-zero). The ABEI task sets the state tag to true (non-zero)when the task starts to indicate that the block operation is inactive. In order tofacilitate self-triggering block operations the ABEI task will force write the state tag totrue (non-zero) on start up and when a self-triggered block operation is reenabled viathe disable tag for that block operation.

Self-Triggered Solicited Block Operations

This method is designed to block read or block write data to or from the A-BController as fast as the ABEI task can perform the operation. While causing theleast impact to other operations of this task and other FactoryLink or non-FactoryLink tasks running on the same system. In this method a single tag is usedfor both the trigger and state fields of the block operation. When the ABEI task startsit will force the value of the state tag to true (non-zero), causing a change to thetrigger tag, which is detected by the ABEI task and starts the block operation. Whenthe block operation is initiated the ABEI task will set the value of the state tag to false(zero) and when the block operation finishes the ABEI task will set the value of thestate tag to true (non-zero) causing a change to the trigger tag. This change in thetrigger is detected by the ABEI task and restarts the block operation. Thus in theabsence of other factors the block operation is started when the ABEI task starts,and the block operation is restarted each time it finishes as long as the ABEI task isrunning.

18


If a disable tag is specified for a self triggered operation the setting of the disable tagto true (non-zero) disabling the block operation, will cause self-trigging of theoperation to stop. This is because the state tag is updated only on changes in theActive/Inactive State of the operation. Without special handling in the ABEI taskenabling the operation by setting the disable tag to false (zero) would not restart theself-triggering operation. The ABEI task looks on changes to solicited operationsdisable tags that enable the operation when the operation was disabled for whetherthe solicited operation has the same tag as its trigger and state tags. If so the ABEItask will force write the state tag to true (non-zero) restarting the self-triggeringoperation.

Excessive overhead can be produced in the task if a disable tag is specified and thesame tag is used as the trigger tag and the complete tag of the operation. Thecomplete tag is set by the task upon handling a change in the trigger. If the disabletag is true, disabling the operation, once a change is detected in the trigger tag thetask will set the complete tag causing a change in the trigger causing the task to setthe complete tag causing a change in the trigger ...

Daisy-Chained Block Operations

This method is designed to force the ABEI task to perform a series of solicited blockoperations one at a time and in a specific sequence. Note this applies only to theindividual Read/Write Information tables used and not to the commands contained inthe tables used or other Read/Write Information tables in the application. Toimplement this method use the complete tag of the first operation in the series as thetrigger of the second operation, continue in this fashion until all subsequentoperations are triggered on the complete tag of the previous operation. This methodcan be used to perform the sequence of operations in the same manner as anindividual block read/write by specifying a trigger tag for the first operation. The daisychain can be made circular by using the complete tag of the last operation as thetrigger of the first operation. Thus when the last operation is finished the firstoperation is triggered and so on though the daisy chain.

The complete tags are not written by the ABEI task on startup, thus some externalmethod is required to start the daisy chain.

If the complete tag is used as the trigger in the next operation disable tags may beused to disable a single operation in the chain. The single operation would not beperformed but its complete tag would be set to trigger the following operation. If allthe disable tags in a circular daisy chain are true then the condition of excessiveoverhead in the task similar to that described when using complete tags for self-triggered operations will exist.

The state tag should not be used to daisy chain. When the task starts it force writesstate tags to true (non-zero). This will cause all of the operations in the chain to betriggered simultaneously. Since the order that the ABEI task detects simultaneoustriggers is indeterminate and since the ABEI task performs multiple simultaneoussolicited operations, the serial and sequential nature desired in this method will notbe accomplished. Also the use of a disable tag to disable a single operation in thechain would break the chain.

19


6. ABEI Program ArgumentsThe Allen-Bradley Ethernet Interface task allows for some adjustments of itsresource usage by use of “program arguments”. The arguments are entered in thefollowing format:

“-Innnn –I nn –Innn …” where: - Denotes the start of a argument I Argument Identifier nnnn Integer number (this is not a fixed number of digits)

Each argument has a minimum and maximum value. if a value below the minimumis given the minimum is used. If a value above the maximum is given the maximumis used.

There are three places where these arguments can be specified. These threelocations are checked for arguments in the order they are listed below. The lastdefinition of an argument will be the value used by the task.

Program Arguments Locations

System Configuration Information Table

String entered into the “Program Arguments” field of the System configurationInformation in the row that defines the ABEI task.

Environment String

The environment string is "ABEIPARM" this can either be set in the System -> Envi-ronment applet from the control panel or from a DOS command session entering thecommand:

"Set ABEIPARM=[arguments]"

Note: If set from a DOS command session FactoryLink must be run from that com-mand session.

Note: In the DOS set command there is no space between "ABEIPARM" and theequals sign "=", a space after the equals sign is optional.

Task Command Line from Command Prompt

The ABEI task can be started when the FactoryLink Application is running byentering the command: “abei” at the command prompt. Program arguments can bespecified in this command as: “abei –Inn –Innn –In … “

Note: Before starting the ABEI task in this manner assure the ABEI task is notalready running.

Argument Descriptions

Task Sleep Period

Unlike the majority of FactoryLink tasks a device interface task must often react toevents other than changes to tags in the RTDB, for example processing unsolicitedmessages from an A-B Controller. The ABEI task accomplishes this by using “TimeSlices” of the CPU to check for and process monitored events and then releases theCPU for a “Sleep Period”. The smaller the sleep period the faster the task will

20


respond to events; however this increases the amount of CPU time that is used bythe task. The Higher the sleep period the less CPU time used by the task; howeverthe task will take longer to detect and process events. This parameter is inmilliseconds (1/1000th of a second).

Parameter ID: sDefault Value: 10Minimum Value: 1Maximum Value: 1500

Device Packet Retry Count

Defines the number of times a command packet will be resent to a device on certaintransitional (non-fatal) errors.

Parameter ID: rDefault Value: 2Minimum Value: 1Maximum Value: 10

Solicited Packets in Single Time Slice

Defines the maximum number of solicited response packets a device will receiveand process in a single CPU Time Slice. The higher the number the higher thethroughput but the longer it may take for the task to complete a time slice andrelease the CPU.

Parameter ID: pDefault Value: 25Minimum Value: 1Maximum Value: 1000

Unsolicited Packets in Single Time Slice

Defines the maximum number of unsolicited command packets a device will receiveand process in a single CPU Time Slice. The higher the number the higher thethroughput but the longer it may take for the task to complete a time slice andrelease the CPU.

Parameter ID: uDefault Value: 25Minimum Value: 1Maximum Value: 1000

Maximum Number of Messages in Log File

In the “ABEI Message Logging” section below the logging parameter “maxmsg” isdescribed as setting the maximum number of messages written to a log file at10,000. This parameter controls the maximum number of messages.

Parameter ID: mDefault Value: 10,000Minimum Value: 100Maximum Value: 250,000

21


7. Allen-Bradley Data Table Address StringsThis section describes the fully specified address string format for the “Address” fieldin Read/Write Information tables. While the driver supports short hand addressstrings (for example: “B/129” to denote bit129 of Binary file 3) only the fully specifiedformats are described.

PLC-5 Logical Addressing

PLC-5 I/O Data Tables

The addressing scheme for inputs and outputs is different from that used for otherPLC-5 data files. The addressing used by the Driver is detailed below.

The standard format is as follows:

filetype:[wordnumber][/bit]

where

filetype = Either I for input or O for output

wordnumber = Word number in OCTAL (optional) If the word number is omitted, a zero (0) is assumed. The valid range for word number is 0 - 37.

bit = Bit number in OCTAL (optional) specifiedafter slash (slash must be included if bit number is specified) If the bit number is omitted, a zero(0) is assumed.

Note: The filetype and wordnumber may be separated by either a colon (:)or a semicolon (;).

I - Inputs

The input image file uses no mnemonics.

Examples:

Address: Description: I:7/1 Element 7, bit 1I:30/7 Element 30 (octal), bit 7I/17 Element 0, bit 17 (octal)I:32/0 Element 32 (octal), bit 0

O - Outputs

The output image file uses no mnemonics.

Examples:

Address: Description: O:7/1 Element 7, bit 1O:30/7 Element 30 (octal), bit 7O/17 Element 0, bit 17 (octal)O:32/0 Element 32 (octal), bit 0

22


All Other PLC-5 Data Tables

The addressing scheme for the remaining PLC-5 Data Files are similar to inputs andoutputs. The addressing used by the Driver is detailed below.


filetype[filenumber]:[element][.subelement] [/bit] [,length]

where

filetype = One of the following (required)A, B, BT, C, D, F, MG, N, PD, R, S, ST, or T

filenumber = File number in DECIMAL (optional)If the file number is omitted, the default for

that file type is assumed (i.e. T: = T4:).

element = Element number in DECIMAL(optional)

Valid ranges are as configured in PLC. Ifelement is not specified, a zero (0) is

assumed.

(Of the following you may use one or none :)

subelement = Subelement number specified in DECIMAL ormnemonic (optional). Subelements are onlyvalid for the file types where they are

specificallymentioned below.

bit = Bit number in DECIMAL (optional) specifiedafter slash (slash must be included if bit

numberis specified). If the bit number is omitted, a

zero(0) is assumed. Some file types, as described

below, permit the use of bit mnemonics.

Length = Number of words to be read into messagetag.

This is always preceded by a comma(optional).

Note: The filenumber and element may be separated by either a colon (:) or asemicolon (;).

A - ASCII

The ASCII file uses no subelements or mnemonics. Please note that no default filenumber exists for an ASCII file.

Examples:

23


Address: Description:A10:10 File 10, word 10, bit 0A10:10,20 File 10, word 10, length 20 (40 bytes)A20:30/14 File 20, word 30, bit 14

B - Binary

The binary file uses no subelements or mnemonics.

Examples:

Address: Description:B/17 File 3, word 1, bit 1B3/17 As aboveB13:1/2 File 13, word 1, bit 2

BT - Block Transfer

The block transfer file permits both subelement mnemonics and bit mnemonics.Please note that no default file number exists for this file type and that this file type isonly valid for “new” generation PLC-5s (5/30, 5/40, 5/60, 5/80).

Bits:

Number: Mnemonic: Description:15 EN Enabled14 ST Start13 DN Done12 ER Error11 CO Continue10 EW Enable wait9 NR No response8 TO Time out7 RW Read/Write

Subelements:

Number: Mnemonic: Description:1 RLEN Receive length. Requested word count.2 DLEN Done length. Transmitted word count.3 FILE File-type number.4 ELEM Element. Word number.5 RGS Rack/Group/Slot.

Examples:

Address: Description:BT12:1.RLEN File 6, control 1, receive length valueBT20:2.FILE File 20, control 2, File type valueBT15:5/ST File 6, control 5, start bit

24


C - Counter

The counter file permits both subelement mnemonics and bit mnemonics.

Bits:

Number: Mnemonic: Description:15 CU Count up14 CD Count down13 DN Done12 OV Overflow11 UN Underflow

Subelements:

Number: Mnemonic: Description:1 PRE Preset Value2 ACC Accumulated Value

Examples:

Address: Description:C:1.PRE File 5, counter 1, preset valueC20:2.ACC File 20, counter 2, accumulated valueC5:5.DN File 5, counter 5, done bitC5:6/12 File 5, counter 6, overflow bit

D- Decimal

The decimal file uses no subelements or mnemonics. This section is comprised of16 bit BCD words. Please note that no default file number exists for a decimal file.

Examples:

Address: Description:D0:10 File 0, element 10D8:11 File 8, element 11

F - Floating Point

The floating point file uses no subelements or mnemonics.

Examples:

Address: Description:F:10 File 8, element 10, bit 0F8:10 As above

MG - Message

The message file permits both subelement mnemonics and bit mnemonics. Pleasenote that no default file number exists for this file type and that this file type is onlyvalid for “new” generation PLC-5s (5/30, 5/40, 5/60, 5/80).

Bits:

Number: Mnemonic: Description:9 NR No response8 TO Time out7 EN Enable

25


6 ST Start transmission5 DN Done4 ER Error3 CO Continuous2 EW Enable waiting

Subelements:

Number: Mnemonic: Description:1 ERR Error code2 RLEN Request length.3 DLEN Done length

Examples:

Address: Description:MG11:1.ERR File 11, message 1, error codeMG21:2.3 File 21, message 2, done lengthMG15:5/CO File 15, message 5, continuous bit

N - Integer

The integer file uses no subelements or mnemonics.

Examples:

Address: Description:N:10 File 7, word 10, bit 0N7:10 As aboveN20:30/14 File 20, word 30, bit 14

PD - PID Loop

The PID file permits both subelement mnemonics and bit mnemonics. Please notethat no default file number exists for this file type and that this file type is only validfor “new” generation PLC-5s (5/30, 5/40, 5/60, 5/80).

Bits:

Number: Mnemonic: Description:28 INI PID initialized27 SPOR Set point out of range26 OLL Output alarm, Low limit25 OLH Output alarm, High limit24 EWD Error within dead band19 DVNA Deviation High Alarm18 DVPA Deviation Low Alarm17 PVLA Process Variable Low Alarm16 PVHA PV High Alarm15 EN Enable9 CT Cascaded Type8 CL Cascaded Loop7 PVT Process Variable Tracking6 DO Derivative Of4 SWM Software A/M Mode2 CA Control Action

26


1 MO Station Mode (auto/manual)0 PE PID Equation Type

Subelements:

Number: Mnemonic: Description:2 SP Setpoint4 KP Proportional gain6 KI Initial gain8 KD Derivative gain10 BIAS Output bias %12 MAXS Maximum scaled value14 MINS Minimum scaled value16 DB Dead band18 SO Set output %20 MAXO Maximum Output limit22 MINO Minimum Output limit24 UPD Update time26 PV Process Variable28 ERR Error: Scaled30 OUT Output32 PVH PV alarm High34 PVL PV alarm Low36 DVP Deviation Alarm +38 DVN Deviation Alarm -40 PVDB PV alarm dead band42 DVDB Deviation alarm dead band44 MAXI Maximum Input46 MINI Minimum Input48 TIE Tieback %

Examples:

Address: Description:PD11:1.SP File 11, PID 1, setpointPD16:2.DB File 16, PID 2, dead bandPD15:5/PE File 15, PID 5, equation bitPD70:1/OLL File 70, PID 1, lower output alarm

R - Control

The control file permits both subelement mnemonics and bit mnemonics.

Bits:

Number: Mnemonic: Description:15 EN Enabled14 EU Enable unload13 DN Done12 EM Empty11 ER Error10 UL Unload9 IN Inhibit Comparison8 FD Found

Subelements:

27


Number: Mnemonic: Description:1 LEN Length2 POS Position

Examples:

Address: Description:R:1.LEN File 6, control 1, length valueR20:2.POS File 20, control 2, position valueR6:5.UL File 6, control 5, unload bitR6:6/14 File 6, control 6, enable unload bit

S - Status

The status file uses no subelements or mnemonics.

Examples:

Address: Description:S:10 File 2, word 10, bit 0S2:10 As above

ST - String

The string file permits subelement mnemonics. Please note that no default filenumber exists for this file type and that this file type is only valid for “new” generationPLC-5s (5/30, 5/40, 5/60, 5/80).

Subelements:

Number: Mnemonic: Description:0 LEN Length. Specifies an even number of bytes.1 DATA Actual string data

Examples:

Address: Description:ST22:1.LEN File 22, string 1, length valueST22:2.1,5 File 22, string 2, string data, length 5

T - Timer

The timer file permits both subelement mnemonics and bit mnemonics.

Bits:

Number: Mnemonic: Description:15 EN Enabled14 TT Timing13 DN Done

Subelements:


Examples:

28


Address: Description:T:1.PRE File 4, timer 1, preset valueT20:2.ACC File 20, timer 2, accumulated valueT4:5.DN File 4, timer 5, timer done bitT4:6/15File 4, timer 6, enabled bit

29


SLC Logical Addressing

SLC I/O Data Tables

The addressing used by the Driver is detailed below.


filetype:[I/Oslotnumber][.wordnumber][/bit]

where

filetype = Either I for input or O for output

I/Oslotnumber = I/O Slot Number in DECIMAL (0-30)

wordnumber = Word number in DECIMAL (optional) If theword

number is omitted, a zero (0) is assumed. Ifthe

device in the slot provides more then oneword

(16bits) of data the word number must be specified to access the additional words of

data.The valid range for the word number is 0 -

127.

bit = Bit number in DECIMAL (optional) specifiedafter slash (slash must be included if bit

numberis specified). The valid range is:

0 – 7 (8 bit I/O)0 - 15 (16 or more bits)If the bit number is omitted, a zero (0) isassumed.

Note: The filetype and I/O slotnumber may be separated by a colon(:) or asemicolon(;).

O - Output Image

The output image file is file 0 of the data table. This file uses no mnemonics.

Examples:

Address: Description:O:7/1 Slot 7, bit 1O:30/7 Slot 30, bit 7O:3.1/3 Slot 3, bit 19

I - Input Image

The file for input image elements is file 1 of the data table. This file uses nomnemonics.

Examples:

Address: Description:I:7/1 Slot 7, bit 1

30


I:30/7 Slot 30, bit 7I:3.1/3 Slot 3, bit 19

All Other SLC Data Tables

The addressing used by the Driver is detailed below.


filetype[filenumber]:[element][.subelement] [/bit] [,length]

where

filetype = One of the following (required)A, B, C, F, N, R, or T.

filenumber = File number in DECIMAL (optional) If the filenumber is omitted, the default for that file type

isassumed (i.e. T: = T4:).

element = Element number in DECIMAL(optional) Valid ranges are as configured in PLC. If elementis not specified, a zero (0) is assumed.

(Of the following you may use one or none :)

subelement = Subelement number specified in DECIMAL or mnemonic (optional). Subelements are only valid for the file types where they arespecifically mentioned below.

bit = Bit number in DECIMAL (optional) specified after slash (slash must be included if bitnumber is specified). Valid bit numbers are 0 - 15.Some file types, as described below, permit the useof bit mnemonics. If the bit number is omitted, a zero (0) is assumed.

length = Number of words to be read into messagetag. This is always preceded by a comma.

Note: The filenumber and element may be separated by either a colon (:) or asemicolon (;).

31


A - ASCII

The ASCII file uses no subelements or mnemonics. Please note that no default filenumber exists for an ASCII file.

Examples:

Address: Description:A10:10 File 10, word 10, bit 0A10:10,20 File 10, word 10, length 20 (40 bytes)A20:30/14 File 20, word 30, bit 14

B - Bit (Binary)

Each binary element consists of one word. You can address a binary element in itsentirety or you can address any particular data bit of an element individually.

Examples:

Address: Description:B/17 File 3, word 1, bit 1B3/17 As aboveB13:1/2 File 13, word 1, bit 2

C - Counters

Each counters structure consists of three words. The counters file permits bothsubelement mnemonics and bit mnemonics.

Bits:

Number: Mnemonic: Description:15 CU Count up14 CD Count down13 DN Done12 OV Overflow11 UN Underflow

Subelements:


Examples:

Address: Description:C:1.PRE File 5, counter 1, preset valueC20:2.ACC File 20, counter 2, accumulated valueC5:5/DN File 5, counter 5, done bitC5:6/12 File 5, counter 6, overflow bit

F - Floating Point

Each floating point element consists of two words. The floating point file permits nosubelements or mnemonics.

Examples:

32


Address: Description:F:10 File 8, element 10, bit 0F8:10 As above

N - Integer

The integer file uses no subelements or mnemonics.

Examples:

Address: Description:N:10 File 7, word 10, bit 0N7:10 As aboveN20:30/14 File 20, word 30, bit 14

R - Control

Each control block consists of three words. The control file permits both subelementmnemonics and bit mnemonics.

Bits:

Number: Mnemonic: Description:15 EN Enabled14 EU Unloading Enabled13 DN Done12 EM Empty11 ER Error10 UL Unload9 IN Inhibit Comparisons8 FD Found

Subelements:

Number: Mnemonic: Description:1 LEN Length2 POS Position

Examples:

Address: Description:R:1.LEN File 6, control 1, length valueR20:2.POS File 20, control 2, position valueR6:5/UL File 6, control 5, unload bitR6:6/14 File 6, control 6, enable unload bit

T - Timers

The timers file accommodates up to 256 timer structures. Each timer structureconsists of three words. You can address a timer structure in its entirety or you canaddress any particular member of a structure individually.

Bits:

Number: Mnemonic: Description:15 EN Enabled

33


14 TT Timer Timing13 DN Done

Subelements:


Examples:

Address: Description:T:1.PRE File 4, timer 1, preset valueT20:2.ACC File 20, timer 2, accumulated valueT4:5/DN File 4, timer 5, done bitT4:6/15 File 4, timer 6, enabled bit

34


8. ABEI Error Codes and Extended Error CodesIn the Device Definitions Configuration Table there are fields to assign tags toreceive codes and extended codes to report errors detected in the device. If the tagsassigned to these fields are analog or long analog tags they will contain specificvalues for the detected error. This section describes these values.

Code: 0 – Empty

No Error. There are no extended code values for this code.

Code: 1 – Allocation of Socket Failed

The task was unable to create a socket for the device, assure that the TCP/IPprotocol is properly installed and sufficient resources are allocated to it. There areno extended code values for this code.

Code: 2 – IP Error

The task received an error when attempting to perform some operation on a socket(connection to an A-B Controller). With this code the extended code will contain theerror code resulting from the attempt. Some of the more common error codes arelisted below. For a complete list please view the “winsock.h” and “winsock2.h” ‘C’include files for the Win32 SDK (Microsoft provided development libraries forWindows 32-bit operating systems). The constant “WSABASEERR” has beensubtracted from the error code before being written to the tag.

Extended Code: 35 – WSAEWOULDBLOCK

This code should be handled internally by the ABEI task. If you see this codeplease report it to our tech-support department.

Extended Code: 36 – WSAEINPROGRESS

This code should be handled internally by the ABEI task. If you see this codeplease report it to our tech-support department.

Extended Code: 38 – WSAENOTSOCK

This code is generated when an operation was requested on a handle that isnot an open socket. The ABEI task should not generate this error. If you seethis code please report it to our tech-support department.

Extended Code: 45 – WSAEOPNOTSUPP

This code is generated when attempting to set an option on a socket that isnot supported by the TCP/IP protocol implementation in the operatingsystem. On Windows NT and Windows 2000 this error should not occur. Ifyou see this code please report it to our tech-support department.

Extended Code: 50 – WSAENETDOWN

Check that the TCP/IP protocol is properly installed.

35


Extended Code: 51 – WSAENETUNREACH

Network unreachable, this can result from numerous circumstances, forexample, TCP/IP protocol improperly installed or configured, A-B ControllerIP address incorrect or improper routing, invalid addresses in the host aliasfile. The network card could be down or a device providing the route to thenetwork segment could be unavailable. This list is intended to denote thetype of problem that can generate this error code and should not beconsidered a complete list of all possible problems.

Extended Code: 53 – WSAECONNABORTED

This code is generated when a send or receive is attempted on a connectionthat has been disconnected but the disconnection had not been detected bythe task before the send or receive attempt. Detection of this code will causethe device to go into an error recovery state.

Extended Code: 54 – WSAECONNRESET

This code is normally generated when a send or receive is attempted on aconnection that has been disconnected by the A-B Controller. Detection ofthis code will cause the device to go into an error recovery state.

Extended Code: 57 – WSAENOTCONN

This code is generated when a send or receive is attempted on a connectionthat has been disconnected but the disconnection has not yet beendetermined by the task. Detection of this code will cause the device to go intoan error recovery state.

Extended Code: 61 – WSAECONNREFUSED

The addressed A-B Controller did not accept the connection request. Assure thatthe A-B Controller is properly configured and is not overloaded with connections toother network devices, or too many ABEI Task devices are mapped to the A-BController.

Extended Code: 64 – WSAEHOSTDOWN

Check that the addressed A-B Controller is connected and active.

Extended Code: 65 – WSAEHOSTUNREACH

Check that the TCP/IP address for the device is valid. Check that the TCP/IPprotocol has been properly installed and configured.

Code: 3 - Timeout

The task waited past it’s allotted time period for some communication to completewith the A-B Controller. There are no extended code values for this code.

Code: 4 – Local Status Error

In the response packet to a solicited command the A-B Controller may report errors.For this code the A-B Controller reported a “local status” error. The extended codesare the actual value returned by the device. In the list below the quoted phrase isquoted from Allen-Bradley documentation. If the extended code is not in the list

36


below the code has not been listed in Allen-Bradley documentation (References toAllen-Bradley documentation are of most currently available to the author at the timeof writing this manual).

Extended Code: 1

“station cannot buffer command”: Try reducing the “Max Concurrent Packets”field value in the Device Definitions Table.

Extended Code: 2

“destination node (PLC) not found on DH+”

Extended Code: 3

“duplicate token holder detected”

Extended Code: 4

“local port is disconnected”

Extended Code: 5

“application layer timed out waiting for a response”

Extended Code: 6

“duplicate node detected”

Extended Code: 7

"station is off-line"

Extended Code: 8

"hardware fault"

Code: 5 – Remote Status Error

In the response packet to a solicited command the A-B Controller may report errors.For this code the A-B Controller reported a “remote status” error. The extendedcodes are the actual value returned by the device. In the list below the quotedphrase is quoted from Allen-Bradley documentation. If the extended code is not inthe list below the code has not been listed in Allen-Bradley documentation(References to Allen-Bradley documentation are of most currently available to theauthor at the time of writing this manual).

Extended Code: 16

"illegal command or format": Assure that the proper device type (PLC-5 orSLC) is configured for this device.

Extended Code: 32

"host has a problem and will not communicate"

Extended Code: 48

"remote node host is missing, disconnected, or shut down"

37


Extended Code: 64

"host could not complete function due to hardware problem"

Extended Code: 80

"addressing problem or memory protect rungs"

Extended Code: 96

"function disallowed due to command protection selection"

Extended Code: 112

"processor is in program mode"

Extended Code: 128

"compatibility mode file missing or communication zone problem"

Extended Code: 144

“remote node cannot buffer command”: Try reducing the “Max ConcurrentPackets” field value in the Device Definitions Table.

Extended Code: 160

“not used”

Extended Code: 176

“remote node problem due to download”

Extended Code: 192

“cannot execute command due to active IPBs”

Extended Code: 208

“not used”

Extended Code: 224

“not used”

Code: 6 – Extended Status Error

In the response packet to a solicited command the A-B Controller may report errors.For this code the A-B Controller reported an “extended status” error. The extendedcodes are the actual “extended status” value returned by the device. In the list belowthe quoted phrase is quoted from Allen-Bradley documentation. If the extended codeis not in the list below the code has not been listed in Allen-Bradley documentation(References to Allen-Bradley documentation are to that currently available to theauthor at the time of writing this manual)

Extended Code: 1

“a field has an illegal value”: Assure the proper device type (PLC-5 or SLC) isset for this device in the Device Definitions Table.

38


Extended Code: 2

“less levels specified in address than minimum for any address” : Assure theproper device type (PLC-5 or SLC) is set for this device in the DeviceDefinitions Table.

Extended Code: 3

“more levels specified in address than system supports” : Assure the properdevice type (PLC-5 or SLC) is set for this device in the Device DefinitionsTable.

Extended Code: 4

“symbol not found”

Extended Code: 5

“symbol is of improper format”

Extended Code: 6

“address does not point to something usable”: Assure the addressed fileactually exists in the A-B Controller.

Extended Code: 7

“file is of wrong size”: Assure the addressed file in the A-B Controller actuallyhas the number of elements referenced.

Extended Code: 8

“cannot complete request, situation has changed since the start of thecommand”

Extended Code: 9

“data or file is too large”: Assure the addressed file in the A-B Controlleractually has the number of elements referenced.

Extended Code: 10

“transaction size plus word size is too large”: Assure the addressed file in theA-B Controller actually has the number of elements referenced.

Extended Code: 11

“access denied, improper privilege”

Extended Code: 12

“condition cannot be generated, resource is not available”

Extended Code: 13

“condition already exists, resource is already available”

39


Extended Code: 14

“command cannot be executed”

Extended Code: 15

“histogram overflow”

Extended Code: 16

“no access”

Extended Code: 17

“illegal data type”

Extended Code: 18

“invalid parameter or invalid data”

Extended Code: 19

“address reference exists to deleted data table”

Extended Code: 20

“command execution failure for unknown reason”

Extended Code: 21

“data conversion error”

Extended Code: 22

“scanner not able to communicate with 1771 rack adapter”

Extended Code: 23

“adapter cannot communicate with module”

Extended Code: 24

“1771 module response was not valid”

Extended Code: 25

“duplicated label”

Extended Code: 26

“file is open; another node owns it”

Extended Code: 27

“another node is the program owner”

40


Code: 7 – Invalid Response

The ABEI task was unable to interpret the response packet received on a solicitedconnection. There are no extended code values for this code.

Code: 8 – Invalid Command

The ABEI task was unable to interpret the command packet received on anunsolicited connection. There are no extended code values for this code.

Code: 9 – Unsupported Command

The ABEI task does not support the kind of command packet received on anunsolicited connection. There are no extended code values for this code.

Code: 10 – Invalid Device Type

The entry in the “Device Type” field in the Device Definitions Table is not supportedby the executing version of the ABEI Task. Make sure that the same version of theABEI task is installed for both “development” and “run-time” FactoryLink systems.There are no extended code values for this code.

Code: 11 – Invalid Unsolicited Session Establish Me ssage

The ABEI task was unable to recognize the initial unsolicited session connectioncommand received from the device. Assure that the device is a valid A-B Controlleror providing true emulation. There are no extended code values for this code.

Code: 12 – Invalid IP Address

The ABEI task was unable to recognize the contents of the "TCP/IP Address HostName" field of the Device Definitions table or the contents of the message tagspecified in this field as a valid IP address or host name alias. There are noextended code values for this code.

41


9. ABEI MessagesThe ABEI task will display messages in the task’s console window. This may eitherbe the “runmgr text window” or a separate “ABEI text window” depending on whetheror not the ‘S’ flag is set for the ABEI task in the Flags field of the System Configura-tion Information Table. Additionally these messages can be logged to a text log fileby enabling write to disk in the ABEI logging function. For more information on theABEI logging function please refer to the section on ABEI logging which follows.

We have attempted to make these messages as self-explanatory as reasonablypossible; however a brief description of some of the messages is given below.

Axisware A-B Ethernet Ver X.YY

Banner line, this line is displayed on task start up and gives the current version of thetask. ‘X’ is the major version number and ‘YY’ is the minor version number.

Demo Time Limit Reached Task in suspend mode

The task was installed using the demonstration license and the task has beenrunning for the demonstration time period. Restarting the task will cause it to restartthe demo time period. While in suspend mode the task will not operate.

Out of Memory …

The task allocates and frees memory during operation for temporary buffer space.When the task attempted to allocate a buffer the operating system was unable toprovide the memory. In today’s operating systems this should be far less commonthen in previous times, but the same conditions apply: either reduce the amount ofdata required by the task or reduce the number of tasks running on the system.

Unable to open .ct filect_read_index failedInvalid ct table typeDevice ct table length mismatchct_read_recs error reading device tableError reading R/W Table Header of Table ..ct_read_recs failed reading records of R/W table …Invalid return from ct_get_nrecs …R/W table record length mismatchR/W table header length mismatchInvalid ct table type …

These messages denote some problem with the FactoryLink application. Ensurethat the application matches the version of the task installed and/or rebuild the “ct”files with the command “ctgen ABEI”. Please refer to FactoryLink documentation formore information on configuration and building of applications.

Device: %s Invalid host alias for TCP/IP Address …

Either the literal string entered into the “TCP/IP Address Host Name” field of theDevice Definitions table or the string contained in the message tag specified in thisfield is not a valid TCP/IP (dot) address or does not have a corresponding entry inthe host alias file.

42


FlRead Error …FlWrite Error …fl_read failed … fl_read failed …fl_forced_write failed …fl_write failed … fl_clear_chang failed …Error: fl_clear_chng error …

The task monitors return codes from the FactoryLink RTDB ApplicationProgramming Interface (API). This style of message will denote that a RTDB APIerror occurred displaying the error number and a text description of the error.

{Operation} of Table: {Table Name}:Device:{Device N ame} Local Sts Error:0xEE{Operation} of Table:{Table Name}:Device:{Device Na me} Remote Sts Error:0xEE{Operation} of Table:{Table Name}:Device:{Device Na me} Ext Sts Error: 0x%EE

There are three classes of errors reported by the A-B Controller in a commandresponse, Local Status, Remote Status, and Extended Status. These messagesdenote that one of these classes of errors (error code 0xEE) was received by device{Device Name} when an {Operation} (Block Read, Block Write or Exception Write)was being performed on Read/Write Information Table {Table Name}. Thesemessages will be followed by a message giving the translation for the error codefrom Allen-Bradley documentation in double quotes “” and any available additionalinformation in parenthesis ().

Unable to allocate solicited socket for device: {De vice Name}Device: {Device Name} solicited ioctlsocket error { Error Code} {ErrorDescription}Device: {Device Name} solicited ioctlsocket error { Error Cord} {ErrorDescription}

The task was unsuccessful with creating and setting up a “socket” with which toperform solicited commands with device {Device Name}. This may be due to a lackof resources on the processing station (PC). Ensure that TCP/IP is properly installedand has sufficient resources.

Unable to allocate unsolicited base(listen) socketsetsockopt failed on Unsolicited base(listen) socke t …ioctlsocket failed on Unsolicited base(listen) sock et …listen failed on Unsolicited base(listen) socket …accept failed on Unsolicited base(listen) socket …repost of listen failed on Unsolicited base(listen) socket …

The task was unsuccessful with creating and setting up a “socket” on which to listenfor commands from A-B Controllers for unsolicited operations. This may be due to alack of resource on the processing station (PC) or because some other programrunning on the processing station has taken this resource. Ensure that TCP/IP isproperly installed, has sufficient resources, and other programs attempting tocommunicate with A-B Controllers over Ethernet are not running. Even thoughunsolicited operations will not function solicited operation may continue to function.

43


10. ABEI Message Logging

By default the ABEI task will not create a log file and only messages in the “error”category are displayed in the task’s console window. Setting “logging parameters” ina system environment variable can modify this behavior. This section describesthese “logging parameters”. The environment variable is parsed upon task startupthus to change a parameter the environment variable must be modified and then thetask stopped and restarted. The default state for each parameter is disabled (off)thus if one of the following parameters is desired it must be enabled (turned on) inthe environment variable. The environment variable is parsed left to right thus the“last” (rightmost) reference to a parameter will define its final state.

The environment string is “ABEILOG” this can either be set in the “system environ-ment dialog” from the control panel or from a DOS command session entering thecommand:

“Set ABEILOG={parameters}”

A parameter is enabled by setting the parameters to “+{Parameter ID}” or disabledby setting the parameters to “-{Parameter ID}” there must be at least one space be-tween the parameters. Note: in the Set command there is no space between“ABEILOG” and the equals sign “=”, a space after the equals sign is optional. All pa-rameters are made up of lower case characters. The following parameters are de-fined:

disk

Use this parameter to enable/disable the creation of the log file. Ifenabled the log file “%FLAPP%\log\abei.log” will be recreated eachtime the task is started. The log file is created so as to overwrite anyprevious ABEI log file in the “%FLAPP%\log” directory.

unique

If the “disk” parameter above is enabled, enabling this parameter willcause the task to create a unique log file name each time the task isstarted. The task creates a unique name by inserting a time stamp inthe file name as “%FLAPP%\log\abeiYYMMDDHHMMSS.log”.Where ‘YY’ is the two digit year, ‘MM’ is the two digit month, ‘DD’ isthe two digit day of month, ‘HH’ is the two digit (24 hour) hour, ‘MM’ isthe two digit minute, and ‘SS’ is the two digit second of when the filewas created (task startup).

Note: Using a unique file name can be useful however this keepsthe task from overwriting the previous file in the log directory.Thus care should be taken to remove log files that are nolonger useful or excessive disk space may be used.

maxmsg

Enabling this parameter will limit the number of messages written tothe log file to 10,000. When 10,000 messages have been written tothe file the file will be closed and upon the next message to belogged the file will be reopened.

Note: Enabling this parameter will force the enabling of the “unique”parameter described above.

44


warn

Use this parameter to enable/disable the displaying of “Warning” cat-egory messages. Messages in this category display informationabout potential problems in the application but do not prevent thetask from performing its function.

dvcsts

Use this parameter to enable/disable messages that denote when adevice changes its connection status.

dmpctinp

Use this parameter to enable/disable a “dump” of the configurationdata read by the task on startup. This information could be useful indetermining configuration problems.

dmptrig

Use this parameter to enable/disable a “dump” of the “triggers” (aninternal structure used to perform each operation on a Read/Write In-formation Table) generated by the task from its configuration infor-mation. This information could be useful in determining configurationproblems. This information includes a detailed description of all com-mands (packets) built for each operation on a table.

dmptrgtag

This parameter is only valid if the “dmptrig” parameter above is en-abled. Enabling this parameter will include individual tag informationin the trigger dump information.

proc&line

Use this parameter to enable/disable the inclusion of the source filename, procedure, and source file line number in each “logged”message. This information can be useful to tech-support inidentifying exactly which source code line generated the message.Note: this information will only be added to the messages in the logfile; it will not be displayed in the console window.

all

Use this parameter to enable/disable all of the above parameters.

Examples:

Set ABEILOG=+all –dmptrgtag

Enable all logging parameters then disable the “dmptrgtag” parame-ter

Set ABEILOG=+disk +warn +proc&line

Enable logging to disk, include warning messages, and includesource line information in messages. If sufficient disk space is avail-able this mode is suggested for normal operation.

Set ABEILOG=+warn

45


Include warning category messages in the console window. Thisdoes not enable logging to disk thus no log file would be created.

46

axisware abei manual: factorylink driver for allen-bradley ethernet plc-5/xxes & slc-5/05

Documents