Modbus RTU Serial Driver Help 2009 Kepware Technologies

Transcription

1 Modbus RTU Serial Driver Help 2009 Kepware Technologies

2 1 Table of Contents 1 Getting Started... 3 Help Contents... 3 Overview Device Setup... 3 Device Setup... 3 Cable Diagram... 4 Modem Setup... 4 Settings Block Sizes Variable Import... Settings 8 Framing... 9 Error Handling Automatic Tag... Database Generation 12 Automatic Tag... Database Generation 12 Exporting Variables... from Concept 13 Exporting Variables... from ProWORX 14 4 Data Types Description Data Types Description Address Descriptions Address Descriptions Address Descriptions:... Modbus 17 Address Descriptions:... Magnetek 20 Address Descriptions:... Elliot 21 Address Descriptions:... Daniel S Address Descriptions:... Dynamic Fluid Meter 22 Address Descriptions:... Omni 23 Address Descriptions:... Omni 23 Omni Custom... Packets 26 Omni Raw... Data Archive 27 Omni Text... Reports 32 Omni Text... Archive 33 6 Error Descriptions Error Descriptions Address '<address>'... is out of range for the specified device or register 35 Array size is out... of range for address '<address>' 36 Array support... is not available for the specified address: '<address>' 36 Bad address in... block [<start address> to <end address>] on device '<device name>' 36 Bad array spanning... [<address> to <address>] on device '<device>' 36 Communications... error on COMn [<error mask>] 37 COMn does not... exist 37 COMn is in use... by another application 37 Could not read... Omni text buffer due to memory allocation problem 37 Could not read... Omni text report '<address>' on device '<device name>' due to packet 38 Data Type '<type>'... is not valid for device address '<address>' 38 Description truncated... for import file record number <record> 38 Device address... '<address>' contains a syntax error 38 Device address... '<address>' is not supported by model '<model name>' 38

3 Contents 2 Device address... '<address>' is Read Only 39 Device '<device... name>' is not responding 39 Error opening... COMn 39 Error parsing... import file record number <record>, field <field> 39 Error writing Omni... text data to file for '<tag name>' on device '<device name>' 40 File exception... encountered during tag import 40 Imported tag name... '<tag name>' is invalid. Name changed to '<tag name>' 40 Missing address No Omni text... archive data available in specified date range on device '<device name>' 40 Omni text output... file specified for '<tag name>' on device '<device name>' 41 Received block... length of '<received length>' does not match expected length of '<expected length>' for 41 address Tag import '<address>' failed... due on to device low memory '<device>' resources 41 Tag '<tag name>'... could not be imported because data type '<data type>' is not supported 41 Unable to set... comm parameters on COMn 42 Unable to write... to address '<address>' on device '<device>': Device responded with exception code 42 '<code>' Unable to write... to '<address>' on device '<device name>' 42 Write failed for... '<tag name>' on device '<device name>'. Maximum path length of '<number>' 42 Write to Omni... text report '<address>' on device '<device name>' truncated 42 Modbus Exception... Codes 43 Modbus Exception... Codes 43 Index 44 2

4 3 Help version CONTENTS Overview What is the Modbus RTU Serial Driver? Device Setup How do I configure a device for use with this driver? Automatic Tag Database Generation How can I easily configure tags for the Modbus RTU Serial driver? Data Types Description What data types does this driver support? Address Descriptions How do I address a data location on a Modbus device? Error Descriptions What error messages are produced by the Modbus RTU Serial driver? Overview The Modbus RTU Serial Driver provides an easy and reliable way to connect Modbus RTU Serial devices to OPC Client applications, including HMI, SCADA, Historian, MES, ERP and countless custom applications. It intended for use with serial devices that support the Modbus RTU protocol. The Modbus RTU Serial driver has been developed to support a wide range of Modbus RTU compatible devices. This driver's special features allow users to control the following: the amount of data requested from a device in a single request, the word ordering of 32 bit double register values, the byte ordering of 16 and 32 bit register values and address base adjustment. The Modbus RTU driver can also control the operation of the RTS line for use with radio modems that require specific RTS timing. The driver also supports sending broadcast messages on Device ID 0. Device Setup Supported Devices Modbus compatible devices Elliott Flow Computer Magnetek GPD 515 Drive Omni Flow Computer Daniel S500 Flow Computer Dynamic Fluid Meter (DFM) SFC3 TSXCUSBMBP USB Adapter Communication Protocol Modbus RTU Protocol. Supported Communication Parameters* Baud Rate: 1200, 2400, 9600, Parity: Odd, Even, None Data Bits: 8 Stop Bits: 1,2 *Not all of the listed configurations may be supported in every device. Maximum Number of Channels and Devices The maximum number of channels supported by this driver is 100. The maximum number of devices supported is 255. Ethernet Encapsulation

