Modbus TCP/IP Option Instruction Manual

s800v004, s801v003 and lower

Notice 2006 WALCHEM Corporation Five Boynton Road, Holliston, MA 01746 USA (508) 429-1110 All Rights Reserved Printed in USA Proprietary Material
The information and descriptions contained herein are the property of WALCHEM Corporation. Such information and descriptions may not be copied or reproduced by any means, or disseminated or distributed without the express prior written permission of WALCHEM Corporation, Five Boynton Road, Holliston, MA 01746.

Statement of Limited Warranty WALCHEM Corporation warrants equipment of its manufacture, and bearing its identification to be free from defects in workmanship and material for a period of 24 months for electronics and 12 months for mechanical parts from date of delivery from the factory or authorized distributor under normal use and service and otherwise when such equipment is used in accordance with instructions furnished by WALCHEM Corporation and for the purposes disclosed in writing a the time of purchase, if any. WALCHEM Corporations liability under this warranty shall be limited to replacement or repair, F.O.B. Holliston, MA U.S.A. of any defective equipment or part which, having been returned to WALCHEM Corporation, transportation charges prepaid, has been inspected and determined by WALCHEM Corporation to be defective. Replacement elastomeric parts and glass components are expendable and are not covered by any warranty. THIS WARRANTY IS IN LIEU OF ANY OTHER WARRANTY, EITHER EXPRESS OR IMPLIED, AS TO DESCRIPTION, QUALITY, MERCHANTABILITY, and FITNESS FOR ANY PARTICULAR PURPOSE OR USE, OR ANY OTHER MATTER. 180277 Rev B February 2006

TABLE OF CONTENTS 1.0

SCOPE .................................................................................... 1
VERSIONS ......................................................................................................1

2.0 3.0 4.0

INTRODUCTION...................................................................... 1 OVERVIEW.............................................................................. 2 MODBUS/TCP DRIVER........................................................... 2

4.1 MODBUS PROTOCOL ....................................................................................2 4.1.1. TCP..........................................................................................................2 4.1.2 Function Codes........................................................................................3 4.2 TCP/IP INTERFACE ........................................................................................4 4.3 DATA MODEL .................................................................................................4 4.4 DATA REFRESH .............................................................................................5 4.5 DATA ENCODING ...........................................................................................5 4.5.1 Binary.......................................................................................................5 4.5.2 16-Bit Word (short)...................................................................................6 4.5.3 32-Bit Word (int) .......................................................................................6 4.5.4 Float Inverse ............................................................................................6 4.5.5 Strings......................................................................................................6 4.6 DATA DICTIONARY ........................................................................................7 4.6.1 Addressing (0- or 1-Based) ......................................................................7 4.6.2 Header Data.............................................................................................7 4.6.3 Alarm Data ...............................................................................................8 4.6.4 Status Data ............................................................................................12 4.6.5 Dynamic Data ........................................................................................15

1.0

SCOPE

This document is a User Interface Specification for the Webmaster Modbus/TCP product feature. This is a mapping of the various dynamic variables to their Modbus/TCP register locations. This document supports the Modbus feature in the following software versions: S800v004 or earlier 1.1. VERSIONS Date 1/8/04 1/19/04 2/17/06 Version 0.3 1 2 Author Ron Gross Nate Martin Charles Johnson Changes Functional Spec Based on Functional Spec. Clarification and Commentary S801v003 or earlier

2.0

INTRODUCTION

The Webmaster product supports TCP/IP communications on 3 different network interfaces (USB, modem, and Ethernet). All configurations of set points are accomplished with a computer running a browser (such as Microsoft Internet Explorer) connected to the WebMaster over one of these interfaces. The Modbus/TCP option allows the WebMaster to communicate with PC-based applications such as WonderWare and Intellution HMI/SCADA programs, Building Energy Management systems, Distributed Control Systems (DCS), as well as stand-alone HMI devices. The Modbus/TCP information is only available over the Ethernet interface. The WebMaster is a Modbus Server, meaning that it is only capable of responding to requests from the HMI device. The WebMaster cannot initiate the flow of information, for example, it will not immediately send a new alarm message. It will wait until the HMI device requests the current data contained in specific register locations. In addition, the HMI software cannot be used to change set points. This is only possible using browser software. If the HMI device does not directly support Modbus/TCP protocol, then a protocol translation gateway may be required to convert from Modbus/TCP to a protocol that the device supports. Note that Modbus/RTU requires a serial interface, not Ethernet, and therefore is not directly compatible with the WebMaster.

