Allen-Bradley Micro800 Serial Driver Help Kepware, Inc.

Transcription

1 Allen-Bradley Micro800 Serial Driver Help 2015 Kepware, Inc.

2 2 Table of Contents Table of Contents 2 Overview 5 Channel Setup 6 Device Setup 7 Communications Parameters 8 Options 9 Performance Optimizations 11 Optimizing Communications 11 Optimizing Applications 11 Data Types Description 13 Address Descriptions 13 Address Formats 14 Tag Scope 15 Addressing Atomic Data Types 16 Addressing Structured Data Types 17 Addressing STRING Data Type 17 Ordering of Array Data 18 Advanced Use Cases 19 BOOL 19 SINT, USINT, and BYTE 20 INT, UINT, and WORD 22 DINT, UDINT, and DWORD 24 LINT, ULINT, and LWORD 26 REAL 27 LREAL 29 SHORT_STRING 30 Error Codes 32 Encapsulation Protocol Error Codes 32 CIP Error Codes 32 0x0001 Extended Error Codes 33 0x001F Extended Error Codes 33 0x00FF Extended Error Codes 33 Error Descriptions 35 Address Validation 35 Address <address> is out of range for the specified device or register. 35 Array size is out of range for address <address>. 35 Array support is not available for the specified address: <address>. 35 Data Type <type> is not valid for device address <address>. 36 Device address <address> contains a syntax error. 36 Device address <address> is not supported by model <model name>. 36 Device address <address> is read only. 36 Memory could not be allocated for tag with address <address> on device <device name>. 36

3 3 Missing address 37 Communication Messages 37 Device <device> responded with CIP error: Status Code=<status code>, Ext. Status Code=<extended status code>. 37 Device <device> responded with DF1 error: Data Link Layer NAK. 37 Device <device> responded with DF1 error: Frame received failed checksum validation. 38 Device <device> responded with DF1 error: No data received. 38 Device <device> responded with DF1 error: Slave sink/source full. 38 Device <device> responded with DF1 error: Status Code=<status code>. 38 Fragmentation Protocol NAK, Error Code=<error code>. 39 Frame received from device <device> contains errors. 39 Unexpected Fragmentation Command <command>. 39 Unexpected Fragmentation Function received. 39 Device Specific Messages 39 Device <device name> is not responding. 40 Encapsulation error occurred during a request to device <device name>. [Encap. Error=<code>]. 40 Error occurred during a request to device <device name>. [CIP Error=<code>, Ext. Error=<code>]. 40 Read Errors (Blocking) 41 Read request for <count> element(s) starting at <tag address> on device <device name> failed due to a framing error. Block Deactivated. 41 Unable to read <count> element(s) starting at <tag address> on device <device name>. [CIP Error=<code>, Ext. Error=<code>]. 41 Unable to read <count> element(s) starting at <tag address> on device <device name>. Block deactivated. 41 Unable to read <count> element(s) starting at <tag address> on device <device name>. Block does not support multi-element arrays. Block Deactivated. 42 Unable to read <count> element(s) starting at <tag address> on device <device name>. Data type <type> is illegal for this block. 42 Unable to read <count> element(s) starting at <tag address> on device <device name>. Data type <type> not supported. 42 Unable to read <count> element(s) starting at <tag address> on device <device name>. Native Tag data type <type> unknown. Block deactivated. 43 Write Errors 43 Unable to write to <tag address> on device <device name>. 43 Unable to write to tag <tag address> on device <device name>. [CIP Error=<code>, Ext. Status=<code>]. 43 Unable to write to tag <tag address> on device <device name>. Data type <type> is illegal for this tag. 44 Unable to write to tag <tag address> on device <device name>. Data type <type> not supported. 44 Unable to write to tag <tag address> on device <device name>. Native Tag data type <type> unknown. 44 Unable to write to tag <tag address> on device <device name>. Tag does not support multi-element arrays. 44 Write request for tag <tag address> on device <device name> failed due to a framing error. 45 Read Errors (Non-Blocking) 45 Read request for tag <tag address> on device <device name> failed due to a framing error. Tag deactivated. 45 Unable to read <tag address> on device <device name>. Tag deactivated. 45 Unable to read tag <tag address> on device <device name>. [CIP Error=<code>, Ext. Error=<code>]. 46

4 4 Unable to read tag <tag address> on device <device name>. Data type <type> is illegal for this tag. Tag deactivated. 46 Unable to read tag <tag address> on device <device name>. Data type <type> not supported. Tag deactivated. 46 Unable to read tag <tag address> on device <device name>. Native Tag data type <type> unknown. Tag deactivated. 46 Unable to read tag <tag address> on device <device name>. Tag does not support multi-element arrays. Tag deactivated. 47 Glossary 48 Index 49

5 5 Help version CONTENTS Overview What is the Allen-Bradley Micro800 Serial driver? Channel Setup How do I configure the channel's link settings? Device Setup How do I configure a device for use with this driver? Performance Optimizations How do I get the best performance from the Allen-Bradley Micro800 Serial driver? Data Types Description What data types does this driver support? Address Descriptions How do I address a tag on an Allen-Bradley Micro800 Serial device? Error Codes What are the Allen-Bradley Micro800 Serial error codes? Error Descriptions What error messages does this driver produce? Glossary Where can I find a list of terms relating to the Allen-Bradley Micro800 Serial driver? Overview The Allen-Bradley Micro800 Serial Driver provides a reliable way to connect Allen-Bradley Micro800 controllers over Serial to OPC client applications, including HMI, SCADA, Historian, MES, ERP, and countless custom applications.

6 6 Channel Setup Link Settings Descriptions of the parameters are as follows: Station ID: This parameter specifies a unique Network ID for the local machine. It should be set based on the device with which it is communicating (excluding radio modems). The format is in decimal. The default setting is 0. Link Protocol: This parameter specifies the link protocol that will be used for communications. The default setting is Full Duplex. Only Accept Responses for Station ID: When checked, this parameter limits the acceptance of responses to those that are destined for the station as indicated by the Station ID. This parameter only applies to Full Duplex. The default setting is unchecked. Note: If the destination device is on a DH+ or DH-485 network, communication must go through a Serialto-DH+/DH-485 converter (that is, a KF2/KF3 module). In this case, the device being communicated with is the converter and not the destination device itself. For this configuration, the Station ID should be set to the converter's node address. The range for DH-4850 is 1 to 63. If the destination device is not on a DH+ or DH-485 network, the device being communicated with is a Micro800. The Station ID for this configuration can be set to an arbitrary unique address. The range is 0 to 255.