5 4 This driver supports Ethernet Encapsulation, which allows the driver to communicate with serial devices attached to an Ethernet network using a terminal server such as the Lantronix DR1. To enable Ethernet Encapsulation for the channel, click Use Ethernet Encapsulation in the Communications dialog in Channel Properties. For more information, refer to the main OPC Server help file. Device ID (PLC Network Address) Modbus RTU Serial devices are assigned Device IDs in the range 0 to 255. When using Modbus Device ID 0, the driver will send only broadcast Write messages to remote stations. When configuring a device under the channel, setting the Device ID to 0 will place that device in broadcast mode. Only Writes will occur from this device. Reads from the broadcast device will always return zero. All other Device IDs (1-255) will read and write data to/from the remote Modbus RTU device. Flow Control When using an RS232/RS485 converter, the type of flow control that is required will depend on the converter's needs. Some do not require any flow control and others will require RTS flow. Consult the converter's documentation in order to determine its flow requirements. We recommend using an RS485 converted that provides automatic flow control. Note: When using the manufacturer's supplied communications cable, it is sometimes necessary to choose a flow control setting of RTS or RTS Always under the Channel Properties. The Modbus RTU driver supports the RTS Manual flow control option. This selection is used to configure the driver for operation with radio modems that require special RTS timing characteristics. For more information on RTS Manual flow control, refer to the main OPC Server help file topic "Channel Wizard." Cable Diagram For recommended wiring and cable diagrams, refer to the Modbus device manufacturer's documentation. For example, the Modicon 984 Modbus Controller cable diagram is shown below. Modem Setup This driver supports modem functionality. For more information, please refer to the topic "Modem Support" in the OPC Server Help documentation. Settings

6 5 Zero vs. One Based Addressing Data Access Group If the address numbering convention for the device starts at one as opposed to zero, it can be specified when defining the parameters for the device. By default, user entered addresses will have one subtracted from them when frames are constructed to communicate with a Modbus device. If the device doesn't follow this convention, then the Use zero based addressing check box should be unchecked in Device Properties. For information on the appropriate application to obtain information on setting Device Properties, refer to the online help documentation. The default behavior follows Modicon PLCs conventions. Zero vs One Based Bit Addressing Within Registers Memory types that allow bits within Words can be referenced as a Boolean. The addressing notation for doing this is as follows: <address>.<bit> where <bit> represents the bit number within the word. Zero Based Bit Addressing within registers provides two ways of addressing a bit within a given word: Zero Based and One Based. Zero Based Bit addressing within registers simply means the first bit begins at 0. One Based Bit addressing means that the first bit begins at 1. Zero Based Bit Addressing within registers (Default Setting / Checked) Data Type Bit Range Word Bits 0 15 One Based Bit Addressing within registers (Unchecked) Data Type Bit Range Word Bits 1 16 Holding Register Bit Mask Writes When writing to a bit location within a holding register, the driver should only modify the bit of interest. Some devices support a special command to manipulate a single bit within a register (Function code hex 0x16 or decimal 22). If the device does not support this feature, the driver will need to perform a Read/Modify/Write operation to ensure that only the single bit is changed. Check this box if the device supports holding register bit access. By default, it is left unchecked. If this setting is selected, then the driver will use function code 0x16, irrespective of the setting for Use Modbus function 06 for single register writes. However, if this setting is not selected, then the driver will use either function code 0x06 or 0x10 depending on the selection for 'Use Modbus function 06 for single register writes.' Note: When Modbus byte order is deselected, the byte order of the masks sent in the command will be Intel byte order. Use Modbus Function 06 or 16 The Modbus driver has the option of using two Modbus protocol functions to write holding register data to the target device. In most cases, the driver switches between these two functions based on the number of registers being written. When writing a single 16 bit register, the driver will generally use the Modbus function 06. When writing a 32 bit value into two registers, the driver will use Modbus function 16. For the standard Modicon PLC, the use of either of these functions is not a problem. There are, however, a large number of 3rd party devices that have implemented the Modbus protocol. Many of these devices support only the use of Modbus function 16 to write to Holding registers, regardless of the number of registers to be written. The Use Modbus function 06 selection is used to force the driver to use only Modbus function 16 if needed. By default, this selection is checked which allows the driver to operate as it has historically, switching between 06 and 16 as needed. If a device requires all writes be done using only Modbus function 16, uncheck this selection. Note: For bit within word writes, the Holding Register Bit Mask Writes property takes precedence over this property (Use Modbus Function 06). If Holding Register Bit Mask Writes is selected, then function code 0x16 is used no matter what the selection for this property. However, if Holding Register Bit Mask Writes is not selected, then depending upon the selection of this property either function code 0x06 or 0x10 will be used for bit within word writes.

7 6 Use Modbus Function 05 or 15 The Modbus driver has the option of using two Modbus protocol functions to write Output coil data to the target device. In most cases the driver switches between these two functions based on the number of coils being written. When writing a single coil, the driver will use the Modbus function 05. When writing an array of coils, the driver will use Modbus function 15. For the standard Modicon PLC the use of either of these functions is not a problem. There are, however, a large number of third party devices that have implemented the Modbus protocol. Many of these devices support only the use of Modbus function 15 to write to output coils regardless of the number of coils to be written. The Use Modbus function 05 selection is used to force the driver to use only Modbus function 15 if needed. By default, this selection is checked which allows the driver to operate as it has historically, switching between 05 and 15 as needed. If a device requires all writes be done using only Modbus function 15, uncheck this selection. Modbus Byte Order Data Encoding Group The Ethernet driver's byte order can be changed from the default Modbus byte ordering to Intel byte ordering by using this selection. This selection will be checked by default, which is the normal setting for Modbus compatible devices. If the device uses Intel byte ordering, deselecting this selection will enable the Modbus driver to properly read Intel formatted data. Note: This setting does not apply to the Omni model. It always uses Modbus byte order. First Word Low in 32 Bit Data Types Two consecutive registers' addresses in a Modbus device are used for 32 bit data types. Users can specify whether the driver should assume the first word is the low or the high word of the 32 bit value. The default, first word low, follows the convention of the Modicon Modsoft programming software. Note: This setting does not apply to the Omni model. It always uses Modbus byte order. First DWord Low in 64 Bit Data Types Four consecutive registers' addresses in a Modbus device are used for 64 bit data types. Users can specify whether the driver should assume the first DWord is the low or the high DWord of the 64 bit value. First DWord low (the default) follows the default convention of 32 bit data types. Note: This setting does not apply to the Omni model. It always uses Modbus byte order. Use Modicon Bit Ordering When checked, the driver will reverse the bit order on reads and writes to registers to follow the convention of the Modicon Modsoft programming software. For example, a write to address /1 will affect bit 15/16 in the device when this option is enabled. This option is disabled (unchecked) by default. Note: For the following example, the 1st through 16th bit signifies either 0-15 bits or 1-16 bits depending on if the driver is set at Zero Based or One Based Bit Addressing within registers. MSB = Most Significant Bit LSB = Least Significant Bit Use Modicon Bit Ordering Checked MSB LSB Use Modicon Bit Ordering Unchecked (Default Setting) MSB Data Encoding Options Details The following summarizes usage of the Data Encoding options. Use default Modbus byte order option sets the data encoding of each register/16 bit value. LSB