3.0

OVERVIEW

Modbus/TCP is a form of Modbus that uses the TCP/IP layers as a base layer for controlling the communications between different devices. The Modbus/TCP protocol supports multiple types of data transactions, from reading single bits per transaction, to advanced object-oriented operations. However, to ensure the most compatible system available, the simplest function set is to be made available. The Modbus/TCP has each transaction type classified in to conformance classes, to ensure consistency and interoperability. Class 0 is the simplest, and allows for reading and writing of multiple 16-bit registers. The Modbus/TCP feature of the WebMaster will support reading of these 16-bit registers, which allows the WebMaster to establish a block of data which contains all the process variables, set points, alarms and input/output statuses that are to be made public to a Modbus/TCP client. This block of data is packaged so that it can be read in 16-bit chunks (or registers) at a time, regardless of the type of data within it. In the following sections, the formatting, storing, and reading of this data are described.

4.0
4.1

MODBUS/TCP DRIVER
MODBUS PROTOCOL

The Modbus protocol, as well as the TCP extension, is well documented in the specifications which are available at http://www.modbus.org, a website established by the Modbus Organization for supporting and organizing the Modbus protocol. Only the use of the protocol is documented here. 4.1.1. TCP The Modbus/TCP extension includes 7 additional bytes to the original Modbus protocol, which allows for transport over the TCP/IP layers.
MBAP Header Function Code Data

The MBAP Header (Modbus Application Protocol Header) consists of 7 bytes of information:
Transaction Identifier Protocol Identifier Length Unit Identifier 2 bytes 2 bytes 2 bytes 1 byte identification of Request/Response transaction copied from request to response 0 = Modbus protocol number of following bytes includes the unit identifier identification of remote slave, can be used for broadcasting (not supported)

The Unit Identifier has a special consideration in the WebMaster implementation. If the value is 0, then the request is considered to be a broadcast message; therefore the packet will be processed, and no response will be generated. If the value is anything else, the packet will be processed and a response will be generated. The broadcast Unit Identifier address is not supported as of this release, as the only function code supported is Read Holding Registers; therefore, a response is required at all times. 4.1.2 Function Codes The Modbus/TCP feature only supports Function Code 3 (FC3), Read Multiple Registers, which allows the reading of up to 125 16-bit registers, or quantities, within a single request/response cycle. The 125-register limitation is established for the Modbus/TCP standard to maintain consistency with the original Modbus protocol standard, even though a TCP/IP packet can support more data. Request Function Code Starting Address Quantity of Registers Response Function Code Byte Count Register Values 1 byte 1 byte N* x 2 bytes 0x03 2 x N* 1 byte 2 bytes 2 bytes 0x03 0x0000 to 0xFFFF 1 to 125 (0x01 to 0x7D)

*N = quantity of registers Error Function Code Exception Code 1 byte 1 byte 0x83

Any other Function Code request will be returned with an error response indicating the Function Code is not supported, as well as a request for too much data or data at a register address that is not present.

4.2 TCP/IP INTERFACE The Modbus/TCP interface is attached to the TCP/IP stack that is implemented within the WebMaster product, and will listen to all communications that come in on Modbus/TCP registered port 502. The Modbus/TCP client uses the standard TCP methods for communicating with the driver, as established by the BSD socket interface: connect(), send(), receive() and close(). Up to 10 connections/sockets are possible at one time. If there are 10 active connections, any attempt at any more connections is ignored. Once a connection has been established, it will be closed after 1 minute of inactivity. 4.3 DATA MODEL Modbus bases its data model on a series of tables that have individual characteristics. The four primary tables are: Primary table Discrete Inputs Coils Input Registers data type single bit single bit 16-bits type of access read-only read-write read-only read-write

Holding Registers 16-bits

There is no requirement for how the tables are implemented within the product, but the tables are distinctive because of the method that is used to access them within the protocol. Since only FC3 is supported in the WebMaster implementation, only the Holding Registers-type table is required. To access each entry in to the Holding Register table, a starting address (0 indicates the first entry in the table) is required as well as the number of registers that are requested. The data storage does not need to be consecutive; in fact, this implementation uses multiple blocks within the Holding Register table to support future enhancements and additions to the data without changing the location of the data already present. The Holding Register table is a large structure that contains smaller structures, each containing the specific types of data, and associated with a defined starting address offset for each type of data. The offset allows the driver to determine if the request needs to access data from the specific structure.