7 7 Device Setup Supported Devices Micro830 Micro850 Note: The connection is made over an embedded Serial port or plug-in Serial module. Communication Protocol Rockwell Automation Fragmentation Protocol (CIP over DF1). Maximum Number of Channels and Devices The maximum number of channels supported is 256. The maximum number of devices supported is Device ID The Device ID is the PLC's network address. For PLCs on a DH-485 or DH+ network, the range is 1 to 63. Otherwise, the range is 0 to 255. For Full Duplex, use the default address (1). For Half-Duplex, match the slave address. For Radio Modem, match the slave/peer address. Ethernet Encapsulation This driver supports Ethernet Encapsulation, which allows the driver to communicate with serial devices attached to an Ethernet network using a terminal server. Ethernet Encapsulation mode may be invoked through the COM ID dialog in Channel Properties. For more information, refer to the server's help documentation. DH-485 and DH+ Support An Allen Bradley KF3 or compatible device is needed to connect the driver to the DH-485 network. There are four options for communicating to a device on DH+ using the Allen-Bradley Micro800 Serial Driver. Allen Bradley KF2 or compatible device U2DHP USB converter. This converter appears as a new serial port to the system. DataLink DL Interface Cards (PCI/ISA/PC104). These cards add virtual serial ports for seamless configuration. DataLink DL4500 Ethernet-to-DH+ Converter. Configure the device for Ethernet Encapsulation. NIC is required. Cable Diagram

8 8 Communications Parameters Error Detection Description of the parameter is as follows: Error Detection: This parameter specifies the method of error detection. Options include BCC (Block Check Character) and CRC (Cyclic Redundancy Check). Users must choose the checksum method expected by the device; otherwise, the device will fail requests. The default setting is CRC. CIP - Watchdog

9 9 Description of the parameter is as follows: Inactivity Watchdog: This parameter specifies the amount of time a connection can remain idle (without Read/Write transactions) before being closed by the controller. In general, the larger the watchdog value, the more time it will take for connection resources to be released by the controller (and vice versa). The default setting is 32 seconds. Options Project Description of the parameter is as follows: Default Data Type: This parameter specifies the data type that will be assigned to a Client/Server Tag when the default type is selected during tag addition/modification/import. The default setting is Float. Default Data Type Conditions Client/Server Tags are assigned the default data type when any of the following conditions occur: 1. A Dynamic Tag is created in the client with Native as its assigned data type. 2. A Static Tag is created in the server with Default as its assigned data type. Data Access

10 10 Description of the parameter is as follows: Array Block Size: This parameter specifies the maximum number of atomic array elements that will be read in a single transaction. The value is adjustable and ranges from 30 to 3840 elements. The default setting is 120 elements. Note: For Boolean arrays, a single element is considered a 32 element bit array. Thus, setting the block size to 30 elements translates to 960 bit elements, whereas 3840 elements translate to bit elements.

11 11 Performance Optimizations Several guidelines may be applied to the Allen-Bradley Micro800 Serial Driver to gain maximum performance. For more information on optimization at the communication and application levels, select a link from the list below. Optimizing Communications Optimizing Application Optimizing Communications As with any programmable controller, there are a variety of ways to enhance the overall performance and system communications. Keep Native Tag Names Short Native Tags read from and write to the device by specifying its symbolic name in the communications request. As such, the longer the tag name is, the larger the request will be. Array Elements Blocked To optimize the reading of atomic array elements, read a block of the array in a single request instead of individually. The more elements read in a block, the greater the performance. Since transaction overhead and processing consumes the most time, do as few transactions as possible while scanning as many desired tags as possible. This is the essence of array element blocking. Block sizes are specified as an element count. A block size of 120 elements means that a maximum of 120 array elements will be read in one request. The maximum block size is 3840 elements. Boolean arrays are treated differently: in protocol, a Boolean array is a 32 bit array. Thus, requesting element 0 is requesting bits 0 through 31. To maintain consistency in discussion, a Boolean array element will be considered a single bit. In summary, the maximum number of array elements (based on block size of 3840) that can be requested is as follows: BOOL, 3840 SINT, 3840 INT, 3840 DINT, 3840 LINT, and 3840 REAL. The block size is adjustable, and should be chosen based on the project at hand. For example, if array elements 0-26 and element 3839 are tags to be read, then using a block size of 3840 is not only overkill, but detrimental to the driver's performance. This is because all elements between 0 and 3839 will be read on each request, even though only 28 of those elements are of importance. In this case, a block size of 30 is more appropriate. Elements 0-26 would be serviced in one request and element 3839 would be serviced on the next. See Also: Options Optimizing Applications The Allen-Bradley Micro800 Serial Driver has been designed to provide the best performance with the least amount of impact on the system's overall performance. While the Allen-Bradley Micro800 Serial Driver is fast, there are a couple of guidelines that can be used in order to gain maximum performance. The server refers to communications protocols like Allen-Bradley Micro800 Serial as a channel. Each channel defined in the application represents a separate path of execution in the server. Once a channel has been defined, a series of devices must then be defined under that channel. Each of these devices represents a single Micro800 CPU from which data will be collected. While this approach to defining the application will provide a high level of performance, it won't take full advantage of the Allen-Bradley Micro800 Serial Driver or the network. An example of how the application may appear when configured using a single channel is shown below.