8 7 First word low in 32 bit data types option sets the data encoding of each 32 bit value and each double word of a 64 bit value. First DWord low in 64 bit data types option sets the data encoding of each 64 bit value. Data Types Use default Modbus byte order Applicable First word low in 32 bit data types Applicable Word, Short, BCD Yes No No Float, DWord, Long, LBCD Yes Yes No Double Yes Yes Yes First DWord low in 64 bit data types Applicable If needed, use the following information and the particular device's documentation to determine the correct settings of the Data Encoding options. The default settings are correct for the majority of Modbus devices. Data Encoding Group Option Use default Modbus byte order Checked Use default Modbus byte order Unchecked First word low in 32 bit data types Unchecked First word low in 32 bit data types Checked First DWord low in 64 bit data types Unchecked First DWord low in 64 bit data types Checked Data Encoding High Byte (15..8) Low Byte (7..0) Low Byte (7..0) High Byte (15..8) High Word (31..16) High Word(63..48) of Double Word in 64 bit data types Low Word (15..0) Low Word (47..32) of Double Word in 64 bit data types High Double Word (63..32) Low Double Word (31..0) Low Word (15..0) Low Word (47..32) of Double Word in 64 bit data types High Word (31..16) High Word (63..48) of Double Word in 64 bit data types Low Double Word (31..0) High Double Word (63..32) Block Sizes

9 8 Coil Block Sizes Coils can be read from 8 to 2000 points (bits) at a time. A higher block size means more points will be read from the device in a single request. The block size can be reduced in order to read data from non-contiguous locations within the device. Register Block Sizes Registers can be read from 1 to 125 locations (words) at a time. A higher block size means more register values will be read from the device in a single request. The block size can be reduced in order to read data from non-contiguous locations within the device. Caution: If the Register Block sizes value is set above 120 and a 32 or 64 bit data type is used for any tag, then a "Bad address in block" error could occur. To prevent this error, decrease the block size value to 120. Perform Block Read on Strings When checked, this option will block read string tags (which are normally read individually). String tags will also be grouped together depending on the selected block size. Block reads can only be performed for Modbus model string tags. Variable Import Settings The Variable Import Settings parameters specify the location of the variable import file that will be used when Automatic Tag Database Generation is enabled.

10 9 Descriptions of the parameters are as follows: Variable Import File: This parameter is used to browse to the exact location of the Concept or ProWORX variable import file that the driver will use during Automatic Tag Database Generation. Include Descriptions: When checked, imported tag descriptions will be used if present in the file. Note: For more information on configuring the Automatic Tag Database Generation feature (and how to create a variable import file), refer to Automatic Tag Database Generation. Framing Since some terminal server devices will add additional data to Modbus frames, the Framing parameters are used to configure the driver to ignore the additional bytes in response messages.

11 10 Descriptions of the parameters are as follows: Use Modbus TCP Framing: When checked, this parameter is used to communicate with native Modbus TCP devices using Ethernet Encapsulation. Leading bytes: This parameter is used to specify the number of bytes to be attached to the beginning of Modbus responses. Values may range from 0 to 8. Trailing bytes: This parameter is used to specify the number of bytes to be attached to the end of Modbus responses. Values may range from 0 to 8. Using Ethernet Encapsulation Ethernet Encapsulation must be enabled in order for Framing to be available; otherwise, the selection Use Modbus TCP Framing will be grayed out in the dialog box. To invoke Ethernet Encapsulation, use the following steps. 1. Go to the device's Channel Properties page. 2. In the Communications dialog, click Use Ethernet Encapsulation. This enables Ethernet Encapsulation for the channel. 3. Next, open the device's Device Properties page. Fill out the Ethernet Encapsulation parameters as shown below. IP Address: Enter the device's IP address. Port Number: Generally, 502 is entered for Modbus TCP devices. Protocol: TCP/IP

12 11 See Also: Device Setup Error Handling The Error Handling parameters determine how to deal with errors from the device.