The data within the WebMaster system that is to be made public (process variables, set points, alarms and input/output status) is divided in to four structures (header, alarms, status data, and dynamic data). Any time new data needs to be added to the table (upgraded product, different version, etc), the new data is added to the end of the particular structure that corresponds with that type of data. The data is stored within the tables local to the Modbus/TCP driver, which allows the driver to quickly access it during a request. The tables are indexed in to during a request using the starting address of the request and the defined offset for that structure. For example, if the structure containing the headers has an defined offset of 0, and is 128 bytes long and a request for starting address 10 with a length of 5 words is received, the 20th through 29th byte within the table are sent to the client. Once the data is stored within the local tables, the driver does not differentiate what is stored in them. The Modbus/TCP client needs to know what data is stored in which register locations to be able to retrieve it, process it, and/or display it. 4.4 DATA REFRESH

To ensure that the Modbus/TCP client has the most recent data available to it, the Modbus/TCP periodically refreshes the data by reading the selected data and storing it in the specific locations within the tables. The refresh is performed at a periodic rate to ensure data is new, yet not too often to affect the performance of the WebMaster product. 4.5 DATA ENCODING

Modbus uses a big-endian representation for addresses and data items. This means that when a numerical quantity larger than a single byte is transmitted, the MOST significant byte is sent first. The following sub-topics describe the different types of encoding and show how the data is encoded as it is within the Modbus/TCP packet. Most client drivers will extract the data from the packet in the correct format for use/display within the client environment. 4.5.1 Binary A binary item is represented as a single bit within a data word. All binary data is packed in to 16-bit data words, which are accessed using FC3 therefore, a single register contains 16 bits of binary data, each having a specific meaning. value 0xAA55 (101010100101) 1st 0xAA 2nd 0x55

(10101010) (01010101)

4.5.2

16-Bit Word (short)

A 16-bit word item is transmitted with the MOST significant byte first. FC3 reads 16-bit items at a time; therefore, each of these data items will fit within one register that is read. value 0x1234 4.5.3 1st 0x12 2nd 0x34

32-Bit Word (int)

A 32-bit word item is transmitted with the MOST significant byte first, then the next MOST significant, until all bytes are transmitted. FC3 reads 16-bit items at a time; therefore, two registers are required to read each 32-bit data item. 1st register Value 0x12345678 4.5.4 Float Inverse 1st 0x12 2nd 0x34 2nd register 1st 0x56 2nd 0x78

A float is 32-bits within the WebMaster product; therefore is transmitted just as a 32-bit word item is. FC3 reads 16-bit items at a time; therefore, two registers are required to read each float data item. 1st register Value 0x12345678 (as stored in memory) 4.5.5 Strings 1st 0x12 2nd 0x34 2nd register 1st 0x56 2nd 0x78

A string is a group of 8-bit data items having a fixed length. The first character of a string is transmitted first, followed by the remaining characters. FC3 reads 16bit items at a time; therefore, a single register contains two characters of the string. To simply string storage/transfer, each string should be of an even-byte length. 1st register 2nd register 3rd register 4th register value Walchem 1st W 2nd a 1st l 2nd c 1st h 2nd e 1st m 2nd ?

4.6

DATA DICTIONARY

The following tables detail the Modbus addresses required to access each item of the public data. 4.6.1 Addressing (0- or 1-Based) The addressing within the Modbus/TCP protocol (that is, the data within the physical packet) is 0-based, meaning the first element/item to be accessed is referenced by address 0. The Modbus standard for handling and displaying the data is 1-based, meaning the first element/data item to be access is referenced by address 1. Most client applications handle this by having the user enter the 1-based number, and then subtract 1 to revert to the 0-based addressing required at the protocol level. Some client applications allow the user to enter the 0-based number, or a combination, depending on how it is configured. The addresses defined within the following table are 1-based, as the majority of the client applications work with this method. 4.6.2 Header Data Header data consists of strings that are available to describe miscellaneous parts of the product. Refer to section 4.5.5 Strings for the method to extract the string data. For example, to read the Date item, a Read Holding Register request is generated with address 40033 and a register quantity of 12. Example of System Summary Information Table: Header Data Item Controller Name Controller Location Date Software Version Number Model Number Serial Number Controller Phone Number Address 0001 0017 0033 0045 0061 0077 0093 Register Quantity 16 16 12 16 16 16 16 Item Size (bytes) 32 32 24 32 32 32 32

4.6.3

Alarm Data

