Allen-Bradley Ethernet Driver Table of Contents Allen-Bradley Ethernet Driver Table of Contents Allen-Bradley Ethernet Driver Overview Setup Channel Properties - General Channel Properties - Ethernet Communications Channel Properties - Write Optimizations Channel Properties - Advanced Channel Properties - Communication Serialization...
Page 3
Allen-Bradley Ethernet Driver Block Transfer Files Event Log Messages Unable to read data block from device. Frame received contains errors. | Block start address = '<address>'. Unable to read data block from the device. Tag deactivated. | Block start address = '<address>', Status code = <code>, Extended status code = <code>.
Device Setup How do I configure a device for use with this driver? Optimizing Allen-Bradley Ethernet Communications How do I get the best performance from the Allen-Bradley Ethernet Driver? Data Types Description What data types are supported by this driver?
The Allen-Bradley Ethernet Driver provides a reliable way to connect Allen-Bradley Ethernet devices to client applications; including HMI, SCADA, Historian, MES, ERP, and countless custom applications. This driver sup- ports the Allen Bradley SLC 5/05 series, PLC-5 series, and SoftPLC PLCs. Address ranges are open to support future models for this series of PLCs.
Allen-Bradley Ethernet Driver Setup Communication Protocol Allen-Bradley Ethernet Supported Devices SLC 5/05 processor* PLC-5 series (excluding the PLC-5/250 series) SoftPLC *Address ranges are open in the driver to allow for new devices. The driver may support a device even if it is not listed above.
Allen-Bradley Ethernet Driver For information on reserved characters, refer to "How To... Properly Name a Channel, Device, Tag, and Tag Group" in the server help. Description: User-defined information about this channel. Many of these properties, including Description, have an associated system tag.
Allen-Bradley Ethernet Driver Write All Values for All Tags: This option forces the server to attempt to write every value to the con- troller. In this mode, the server continues to gather write requests and add them to the server's internal write queue.
Allen-Bradley Ethernet Driver Inter-Device Delay: Specify the amount of time the communications channel waits to send new requests to the next device after data is received from the current device on the same channel. Zero (0) disables the delay. Note: This property is not available for all drivers, models, and dependent settings.
Allen-Bradley Ethernet Driver Is the channel using a serial or Ethernet driver? Does the driver read tags in separate requests, or are multiple tags read in a block? Have the device's Timing properties (such as Request timeout and Fail after x successive timeouts)
Allen-Bradley Ethernet Driver Rate. The data is not saved if the server removes the item (such as when the server is reinitialized). The default is No. Notes: 1. This System tag (_Simulated) is read only and cannot be written to for runtime protection. The System tag allows this property to be monitored from the client.
Allen-Bradley Ethernet Driver Communications Timeouts Connect Timeout: This property (which is used primarily by Ethernet based drivers) controls the amount of time required to establish a socket connection to a remote device. The device's connection time often takes longer than normal communications requests to that same device. The valid range is 1 to 30 seconds. The default is typically 3 seconds, but can vary depending on the driver's specific nature.
Allen-Bradley Ethernet Driver Demote on Failure: When enabled, the device is automatically taken off-scan until it is responding again. Tip: Determine when a device is off-scan by monitoring its demoted state using the _AutoDemoted system tag. Timeouts to Demote: Specify how many successive cycles of request timeouts and retries occur before the device is placed off-scan.
To correctly use the Generic Module, users must know the number of Input and Output words required for each module. Consult Allen-Bradley I/O user manual documentation to confirm Input and Output requirements and be aware that requirements may be different based on Class 1 or Class 3 operation.
The range of accepted values is shown in the table below. Consult the Allen-Bradley user manual for the specific I/O module to configure to confirm input and output requirements. Requirements may be different based on Class 1 or Class 3 operation.
Page 16
Allen-Bradley Ethernet Driver Module Type Input Words Output Words 1746-NI8 8 Ch Analog Input, Class 3 1746-NIO4I Analog Comb 2 in & 2 Current Out 1746-NIO4V Analog Comb 2 in & 2 Voltage Out 1746-NO4I 4 Ch Analog Current Output...
PLC from which data is collected. While this approach to defining the application provides a high level of per- formance, it doesn't take full advantage of the Allen-Bradley Ethernet Driver or the network. An example of how the application may appear when configured using a single channel is shown below.
Allen-Bradley Ethernet Driver Data Types Description Data Type Description Boolean Single bit Byte Unsigned 8-bit value Char Signed 8-bit value Word Unsigned 16-bit value Short Signed 16-bit value DWord Unsigned 32-bit value Long Signed 32-bit value Two-byte packed BCD, four decimal digits...
Allen-Bradley Ethernet Driver Address Descriptions Address specifications vary depending on the model in use. Select a link from the following list to obtain spe- cific address information for the model of interest. General Addressing SLC 5/05 Open Addressing PLC-5 Family and Soft PLC Addressing General Addressing The general addresses below pertain to SLC 5/05, PLC-5, and SoftPLC.
Allen-Bradley Ethernet Driver Syntax Data Type O:<slot>/<bit>[cols] Boolean* O:<slot>.<word>/<bit> Boolean O:<slot>.<word>/<bit>[rows][cols] Boolean* O:<slot>.<word>/<bit>[cols] Boolean* *Array types Slot and Word Configurations The following slot and word locations are allowed for each model. For information, refer to Device Setup. PLC Model Min Slot Max.
Page 21
Allen-Bradley Ethernet Driver Syntax Data Type I:<word> Short, Word, BCD I:<word>/<bit> Boolean I:<word>/<bit>[rows][cols] Boolean* I:<word>/<bit>[cols] Boolean* I/bit Boolean I/bit[rows][cols] Boolean* I/bit[cols] Boolean* *Array types Note: Word and bit address information is in octal for PLC-5 and SoftPLC models. This follows the con- vention of the programming software.
Allen-Bradley Ethernet Driver SLC 5/05 Addresses Word 0 slot 1 I:1.0 Word 0 slot 1 (same as I:1) I:12 Word 0 slot 12 I:12.2 Word 2 slot 12 I:4.0/0 Bit 0 word 0 slot 4 I:4/0 Bit 0 slot 4 (same as I:4.0/0) I:4.2/0...
Allen-Bradley Ethernet Driver Binary Files To access Binary files, specify a file number and a word (and optionally, a bit in the word). The default data type for all syntax is shown in bold. Syntax Data Type B<file>:<word> Short, Word, BCD, DWord, Long, LBCD B<file>:<word>...
Allen-Bradley Ethernet Driver PLC Model File Number Max. Element SLC 5/05 Open 4, 9-999 PLC-5 Family 3-999 1999 SoftPLC 3-9999 9999 The following fields are allowed for each element. Refer to the PLC documentation for the meaning of each field.
Allen-Bradley Ethernet Driver Control Files Control files are a structured type whose data is accessed by specifying a file number, an element and a field. The default data type depends on the field being accessed. Integer fields receive a default data type of Word.
Allen-Bradley Ethernet Driver Note: The number of array elements (in bytes) cannot exceed the block request size specified. This means that array size cannot exceed 16 words given a block request size of 32 bytes. For more information, refer to Block Request Size.
Allen-Bradley Ethernet Driver Syntax Data Type A<file>:<char> Char, Byte* A<file>:<char> [rows][cols] Char, Byte* A<file>:<char> [cols] Char, Byte* A<file>:<word offset>/length String** Note: The number of array elements cannot exceed the block request size specified. For more information, refer to Block Request Size.
Allen-Bradley Ethernet Driver PLC Model File Number Max. Word SLC 5/05 Open 9-999 PLC-5 Family 3-999 SoftPLC 3-9990 9999 Example Description ST9:0 String 0 ST18:10 String 10 String Length While the .LEN field is not supported, string length can be obtained with a COPY or MOVE function, as shown below.
Allen-Bradley Ethernet Driver Syntax Data Type D<file>:<word> BCD, LBCD D<file>:<word> [rows][cols] BCD, LBCD* D<file>:<word> [cols] BCD, LBCD* *Array types Note: The number of array elements (in bytes) cannot exceed the block request size specified. This means array size cannot exceed 16 BCDs given a block request size of 32 bytes. For more information, refer to...
Allen-Bradley Ethernet Driver Element Field Data Type Access MAXO Real Read/Write MINO Real Read/Write Real Read/Write Real Read/Write Real Read/Write Real Read/Write Real Read/Write Real Read/Write Real Read/Write Real Read/Write PVDB Real Read/Write DVDB Real Read/Write MAXI Real Read/Write MINI...
Allen-Bradley Ethernet Driver PLC Model File Number Max. Element SLC 5/05 Open PLC-5 Family 3-999 SoftPLC 3-9999 9999 The following fields are allowed for each element. Refer to the PLC documentation for the meaning of each field. Element Field Data Type...
Page 32
Allen-Bradley Ethernet Driver Element Field Data Type Access Boolean Read/Write Boolean Read/Write Boolean Read/Write Boolean Read/Write Boolean Read/Write Example Description BT14:0.RLEN Requested length field of BT 0 file 14 BT18:6.CO Continue bit of BT 6 file 18 www. kepware.com...
Allen-Bradley Ethernet Driver Event Log Messages The following information concerns messages posted to the Event Log pane in the main user interface. Consult the server help on filtering and sorting the Event Log detail view. Server help contains many common mes- sages, so should also be searched.
Allen-Bradley Ethernet Driver 1. Check the status and extended status codes returned by the PLC. The extended status code may not always be returned; error information is contained within the status code. The codes are displayed in hexadecimal. 2. Status code errors in the low nibble indicate errors found by the local node. The driver continues to retry reading these blocks of data periodically.
Allen-Bradley Ethernet Driver à Note: 1. Check the status and extended status codes returned by the PLC. The extended status code may not always be returned; error information is contained within the status code. The codes are displayed in hexadecimal. 2. Status code errors in the low nibble indicate errors found by the local node. The driver continues to retry reading these blocks of data periodically.
Allen-Bradley Ethernet Driver Possible Cause: The address written to does not exist in the PLC. Possible Solution: Verify the address exists in the PLC. Ã Note: 1. Check the status and extended status codes returned by the PLC. The extended status code may not always be returned;...
Allen-Bradley Ethernet Driver Unable to write to address on device. | Address = '<address>', Status code = <code>. Error Type: Warning Possible Cause: 1. The Ethernet connection between the device and the host PC is broken. 2. The communication parameters for the Ethernet connection are incorrect.
Need help?
Do you have a question about the SLC 5/05 series and is the answer not in the manual?
Questions and answers