13 12 Descriptions of the parameters are as follows: Deactivate Tags on Illegal Address Exception: When checked, the driver will stop polling for a block of data if the device returns Modbus exception code 2 (illegal address) or 3 (illegal data, such as number of points) in response to a read of that block. This is the default setting. Uncheck this setting in order to read addresses that can become accessible in a dynamic fashion in the device. The default setting is checked. Reject Repeated Messages: When checked, the driver will expect repeated messages. When unchecked, the driver will interpret a repeated message an an invalid response and will retry the request. The default setting is unchecked. Note: Some message-relay equipment will echo Modbus requests back to the driver. Automatic Tag Database Generation Overview The Modbus RTU Serial driver makes use of the OPC Server's Automatic Tag Database Generation feature, which enables drivers to automatically create tags that access data points used by the device's ladder program. While it is sometimes possible to query a device for the information needed to build a tag database, this driver must use a Variable Import File instead. Variable import files can be generated using the Concept and ProWORX device programming applications. Creating the Variable Import File The import file must be in semicolon delimited Concept.TXT format. This is the default export file format of the Concept device programming application. The ProWORX programming application can also export variable data in this format. For application-specific information on creating the variable import file, refer to Exporting Variables from Concept and Exporting Variables from ProWORX. OPC Server Configuration The automatic tag database generation feature can be customized to fit an application's specific needs. The primary control options can be set during the Database Creation step of the Device Wizard or later by selecting Device Properties Database Creation. For more information, refer to the OPC Server's Help Documentation. This driver requires additional settings in addition to the basic settings that are common to all drivers that support automatic tag database generation. The specialized settings include the name and location of the variable import file, which can be specified during the Variable Import Settings step of the Device Wizard or later by selecting Device

14 13 Properties Variable Import Settings tab. For more information, refer to Variable Import Settings. Operation Depending on the configuration, tag generation may start automatically when the OPC Server project starts or be initiated manually at some other time. The OPC Server's event log will show when the tag generation process started, any errors that occurred while processing the variable import file and when the process completed. Exporting Variables from Concept As the ladder program is created, symbolic names for various data points referenced can be defined using the Variable Editor. Additional symbols and constants that are not used by the ladder program can also be defined. Note: Though Concept is used to define variable names that begin with an underscore, such names are not allowed by the OPC server. The driver will modify invalid imported tag names as needed, and inform users of any such name changes in the server s event log. User defined data types are not currently supported by this driver. Records in the export file containing references to such types will be ignored. The table below displays the supported simple data types. Concept Data Type BOOL Byte DINT INT REAL TIME UDINT UINT Word Generated Tag Data Type Boolean Word Long Short Float DWord DWord Word Word Note 1: Unlocated variables, which do not correspond to a physical address in the device, will be ignored by the driver. Note 2: Comments are allowed and can be included as the generated tag descriptions or not. For more information,

15 14 refer to Variable Import Settings. Exporting Variable from Concept After the variables have been defined, they must be exported from Concept. 1. Click File Export. Then, select the Variables: Text delimited format. 2. Click OK. Next, specify the filter and separator settings. 3. Although any filter setting can be chosen, this driver will only be able to read the exported data if the default semicolon separator is used. Click OK to generate the file. Exporting Variables from ProWORX In order for ProWORX to export the necessary variable information, Symbols must be checked. To do so, click File Preferences and make sure that it is selected. Note: As the ladder program is created, symbolic names for the various data points reference can be defined using the Document Editor.

16 15 Note: ProWORX does not place many restrictions on variable names. However, the OPC Server requires that tag names consist of only alphanumeric characters and underscores, and that the first character not be an underscore. The driver will modify invalid imported tag names as needed, and inform users of any such name changes in the server's event log. ProWORX will assign a data type of either BOOL or INT to the exported variables. The driver will create tags of type Boolean and Short respectively. In order to generate tags with other data types, users should manually edit the exported file and use any of the supported Concept data types. For a list of supported types, refer to Exporting Variables from Concept. Exporting Variables from ProWORX Once the variables have been defined, they must be exported from ProWORX. 1. Click File Utilities Import/Export. 2. Select Export and the Concept.TXT file format. 3. Descriptors are allowed and may be included as the generated tag descriptions. For more information, refer to Variable Import Settings.

17 16 4. Click OK to generate the file. Data Types Description Data Type Boolean Word Short DWord Long BCD LBCD String Description Single bit Unsigned 16 bit value bit 0 is the low bit bit 15 is the high bit Signed 16 bit value bit 0 is the low bit bit 14 is the high bit bit 15 is the sign bit Unsigned 32 bit value bit 0 is the low bit bit 31 is the high bit Signed 32 bit value bit 0 is the low bit bit 30 is the high bit bit 31 is the sign bit Two byte packed BCD Value range is Behavior is undefined for values beyond this range. Four byte packed BCD Value range is Behavior is undefined for values beyond this range. Null terminated ASCII string Supported on Modbus Model, includes HiLo LoHi byte order

18 17 Double* selection. 8 Byte and 16 Byte Omni Flow Computer string data 64 bit floating point value The driver interprets four consecutive registers as a double precision value by making the last two registers the high DWord and the first two registers the low DWord. Double Example If register is specified as a double, bit 0 of register would be bit 0 of the 64 bit data type and bit 15 of register would be bit 63 of the 64 bit data type. Float* 32 bit floating point value The driver interprets two consecutive registers as a single precision value by making the last register the high word and the first register the low word. Float Example If register is specified as a float, bit 0 of register would be bit 0 of the 32 bit data type and bit 15 of register would be bit 31 of the 32 bit data type. *The descriptions assume the default first DWord low data handling of 64 bit data types, and first word low data handling of 32 bit data types. Address Descriptions Address specifications vary depending on the model in use. Select a link from the following list to obtain specific address information for the model of interest. Modbus Addressing Magnetek GPD 515 Drive Addressing Elliott Flow Computer Addressing Daniels S500 Flow Computer Addressing Dynamic Fluid Meter Addressing Omni Flow Computer Addressing Address Descriptions: Modbus The default data types for dynamically defined tags are shown in bold where appropriate. Modbus Addressing Decimal Format Address Range Data Type Access* Output Coils Boolean [Function Codes (decimal): 01, 05, 15] Input Coils Boolean Read Only [Function Code (decimal): 02] Internal Registers [Function Code (decimal): 04] Word, Short, BCD Float, DWord, Long, LBCD Double Read Only 3xxxxx.0/1-3xxxxx.15/16 Boolean (See Settings Option Use zero based Bit Addressing within registers) Internal Registers As String with HiLo Byte Order H H String** Read Only [Function Codes (decimal): 04].Bit is string length, range 2 to 240