Alarm states are bit-based, with up to 16 alarms encoded within each register. To access an individual alarm state, the register is read (using the address value before the :), and the specific bit of the register is checked, with the following rules. Refer to section 4.5.2 16-Bit Word (short) for the method to properly extract the data. 1001:1:1 1005:9-4 defines a single bit, with :1 indicating the least significant bit of the word and :16 defining the most significant bit of the word defines multiple bits, with :9-4 defining bits 4 through 9 of the word

NOTE:* unused bits * place holders are provided to allow for future expansion For example, to check the Modem Failure Alarm, a Read Holding Register is generated with address 41001 and a register quantity of 1. When the data is returned, and is extracted, it is bit-ored with 2 to determine the state. While Sensor 1-4 is tied to the physical location of the Sensor 1-4 input cards, the Analog and Digital inputs are tied to the softwares designation of an input. For example, the first analog input programmed as a Level type of input is Level Analog Input [1]. Alarm Data Item Modem Failure Alarm Ethernet Failure Alarm Analog Input Board Failure Alarm Digital Input Board Failure Alarm Non-Responding Slave Alarm * unused bits * Pump Failure Alarm Sensor [1] Board Failure Alarm Sensor [1] Sensor Error Alarm Sensor [1] Low Alarm Sensor [1] High Alarm Sensor [1] Calibration Time Sensor [1] Temperature Error Sensor [1] Temperature Low Alarm Sensor [1] Temperature High Alarm Sensor [2] Board Failure Alarm Sensor [2] Sensor Error Alarm Sensor [2] Low Alarm Sensor [2] High Alarm Sensor [2] Calibration Time
8

Address 1001:2 1001:3 1001:4 1001:5 1001:6 1001:7 1001:16-8 1002:1 1002:2 1002:3 1002:4 1002:5 1002:6 1002:7 1002:8 1002:9 1002:10 1002:11 1002:12 1002:13

Bit Count 1 1 1 1 1 1 9 1 1 1 1 1 1 1 1 1 1 1 1 1

Sensor [2] Temperature Error Sensor [2] Temperature Low Alarm Sensor [2] Temperature High Alarm Sensor [3] Board Failure Alarm Sensor [3] Sensor Error Alarm Sensor [3] Low Alarm Sensor [3] High Alarm Sensor [3] Calibration Time Sensor [3] Temperature Error Sensor [3] Temperature Low Alarm Sensor [3] Temperature High Alarm Sensor [4] Board Failure Alarm Sensor [4] Sensor Error Alarm Sensor [4] Low Alarm Sensor [4] High Alarm Sensor [4] Calibration Time Sensor [4] Temperature Error Sensor [4] Temperature Low Alarm Sensor [4] Temperature High Alarm Level Analog Input [1] Low Alarm Level Analog Input [1] Sensor Error Level Analog Input [2] Low Alarm Level Analog Input [2] Sensor Error Level Analog Input [3] Low Alarm Level Analog Input [3] Sensor Error Level Analog Input [4] Low Alarm Level Analog Input [4] Sensor Error Level Analog Input [5] Low Alarm Level Analog Input [5] Sensor Error Level Analog Input [6] Low Alarm Level Analog Input [6] Sensor Error Level Analog Input [7] Low Alarm Level Analog Input [7] Sensor Error Level Analog Input [8] Low Alarm Level Analog Input [8] Sensor Error Generic Analog Input [1] Low Alarm Generic Analog Input [1] High Alarm Generic Analog Input [1] Sensor Error Generic Analog Input [2] Low Alarm Generic Analog Input [2] High Alarm Generic Analog Input [2] Sensor Error Generic Analog Input [3] Low Alarm Generic Analog Input [3] High Alarm Generic Analog Input [3] Sensor Error
9

1002:14 1002:15 1002:16 1003:1 1003:2 1003:3 1003:4 1003:5 1003:6 1003:7 1003:8 1003:9 1003:10 1003:11 1003:12 1003:13 1003:14 1003:15 1003:16 1004:1 1004:2 1004:9 1004:10 1005:1 1005:2 1005:9 1005:10 1006:1 1006:2 1006:9 1006:10 1007:1 1007:2 1007:9 1007:10 1008:1 1008:2 1008:3 1008:9 1008:10 1008:11 1009:1 1009:2 1009:3

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

Generic Analog Input [4] Low Alarm Generic Analog Input [4] High Alarm Generic Analog Input [4] Sensor Error Generic Analog Input [5] Low Alarm Generic Analog Input [5] High Alarm Generic Analog Input [5] Sensor Error Generic Analog Input [6] Low Alarm Generic Analog Input [6] High Alarm Generic Analog Input [6] Sensor Error Generic Analog Input [7] Low Alarm Generic Analog Input [7] High Alarm Generic Analog Input [7] Sensor Error Generic Analog Input [8] Low Alarm Generic Analog Input [8] High Alarm Generic Analog Input [8] Sensor Error Relay Output Timeout Alarm