12 12 Each device appears under a single channel, called "Micro800". In this configuration, the driver must move from one device to the next as quickly as possible in order to gather information at an effective rate. As more devices are added or more information is requested from a single device, the overall update rate begins to suffer. If the Allen-Bradley Micro800 Serial Driver could only define one single channel, then the example shown above would be the only option available; however, the Allen-Bradley Micro800 Serial Driver can define up to 256 channels. Using multiple channels distributes the data collection workload by simultaneously issuing multiple requests to the network. An example of how the same application may appear when configured using multiple channels to improve performance is shown below. Each device has now been defined under its own channel. In this new configuration, a single path of execution is dedicated to the task of gathering data from each device. If the application has 256 or fewer devices, it can be optimized exactly how it is shown here. The performance will improve even if the application has more than 256 devices. While 256 or fewer devices may be ideal, the application will still benefit from additional channels. Although spreading the device load across all channels will cause the server to move from device to device again, it can now do so with far less devices to process on a single channel.

13 13 Data Types Description Data Type Boolean Byte Char Word Short DWord Long BCD LBCD Float Double Date String Description Single bit Unsigned 8-bit value Signed 8-bit value Unsigned 16-bit value Signed 16-bit value Unsigned 32-bit value Signed 32-bit value Two byte packed BCD, four decimal digits Four byte packed BCD, eight decimal digits 32-bit IEEE Floating point 64-bit IEEE Floating point 64-bit Date/Time Null terminated character array Address Descriptions Micro800 uses a tag or symbol-based addressing structure referred to as Native Tags. These tags differ from conventional PLC data items in that the tag name itself is the address, not a file or register number. The Allen-Bradley Micro800 Serial Driver allows users to access the controller's atomic data types: BOOL, SINT, USINT, BYTE, INT, UINT, WORD, DINT, UDINT, DWORD, LINT, ULINT, LWORD, REAL, LREAL, and SHORT_ STRING. Although some of the pre-defined types are structures, they are ultimately based on these atomic data types. Thus, all non-structure (atomic) members of a structure are accessible. For example, a TIMER cannot be assigned to a server tag but an atomic member of the TIMER can be assigned to the tag (for example, TIMER.EN, TIMER.ACC, and so forth). If a structure member is a structure itself, both structures must be expanded to access an atomic member of the substructure. This is more common with user-defined and module-defined types, and is not found in any of the pre-defined types. Atomic Data Type Description Client Type Range BOOL Single bit value VT_BOOL 0, 1 SINT Signed 8 bit value VT_U1-128 to 127 USINT Unsigned 8 bit value VT_UI1 0 to 255 BYTE Bit string (8 bits) VT_UI1 0 to 255 INT Signed 16 bit value VT_I2-32,768 to 32,767 UINT Unsigned 16 bit value VT_UI2 0 to WORD Bit string (16 bits) VT_UI2 0 to DINT Signed 32 bit value VT_I4-2,147,483,648 to 2,147,483,647 UDINT Unsigned 32 bit value VR_UI4 0 to DWORD Bit string (32 bits) VR_UI4 0 to LINT Signed 64 bit value VT_R E+308 to E-308, 0, 2.225E-308 to 1.798E+308 ULINT Unsigned 64 bit value VT_R E+308 to E-308, 0, 2.225E-308 to 1.798E+308 LWORD Bit string (64 bits) VT_R E+308 to E-308, 0, 2.225E-308 to 1.798E+308 REAL LREAL SHORT_STRING 32 bit IEEE Floating point 64 bit IEEE Floating point Character string. The maximum number of characters allowed is 80. VT_R E-38 to 3.403E38, 0, E- 38 to VT_R E+308 to E-308, 0, 2.225E-308 to 1.798E+308 VT_BSTR See Also: Advanced Use Cases Client/Server Tag Address Rules