19 18 bytes. Internal Registers As String with LoHi Byte Order L L String** Read Only [Function Codes (decimal): 04] Holding Registers [Function Codes (decimal): 03, 06, 16] [Function Codes (decimal): 03, 06, 16, 22] Holding Registers As String with HiLo Byte Order [Function Codes (decimal): 03, 16] Holding Registers As String with LoHi Byte Order [Function Codes (decimal): 03, 16].Bit is string length, range 2 to 240 bytes xxxxx.0/1-4xxxxx.15/16 (See Settings Option Use zero based Bit Addressing within registers) H H.Bit is string length, range 2 to 240 bytes L L.Bit is string length, range 2 to 240 bytes. Word, Short, BCD Float, DWord, Long, LBCD Double Boolean String** String** Modbus Addressing Hexadecimal Format Address Range Data Type Access Output Coils H H0FFFF Boolean [Function Codes (decimal): 01, 05, 15] Input Coils H H1FFFF Boolean Read Only [Function Code (decimal): 02] Internal Registers [Function Code (decimal): 04] H H H H3FFFF H H3FFFD Word, Short, BCD Float, DWord, Long, LBCD Double Read Only H3xxxxx.0/1-H3xxxxx.F/10 Boolean (See Settings Option Use zero based Bit Addressing within registers) Internal Registers As String with HiLo Byte Order H H-H3FFFF.240H String** Read Only [Function Codes (decimal): 04] Internal Registers As String with LoHi Byte Order.Bit is string length, range 2 to 240 bytes. H L-H3FFFF.240L String** Read Only [Function Codes (decimal): 04] Holding Registers [Function Codes (decimal): 03, 06, 16] [Function Codes (decimal): 03, 06, 16, 22].Bit is string length, range 2 to 240 bytes. H H H H4FFFF H H4FFFD H4xxxxx.0/1-H4xxxxx.F/10 (See Settings Option Use zero based Bit Addressing within registers) Word, Short, BCD Float, DWord, Long, LBCD Double Boolean

20 19 Holding Registers As String with HiLo Byte Order H H-H4FFFF.240H String** [Function Codes (decimal): 03, 16].Bit is string length, range 2 to 240 bytes. Holding Registers As String with LoHi Byte Order H L-H4FFFF.240L String** [Function Codes (decimal): 03, 16].Bit is string length, range 2 to 240 bytes. *Write Only Access All addresses may be set as Write Only by prefixing a "W" to the address such as "W40001", which will prevent the driver from reading the register at the specified address. Any attempts by the client to read a Write Only tag will result in obtaining the last successful write value to the specified address. If no successful writes have occurred, the client will receive 0/NULL for numeric/string values for an initial value. Caution: Setting the Client Access privileges of Write Only tags to Read Only will cause writes to these tags to fail and the client to always receive 0/NULL for numeric/string values. **String Support The Modbus model supports reading and writing holding register memory as an ASCII string. When using holding registers for string data, each register will contain two bytes of ASCII data. The order of the ASCII data within a given register can be selected when the string is defined. The length of the string can be from 2 to 240 bytes and is entered in place of a bit number. The length must be entered as an even number. The byte order is specified by appending either a "H" or "L" to the address. String Examples 1. To address a string starting at with a length of 100 bytes and HiLo byte order, enter: H 2. To address a string starting at with a length of 78 bytes and LoHi byte order, enter: L Note: The string's length may be limited by the maximum size of the write request that the device will allow. If, while utilizing a string tag, an error message of "Unable to write to address <address> on device <device>: Device responded with exception code 3" is received in the server event window, this means the device did not like the string's length. If possible, try shortening the string. Normal Address Examples 1. The 255'th output coil would be addressed as '0255' using decimal addressing or 'H0FF' using hexadecimal addressing. 2. Some documentation refers to Modbus addresses by function code and location. For instance, function code 3; location 2000 would be addressed as '42000' or 'H47D0' (the leading '4' represents holding registers or function code 3). 3. Some documentation refers to Modbus addresses by function code and location. For instance, setting function code 5 location 100 would be addressed as '0100' or 'H064' (the leading '0' represents output coils or function code 5). Writing 1 or 0 to this address would set or reset the coil. Array Support Arrays are supported for internal and holding register locations for all data types except for Boolean and strings. Arrays are also supported for input and output coils (Boolean data types). There are two methods of addressing an array. Examples are given using holding register locations. 4xxxx [rows] [cols] 4xxxx [cols] this method assumes rows is equal to one. For arrays, rows multiplied by cols cannot exceed the block size that has been assigned to the device for the register/ coil type. For register arrays of 32 bit data types, rows multiplied by cols multiplied by 2 cannot exceed the block size. Packed Coil Address Type