1009:9 1009:10 1009:11 1010:1 1010:2 1010:3 1010:9 1010:10 1010:11 1011:1 1011:2 1011:3 1011:9 1011:10 1011:11 1012:1-8

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 8

Flow Meter Analog Input [1] Sensor Error Flow Meter Analog Input [1] High Alarm Flow Meter Analog Input [1] Low Alarm Flow Meter Analog Input [1] Total Alarm Flow Meter Analog Input [2] Sensor Error Flow Meter Analog Input [2] High Alarm Flow Meter Analog Input [2] Low Alarm Flow Meter Analog Input [2] Total Alarm Flow Meter Analog Input [3] Sensor Error Flow Meter Analog Input [3] High Alarm Flow Meter Analog Input [3] Low Alarm Flow Meter Analog Input [3] Total Alarm Flow Meter Analog Input [4] Sensor Error Flow Meter Analog Input [4] High Alarm Flow Meter Analog Input [4] Low Alarm Flow Meter Analog Input [4] Total Alarm Flow Meter Analog Input [5] Sensor Error Flow Meter Analog Input [5] High Alarm Flow Meter Analog Input [5] Low Alarm

1012:9 1012:10 1012:11 1012:12 1013:1 1013:2 1013:3 1013:4 1013:9 1013:10 1013:11 1013:12 1014:1 1014:2 1014:3 1014:4 1014:9 1014:10 1014:11

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

10

Flow Meter Analog Input [5] Total Alarm Flow Meter Analog Input [6] Sensor Error Flow Meter Analog Input [6] High Alarm Flow Meter Analog Input [6] Low Alarm Flow Meter Analog Input [6] Total Alarm Flow Meter Analog Input [7] Sensor Error Flow Meter Analog Input [7] High Alarm Flow Meter Analog Input [7] Low Alarm Flow Meter Analog Input [7] Total Alarm Flow Meter Analog Input [8] Sensor Error Flow Meter Analog Input [8] High Alarm Flow Meter Analog Input [8] Low Alarm Flow Meter Analog Input [8] Total Alarm Level Switch Low Alarm Generic Counter Rate High Alarm Generic Counter Rate Low Alarm Generic Counter Total Alarm Generic Input Alarm Flow Meter Digital Input [1] High Alarm Flow Meter Digital Input [1] Low Alarm Flow Meter Digital Input [1] Total Alarm Flow Meter Digital Input [2] High Alarm Flow Meter Digital Input [2] Low Alarm Flow Meter Digital Input [2] Total Alarm Flow Meter Digital Input [3] High Alarm Flow Meter Digital Input [3] Low Alarm Flow Meter Digital Input [3] Total Alarm Flow Meter Digital Input [4] High Alarm Flow Meter Digital Input [4] Low Alarm Flow Meter Digital Input [4] Total Alarm Flow Meter Digital Input [5] High Alarm Flow Meter Digital Input [5] Low Alarm Flow Meter Digital Input [5] Total Alarm Flow Meter Digital Input [6] High Alarm Flow Meter Digital Input [6] Low Alarm Flow Meter Digital Input [6] Total Alarm Flow Meter Digital Input [7] High Alarm

1014:12 1015:1 1015:2 1015:3 1015:4 1015:9 1015:10 1015:11 1015:12 1016:1 1016:2 1016:3 1016:4 1018:1-9 1020:1-9 1022:1-9 1024:1-9 1026:1-9 1028:1 1028:2 1028:3 1028:9 1028:10 1028:11 1029:1 1029:2 1029:3 1029:9 1029:10 1029:11 1030:1 1030:2 1030:3 1030:9 1030:10 1030:11 1031:1

1 1 1 1 1 1 1 1 1 1 1 1 1 7 9 9 9 9 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

11

Flow Meter Digital Input [7] Low Alarm Flow Meter Digital Input [7] Total Alarm Flow Meter Digital Input [8] High Alarm Flow Meter Digital Input [8] Low Alarm Flow Meter Digital Input [8] Total Alarm Flow Meter Digital Input [9] High Alarm Flow Meter Digital Input [9] Low Alarm Flow Meter Digital Input [9] Total Alarm 4.6.4 Status Data