14 14 Native Tag names correspond to Client/Server Tag addresses. Both Native Tag names (entered via the Connected Components Workbench) and Client/Server Tag addresses follow the IEC identifier rules. Descriptions of the rules are as follows: Must begin with an alphabetic character or an underscore Can only contain alphanumeric characters and underscores Can have as many as 40 characters Cannot have consecutive underscores Characters are not case sensitive Note: For optimum performance, keep Native Tag names to a minimum in size. The smaller the name, the more requests that can fit in a single transaction. Client/Server Tag Name Rules Tag name assignment in the server differs from address assignment in that names cannot begin with an underscore. See Also: Performance Optimizations Address Formats A Native Tag may be addressed statically in the server or dynamically from a client in several ways. The tag's format will depend on its type and intended usage. For example, the bit format would be used when accessing a bit within a SINT-type tag. For information on address format and syntax, refer to the table below. Note: Every format is native to Connected Components Workbench (CCW) except for the Array formats. Therefore, when referencing an atomic data type, a CCW tag name could be copied and pasted into the server's tag address field and be valid. See Also: Advanced Use Cases Format Syntax Array Element <Native Tag name> [dim 1, dim2, dim 3] Array w/ * * Bit Standard String <Native Tag name> {# columns} <Native Tag name> {# rows}{# columns} <Native Tag name> {# columns} <Native Tag name> {# rows}{# columns} <Native Tag name>.bit <Native Tag name>.[bit] <Native Tag name> <Native Tag name> *Since these formats may request more than one element, the order in which array data is passed depends on the dimension of the array tag. For example, if rows times cols = 4 and the Native Tag is a 3X3 element array, then the elements that are being referenced are array_tag [0,0], array_tag [0,1], array_tag [0,2], and array_tag [1,0] in that exact order. The results would be different if the Native Tag were a 2X10 element array. For more information, refer to Ordering of Array Data. Expanded Address Formats Array Element At least 1 dimension (but no more then 3) must be specified. Syntax Example Notes <Native Tag Name> [dim1] tag_1 [5] N/A <Native Tag name> [dim 1, dim2] tag_1 [2, 3] N/A <Native Tag name> [dim 1, dim2, dim 3] tag_1 [2, 58, 547] N/A Array With Since this class may request more than one element, the order in which array data is passed depends on the dimension of the Array Tag. Syntax Example Notes <Native tag_1 [5] The number of elements to Read/Write equals the number of rows multiplied by the

15 15 Syntax Example Notes Tag name> [offset] {# of columns} <Native Tag name> [offset] {# of rows}{# of columns} {8} number of columns. If no rows are specified, the number of rows will default to 1. At least 1 element of the array must be addressed. tag_1 [5] {2}{4} The array begins at a zero offset (array index equals 0 for all dimensions). Note: If rows*cols = 4 and the Native Tag is a 3X3 element array, then the elements that are being referenced are array_tag [0,0], array_tag [0,1], array_tag [0,2] and array_tag [1,0] in that exact order. The results would be different if the Native Tag were a 2X10 element array. Array Without Since this class may request more than one element, the order in which array data is passed depends on the dimension of the Array Tag. Syntax Example Notes <Native Tag name> {# of columns} <Native Tag name> {# of rows}{# of columns} tag_1 {8} tag_1 {2}{4} The number of elements to Read/Write equals the number of rows multiplied by the number of columns. If no rows are specified, the number of rows will default to 1. At least 1 element of the array must be addressed. The array begins at a zero offset (array index equals 0 for all dimensions). Note: For example, if rows*cols = 4 and the Native Tag is a 3X3 element array, then the elements that are being referenced are array_tag [0,0], array_tag [0,1], array_tag [0,2] and array_tag [1,0] in that exact order. The results would be different if the Native Tag were a 2X10 element array. Bit Syntax Example Notes <Native Tag name>. bit tag_1. 0 N/A <Native Tag name>. [bit] tag_1. [0] N/A Standard Syntax Example Notes <Native Tag name> tag_1 N/A String Syntax Example Notes <Native Tag name> tag_1 The number of characters to Read/Write equals the string length and must be at least 1. Note: For more information on how elements are referenced for 1, 2 and 3 dimensional arrays, refer to Ordering of Array Data. Tag Scope The scope of variables can be local to a program or global to a controller. Local variables are assigned to a specific program in the project; they are available only to that program. Global variables belong to the controller in the project; they are available to any program in the project. Local Variables

16 16 Local variables (program-scoped tags) cannot be accessed directly through the communications port of the controller, so are not directly supported within the driver. If access is required, cut and paste the tags from the Local variable table to the Global variable table. Global Variables Global Variables (controller-scoped tags) are Native Tags that have global scope in the controller. Any program or task can access Global Tags; however, the number of ways a Global Tag can be referenced depends on both its Native Data Type and the address format being used. User-Defined Data Types Users may create unique data types, e.g. STRING with 12 characters rather than 80. These user-defined data types may be used as local or global variables. Structured Variables There are no structured variables in Micro800 controllers. Users may build unique Data Types, but each member must have a unique name. Addressing Atomic Data Types The table below contains suggested usage and addressing possibilities for each Native Data Type given the available address formats. For each data type's advanced addressing possibilities, click Advanced. Note: Empty cells do not necessarily indicate a lack of support. BOOL Tag Standard Array Element Array w/wo Bit String Data Type Advanced Boolean Boolean (BOOL 1 dimensional array) Boolean Array (BOOL 1 dimensional array) Example BOOLTAG BOOLARR[0] BOOLARR[0]{32} SINT, USINT, and BYTE Tag Standard Array Element Array w/wo Bit String Data Type Advanced Byte, Char Byte, Char Byte Array, Char Array (SINT 1/2/3 dimensional array) Boolean (Bit w/i SINT) Example SINTTAG SINTARR[0] SINTARR[0]{4} SINTTAG.0 j INT, UINT, and WORD Tag Standard Array Element Bit String Data Type Advanced Word, Short Word, Short Word Array, Short Array (INT 1/2/3 dimensional array) Boolean (Bit w/i INT) Example INTTAG INTARR[0] INTARR[0]{4} INTTAG.0 DINT, UDINT, and DWORD Tag Standard Array Element Array w/wo Bit String Data Type Advanced DWord, Long DWord, Long DWord Array, Long Array Boolean (Bit w/i DINT) Example DINTTAG DINTARR[0] DINTARR[0]{4} DINTTAG.0 LINT, ULINT, and LWORD Advanced Tag Standard Array Element Array w/wo Bit String Data Type Advanced Double, Date Double, Date Double Array Example LINTTAG LINTARR[0] LINTARR[0]{4}

17 17 REAL Tag Standard Array Element Array w/wo Bit String Data Type Float Float Float Array Advanced Example REALTAG REALARR[0] REALARR[0]{4} LREAL Tag Standard Array Element Array w/wo Bit String Data Type Double Double Double Array Advanced Example LREALTAG LREALARR[0] LREALARR[0]{4} SHORT_STRING Tag Standard Array Element Array w/wo Bit String Data Type String String Advanced Example STRINGTAG STRINGARR[0] See Also: Address Formats Addressing Structured Data Types Structures cannot be referenced at the structure level: only the atomic structure members can be addressed. For more information, refer to the examples below. Native Tag TIMER Valid Client/Server Tag Address = MyTimer.ACC Data type = DWord Invalid Client/Server Tag Address = MyTimer Data type =?? Addressing STRING Data Type STRING is a pre-defined Native Data Type whose structure contains two members: DATA and LEN. DATA is an array of SINTs and stores the characters of the string. LEN is a DINT and represents the number of characters in DATA to display to a client. Note: Because LEN and Data are atomic members, they must be referenced independently from the client/server. Description Syntax Example STRING Value DATA/<Maximum STRING Length> MYSTRING.DATA/82 Actual STRING Length LEN MYSTRING.LEN Reads The string read from DATA will be terminated by the following: a. The first null terminator encountered. b. The value in LEN if a) doesn't occur first. c. The <Maximum STRING Length> if either a) or b) doesn't occur first. Example MYSTRING.DATA contains "Hello World" in the PLC, but LEN is manually set to 5. A read of MYSTRING.DATA/82 will display "Hello". If LEN is set to 20, MYSTRING.DATA/82 will display "Hello World".

18 18 Writes When a STRING value is written to DATA, the driver will also write to LEN with the length of DATA written. If the write to LEN fails for any reason, the write operation to DATA will be considered failed as well (despite the fact that the DATA write to the controller succeeded). Note: This behavior was designed specifically for Native Tags of type STRING (or a custom derivative of STRING). The following precautions apply to users who wish to implement their own string in UDTs. If a UDT exists that has a DATA member referenced as a string and a LEN member referenced as a DINT, the write to LEN will succeed regardless of the intentions of LEN for the given UDT. Care must be taken when designing UDTs to avoid this possibility if LEN is not intended to be the length of DATA. If a UDT exists that has a DATA member referenced as a string but does not have a LEN member, the write to LEN will fail silently without consequence to DATA. Example MYSTRING.DATA/82 holds the value "Hello World." MYSTRING.LEN holds 11. If the value "Alarm Triggered" is written to MYSTRING.DATA/82, 15 will be written to MYSTRING.LEN. If the write to MYSTRING.LEN fails, MYSTRING.LEN will hold its previous value of 11 while MYSTRING.DATA/82 displays the first 11 characters ("Alarm Trigg"). If the write to MYSTRING.DATA/82 fails, neither tag is affected. Ordering of Array Data Dimensional Arrays - array [dim1] 1 dimensional array data is passed to and from the controller in ascending order. for (dim1 = 0; dim1 < dim1_max; dim1++) Example: 3 element array array [0] array [1] array [2] Dimensional Arrays - array [dim1, dim2] 2 dimensional array data is passed to and from the controller in ascending order. for (dim1 = 0; dim1 < dim1_max; dim1++) for (dim2 = 0; dim2 < dim2_max; dim2++) Example: 3X3 element array array [0, 0] array [0, 1] array [0, 2] array [1, 0] array [1, 1] array [1, 2] array [2, 0] array [2, 1] array [2, 2] Dimensional Arrays - array [dim1, dim2, dim3] 3 dimensional array data is passed to and from the controller in ascending order. for (dim1 = 0; dim1 < dim1_max; dim1++) for (dim2 = 0; dim2 < dim2_max; dim2++) for (dim3 = 0; dim3 < dim3_max; dim3++) Example: 3X3x3 element array array [0, 0, 0] array [0, 0, 1] array [0, 0, 2] array [0, 1, 0] array [0, 1, 1] array [0, 1, 2] array [0, 2, 0] array [0, 2, 1] array [0, 2, 2] array [1, 0, 0] array [1, 0, 1]

19 19 array [1, 0, 2] array [1, 1, 0] array [1, 1, 1] array [1, 1, 2] array [1, 2, 0] array [1, 2, 1] array [1, 2, 2] array [2, 0, 0] array [2, 0, 1] array [2, 0, 2] array [2, 1, 0] array [2, 1, 1] array [2, 1, 2] array [2, 2, 0] array [2, 2, 1] array [2, 2, 2] Advanced Use Cases For more information on the advanced use cases for a specific atomic data type, select a link from the list below. BOOL SINT, USINT, and BYTE INT, UINT, and WORD DINT, UDINT, and DWORD LINT, ULINT, and LWORD REAL LREAL SHORT_STRING BOOL For more information on the format, refer to Address Formats. Format Supported Data Types Notes Array Element Boolean The Native Tag must be a 1 dimensional array. Array w/ Boolean Array 1. The Native Tag must be a 1 dimensional array. 2. The offset must lay on a 32-bit boundary. 3. The number of elements must be a factor of 32. Boolean Array 1. The Native Tag must be a 1 dimensional array. 2. The number of elements must be a factor of 32. Bit Boolean 1. The Native Tag must be a 1 dimensional array. Standard String Boolean, Byte, Char, Word, Short, BCD, DWord, Long, LBCD, Float* Not supported. None 2. The range is limited from 0 to 31. *The Float value will equal the face value of the Native Tag in Float form (non-ieee Floating point number). Examples Examples highlighted in yellow signify common use cases. BOOL Atomic Tag - booltag = True

20 20 Server Tag Address Format Data Type Notes booltag Standard Boolean Value = True booltag Standard Byte Value = 1 booltag Standard Word Value = 1 booltag Standard DWord Value = 1 booltag Standard Float Value = 1.0 booltag [3] Array Element Boolean Invalid: Tag is not an array. booltag [3] Array Element Word Invalid: Tag is not an array. booltag {1} Word Invalid: Not supported. booltag {1} Boolean Invalid: Not supported. booltag [3] {32} Array w/ Boolean Invalid: Tag is not an array. booltag. 3 Bit Boolean Invalid: Tag is not an array. booltag / 1 String String Invalid: Not supported. booltag / 4 String String Invalid: Not supported. BOOL Array Tag - bitarraytag = [0,1,0,1] Server Tag Address Format Data Type Notes bitarraytag Standard Boolean Invalid: Tag cannot be an array. bitarraytag Standard Byte Invalid: Tag cannot be an array. bitarraytag Standard Word Invalid: Tag cannot be an array. bitarraytag Standard DWord Invalid: Tag cannot be an array. bitarraytag Standard Float Invalid: Tag cannot be an array. bitarraytag [3] Array Element Boolean Value = True bitarraytag [3] Array Element Word Invalid: Bad data type. bitarraytag {3} Word Invalid: Tag cannot be an array. bitarraytag {1} Word Invalid: Tag cannot be an array. bitarraytag {1} Boolean Invalid: Array size must be a factor of 32. bitarraytag {32} Boolean Value = [0,1,0,1,...] bitarraytag [3] {32} Array w/ Boolean must begin on 32-bit boundary. bitarraytag[0]{32} Array w/ Boolean Value = [0,1,0,1,...] bitarraytag[32]{64} Array w/ Boolean Syntax valid. Element is out of range. bitarraytag. 3 Bit Boolean Value = True bitarraytag / 1 String String Invalid: Not supported. bitarraytag / 4 String String Invalid: Not supported. SINT, USINT, and BYTE For more information on the format, refer to Address Formats. Format Supported Data Types Notes Array Element Array w/ Byte, Char, Word, Short, BCD, DWord, Long, LBCD, Float*** Byte Array, Char Array, Word Array, Short Array, BCD Array**, DWord Array, Long Array, LBCD Array**, Float Array**,*** Boolean Array The Native Tag must be an array. The Native Tag must be an array. 1. Use this case to have the bits within an SINT in array form. This is not an array of SINTs in Boolean notation. 2. Applies to bit-within-sint only. Example: tag_1.0{8}. Byte Array, Char Array, Word Array, Short Array, BCD Array**, DWord Array, Long Array, LBCD Array**, Float Array**,*** 3. The.bit plus the array size cannot exceed 8 bits. Example: tag_1.1 {8} exceeds an SINT, tag_1.0{8} does not. If accessing more than a single element, the Native Tag must be

21 21 Format Supported Data Types Notes an array. Bit Boolean 1. The range is limited from 0 to 7. Standard Boolean*, Byte, Char, Word, Short, BCD, DWord, Long, LBCD, Float*** None 2. If the Native Tag is an array, the bit class reference must be prefixed by an array element class reference. Example: tag_1 [2,2,3].0. String String 1. If accessing a single element, the Native Tag does not need to be an array. Note: The value of the string will be the ASCII equivalent of the SINT value. Example: SINT = 65dec = "A". 2. If accessing more than a single element, the Native Tag must be an array. The value of the string will be the null-terminated ASCII equivalent of all the SINTs in the string. 1 character in string = 1 SINT. *Non-zero values will be clamped to True. **Each element of the array corresponds to an element in the SINT array. Arrays are not packed. ***Float value will equal face value of Native Tag in Float form (non-ieee Floating point number). Examples Examples highlighted in yellow signify common use cases for SINT, USINT, and BYTE. SINT, USINT, and BYTE Atomic Tag - sinttag = 122 (decimal) Server Tag Address Format Data Type Notes sinttag Standard Boolean Value = True sinttag Standard Byte Value = 122 sinttag Standard Word Value = 122 sinttag Standard DWord Value = 122 sinttag Standard Float Value = sinttag [3] Array Element Boolean Invalid: Tag is not an array. Also, Boolean is invalid. sinttag [3] Array Element Byte Invalid: Tag is not an array. sinttag {3} Byte Invalid: Tag is not an array. sinttag {1} Byte Value = [122] sinttag {1} Boolean Invalid: Bad data type. sinttag [3] {1} Array w/ Byte Invalid: Tag is not an array. sinttag. 3 Bit Boolean Value = True sinttag. 0 {8} Boolean Value = [0,1,0,1,1,1,1,0] Bit value of 122 sinttag / 1 String String Invalid: Syntax / data type not supported. sinttag / 4 String String Invalid: Syntax / data type not supported. SINT, USINT, and BYTE Array Tag - sintarraytag [4,4] = [[83,73,78,84],[5,6,7,8],[9,10,11,12], [13,14,15,16]] Server Tag Address Format Data Type Notes sintarraytag Standard Boolean Invalid: Tag cannot be an array.

22 22 Server Tag Address Format Data Type Notes sintarraytag Standard Byte Invalid: Tag cannot be an array. sintarraytag Standard Word Invalid: Tag cannot be an array. sintarraytag Standard DWord Invalid: Tag cannot be an array. sintarraytag Standard Float Invalid: Tag cannot be an array. sintarraytag [3] Array Element Byte Invalid: Server tag missing dimension 2 address. sintarraytag [1,3] Array Element Boolean Invalid: Boolean not allowed for array elements. sintarraytag [1,3] Array Element Byte Value = 8 sintarraytag {10} sintarraytag {2} {5} sintarraytag {1} sintarraytag {1} Byte Value = [83,73,78,84,5,6,7,8,9,10] Word Value = [83,73,78,84,5] [6,7,8,9,10] Byte Value = 83 Boolean Invalid: Bad data type. sintarraytag [1,3] {4} Array w/ Byte Value = [8,9,10,11] sintarraytag. 3 Bit Boolean Invalid: Tag must reference atomic location. sintarraytag [1,3]. 3 Bit Boolean Value = 1 sintarraytag [1,3]. 0 {8} Boolean Value = [0,0,0,1,0,0,0,0] sintarraytag / 1 String String Invalid: Syntax / data type not supported. sintarraytag / 4 String String Invalid: Syntax / data type not supported. INT, UINT, and WORD For more information on the format, refer to Address Formats. Format Supported Data Types Notes Array Element Array w/ Byte, Char**, Word, Short, BCD, DWord, Long, LBCD, Float**** Byte Array, Char Array**, Word Array, Short Array, BCD Array, DWord Array, Long Array, LBCD Array***, Float Array ***,**** Boolean Array Byte Array, Char Array**, Word Array, Short Array, BCD Array, DWord Array, Long Array, LBCD Array ***, Float Array ***,**** The Native Tag must be an array. The Native Tag must be an array. 1. Use this case to have the bits within an INT in array form. This is not an array of INTs in Boolean notation. 2. Applies to bit-within-int only. Example: tag_1.0{16}. 3. The.bit plus the array size cannot exceed 16 bits. Example: tag_1.1 {16} exceeds an INT, tag_1.0 {16} does not. If accessing more than a single element, the Native Tag must be an array. Bit Boolean 1. The range is limited from 0 to 15. Standard Boolean*, Byte, Char**, Word, Short, BCD, DWord, Long, LBCD, Float**** None 2. If the Native Tag is an array, the bit class reference must be prefixed by an array element class reference. Example: tag_1 [2,2,3].0. String String 1. If accessing a single element, the controller tag does not need to be

23 23 Format Supported Data Types Notes an array. Note: The value of the string will be the ASCII equivalent of the INT value (clamped to 255). Example: INT = 65dec = "A". 2. If accessing more than a single element, the Native Tag must be an array. The value of the string will be the null-terminated ASCII equivalent of all the INTs (clamped to 255) in the string. 1 character in string = 1 INT, clamped to 255. Note: INT strings are not packed. For greater efficiency, use SINT strings or the STRING structure instead. *Non-zero values will be clamped to True. **Values exceeding 255 will be clamped to 255. *** Each element of the array corresponds to an element in the INT array. Arrays are not packed. ****Float value will equal face value of Native Tag in Float form (non-ieee Floating point number). Examples Examples highlighted in yellow signify common use cases for INT, UINT, and WORD. INT, UINT, and WORD Atomic Tag - inttag = (decimal) Server Tag Address Class Data Type Notes inttag Standard Boolean Value = True inttag Standard Byte Value = 255 inttag Standard Word Value = inttag Standard DWord Value = inttag Standard Float Value = inttag [3] Array Element Boolean Invalid: Tag is not an array. Also, Boolean is invalid. inttag [3] Array Element Word Invalid: Tag is not an array. inttag {3} Word Invalid: Tag is not an array. inttag {1} Word Value = [65534] inttag {1} Boolean Invalid: Bad data type. inttag [3] {1} Array w/ Word Invalid: Tag is not an array. inttag. 3 Bit Boolean Value = True inttag. 0 {16} Boolean Value = [0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1] Bit value of inttag / 1 String String Invalid: Syntax / data type not supported. inttag / 4 String String Invalid: Syntax / data type not supported. INT, UINT, and WORD Array Tag - intarraytag [4,4] = [[73,78,84,255],[256,257,258,259], [9,10,11,12],[13,14,15,16]] Server Tag Address Class Data Type Notes intarraytag Standard Boolean Invalid: Tag cannot be an array. intarraytag Standard Byte Invalid: Tag cannot be an array. intarraytag Standard Word Invalid: Tag cannot be an array. intarraytag Standard DWord Invalid: Tag cannot be an array. intarraytag Standard Float Invalid: Tag cannot be an array.

24 24 Server Tag Address Class Data Type Notes intarraytag [3] Array Element Word Invalid: Server tag is missing dimension 2 address. intarraytag [1,3] Array Element Boolean Invalid: Boolean not allowed for array elements. intarraytag [1,3] Array Element Word Value = 259 intarraytag {10} intarraytag {2} {5} intarraytag {1} intarraytag {1} Byte Value = [73,78,84,255,255,255,255,255,9,10] Word Value = [73,78,84,255,256] [257,258,259,9,10] Word Value = 73 Boolean Invalid: Bad data type. intarraytag [1,3] {4} Array w/ Word Value = [259,9,10,11] intarraytag. 3 Bit Boolean Invalid: Tag must reference atomic location. intarraytag [1,3]. 3 Bit Boolean Value = 0 intarraytag [1,3]. 0 {16} Boolean Value = [1,1,0,0,0,0,0,0,1,0,0,0,0,0,0,0] Bit value for 259 intarraytag / 1 String String Invalid: Syntax / data type not supported. intarraytag / 3 String String Invalid: Syntax / data type not supported. DINT, UDINT, and DWORD For more information on the format, refer to Address Formats. Format Supported Data Types Notes Array Element Array w/ Byte, Char**, Word, Short, BCD***, DWord, Long, LBCD, Float**** Byte Array, Char Array**, Word Array, Short Array, BCD Array***, DWord Array, Long Array, LBCD Array, Float Array**** Boolean Array Byte Array, Char Array**, Word Array, Short Array, BCD Array***, DWord Array, Long Array, LBCD Array, Float Array**** The Native Tag must be an array. The Native Tag must be an array. 1. Use this case to have the bits within an DINT in array form. This is not an array of DINTs in Boolean notation. 2. Applies to bit-within-dint only. Example: tag_1.0{32}. 3. The.bit plus the array size cannot exceed 32 bits. Example: tag_1.1 {32} exceeds an DINT, tag_1.0 {32} does not. If accessing more than a single element, the Native Tag must be an array. Bit Boolean 1. The range is limited from 0 to 31. Standard Boolean* Byte, Char** Word, Short, BCD*** DWord, Long, LBCD Float**** None 2. If Native Tag is an array, bit class reference must be prefixed by an array element class reference. Example: tag_1 [2,2,3].0. String String 1. If accessing a single element, the controller tag does not need to be an array.

25 25 Format Supported Data Types Notes Note: The value of the string will be the ASCII equivalent of the DINT value (clamped to 255). Example: SINT = 65dec = "A". 2. If accessing more than a single element, the Native Tag must be an array. The value of the string will be the null-terminated ASCII equivalent of all the DINTs (clamped to 255) in the string. 1 character in string = 1 DINT, clamped to 255. Note: DINT strings are not packed. For greater efficiency, use SINT strings or the STRING structure instead. *Non-zero values will be clamped to True. **Values exceeding 255 will be clamped to 255. ***Values exceeding will be clamped to ****Float value will equal face value of Native Tag in Float form (non-ieee Floating point number). Examples Examples highlighted in yellow signify common use cases for DINT, UDINT, and DWORD. DINT, UDINT, and DWORD Atomic Tag - dinttag = (decimal) Server Tag Address Format Data Type Notes dinttag Standard Boolean Value = True dinttag Standard Byte Value = 255 dinttag Standard Word Value = dinttag Standard DWord Value = dinttag Standard Float Value = dinttag [3] Array Element Boolean Invalid: Tag is not an array. Also, Boolean is invalid. dinttag [3] Array Element DWord Invalid: Tag is not an array. dinttag {3} dinttag {1} dinttag {1} DWord Invalid: Tag is not an array. DWord Value = [70000] Boolean Invalid: Bad data type dintag [3] {1} Array w/ DWord Invalid: Tag is not an array. dinttag. 3 Bit Boolean Value = False dinttag. 0 {32} Boolean Value = [0,0,0,0,1,1,1,0,1,0,0,0,1,0,0,0,1,0,...0] Bit value for dinttag String String Invalid: Syntax / data type not supported. dinttag String String Invalid: Syntax / data type not supported. DINT, UDINT, and DWORD Array Tag - dintarraytag [4,4] = [[68,73,78,84],[256,257,258,259], [9,10,11,12],[13,14,15,16]] Server Tag Address Format Data Type Notes dintarraytag Standard Boolean Invalid: Tag cannot be an array. dintarraytag Standard Byte Invalid: Tag cannot be an array. dintarraytag Standard Word Invalid: Tag cannot be an array. dintarraytag Standard DWord Invalid: Tag cannot be an array.

26 26 Server Tag Address Format Data Type Notes dintarraytag Standard Float Invalid: Tag cannot be an array. dintarraytag [3] Array Element DWord Invalid: Server tag missing dimension 2 address. dintarraytag [1,3] Array Element Boolean Invalid: Boolean not allowed for array elements. dintarraytag [1,3] Array Element DWord Value = 259 dintarraytag {10} dintarraytag {2}{5} dintarraytag {1} dintarraytag {1} Byte Value = [68,73,78,84,255,255,255,255,9,10] DWord Value = [68,73,78,84,256] [257,258,259,9,10] DWord Value = 68 Boolean Invalid: Bad data type. dintarraytag [1,3]{4} Array w/ DWord Value = [259,9,10,11] dintarraytag. 3 Bit Boolean Invalid: Tag must reference atomic location. dintarraytag [1,3]. 3 Bit Boolean Value = 0 dintarraytag [1,3].0 {32} Boolean Value = [1,1,0,0,0,0,0,0,1,0,0,0,0,0,0,0] Bit value for 259 dintarraytag String String Invalid: Syntax / data type not supported. dintarraytag String String Invalid: Syntax / data type not supported. LINT, ULINT, and LWORD For more information on the format, refer to Address Formats. Format Supported Data Types Notes Array Element Double* Date** The Native Tag must be an array. Array w/ Double Array* The Native Tag must be an array. Double Array* If accessing more than a single element, the controller tag must be an array. Bit Not supported. Not supported. Standard Double* Date** None String Not supported. Not supported. *Double value will equal face value of controller tag in Float form (non-ieee Floating point number). **Date values are in universal time (UTC), not localized time. Examples Examples highlighted in yellow signify common use cases for LINT, ULINT, and LWORD. LINT, ULINT, and LWORD Atomic Tag - linttag = T16:46: (date) == E+15 (decimal) Server Tag Address Format Data Type Notes linttag Standard Boolean Invalid: Boolean is not supported. linttag Standard Byte Invalid: Byte is not supported. linttag Standard Word Invalid: Word is not supported. linttag Standard Double Value = E+15 linttag Standard Date Value = T16:46:40.000* linttag [3] Array Element Boolean Invalid: Tag is not an array. Also, Boolean is invalid. linttag [3] Array Element Double Invalid: Tag is not an array. linttag {3} Double Invalid: Tag is not an array. linttag {1} Double Value = [ E+15] linttag {1} Boolean Invalid: Bad data type. lintag [3] {1} Array w/ Double Invalid: Tag is not an array. linttag. 3 Bit Boolean Invalid: Syntax/data type not supported. linttag / 1 String String Invalid: Syntax/data type not supported.

27 27 *Date values are in universal time (UTC), not localized time. LINT, ULINT, and LWORD Array Tag - dintarraytag [2,2] = [0, E+15],[9.4666E+14, E+14] where: E+15 == T16:46: (date) E+14 == T17:06: E+14 == T17:00: == T00:00: Server Tag Address Format Data Type Notes lintarraytag Standard Boolean Invalid: Boolean not supported. lintarraytag Standard Byte Invalid: Byte not supported. lintarraytag Standard Word Invalid: Word not supported. lintarraytag Standard Double Invalid: Tag cannot be an array. lintarraytag Standard Date Invalid: Tag cannot be an array. lintarraytag [1] Array Element Double Invalid: Server tag missing dimension 2 address. lintarraytag [1,1] Array Element Boolean Invalid: Boolean not allowed for array elements. lintarraytag [1,1] Array Element Double Value = E+14 lintarraytag [1,1] Array Element Date Value = T17:00:00.000* lintarraytag {4} lintarraytag {2} {2} lintarraytag {4} lintarraytag {1} lintarraytag {1} lintarraytag [0,1] {2} Double Double Date Double Value = 0 Boolean Value = [0, E+15, E+14, E+14] Value = [0, E+15][ E+14, E+14] Invalid: Date array not supported. Invalid: Bad data type. Array w/ Double Value = [ E+15, E+14] lintarraytag. 3 Bit Boolean Invalid: Syntax/data type not supported. lintarraytag / 1 String String Invalid: Syntax/data type not supported. *Date values are in universal time (UTC), not localized time. REAL For more information on the format, refer to Address Formats. Format Supported Data Types Notes Array Element Array w/ Byte, Char**, Word, Short, BCD***, DWord, Long, LBCD, Float**** Byte Array, Char Array**, Word Array, Short Array, BCD Array***, DWord Array, Long Array, LBCD Array, Float Array**** Boolean Array The Native Tag must be an array. The Native Tag must be an array. 1. Use this case to have the bits within an REAL in array form. This is not an array of REALs in Boolean notation. 2. Applies to bit-within-real only. Example: tag_1.0{32}. Byte Array, Char Array**, Word Array, Short Array, BCD Array***, DWord Array, Long Array, LBCD Array, Float Array**** 3. The.bit plus the array size cannot exceed 32 bits. Example: tag_1.1 {32} exceeds an REAL, tag_1.0 {32} does not. If accessing more than a single element, the Native Tag must be

28 28 Format Supported Data Types Notes an array. Bit Boolean 1. The range is limited from 0 to 31. Standard Boolean* Byte, Char** Word, Short, BCD*** DWord, Long, LBCD Float**** None 2. If the Native Tag is an array, the bit class reference must be prefixed by an array element class reference. Example: tag_1 [2,2,3].0. Note: Float is cast to a DWord to allow referencing of bits. String String 1. If accessing a single element, the controller tag does not need to be an array. Note: The value of the string will be the ASCII equivalent of the REAL value (clamped to 255). Example: SINT = 65dec = "A". 2. If accessing more than a single element, the Native Tag must be an array. The value of the string will be the null-terminated ASCII equivalent of all the REALs (clamped to 255) in the string. 1 character in string = 1 REAL, clamped to 255. Note: REAL strings are not packed. For greater efficiency, use SINT strings or the STRING structure instead. *Non-zero values will be clamped to True. **Values exceeding 255 will be clamped to 255. ***Values exceeding will be clamped to ****Float value will be a valid IEEE single precision Floating point number. Examples Examples highlighted in yellow signify common use cases. REAL Atomic Tag - realtag = (decimal) Server Tag Address Format Data Type Notes realtag Standard Boolean Value = True realtag Standard Byte Value = 255 realtag Standard Word Value = 512 realtag Standard DWord Value = 512 realtag Standard Float Value = realtag [3] Array Element Boolean Invalid: Tag is not an array. Also, Boolean is invalid. realtag [3] Array Element DWord Invalid: Tag is not an array. realtag {3} realtag {1} DWord Invalid: Tag is not an array. Float Value = [512.5]