21 20 The Packed Coil address type allows access to multiple consecutive coils as an analog value. This feature is available for both input coils and output coils, polled mode only. The only valid data type is Word. The syntax is: Output coils: 0xxxxx#nn Word Input coils: 1xxxxx#nn Word Read Only where xxxxx is the address of the first coil (decimal and hex values allowed), and nn is the number of coils to be packed into an analog value (1-16, decimal only). The bit order will be such that the start address will be the LSB (least significant bit) of analog value. Address Descriptions: Magnetek GPD 515 This table provides the general ranges of data available from the Magnetek GPD 515 Drive. Consult the Magnetek Modbus RTU Technical Manual, part number TM4025, for information on how specific Drive parameters can be accessed using Modbus RTU addressing. In all cases, the letter H (used to signify Hex addressing) should precede the desired address. The default data types for dynamically defined tags are shown in bold where appropriate. Magnetek GPD 515 Addressing Hexadecimal Format Address Range Data Type Access Command Registers H40001-H4000F Word, Short Bit Level Access H4xxxx.0/1-H4xxxx.F/10 Boolean (See Settings Option Use zero based Bit Addressing within registers) Monitor Registers H40010-H4001A Word, Short Read Only Bit Level Access H4xxxx.0/1-H4xxxx.F/10 Boolean (See Settings Option Use zero based Bit Addressing within registers) Drive Parameter Registers (Monitor Only) Bit Level Access H40020-H40097 H4xxxx.0/1-H4xxxx.F/10 Word, Short Boolean Read Only (See Settings Option Use zero based Bit Addressing within registers) Drive Parameter Registers H40100-H4050D Word, Short Bit Level Access H4xxxx.0/1-H4xxxx.F/10 Boolean (See Settings Option Use zero based Bit Addressing within registers) Special Registers H4FFDD ACCEPT H4FFFD ENTER Word, Short Write Only Example To access the Driver's Operation Status, address 02BH, enter the following address: H4002B Note: When adding a Magnetek Device to the OPC Server project, users must make sure that the setting "Use Zero Based Addressing" is not checked. If this parameter is not set correctly, the Modbus RTU driver will offset all of the Magnetek addresses by 1. Array Support Arrays are supported for holding register locations for all data types except Boolean. There are two methods of addressing an array. Examples are given using holding register locations.

22 21 4xxxx [rows] [cols] 4xxxx [cols] this method assumes rows is equal to one. Rows multiplied by cols cannot exceed the block size that has been assigned to the device for the register type. Address Descriptions: Elliot The default data types for dynamically defined tags are shown in bold where appropriate. Address Range Data Type Access Output Coils Boolean Input Coils Boolean Read Only Internal Registers Word, Short, BCD Float, DWord, Long, LBCD Read Only 3xxxxx.0/1-3xxxxx.15/16 (See Settings Option Use zero based Bit Addressing within registers) Holding Registers xxxxx.0/1-4xxxxx.15/16 (See Settings Option Use zero based Bit Addressing within registers) Boolean Word, Short, BCD (1) Float, DWord, Long, LBCD Boolean Note: Address ranges to and to are 32 bit registers. Addresses in the range of to use a default data type of Long. Addresses in the range of to use a default data type of Float. Since these address registers are 32 bit, only Float, DWord, Long or LBCD data types are allowed. Arrays are not allowed for these special address ranges. Array Support Arrays are supported for internal and holding register locations for all data types except Boolean. There are two methods of addressing an array. Examples are given using holding register locations. 4xxxx [rows] [cols] 4xxxx [cols] this method assumes "rows" is equal to one. Rows multiplied by cols cannot exceed the block size that has been assigned to the device for the register type. For arrays of 32 bit data types, rows multiplied by cols multiplied by 2 cannot exceed the block size. Address Description: Daniel S500 The default data types for dynamically defined tags are shown in bold where appropriate. Address Hex Range Decimal Range Data Type Function Codes Access Totals 000-0FF Double 03 Read Only Calculated / Measured Variables Calculation Constants Keypad Default Values Alarm and Scaling Constants F Float 03, F Float 03, AF Float 03, 16 2B0-5FF Float 03, 16

23 22 Status /Control 700-7FF Boolean 02, 5 Alarms 800-FFF Boolean 02 Read Only Address Descriptions: Dynamic Fluid Meter SFC3 The default data types for dynamically defined tags are shown in bold where appropriate. Dynamic Fluid Meter Addressing Decimal Format Address Range Data Type Access Holding Registers (16 bit) Word, Short, BCD Float, DWord, Long, LBCD xxxxx.0/1-4xxxxx.15/16 Word, Short, BCD Float, DWord, Long, LBCD Boolean (See Settings Option Use zero based Bit Addressing within registers) Holding Registers (32 bit) Float Holding Registers As String with HiLo Byte Order H H H H String.Bit is string length, range 2 to 240 bytes. Holding Registers As String with LoHi Byte Order L L L L String.Bit is string length, range 2 to 240 bytes. Dynamic Fluid Meter Addressing Hexadecimal Format Address Range Data Type Access Holding Registers (16 bit) H H401B58 H H401B57 Word, Short, BCD Float, DWord, Long, LBCD H401F41-H40FFFF H401F41-H40FFFE H4xxxxx.0/1-H4xxxxx.F/10 Word, Short, BCD Float, DWord, Long, LBCD Boolean (See Settings Option Use zero based Bit Addressing within registers) Holding Registers (32 bit) H401B59-H401F40 Float Holding Registers As String with HiLo Byte Order H H-H401B58.240H H401F41.2H-H40FFFF.240H String.Bit is string length, range 2 to 240 bytes. Holding Registers As String with LoHi Byte Order H L-H401B58.240L H401F41.2L-H0FFFF.240L String.Bit is string length, range 2 to 240 bytes. Note: This driver requires that all addresses begin with "4" for the Dynamic Fluid Meter model. This 4 may not always be written explicitly in the Dynamic Fluid Meter documentation. For example, users may see a reference to "Unit ID at address 3001". This value must be addressed in the server as "403001".