1031:2 1031:3 1031:9 1031:10 1031:11 1032:1 1032:2 1032:3

1 1 1 1 1 1 1 1

Status data generally consists of 16-bit words, 32-bit longs or floats. To access an individual Status Data item, 1 or 2 registers are required to be read. Refer to sections 4.5.2 16-Bit Word (short), 4.5.3 32-Bit Word (int) and 4.5.4 Float Inverse for the methods to properly extract the data. The following rules indicate the format of the table: Address defines the starting address to read to access the first element (or only element) of the item

Register Count (Item) defines the number of registers to read to access a single element of the item Register Count (Total)defines the number of registers to read to access all elements of the item Item Count Item [6-1] defines the number of elements within the full item defines the item is an array of elements, with item [1] being accessed first (first set of registers).

For example, to check the second element of Flow meter Analog Input [2] Status, a Read Holding Register is generated with address 42051 (42049 + 2) and a register quantity of 2. While Sensor 1-4 is tied to the physical location of the Sensor 1-4 input cards, the Analog and Digital inputs are tied to the softwares designation of an input. For example, the first analog input programmed as a Level type of input is Level Analog Input [1]. Status Data Item Address Register Count (Item) 2001 2009 2017 2033 2049 2065 2 2 2 2 2 2 Register Count (Total) 8 8 16 16 16 18 Item Count 4 4 8 8 8 9

Sensor [1-4] Status Temperature [1-4] Status Generic Analog Input [1-8] Status Level Analog Input [1-8] Status Flow meter Analog Input [1-8] Status Flow meter Digital Input [1-9] Status

12

Relay Output [1]Control Mode (Hand-OffAuto) Relay Output [1] On-Time SV.OutputStatus [2].OutMode SV.OutputStatus [2].On SV.OutputStatus [3].OutMode SV.OutputStatus [3].On SV.OutputStatus [4].OutMode SV.OutputStatus [4].On SV.OutputStatus [5].OutMode SV.OutputStatus [5].On SV.OutputStatus [6].OutMode SV.OutputStatus [6].On SV.OutputStatus [7].OutMode SV.OutputStatus [7].On SV.OutputStatus [8].OutMode SV.OutputStatus [8].On 4-20 mA Output Status [4-1] Digital Input State [A-C, 1-6]

2083 2085 2086 2088 2089 2091 2092 2094 2095 2097 2098 2100 2101 2103 2104 2106 2107 2115

2 1 2 1 2 1 2 1 2 1 2 1 2 1 2 1 2 1 1

2 1 2 1 2 1 2 1 2 1 2 1 2 1 2 1 8 1 1

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 4 1 1

SV.Connection.DialedManually 2119 The status message is encoded using the following values.
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Normal Off On Ok Self Test Wait Sampling Hold Sensor Error High Alarm Low Alarm Calibration Time Board Failure Pump Failure Total Alarm

For Sensor inputs, Temperature inputs, Digital inputs and Analog inputs:

13

For Analog outputs and Relay outputs: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 Off On Time Out A/D Startup Hand Manual Off Failure Invalid Calibrate Calibrate Sen 1 Calibrate Sen 2 Calibrate Sen 3 Calibrate Sen 4 Normal Overrange Underrange Loop Cal Sensor Error Internal Lock Unknown DI A Lockout DI B Lockout DI C Lockout DI 1 Lockout DI 2 Lockout DI 3 Lockout DI 4 Lockout DI 5 Lockout DI 6 Lockout 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 Relay 1 Lockout Relay 2 Lockout Relay 3 Lockout Relay 4 Lockout Relay 5 Lockout Relay 6 Lockout Relay 7 Lockout Relay 8 Lockout No Sensor Selected Waiting Sampling Holding Blowdown No Posi-Flow Configured Units Mismatch Disp. Lockout Bio Lockout PreBleed Lockout Pre-Bleed Waiting On Delay Pending Bleed Lockout Time Bio Add Dispersant Add

Relay Output Modes Digital Input States

256 = On 0 = Off

4.6.5

Dynamic Data

Dynamic data generally consists of 16-bit words, 32-bit longs or floats. To access an individual Dynamic Data item, 1 or 2 registers are required to be read. Refer to sections 4.5.2 16-Bit Word (short), 4.5.3 32-Bit Word (int) and 4.5.4 Float Inverse for the methods to properly extract the data. The following rules indicate the format of the table: Address Register Count (Item) Register Count (Total) Item Count Item [6-1] defines the starting address to read to access the first element (or only element) of the item defines the number of registers to read to access a single element of the item defines the number of registers to read to access all elements of the item defines the number of elements within the full item defines the item is an array of elements, with item [1] being accessed first (first set of registers).

For example, to check the item Sensor [1] Current Reading, a Read Holding Register is generated with address 43001 and a register quantity of 2. While Sensor 1-4 is tied to the physical location of the Sensor 1-4 input cards, the Analog and Digital inputs are tied to the softwares designation of an input. For example, the first analog input programmed as a Level type of input is Level Analog Input [1]. Dynamic Data Item
Sensor [1] Current Reading Sensor [1] Uncalibrated Reading Sensor [1] mV Output Sensor [1] Temperature Reading Sensor [1] Uncalibrated Temperature * unused bits * Sensor [2] Current Reading Sensor [2] Uncalibrated Reading Sensor [2] mV Output Sensor [2] Temperature Reading Sensor [2] Uncalibrated Temperature * unused bits * Sensor [3] Current Reading Sensor [3] Uncalibrated Reading Sensor [3] mV Output Sensor [3] Temperature Reading Sensor [3] Uncalibrated Temperature * unused bits * Sensor [4] Current Reading

Address
3001 3003 3005 3007 3009 3011 3013 3015 3017 3019 3021 3023 3025 3027 3029 3031 3033 3035 3037

Register Count (Item)

Register Count (Total)

Item Count
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

15

Sensor [4] Uncalibrated Reading Sensor [4] mV Output Sensor [4] Temperature Reading Sensor [4] Uncalibrated Temperature * unused bits * 4-20 mA Input [8-1] Uncalibrated mA Reading 4-20 mA Input [8-1] Calibrated Present mA Generic 4-20 [8-1] Present Value Generic 4-20 [8-1] mA? Level 4-20 [8-1] Present Volume * unused bits * PosiFlow [A] Total PosiFlow [A] Date/Time of Last Total Reset * unused bits * PosiFlow [B] Total PosiFlow [B] Date/Time of Last Total Reset * unused bits * PosiFlow [C] Total PosiFlow [C] Date/Time of Last Total Reset * unused bits * PosiFlow [1] Total PosiFlow [1] Date/Time of Last Total Reset * unused bits * PosiFlow [2] Total PosiFlow [2] Date/Time of Last Total Reset * unused bits * PosiFlow [3] Total PosiFlow [3] Date/Time of Last Total Reset * unused bits * PosiFlow [4] Total PosiFlow [4] Date/Time of Last Total Reset * unused bits * PosiFlow [5] Total PosiFlow [5] Date/Time of Last Total Reset * unused bits * PosiFlow [6] Total PosiFlow [6] Date/Time of Last Total Reset 4-20 mA Output [1] Scaled Input Value 4-20 mA Output [1] mA Output 4-20 mA Output [2] Scaled Input Value 4-20 mA Output [2] mA Output 4-20 mA Output [3] Scaled Input Value 4-20 mA Output [3] mA Output 4-20 mA Output [4] Scaled Input Value 4-20 mA Output [4] mA Output Min, Max and Ave Calculated Over x Hours
16

3039 3041 3043 3045 3047 3049 3065 3081 3097 3113 3129 3133 3135 3129 3155 3157 3129 3177 3179 3129 3199 3201 3129 3221 3223 3129 3243 3245 3129 3265 3267 3129 3287 3289 3129 3309 3311 3327 3329 3331 3333 3335 3337 3339 3341 3344

2 2 2 2 2 2 2 2 2 2 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 2 2 2 2 2 2 2 2 1

2 2 2 2 2 16 16 16 16 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 4 2 16 2 2 2 2 2 2 2 2 1

1 1 1 1 1 8 8 8 8 8 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