24 23 String Support The Dynamic Fluid Meter model supports reading and writing holding register memory as an ASCII string. When using holding registers for string data, each register will contain two bytes of ASCII data. The order of the ASCII data within a given register can be selected when the string is defined. The length of the string can be from 2 to 240 bytes and is entered in place of a bit number. The length must be entered as an even number. The byte order is specified by appending either a "H" or "L" to the address. String Examples 1. To address a string starting at with a length of 100 bytes and HiLo byte order, enter: H 2. To address a string starting at with a length of 78 bytes and LoHi byte order, enter: L Note: The string's length may be limited by the maximum size of the write request that the device will allow. If, while utilizing a string tag, an error message of "Unable to write to address <address> on device <device>: Device responded with exception code 3" is received in the server event window, this means the device did not like the string's length. If possible, try shortening the string. Address Descriptions: Omni The default data types for dynamically defined tags are shown in bold where appropriate. Address Range Data Type Access Digital I/O Point Boolean Programmable Boolean Point Boolean Meter Run Status and Alarm Points Micro Motion Alarm Status Points 1n01-001n59 1n76-1n99 n=number of Meter Run 1n60-1n75 n=number of Meter Run User Scratch Pad Boolean Points Boolean Boolean Boolean User ScratchPad One Shot Points Boolean Command Boolean Points/Variables Boolean Meter Station Alarm and Status Points Boolean Prover Alarm and Status Points Boolean Meter Totalizer Roll-over Flags 2n01-2n37 n=number of Meter Run Boolean Misc. Meter Station Alarm and Status Boolean Station Totalizer Roll-over Flags Boolean Station Totalizer Decimal Resolution Boolean 16 Bit Integer Data Addresses Range Data Type Access Custom Data Packet # Short, Word, BCD Custom Data Packet # Short, Word, BCD Custom Data Packet # Short, Word, BCD Misc. 16 bit Integer Data Meter Run 16 bit Integer Data 3n01-3n52 n=number of Meter Run Short, Word, BCD Short, Word, BCD Scratchpad 16 bit Integer Data Short, Word, BCD User Display # Short, Word, BCD

25 24 User Display # Short, Word, BCD User Display # Short, Word, BCD User Display # Short, Word, BCD User Display # Short, Word, BCD User Display # Short, Word, BCD User Display # Short, Word, BCD User Display # Short, Word, BCD Access Raw Data Archive Records Short, Word, BCD Meter Station 16 bit Integer Data Short, Word, BCD Meter #1 Batch Sequence Short, Word, BCD Meter #2 Batch Sequence Short, Word, BCD Meter #3 Batch Sequence Short, Word, BCD Meter #4 Batch Sequence Short, Word, BCD Flow Computer Time/Date Short, Word, BCD Prover 16 bit Integer Data Short, Word, BCD 8 Character ASCII String Data Range Data Type Access Meter Run ASCII Data 4n01-4n39 n=number of Meter Run String Scatch Pad ASCII Data String User Display Definition Variables String Station Auxiliary Input Variables String Meter Station ASCII Data String Meter #1 Batch ID String Meter #2 Batch ID String Meter #3 Batch ID String Meter #4 Batch ID String Prover ASCII String Data String 32 Bit Integer Data Range Data Type Access Meter Run 32 bit Integer Data 5n01-5n99 n=number of Meter Run Long, DWord, LBCD, Float Scratch Pad 32 bit Integer Data Long, DWord, LBCD, Float Station 32 bit Integer Data Long, DWord, LBCD, Float Meter #1 Batch Size Long, DWord, LBCD, Float Meter #2 Batch Size Long, DWord, LBCD, Float Meter #3 Batch Size Long, DWord, LBCD, Float Meter #4 Batch Size Long, DWord, LBCD, Float Additional 32 bit Meter Run Data Long, DWord, LBCD, Float Prover 32 bit Integer Data Long, DWord, LBCD, Float Compact Prover TDVOL/TDFMP Pulses Long, DWord, LBCD, Float 32 Bit IEEE Floating Point Data Range Data Type Access Reserved Data Float, Long, DWord, LBCD Digital to Analog Outputs Float, Long, DWord, LBCD User Variables Float, Long, DWord, LBCD Programmable Accumulator Float, Long, DWord, LBCD Meter Run Data 7n01-7n99 n=number of Meter Run Float, Long, DWord, LBCD

26 25 Scatch Pad Data Float, Long, DWord, LBCD PID Control Data Float, Long, DWord, LBCD Miscellaneous Meter Run Data Float, Long, DWord, LBCD Miscellaneous Variables Float, Long, DWord, LBCD Meter Station Data Float, Long, DWord, LBCD Prover Data Float, Long, DWord, LBCD Configuration Data for Prover Float, Long, DWord, LBCD Last Prove Data Float, Long, DWord, LBCD Data Rejected During Prove Float, Long, DWord, LBCD Prove Run Data Float, Long, DWord, LBCD Prove Average Data Float, Long, DWord, LBCD Prove Run-Master Meter Data Float, Long, DWord, LBCD Proving Series Data Float, Long, DWord, LBCD Data of Meter Being Proved Float, Long, DWord, LBCD Mass Prove Data Float, Long, DWord, LBCD Miscellaneous Meter Run # Float, Long, DWord, LBCD Miscellaneous Meter Run # Float, Long, DWord, LBCD Miscellaneous Meter Run # Float, Long, DWord, LBCD Miscellaneous Meter Run # Float, Long, DWord, LBCD Station Previous Batch Average Data Float, Long, DWord, LBCD 16 Bit Integer Configuration Data Range Data Type Access Meter Run # Short, Word, BCD Meter Run # Short, Word, BCD Meter Run # Short, Word, BCD Meter Run # Short, Word, BCD Prover Configuration Short, Word, BCD General Flow Configuration Short, Word, BCD Serial Port Configuration Short, Word, BCD PID Configuration Short, Word, BCD PLC Data Short, Word, BCD Peer to Peer Setup Short, Word, BCD Raw Data Archive Short, Word, BCD 16 Character ASCII String Data Range Data Type Access Flow Computer Configuration String 32 Bit Integer Data Range Data Type Access Flow Computer Configuration Long, DWord, LBCD, Float 32 Bit IEEE Floating Point Data Range Data Type Access Flow Computer Configuration Float, Long, DWord, LBCD Supported Extended Omni Types Custom Packets Raw Data Archive Text Reports Text Archive