Sensor [1] Average Reading Sensor [1] Minimum Reading Sensor [1] Maximum Reading Sensor [2] Average Reading Sensor [2] Minimum Reading Sensor [2] Maximum Reading Sensor [3] Average Reading Sensor [3] Minimum Reading Sensor [3] Maximum Reading Sensor [4] Average Reading Sensor [4] Minimum Reading Sensor [4] Maximum Reading Generic AI [1] Average Reading Generic AI [1] Minimum Reading Generic AI [1] Maximum Reading Generic AI [2] Average Reading Generic AI [2] Minimum Reading Generic AI [2] Maximum Reading Generic AI [3] Average Reading Generic AI [3] Minimum Reading Generic AI [3] Maximum Reading Generic AI [4] Average Reading Generic AI [4] Minimum Reading Generic AI [4] Maximum Reading Generic AI [5] Average Reading Generic AI [5] Minimum Reading Generic AI [5] Maximum Reading Generic AI [6] Average Reading Generic AI [6] Minimum Reading Generic AI [6] Maximum Reading Generic AI [7] Average Reading Generic AI [7] Minimum Reading Generic AI [7] Maximum Reading Generic AI [8] Average Reading Generic AI [8] Minimum Reading Generic AI [8] Maximum Reading Level AI [1] Average Reading Level AI [1] Minimum Reading Level AI [1] Maximum Reading Level AI [2] Average Reading Level AI [2] Minimum Reading Level AI [2] Maximum Reading Level AI [3] Average Reading Level AI [3] Minimum Reading Level AI [3] Maximum Reading Level AI [4] Average Reading Level AI [4] Minimum Reading
17

3345 3347 3349 3351 3353 3355 3357 3359 3361 3363 3365 3367 3369 3371 3373 3375 3377 3379 3381 3383 3385 3387 3389 3391 3393 3395 3397 3399 3401 3403 3405 3407 3409 3411 3413 3415 3417 3419 3421 3423 3425 3427 3429 3431 3433 3435 3437

2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2

2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

Level AI [4] Maximum Reading Level AI [5] Average Reading Level AI [5] Minimum Reading Level AI [5] Maximum Reading Level AI [6] Average Reading Level AI [6] Minimum Reading Level AI [6] Maximum Reading Level AI [7] Average Reading Level AI [7] Minimum Reading Level AI [7] Maximum Reading Level AI [8] Average Reading Level AI [8] Minimum Reading Level AI [8] Maximum Reading Flow meter AI [1] Average Reading Flow meter AI [1] Minimum Reading Flow meter AI [1] Maximum Reading Flow meter AI [2] Average Reading Flow meter AI [2] Minimum Reading Flow meter AI [2] Maximum Reading Flow meter AI [3] Average Reading Flow meter AI [3] Minimum Reading Flow meter AI [3] Maximum Reading Flow meter AI [4] Average Reading Flow meter AI [4] Minimum Reading Flow meter AI [4] Maximum Reading Flow meter AI [5] Average Reading Flow meter AI [5] Minimum Reading Flow meter AI [5] Maximum Reading Flow meter AI [6] Average Reading Flow meter AI [6] Minimum Reading Flow meter AI [6] Maximum Reading Flow meter AI [7] Average Reading Flow meter AI [7] Minimum Reading Flow meter AI [7] Maximum Reading Flow meter AI [8] Average Reading Flow meter AI [8] Minimum Reading Flow meter AI [8] Maximum Reading Flow meter AI [1] Total Flow meter AI [1] Rate Flow meter AI [2] Total Flow meter AI [2] Rate Flow meter AI [3] Total Flow meter AI [3] Rate
18

3439 3441 3443 3445 3447 3449 3451 3453 3455 3457 3459 3461 3463 3465 3467 3469 3471 3473 3475 3477 3479 3481 3483 3485 3487 3489 3491 3493 3495 3497 3499 3501 3503 3505 3507 3509 3511 3513 3515 3517 3519 3521 3523

2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2

2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

Flow meter AI [4] Total Flow meter AI [4] Rate Flow meter AI [5] Total Flow meter AI [5] Rate Flow meter AI [6] Total Flow meter AI [6] Rate Flow meter AI [7] Total Flow meter AI [7] Rate Flow meter AI [8] Total Flow meter AI [8] Rate Flow Meter Digital Input [A] Total Flow Meter Digital Input [A] Rate Flow Meter Digital Input [B] Total Flow Meter Digital Input [B] Rate Flow Meter Digital Input [C] Total Flow Meter Digital Input [C] Rate Flow Meter Digital Input [1] Total Flow Meter Digital Input [1] Rate Flow Meter Digital Input [2] Total Flow Meter Digital Input [2] Rate Flow Meter Digital Input [3] Total Flow Meter Digital Input [3] Rate Flow Meter Digital Input [4] Total Flow Meter Digital Input [4] Rate Flow Meter Digital Input [5] Total Flow Meter Digital Input [5] Rate Flow Meter Digital Input [6] Total Flow Meter Digital Input [6] Rate RSI LSI

3525 3527 3529 3531 3533 3535 3537 3539 3541 3543 3545 3547 3549 3551 3553 3555 3557 3559 3561 3563 3565 3567 3569 3571 3573 3575 3577 3579 3581 3583

2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2

2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2

1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

19