27 26 Omni Custom Packets The Omni Flow Computer allows users to map various ranges of memory to a single data structure that can be read with a single, highly efficient read command. These data structures are called Custom Packets. Packet Configuration Each Custom Packet may contain up to twenty groups of data points. Each group is defined by its starting index and the number of data points. The total size of the custom packet must not exceed 250 bytes. The addresses used to define the Custom Packets are listed below. Custom Packet 1 (address 1) 3001 Group 1-Starting index 3002 Group 2-Number of points to 3039 Group 20-Starting index 3040 Group 20-Number of points Custom Packet 2 (address 201) 3041 Group 1-Starting index 3042 Group 2-Number of points to 3055 Group 20-Starting index 3056 Group 20-Number of points Custom Packet 3 (address 401) 3057 Group 1-Starting index 3058 Group 2-Number of points to 3095 Group 20-Starting index 3096 Group 20-Number of points Note: Data is returned from the device as 16 bit registers. Digital I/O must be mapped in blocks of 16 bits. Custom Packet Address Syntax Tags can be created to access data at a given offset within a Custom Packet. The address syntax is as follows; the default data types are shown in bold. Address Range Data Type Access CPn_o n = Packet Number (1-3) o = Word offset (0-125) CPn_o.b n = Packet Number (1-3) o = Word offset (0-125) b = Bit number (0/1-15/16) (See Settings Option Use zero based Bit Addressing within registers) Word, Short, BCD, DWord, Long, LBCD, Float, String Boolean Note 1: Only 8 character ASCII string data is supported. Read Only Read Only Note 2: If a 16 character ASCII string data address is contained in group configuration, then data can be read as two 8 character ASCII string data items. Example: Define Custom Packet #1 to map to: 16 bits of Digital I/O ( ), bit integers of Meter Run 1 Batch data ( ), bit floats of Analog Outputs ( ), 4 8 character ASCII strings of Meter Run ( ), 6 8 character ASCII strings of Meter Station ( ) and 2 16 character ASCII strings of Flow Configuration data ( ), for a total of 222 bytes. The Custom Packet configuration registers would have the following values:

28 = = = = = = = = = = = = 2 Tags to access the Digital I/O data would have the following addresses (all 16 values contained in word 0): CP1_0.0 (Word 0 of Custom Packet 1, bit 0-mapped to 1001) CP1_0.1 (Word 0 of Custom Packet 1, bit 1-mapped to 1002)... CP1_0.15 (Word 0 of Custom Packet 1, bit 15-mapped to 1015) Tags to access the Meter Run 1 Batch data would have the following addresses (each 32 bit value uses 2 words): CP1_1 (Word 1 of Custom Packet 1-mapped to 5101) CP1_3 (Word 3 of Custom Packet 1-mapped to 5102)... CP1_29 (Word 29 of Custom Packet 1-mapped to 5115) Tags to access the Analog Output data would have the following addresses (each 32 bit value uses 2 words): CP1_31 (Word 31 of Custom Packet 1-mapped to 7001) CP1_33 (Word 33 of Custom Packet 1-mapped to 7002)... CP1_53 (Word 53 of Custom Packet 1-mapped to 7012) Tags to access the Meter Run 8 character ASCII String data would have the following addresses (each String value uses 4 words): CP1_55 (Word 55 of Custom Packet 1-mapped to 4101)... CP1_67 (Word 67 of Custom Packet 1-mapped to 4104) Tags to access the Meter Station 8 character ASCII String data would have the following addresses (each String value uses 4 words): CP1_71 (Word 71 of Custom Packet 1-mapped to 4808)... CP1_91 (Word 91 of Custom Packet 1-mapped to 4813) Tags to access the Flow Configuration 16 character ASCII String data would have the following addresses (each String value uses 4 words): CP1_95 (Word 95 of Custom Packet 1-mapped to characters 1-8) CP1_99 (Word 99 of Custom Packet 1-mapped to characters 9-16) CP1_103 (Word 103 of Custom Packet 1-mapped to characters 1-8) CP1_107 (Word 107 of Custom Packet 1-mapped to characters 9-16) Omni Raw Data Archive The Omni Flow Computer may be configured to map various ranges of memory to a single data structure, and store that structure in an archive when triggered. Up to ten archives may be configured by the user. There are two additional fixed format archives for Alarm and Audit data. Each archive is a circular buffer, where each new record replaces the oldest record. Record Configuration and Retrieval The record structure of Raw Data Archives 1 to 10 may be configured by the user. Archives 11 and 12 are of fixed format and contain Alarm and Audit data respectively. For a full discussion of Raw Data Archives, refer to Omni Technical Bulletin Each record may contain up to sixteen groups of data points. Each group is defined by its starting index and the number of data points. The addresses used to define the archive records are listed below. The total size of the record