iXC2 Industrial Programmable Remote Terminal Unit (RTU ...literature.rockwellautomation.com/idc/groups/literature/documents/... · iXC2 Industrial Programmable Remote Terminal Unit

iXC2 Industrial Programmable Remote Terminal Unit (RTU)Catalog Numbers 1759-HP17BBBA, 1759-HP17BBBA-VGA

User ManualOriginal Instructions

Important User Information

Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.

Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by suitably trained personnel in accordance with applicable code of practice.

If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be impaired.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

Labels may also be on or inside the equipment to provide specific precautions.

WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to personal injury or death, property damage, or economic loss.

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.

IMPORTANT Identifies information that is critical for successful application and understanding of the product.

SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present.

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous temperatures.

ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).

Table of Contents

Preface Summary of Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Abbreviations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 1Overview Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Standard Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 2Install Your RTU Agency Certifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Safety Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Installation Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Environmental Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Power the RTU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Mount the RTU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Base Unit Mounting Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Using the DIN Rail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 3Embedded I/O Analog Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

DIP Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Digital Inputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Analog Outputs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Digital Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 4Communication Ports COM 1 – RS-232 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

COM 2 – RS-485 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20COM 4 – RS-232 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20LAN1 and LAN2 – Ethernet Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21USB Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 5Communication Port Configuration Default Communication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

COM Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Ethernet Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Rockwell Automation Publication 1759-UM001D-EN-P - January 2018 3

Table of Contents

Chapter 6Communication Protocols EtherNet/IP Device Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

CIP Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Protocol Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28EtherNet/IP Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Connection Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

DNP3 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Protocol Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30DNP3 Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Enron Modbus Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Report Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

MQTT Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33TLS Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Static Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Dynamic Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Chapter 7Access the RTU Login Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

The Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Chapter 8General System Configuration RTU Kernel Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Board Time Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Device ID Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Chapter 9System Status System Status Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

I/O Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Module Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59ISAGRAF Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 10I/O Configuration Configure the AI Channels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Configure the DI Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Configure the AO Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Configure the DO Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Chapter 11Interface Protocols RTU Slave Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

RTU Slave Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69TCP Slave Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70TCP Slave Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

4 Rockwell Automation Publication 1759-UM001D-EN-P - January 2018

Table of Contents

Chapter 12Modbus 3rd Party Interface Modbus RTU Master Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Slave Device Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74RTU Master Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Modbus TCP Master Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78TCP Master Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Internal Transfer Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Chapter 13Logging Message Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Data Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Modbus Data Copy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Chapter 14Advanced Applications RTU Kernel Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Module Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Wireless Messaging Protocol (Gateway). . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

WMP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Serial Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Rejected Serial Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Rejected Transmitters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Registered Transmitters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Change Transmitter ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98WMP Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99WMP Hardware Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Web Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Chapter 15Restore Default Configuration Restore Default Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Chapter 16Downloads ISAGRAF Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Download Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Configuration Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Chapter 17System Upgrade System Upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107


Table of Contents

Chapter 18User-defined Programming (ISAGRAF 6.4) Create a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Create Target Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Add a New Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Wire the Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Configure the Connection Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Create a Simple-addition Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Build the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Appendix ASwitch COM1 to RS-485 Configure RTU COM1 as RS-485 with the BIOS Setting . . . . . . . . . . 119

Appendix BvMiConfig for iXC2 RTU Software Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

iXC2 RTU Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Launch the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Creating a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Modbus Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Modbus Mapping Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

DNP3 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132DNP3 Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132DNP3 Outstation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Mapping and Reformat Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Download the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Monitor the DNP3 Outstation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Event Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152DNP3 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Enron Modbus Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Report Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

MQTT Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Downloading Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Monitoring MQTT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

EtherNet/IP Scanner Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Downloading the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Appendix CDNP3 Object Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Appendix DDNP3 Event Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189


Preface

This manual introduces you to the key components of the iXC2 industrial programmable remote terminal unit (RTU) and describes the procedures for installation, wiring, and system configuration.

You must have a basic understanding of electrical circuitry and be familiar with data acquisition and automation to install, configure, or operate the RTU. If not, obtain the proper training before using this product.

Summary of Changes The table below lists the sections that document new features and additional or updated information on existing features.

Abbreviations This publication uses these abbreviations.

Topic Page

Updated MQTT Implementation - Chapter 6 33

Added new section, MQTT Application - Appendix B 162

Abbreviation Meaning Abbreviation Meaning

AI Analog input iNOC Intelligent Net Oil Computer

AO Analog output I/O Input/output

API Application programming interface IP Internet protocol

ASCII American Standard Code for Information Interchange

LAN Local area network

COM Communication (serial port interface)

LED Light-emitting diode

CPU Central processing unit OPC Open Platform Communications

CTS Clear to send PLC Programmable Logic RTU

DA Data Access RAM Random access memory

DC Direct current RTS Request to Send

DI Digital input RTU Remote terminal unit

DNS Domain name system RX Receive wire

DO Digital output SNMP Simple network management protocol

ETCP Extended transmission control protocol

SQL Structured query language

EU Engineering units TCP Transmission control protocol

FIFO First in, first out TX Transmission wire

GND Electrical ground USB Universal serial bus

HMI Human machine interface VGA Video graphics array

IDE Integrated drive electronics WMP Wireless Messaging Protocol

IEC International Electrotechnical Commission

Rockwell Automation Publication 1759-UM001C-EN-P - January 2018 7

Preface

Additional Resources These documents contain additional information concerning related products from Rockwell Automation.

Contact your local distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/support.

Resource Description

Industrial Automation Wiring and Grounding Guidelines, publication 1770-4.1

Provides general guidelines for installing a Rockwell Automation® industrial system.

Product Certifications website, http://www.ab.com Provides declarations of conformity, certificates, and other certification details.

Modbus Protocol Specifications Available fromwww.modbus.org

Information about the Modbus protocol

National Electrical Code - Published by the National FireProtection Association of Boston, MA.

An article on wire sizes and types for grounding electrical equipment.

IEC 61131-3 Programming Industrial Automation Systems, publication IEC 61131-3

Discusses concepts and programming languages. requirements for programming systems, and aids to decision-making tools.

Allen-Bradley® Industrial Automation Glossary AG-7.1 A glossary of industrial automation Terms andAbbreviations.


http://www.literature.rockwellautomation.com/idc/groups/literature/documents/in/1770-in041_-en-p.pdf


http://www.ab.com

www.modbus.org

www.modbus.org

http://www.dee.ufrj.br/controle_automatico/cursos/IEC61131-3_Programming_Industrial_Automation_Systems.pdf

http://literature.rockwellautomation.com/idc/groups/literature/documents/qr/ag-qr071_-en-p.pdf

http://www.rockwellautomation.com/support

Chapter 1

About the iXC2 RTU

The iXC2 RTU monitors and controls industrial processes such as oil and gas, petrochemical, artificial lift, pump control, and tank level. Combined with the Rockwell Automation® advanced wireless technology, this RTU offers user-configured settings with expansive multi-user connectivity.

Features Overview The RTU is designed with a host of features that can be controlled and monitored remotely. Remote control is done with a web server or Supervisory Control and Data Acquisition (SCADA) network. Figure 1 shows the features that are included in the RTU.

Figure 1 - Feature Description

Feature Description Feature Description Feature Description

1 Primary Power Terminal Connector 7 Power Switch 13 Power Status Indicator

2 Analog Output Terminals 8 Secondary Power Terminal Connector 14 COM 1 Communication Ports

3 Digital Input Terminals 9 Analog Input Terminals 15 VGA Connector

4 Timer Measurement / Opto-isolator Digital Input Terminals

10 Digital Output Terminals 16 Connector Antenna (Wireless radio optional)

5 LAN 2 Ethernet Port 11 COM 4 Communication Serial Port 17 USB Port

6 LAN 1 Ethernet Port 12 COM 2 Communication Serial Port


Chapter 1 About the iXC2 RTU

Notes:


Chapter 2

Install Your RTU

This chapter shows you how to install your RTU. Topics include the following:• Agency Certifications• Safety Considerations• Environmental Specifications• Power the RTU• Mount the RTU

The only tools that are required for these installations are a screwdriver and drill.

Agency Certifications CE

European Union 2004/108/IEC EMC Directive, compliant with:• EN 61326-1; Meas./Control/Lab., Industrial Requirements• EN 61000-6-2; Industrial Immunity• EN 61000-6-4; Industrial Emissions

Ex

European Union 94/9/EC ATEX Directive, compliant with:

EN 61131-2:2007: Programmable controllers – Part 2: Equipment requirements and tests (Clause 8: Zone A/B EMC)

EN 61326-1:2013: Electrical equipment for measurement, control and laboratory use – EMC requirements – Part 1: General requirements (Industrial)

EN 60079-0:2012: Explosive Atmospheres – Part 0: Equipment – General Requirements

EN 60079-15; Potentially Explosive Atmospheres, Protection “n” EN 60079-0; General Requirements II 3 G Ex nA IIB T4 Gc

ATEX Markings

II 3G Ex nA IIB T4 Gc (-30°C <Ta < +70°C)


Chapter 2 Install Your RTU

C-Tick

Australian Radiocommunications Act, compliant with: AS/NZS CISPR11; Industrial Emissions.

Safety Considerations Safety considerations are an important element of proper system installation. Actively considering the safety of yourself and others, and the condition of your equipment, is of primary importance. We recommend reviewing the following safety considerations.

Installation Considerations

Most applications require installation in an industrial enclosure (Pollution Degree 2(1)) to reduce the effects of electrical interference (Over Voltage Category II(2)) and environmental exposure. Locate your RTU as far as possible from power lines, load lines, and other sources of electrical noise such as hard-contact switches, relays, and AC motor drives. For more information on proper grounding guidelines, see the Industrial Automation Wiring and Grounding Guidelines publication 1770-4.1.

(1) Pollution Degree 2 is an environment where normally only non-conductive pollution occurs except that occasionally temporaryconductivity caused by condensation shall be expected.

(2) Over-voltage Category II is the load level section of the electrical distribution system. At this level, transient voltages are controlled and do not exceed the impulse voltage capability of the products insulation.

Environmental Specifications Follow these temperature ratings for installations.

WARNING: EXPLOSION HAZARD in hazardous area• Substitution of components impairs the suitability for Zone 2.• Do not replace components or disconnect equipment unless power has been

switched off.• Do not connect or disconnect components unless power has been switched off.• This product must be installed in an enclosure. All cables that are connected to

the product must remain in the enclosure, conduit, or other means.

ATTENTION: Be careful of metal chips when drilling mounting holes for your RTU or other equipment within the enclosure or panel. Drilled fragments that fall into the base or processor unit could cause damage. Do not drill holes above a mounted RTU if the protective debris strips are removed or the processor is installed.

Operating and Storage Humidity 0...90% Non-Condensing

Operating and Storage Temperature -40...85 °C



Install Your RTU Chapter 2

Power the RTU Perform these steps to power on the RTU.

1. Apply DC power (12…28V DC input range) at the PWR+ and PWR- terminals of the RTU.

2. Turn on the power switch.

3. Verify that the board is powered on by checking that Power status indicator illuminates red.

IMPORTANT The RTU is also equipped with a second set of power terminals. The second set of terminals are used as a pass-through to power the field devices.

Feature Description

1 Primary Power Terminal Connector

2 Power Status Indicator

3 Power On/Off Switch

4 Secondary Power Terminal Connector


Chapter 2 Install Your RTU

Mount the RTU Base Unit Mounting Dimensions

Using the DIN Rail

The RTU is mounted to an EN50022-35x7.5 DIN rail, which is enclosed with the unit. To mount the RTU on a DIN rail, follow these steps.

1. Close the DIN rail latches.

2. Press the DIN rail mounting area of the RTU against the DIN rail.

The latches open, then locks in place.

The base-unit latches lock in the open position so that an entire system can be easily attached to, or removed from, the DIN rail. The maximum extension of the latch is 15 mm (0.67 in.) in the open position; however, the latch can be adjusted to accommodate the mounting requirements. A screwdriver is required for removal of the base unit.

3. Maintain spacing from enclosure walls, wireways, and adjacent equipment. Allow 50 mm (2 in.) of space on all sides, as shown. This method provides ventilation and electrical isolation.

4. This product is intended to be mounted to a well-grounded mounting surface such as a metal panel. Additional grounding connections from the RTU grounding tab or DIN rail (if used) are not required unless the mounting surface cannot be grounded. For additional information, see publication 1770.4-1.

ATTENTION: Electrostatic discharge can damage semiconductor devices inside the base unit. Do not touch the connector pins or other sensitive areas.



Chapter 3

Embedded I/O

This chapter describes the types of I/O available with the RTU, I/O wiring, and DIP switch configurations. Topics include the following:

• Analog Inputs• Digital Inputs• Analog Outputs• Digital Outputs

Analog Inputs The RTU has eight available analog inputs (AI), with each channel providing 24-bit resolution. All AI is transient-protected with a signal range of 4…20 mA. Here is a list of the supported RTU voltage ranges.

• 0…5.12V• 0…2.56V• 0…1.25V• 0…640 mV• 0…320 mV• 0…160 mV• 0…80 mV• 0…40 mV

Figure 2 - Typical Wiring for the RTU AI Terminal

TIP The RTU also supports differential voltage inputs.

IMPORTANT AI channels support sourcing-type sensors; not the sinking type.


Chapter 3 Embedded I/O

DIP Switches

The AI of the RTU can be powered with voltage or current. To switch the power setting, access the DIP switch in the I/O card, next to the power switch.

Follow these instructions to access the DIP switches.

1. Power off the RTU.

2. Use a small Phillips screwdriver (PH1x80) to loosen and remove the screws that fasten the case to the iXC2 unit.

3. Carefully lift to remove the case from unit.

4. To select the AI type (On: Current / Closed: Voltage), use the AI Switch, on the flush side of the RTU. Switch 1 applies to AI 1, and Switch 8 applies to AI 8.

5. Lower the case on the unit.

6. Hand-tighten each screw with the small Phillips screwdriver (PH1x80).

7. Repower the RTU.

WARNING: Remove the power before you remove or insert wires. When you remove or insert a module with power applied, an electric arc occurs. An electric arc can cause personal injury or property damage by:• Sending an erroneous signal to your system’s field devices, causing unintended

machine motion• Causing an explosion in a hazardous environmentElectrical arcing causes excessive wear to contacts on both the module and its mating connector. Worn contacts create electrical resistance.


Embedded I/O Chapter 3

Digital Inputs There are eight opto-isolator digital inputs (DI) and one separate hardware opto-isolator DI that is dedicated to the Pulse accumulation and counter.

Figure 3 - Typical Wiring for the RTU DI Terminal

Analog Outputs There are two analog outputs (AO) with 12-bit resolution. They can be configured for a 4…20 mA or 1…5V output. These outputs can handle loads up to 400 Ω.

Figure 4 - Typical Wiring for the RTU AO Terminal

ATTENTION: Electrostatic discharge can damage integrated circuits or semiconductors if you touch bus connector pins. Follow these guidelines when you handle any module:• Touch a grounded object to discharge static potential.• Wear an approved wriststrap grounding device.• Do not touch the bus connector or connector pins.• Do not touch circuit components inside the module.• If available, use a static-safe workstation.• When not in use, keep the module in its static-shield bag.


Chapter 3 Embedded I/O

Digital Outputs There are eight digital outputs (DO) with transient protection. Each DO sinks up to 500 mA.

Figure 5 - Typical Wiring for the RTU DO Terminal


Chapter 4

Communication Ports

This chapter describes the communication features that are available with the RTU. The method that you use and cables that are required depend on your application. Topics include the following:

• COM 1 – RS-232• COM 2 – RS-485• COM 4 – RS-232• LAN1 and LAN2 – Ethernet Port• USB Port

COM 1 – RS-232 COM1 requires a RJ45-to-DB9 adapter to support RS-232 communications. COM1 can also be configured as a Modbus RTU slave, or Modbus RTU master, to connect to any third-party device.

To configure the wiring for COM1, connect RX, TX, and GND. For a successful “hardware handshake”, you must wire the request to send (RTS) and clear to send (CTS) lines, and check the Toggle RTS on the COM configuration page.

Table 1 describes the RJ45 connector pinout. See Figure 6 for a description of the components of the connection.

Table 1 - RJ45 Connection

TIP See Appendix A for information on switching the RTU from COM 1 to RS-485.

RJ45 Pin# Color DB9 Pin# Signal Name

1 White-Orange 4 DTR out

2 Orange N/C

3 White-Green 6 DSR in

4 Blue 5 GND

5 White-Blue 3 TXD out

6 Green 2 RXD in

7 White-Brown 7 RTS out

8 Brown 8 CTS in


Chapter 4 Communication Ports

Figure 6 - RJ45 Connector Pin Out

COM 2 – RS-485 COM 2 is available on the RTU as an RS-485 Modbus. COM2 can also be configured as a Modbus RTU slave, or as a Modbus RTU master to connect to any third-party device. It connects multiple third-party devices, but is only able to make two-wire, half-duplex connections.

The RTU has a pair of status indicator lights that show the COM2 Communication status. When COM2 is communicating, the pair of lights blinks green for TX and yellow for RX.

COM 4 – RS-232 COM4 can be configured as a Modbus RTU slave, or as a Modbus RTU master, to connect to any third-party device. Only one third-party device can be connected to COM4 at a time. Wiring for this port can be done by connecting RX, TX, and GND. For the “hardware hands shake”, wire the RTS and CTS lines, and check the Toggle RTS on the COM configuration page.

IMPORTANT COM4 is the default port for WMP protocol. When WMP is enabled on COM4, it is not used for third parties.

TIP COM4 can be configured as RS-485 and ZigBee also unless an outdated hardware version is being used.


Communication Ports Chapter 4

LAN1 and LAN2 – Ethernet Port

The RTU has two Ethernet ports that are used to make TCP/IP connections. See Figure 1. The RJ45 connector is used to connect TCP/IP. This port is a 10/100 Ethernet with light-emitting diodes, TX/RX, and works with a straight Ethernet cable for both device-to-personal computer and device-to-device connections. With this LAN connection, crossover cable is not applicable, because the RTU has built-in switching functionality of the TX and RX signals. Table 2 shows the signal connection.

Table 2 - TCP/IP Connections

USB Port The USB port is used to update the loading firmware to the RTU. It also connects peripheral devices such as the mouse and/or keyboard.

Ethernet RJ45 Signal

1 TX+

2 TX-

3 RX+

6 RX-


Chapter 4 Communication Ports

Notes:


Chapter 5

Communication Port Configuration

This chapter describes how to configure the communication ports. Topics include the following:

• Default Communication Configuration• COM Port Configuration• Ethernet Port Configuration

Default Communication Configuration

The RTU has the following default communication configuration.

Table 3 - Default Configuration Parameters

Parameter Default

Communication Rate 9600

Default Parity None

Default Modbus Device ID 1

Default Number of Data Bits for Modbus Communication 8

Default Number of Stop Bits Used in Data Packet 1

COM 1/COM 4 Mode RS-232

COM 2 Mode RS-485


Chapter 5 Communication Port Configuration

COM Port Configuration This section provides information on how to configure the COM port settings. To configure these settings, open the Web Application Tool at Main Menu>System Configuration>COM Port.

Choose a combination of options from the pull-down menu, as per your requirement, and click Set & Restart to see the update.

Figure 7 - COM Port Configuration Page

Item Description

Communication Rate Communication Rate of corresponding COM port

Data Bit Number of Data Bits to be used in a Data packet for Modbus Communication for the corresponding COM Port

Parity Parity to be used in a Data packet for Modbus Communication for the corresponding COM Port.

StopBit Number of Stop Bits to be used in a Data packet for Modbus Communication for the corresponding COM Port

H/W Flow Control Enable Hardware hand shake with RTS and CTS lines of RS-232 Serial Port

Delay After RTS After setting RTS (request to send) line high, the Maximum time the COM port will wait for getting back a CTS (Clear to Send) from the Slave Device.

Type Determines whether COM 1 and COM 4 work on RS-232 or RS-485 mode


Communication Port Configuration Chapter 5

Ethernet Port Configuration To configure to Ethernet port settings, open the Web Application Tool at Main Menu>System Configuration>IP Address.

The two Ethernet ports are configured on the IP Address Configuration page. Both IP Addresses (LAN1 and LAN2) must be configured as different networks. Click Set & Reboot to update the changes.

Figure 8 - IP Address Configuration Page

Item Description

Enable Enable LAN1 and LAN2 Ethernet port

IP Address IP Address of LAN1 and LAN2 Ethernet port

Net Mask Subnet mask of LAN1 and LAN2 Ethernet port

Gateway Default Gateway Address of LAN1 and LAN2 Ethernet port

Domain Name server IP Address of Domain Name Server, if available in the network

Set & Reboot Updates IP Address and reboots the RTU


Chapter 5 Communication Port Configuration

Notes:


Chapter 6

Communication Protocols

This chapter describes communication protocols that are available on the RTU. Topics include the following:

• EtherNet/IP Device Configuration• CIP Implementation• DNP3 Implementation• Enron Modbus Implementation• MQTT Implementation

EtherNet/IP Device Configuration The RTU supports an EtherNet/IP scanner application that connects to EtherNet/IP devices. For each device, the application requires an XML-based device configuration that defines the connection parameters, and the mapping of the produced and consumed data associated with such connections.

To simplify this process, a device definition library structure has been created. This library definition lets you instantiate the device in the vMiConfig configuration utility (Appendix B), and modifies the configuration to suit the application.

CIP Implementation The EtherNet/IP and Common Industrial Protocol (CIP) functionality lets the RTU establish a connection to, and exchange information with, any EtherNet/IP capable device, including drives and remote I/O adapters. This functionality greatly expands the I/O capabilities of the iXC2 RTU without any hardware modification requirements.

Currently the RTU uses internal Modbus registers to exchange data between the various software components that run within the RTU firmware. The new CIP and function also uses an internal Modbus register to exchange data.

Figure 9 - EtherNet/IP Connection Example


Chapter 6 Communication Protocols

Protocol Interfaces

The EtherNet/IP application communicates on user-datagram protocol (UDP) and TCP Ethernet protocols. The TCP protocol is primarily used for Unconnected Messenger Manager (UCMM), and Class 3 connections, while the UDP protocol is used for Class 1 communication.

EtherNet/IP Implementation

The EtherNet/IP application, in combination with the CIP library, supports UCMM, Class 3, and Class 1 connections. The UCMM and Class 3 connections use asynchronous communication, while the Class 1 connection uses synchronous communication and data exchange.

The application supports multiple connections per device, and the connection to multiple devices. As the RTU is intended to establish connections to remote I/O units, it does not accept Class 1 connections, but establishes connections as specified in the EtherNet/IP configuration file.

The following EtherNet/IP services are supported:• List Identity• List Services• List Interfaces• Register Session• Unregister Session• Send RR Data• Send Unit Data

Connection Management

For each configured device, the iXC2 EtherNet/IP scanner application attempts to establish all Class 1 connections that are specified by that device. If the connection is not established, the EtherNet/IP scanner application continues to retry the establishment at regular intervals, until the connection is successfully established.

The scanner application establishes the connections by sending a Forward Open request to the target device. The device, if connected, replies with a Forward Open response, which indicates whether the connection was successful or not.

The Forward Open response also contains configuration data for the device, which is contained in the ConnectionPath parameter. Once the connection has been established, the RTU scanner application and the device exchange the data, via UDP, at the Requested Packet Interval (RPI). If a connection is terminated, for any reason, the scanner application continuously retries the establishment of the connection.


Communication Protocols Chapter 6

Listen Only Connections

Some devices support multiple class-1 connections. The second connection is usually a Listen Only connection, which as the name implies, has only useful information transfer from the device to the scanner. The data from the scanner to the device is typically ignored. This mechanism allows multiple RTUs to monitor the same device, which helps enable a degree of redundancy.

The iXC2 EtherNet/IP scanner only attempts such a connection if:

1. The AcceptListenOnly parameter in the device configuration is true, and

2. The Forward Open response indicates an Ownership Conflict.

The latter implies that another module has already established a “normal” or “owned” connection to the device and cannot accept another such connection. The scanner then attempts to establish a Listen Only connection.

If the initial “owned” connection terminates, and renders the Listen Only connection void, the scanner attempts to reconnect with another Listen Only connection, but failing that a full “owned” connection.

Pre-connection Parameters

The iXC2 EtherNet/IP scanner application makes provision for the configuration of one or more parameters before the Class 1 connection is established. An application example is the configuration of critical control parameters of a drive.

Before attempting any Class 1 connections to the device, each pre-connection parameter is written to the device, one at a time, with the Set Attribute Single service.

If the setting of a parameter fails, and that parameter AbortOnFail attribute is set, then the connection is not established. Instead, the writing of all pre-connection parameters is aborted and restarted. A connection to the device is only attempted once all parameters marked with AbortOnFail, have been written successfully.

Once a connection has been established, and the connection is then terminated for any reason, then all pre-connections parameters are rewritten before the connection is re-established.

Connection Status

For each EtherNet/IP connection, and the input and output assembly, the scanner creates a virtual connection assembly. This assembly comprises a ConnectionStatus integer, which is used by other RTU applications to determine the state of the connection to the device. The structure of the Connection Status is described in Table4.

IMPORTANT Listen Only connection can only exist when one of the other I/O connection types has been established.



Table 4 - Connection Status Structure

DNP3 Implementation Protocol Interfaces

The DNP3 stack is capable of operating in a DNP3 Master or DNP3 Outstation (slave) mode. The DNP3 objects, and their associated mapping to internal Modbus registers, are defined by a configuration file that is created with the vMiConfig Configuration Utility. The DNP3 application communicates on UDP, TCP Ethernet protocols, or on an RS232 Serial. A full description on how to configure and map the DNP3 application can be found in Appendix C.

Security

The DNP3 application provides DNP3 Secure Authentication on the DNP3 TCP, DNP3 UDP, or DNP3 Serial (RS232). The setup and enabling of DNP3 Secure Authentication is configured with the vMiConfig Configuration Utility.

The Secure Authentication implementation follows Version 5, and makes use of the “Pre-Shared Key” key change method.

The following Message Authentication Code (MAC) algorithms may be selected, depending on the implementation (serial / Ethernet):

• HMAC SHA-1 (4/8/10 octets)• HMAC SHA-256 (8/16 octets)• AES GMAC

The use of DNP3 Aggressive Mode is configurable.

DNP3 Objects

A full list of the supported DNP3 objects can be found in Appendix C.

Bit Function Description

Bit 0 The connection is valid.

Bit 1 The connection that is reverted to a Listen-Only connection due to an ownership conflict.

Bit 2 Pre-Connection Parameter Abort The connection to the device was aborted due to the failure of writing one or more pre-connection parameters.

Bit 3...15 Reserved



Enron Modbus Implementation The implementation of the Enron Modbus slave application lets the RTU exchange data with an Enron Modbus Polling master.

The vMiConfig configuration (Appendix B) utility is used to configure the various register, reporting, and event options associated with Enron Modbus.

The Enron Modbus application can be bound to an Ethernet (TCP) port or any one of the serial communication ports.

As the register assignment for Enron Modbus differs from the assignment of a conventional Modbus, a register-mapping facility lets you configure Enron type registers. You can create multiple Enron reports and map them to existing RTU report files. The Enron Modbus event retrieval mechanism is also supported.

Report Configuration

A number of different historical data reports can be configured, although they are based on either the daily or hourly tables that are generated by the Flow Computer application.

Table 5 - Enron Modbus Report Configuration XML Items

The report appears in the configuration utility navigation tree as seen in Figure 10.

Figure 10 - Enron Reports – Tree View

When creating a report, you must first specify various header details from the iXC2 Flow Computer application report. These details include the display name, register reference, and the source table (csv file) for the data. You then create a list

Name Description

ReportName Internal report name given

RegisterReference The register that has been allocated to the specific report (ranges from 701...799 to)

SourceTable Hourly or Daily report.

RecordIndexField The field that is used to index the history report

RecordDateTimeField The field that is used to update the date/time for a requested event

Fields Contains a collection of all fields in the correct order.

Index Response field index number. Thus, one is the first data that is returned, and the second data return, and so on.

FieldName The actual report field that is returned. Thus, you can determine the order of the logged data to be returned



of fields for the report. These fields can either be entered manually, or can be selected with the browse option.

The field configuration not only lets you specify which fields are returned for a specific Enron request, but also the order that the fields are returned. This field configuration lets you create a report that is specific to the requirements of that application Polling master.

To facilitate the field-browsing option, a static XML file is created listing all available fields for each of the available tables, such as HourlyReport and DailyReport.

Figure 11 - Report Field Configuration Example

The Enron Modbus firmware triggers a report generation when a request comes in for the Enron Modbus firmware for either of the four API reports. This action helps enable the RTU firmware to generate the required CSV report. The CSV report is then used to reply to the received request.

History reports (hourly and daily) use the specific record index for the record number to determine which record must be returned. History reports only return one record at a time. The firmware matches the header fields in the CSV file that is created and replies to the Enron request with the correct order and data as configured in vMiConfig. If no record is found for the requested index, then a zero-byte response is returned.

Event reports have a fixed response and return either Operator Events or Alarm Events (depending on what was configured in vMiConfig). Unlike History reports, Event reports return the maximum amount of “unread” events to the Enron Modbus Master. When events/alarms are read, the read index is saved in the EnronMBCfg.xml file that confirms that no events/alarms are transmitted twice. When the Event/Alarm Acknowledge is sent, the Event/Alarm CSV file is deleted and the index is reset back to 1. The event code that is found in the Event CSV report is used to populate the “Changed Register”.

TIP This method of reporting is similar to the method used for API reports via the web server.



MQTT Implementation The implementation of the MQTT application helps enable the iXC2 RTU to exchange data with an MQTT broker.

MQTT provides an efficient mechanism for devices and servers to exchange information with a central broker. Devices can “Publish” their data with a specific topic name, and any other MQTT client (device or server) is then able to “Subscribe” to that topic, and hence receive the data. Multiple consumers are therefore supported without any additional loading on the original publisher. Figure 12 is an overview of the iXC2 MQTT implementation.

Figure 12 - iXC2 MQTT Overview

There are two, independent, MQTT Client Applications, viz. MQTT Client A and MATT Client B.

The vMiConfig utility is used to setup and download the static MQTT configuration to each of the iXC2 MQTT Clients. This configuration includes details of the primary and secondary MQTT Brokers to which the iXC2 client connects.

Each MQTT Client connects to the configured MQTT broker, and subscribes to the configuration topic.

The MQTT Configuration Manager publishes the dynamic configuration for that specific iXC2. This configuration includes a list of tags and transactional datasets that the iXC2 monitors and reports via MQTT. When the iXC2 receives this configuration (by virtue of its subscription), it responds by publishing a configuration acknowledgment, listing any anomalies found in the received configuration.



Then, the iXC2 monitors the Modbus registers, and based on the report criteria, publishes the live tag data and transactional datasets via MQTT.

Should the connection to the MQTT broker not be available at the time of publishing, the iXC2 application will log the tag-data-point value to a local historical log file. Similarly, the transactional datasets are logged to a separate historical log file.

When the connection to the MQTT broker is restored, the iXC2 publishes the historical “Backfill” data with a separate topic.

A detailed description of the MQTT application, including the vMiConfig setup, can be found in Appendix B.

TLS Authentication

The MQTT client applications support the server and client authentication with Transport Layer Security (TLS V1 V1.1 and V1.2).

Background TLS

A TLS connection is established after a successful handshake, between the Client (e.g. iXC-2 MQTT Client Application) and the Server (e.g. MQTT broker). The handshake is illustrated in Figure 13.

Figure 13 - TLS Handshake (Source: IBM)



This handshake helps enable the optional exchange, and authentication, of a client certificate. For this, an additional client certificate, and corresponding private key file will need to be downloaded to the client.

The table below illustrates the files that are required on the client and server platforms to enable client and/or server authentication.

Table 6 - Summary of TLS objects

TLS Operation

During the TLS connection handshake, the server (MQTT broker) transfers its certificate to the iXC2. The iXC2 verifies the certificate against the locally configured Certificate Authority (CA). If this verification fails, the iXC2 aborts the connection.

If the MQTT broker has been configured for client authentication, it requests the client certificate and authenticate the certificate against the configured Certificate Authority (CA).

The broker, depending on the Authenticate Server configuration option, verifies the server certificate against the CA configured on the broker. If this verification fails, the MQTT broker aborts the connection.

LocatedOn Object

Used in Server Authentication

Used in Client Authentication Comment

MQTT Broker

Certificate Authority Yes

Server Certificate (CA Y) Yes Yes

Server's Private Key Yes Yes

Client's Certificate (CA X) - Yes Sent by client during handshake.Validated against the CA.

iXC2

Certificate Authority Yes

Server Certificate (CA Y) Yes Yes Sent by server during handshake.Validated against the CA.

Client's Certificate (CA X) - Yes

Client's Private Key - Yes



Static Configuration

The MQTT application is configured with an XML file, which is created and downloaded to the iXC2 RTU with the configuration utility.

The configuration XML file defines the MQTT broker connection parameters, topic names, and historical logging and reporting parameters.

Figure 14 - Configuration Structure

Here is an example of the XML configuration.



The configuration items for each client are defined in the table below.

Table 7 - MQTT Static Configuration XML Parameter

Name Description

Enable Used to enable the MQTT function.

Device Identifier The MQTT unique identifier

Payload Compression Either None or GZip.The compression (and decompression) is applied to all published and received data.

LWT Enable Enables the Last Will and Testament functionality.

LWT Retain Sets the Retain flag in the LWT message.

Connection Retain Sets the Retain flag in the connection status.

Live Data Topic The topic name to be used for live data publishing.

BackFill Topic The topic name to be used for backfill data publishing.

Config Topic The topic name to be used to subscribe to receive the dynamic configuration.

Config Ack Topic The topic name to be used to publish the configuration acknowledgment, in response to receiving new configuration.

Connection Status Topic The topic name to be used for connection status messages (including the LWT.)

Heartbeat Topic The topic name to be used for heartbeat messages.

Backfill Log Size The maximum size (records) of the backfill historical log file.

Backfill Publish Interval The minimum interval (milliseconds) between backfill data sets being published.

Backfill Publish Size The maximum number of backfill data records to be included in each published set.

Backfill Transaction Log Size The maximum size (datasets) of the backfill transaction historical log file.

Primary and Secondary Broker

Enable Always true. The primary broker cannot be disabled.

Host The host name or IP address of the MQTT broker.

Secure Port The TCP port to be used for secure connections.

Unsecured Port The TCP port to be used for standard (unsecured) connections.

Username The username to be used for authentication.

Password The password to be used for authentication.

Use Authentication Enables authentication. If disabled, an anonymous login is used.

Use TLS Enables secure connections. When enabled the secured port is used and TLS security is applied.

TLS Version TLS Version to be used, either 1.0, 1.1 or 1.2.

Authenticate Server Selects whether the Server Certificate will be authenticated against the Certificate Authority.

Certificate Authority File Certificate Authority, used for server authentication. Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Client Certificate File Client Certificate, used for server to authenticate the client. Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Client Key File Client Key File, must match the Client certificate.Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Keep Alive The MQTT keep alive period (seconds) used when connecting to the MQTT broker.

Ping Interval The interval (seconds) between ping requests sent to the broker. This can be used to keep the connection active. Setting the Ping Interval to zero, disables the pinging action. The connection will then be closed after the Keep Alive interval, if there is no activity.

Clean Session Specifies whether the connection to the MQTT broker will have the Clean Session flag set. When cleared, the iXC-2 and broker would continue with the configured topic subscriptions from the previous session.

MTU Maximum TCP segment size. Defaults to 1460.



Dynamic Configuration

The Dynamic Configuration refers to the configuration that is published by the MQTT broker. It contains the tags and transaction datasets to be monitored, and when to be reported. This configuration is transferred in JSON format.

Table 8 - Dynamic Configuration Parameters

Name Description

header The header contains multiple attributes relating to the configuration file. These attributes are not used by the MQTT application.

payload The payload contains the following:• TagList• TransactionList

Tag List

fqn Fully qualified name of the tag.

modbusID The internal iXC2 Modbus mapping space. The default being -1, the base map.

modbusRange Specifies the Modbus Range to be used, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

address iXC2 Modbus Register Address

datatype Data type of the tag. (See data types listed below.)

modifier Data modifier. Used to reorder bytes of various data types. (See modifier types below.)

correction Used for DateTime types, the number of minutes to be added to the time to convert it to UTC.

scanRate The Interval (milliseconds) at which the tag should be scanned.

scanEnabled Enables the tag monitoring.

fileLogEnabled Enables the tag to be logged when the MQTT connection is not available.

report Specifies the report criteria, to determine if the tag should be reported or not. (See report options below.)

Transaction List

fqn Fully Qualified Name

triggerRange Specifies the Modbus Range to be used for the Trigger register, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

triggerRegister The Modbus register to be monitored for change which is used to trigger the data set extraction process.A zero value implies no trigger action.

minimumTriggerTime The minimum time (seconds) between subsequent triggers. This parameter is used in conjunction withthe Trigger Register to control the reporting, either by time, change or a combination of the two.

controlEnable A Boolean value to specify if the dataset extraction requires the handshake control.

controlRange Specifies the Modbus Range to be used for the Control register, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

controlRegister The Modbus register used for the extraction handshaking. The extraction process is initiated by writing the Control Value to this Register. The register is then monitored and its return to zero is used to indicate that the data set is ready to be read.



controlValue The static value (typically 1 - implying latest record) to be written to the Control Register to initiate theextraction.

uniqueRange Specifies the Modbus Range to be used for the Unique register, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

uniqueRegister The Modbus register, typically contained within the data set, which is used to determine that the data setis new. This value will be compared to the previous value to confirm the data set is new. If not, then thedata set will be discarded and not reported.

itemList List of all the data items

modbusID The internal iXC-2 Modbus mapping space. The default being -1, the base map.

modbusRange Specifies the Modbus Range to be used, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

dataRegister The Modbus register containing the value, or in the case of extended data types, the starting register.

datatype Data type of the item. (See data types listed below.)

modifier Data modifier. Used to reorder bytes of various data types. (See modifier types below.)

correction Used for DateTime types, the number of minutes to be added to the time to convert it to UTC.

elementCount The number of elements, of the associated data type, in the item.

byteSkipping An optional number of bytes to be skipped between each element. This will allow, for example, everyalternate, or every third element to be reported without having to configure multiple individual items.

Name Description



Here is an example of the configuration file.

Figure 15 - Dynamic Configuration JSON Example





A summary of the dynamic configuration parameters is shown in the table below.

Table 9 - Dynamic Configuration Summary

Section Parameter Required Default Example

header corID Yes “123-34345-56-654”,

version Yes “1.0.0”,

createdBy Yes “cpuser”,

payload/tagList fqn Yes “MyEnterprise.Tag1”,

modbusID No -1 “23”

address Yes “39101”,

dataType Yes “Int16”,

modifier No Direct “Reverse”,

correction No 0Used for DateTime types, the number of minutes to be added to the time to convert it to UTC.

scanRate Yes “1000”,

scanEnabled No TRUE true,

fileLogEnabled No FALSE true,

report NoreportType: “Lo 5;Hi 90;DB 2"

payload/ fqn Yes “RPC01”,

triggerRegister Yes “40101”,

minimumTriggerTime Yes “30”,

controlEnable No FALSE “True”,

controlRegister No 0 “40103”,

controlValue No 0 “1”,

uniqueRegister No 0 “41001”,

payload/ modbusID No -1 “23”

dataRegister Yes Menu>Modbus,

dataType Yes “INT”,

modifier No Direct “Reverse”,

correction No 0

No 0Used for DateTime types, the number of minutes to be added to the time to convert it to UTC.

elementCount No 1 “34”,

byteSkipping No 0 “1”



Data Types and Modifiers

Here are the supported data types.

Table 10 - Data Types

The table, below, shows the various Modifiers and their effect on the byte order.

Table 11 - Modifier Options

Type Description Bit Length

BOOL Boolean 1

SINT Signed Byte 8

USINT Unsigned Byte 8

INT Signed Integer 16

UINT Unsigned Integer 16

DINT Signed Double Integer 32

UDINT Unsigned Double Integer 32

LINT Signed Long Integer 64

ULINT Unsigned Long Integer 64

REAL Single Floating Point 32

LREAL Double Floating Point 64

DT32Date Time: 32 bit Integer (Seconds since Jan 1 1970) 32

DTMDYHMSDate Time: month, day, year, hour, minute, second (6 registers) 96

DTEnronDate: Float 32bit - MMDDYY.0 &Time: Float 32bit - HHMMSS.0 64

DT64 Date Time: 64 bit Integer(Seconds since Jan 1 1970)

64

Modifier Option Description

Direct Byte0, Byte 1, Byte2, Byte3

Reverse Byte3, Byte2, Byte1, Byte0

PairSwap Byte 1, Byte 0, Byte 3, Byte 2

ReversePairSwap Byte2, Byte3, Byte0, Byte1



Table 12 shows the applicability of the various modifiers for each data type.

Table 12 - Modifier / Data Type Applicability

Report Types

The Report Type contains a number of conditions that are separated by commas. If any one of the conditions in the list are true, and were false in the previous scan, the tag will be reported.

The condition types are as follows:

Table 13 - Logging Criteria

A maximum of fives conditions can appear in the Report Type. The Lo and Hi limit conditions can be used more than once in a Report Type list, such as Lo 5 and Lo 10.

Leaving the Report Type blank implies “Always True” and results in the tag being reported at the ScanRate interval.

Data TypeModbus Length

Modifier Option

Direct Reverse Pair Swap Reverse Pair Swap

BOOL 1/2 Yes - - -

SINT 1/2 Yes - - -

USINT ½ Yes - - -

INT 1 Yes - Yes -

UINT 1 Yes - Yes -

DINT 2 Yes Yes Yes Yes

UDINT 2 Yes Yes Yes Yes

LINT 4 Yes Yes Yes Yes

ULINT 4 Yes Yes Yes Yes

REAL 2 Yes Yes Yes Yes

LREAL 4 Yes Yes Yes Yes

DT32 2 Yes Yes - -

DTMDYHMS 6 Yes - - -

DTEnron 4 Yes - - -

DT64 4 Yes Yes - -

Keyword Condition Description Example

Lo Low Limit Report when the tag value decreases below the specified limit. Lo 10

Hi High Limit Report when the tag value increases above the specified limit. Hi 95

DB DeadbandReport when the tag value changes by more than the specified limit, since it was last reported. DB 2



Operation

MQTT Connection

When the iXC2 MQTT application starts, it connects to the configured Primary and Secondary (if enabled) MQTT brokers.

If the Last Will and Testament (LWT) functionality has been enabled, the message is included in the initial connection to both the Primary and Secondary brokers.

Once connected, the iXC2 subscribes to the Config topic, and waits for the dynamic configuration to be published.

Although both the Primary and Secondary brokers may be connected, simultaneously, only one broker is active at any time. Only the active broker sends a dynamic configuration and receives live and backfill data.

If an existing dynamic configuration has been cached, then this configuration is used until a newer dynamic configuration is received.

Configuration Acknowledgment

When a new dynamic configuration has been received, the MQTT application responds by publishing a configuration acknowledgment with the ConfigAck topic. This acknowledgment includes any anomalies found in the configuration. An example of the acknowledgment JSON file is shown in the figure, below.

Figure 16 - Configuration Acknowledgment JSON Example



Data Monitoring

The MQTT application makes use of the dynamic configuration to monitor and report on the continuous and transactional data.

Continuous Data

Each tag Modbus register contained within the “Tag List” portion of the dynamic configuration is monitored, provided that the Scan Enabled attribute is set to true. The Report Type criteria is then examined to determine if the tag should be reported.

At the end of each application scan, all the tags that need to be reported, according to the aforementioned Report Type criteria, are added to the Report Cache.

The Report Cache contains the tag information, current value, quality code and UTC time for each of the monitored tags that met their reporting criteria. If the connection to either the Primary or Secondary MQTT broker is available, the Report Cache is published with the preconfigured Live Data topic. If both brokers are connected, data is published only to the active broker.

If the connection is not available, and the FileLog attribute is true, the contents of the Report Cache is copied into the Historical Log file.

The flowchart, below, describes the operation.

Table 14 - Tag Publish Flowchart



Transaction Datasets

For transaction datasets, the iXC2 MQTT application uses the combination of the Trigger Register and Minimum Trigger Time to initiate the transaction data-set extraction. Either one of these attributes can be set to zero, but not both.

If both are set (non-zero), even if the Trigger Register changes, the operation will not continue if the time since the last trigger does not exceed the Minimum Trigger Time.

The Control Enable specifies whether the handshake control mechanism is required. If enabled, and once the Trigger criteria has been satisfied, the Control Value will be written to the ControlRegister. The Control Register is then monitored for its return to zero. If the Control Register is not set to zero, within a reasonable pre-defined timeout (5 seconds), the dataset extraction is aborted.

The Control Register returning to zero signals to the MQTT application that the transaction dataset is ready to be read.

The value of the Unique Register is read and compared to the value of the previous trigger. Should the value be the same, then the dataset will be discarded. This step will be skipped if the Unique Register is set to zero.

The dataset items will then be read and formatted according to the dataset item configuration. This allows multiple items of different data types and formatting rules to be contained within a single dataset.

As in the case with continuous data, if the connection to the broker is available, then the dataset will be immediately published under the LiveData topic.

If the connection is not available, then the dataset will be added to the Historical Transaction log. When the connection is re-established, the datasets within the Historical Transaction log will be published, one dataset at a time, using the BackFill topic.



Live Data Publishing

An example of the Live Data JSON file, including both continuous and transaction data, is shown below.

Figure 17 - Live Data JSON Example

Historical Log

The historical continuous and transaction sets are stored in separate logs.

Continuous Historical Log

The continuous historical log file comprises an array of all the tag reports that were not able to be published in real time. The maximum number of records in the log file is configured in the static configuration. When this limit is reached the logging is suspended.

When the connection to the Broker is restored, the historical data is published with the BackFill topic. The number of historical records per publishing, and the rate at which they are published, is configurable.

As in the case of the Live data, backfill data is only published to the active broker when both brokers are connected. Once a historical record has been published, it will be removed from the historical log.



Historical Transaction Log

The Historical Transaction log comprises an array of transaction datasets, including their quality, timestamp, and item value array. The maximum number of datasets in the log file is configured in the static configuration. When this limit is reached the logging is suspended.

As in the case of the continuous data log, when the connection to the Broker is restored, the historical data is published with the BackFill topic. Only one dataset is published at a time, at a rate that is configured by the static configuration. Once an historical transaction dataset has been published, it is removed from the historical log.

An example of the Backfill Data JSON file, including both historical continuous and historical transaction data, is shown below.

Figure 18 - Backfill Data JSON Example



Notes:


Chapter 7

Access the RTU

This chapter shows you how to sign onto and access your RTU. To perform this task, you must have a personal computer with internet access. Topics include the following:

• Login Options• The Home Page

Login Options To log in to the RTU, perform the following steps:

1. While running the web browser, connect the personal computer to the RTU on Ethernet Port 1 or Port 2.

2. Type the RTU IP address into the address bar of your web browser.

3. You are prompted for authentication. Enter the user level and password.

4. Type ‘Admin’ as the user level and ‘vMonitor401’ as the password. The user name and password are both case sensitive.

IMPORTANT Some screens do not match the example, due to variations in the web browser. The latest version of Windows IE is used for this example.

TIP The factory default IP address is 192.168.0.82, for Port 1, and 192.168.1.83 for Port 2.

TIP The RTU has two user levels; Admin and User. The Admin level is used for this example.

User Level User Name Password Description

Admin Admin vMiRtu800 Grants access to read and modified any parameter configuration.

User vMonitor vMonitor401 Grants access to read only. Cannot do any modification on the parameters configuration.


Chapter 7 Access the RTU

5. Click OK to proceed to the home page.

The Home Page The home page is the central navigation hub of the RTU web server. From this page, you can access the Main Menu options, which house the primary controls of the RTU.

Figure 19 - Home Page

IMPORTANT You can access the tabs/pages (except the RTU Kernel page) from the Main Menu, with the user name and password in Step 3.

Item Description

System Status Provides you with the overall status information for your RTU and associated Communication statistics.

System Configuration Lets you configure advanced RTU settings such as IP Address, COM port settings, Device ID, Board time, and Interface Protocols.

I/O Configuration Lets you modify individual I/O channels and Alarms.

Data Logger Gives you access to configure the data points to be logged.

Modbus Data Copy Lets you copy data from a source address to a destination address.

Modbus 3rd Party Interface Lets you configure Modbus Master Serial/TCP and Internal Transfers.

Gateway Lets you configure and monitor the transmitter status directly from your RTU.

Applications Shows a list of applications currently in the RTU.

Download Lets you download RTU configurations to your personal computer.

System Upgrade Lets you upgrade all type of files that are configured into the RTU.


Chapter 8

General System Configuration

This chapter describes how to configure the general system settings of the RTU. Topics include the following:

• RTU Kernel Configuration• Board Time Configuration• Device ID Configuration

RTU Kernel Configuration The RTU Kernel page enables you to configure the internal applications of the RTU. To access this page, navigate to Main Menu>System Configuration>RTU Kernel.

From the General section of this page, configure the Watch Dog Interval. The Watch Dog time continuously monitors the CPU health, as per the number of cycles set in the Watch Dog Interval.

The Restart Limit value determines how many times the module restarts after termination. After the module is exited, it will restart again.

IMPORTANT To restart the RTU, click Set & Reboot from the RTU Kernel Configuration page. See Figure 20.


Chapter 8 General System Configuration

Figure 20 - RTU Kernel Configuration Page

Board Time Configuration The Board Time is the internal clock that dictates the time and date of the RTU. You can manually set the Date, Time, and Time Zone in the Board Date & Time section. See Figure 21. To access this page, navigate to Main Menu>System Configuration>Board Time.

In the Time Synchronization section, you can enable the Time Synchronization option by checking the Enable box. This option lets you use automatic Time Synchronization with a time server that is enabled. Set an IP address or web link of the NTP Server.

Item Description

Watch Dog Interval Frequency in seconds at which the software watch-dog timer checks RTU Kernel. This time is fixed to 180 seconds and is not user-configurable.

Enable Automatically runs the corresponding module at power-on.

Set & Reboot Updates any changes that are made in the page and reboots the RTU.

TIP For automatic Time Synchronization, verify that the RTU is on a network with a time server that is enabled.


General System Configuration Chapter 8

Figure 21 - Board Time Configuration Page

Item Description

Date (DD/MM/YYYY) Board Date in DD/MM/YYYY format

Time (hh/mm/ss) Board Time in HH:MM:SS format

Time Zone Time zone of the region where the unit is installed. Depending on the time zone that is selected, it can automatically adjust for daylight savings time.

Auto Time Synchronization-Enable

Depending on your Synchronize Everyday selection, it can also enable automatic Time Synchronization with time server on a daily/hourly basis.

Synchronize Everyday Select whether to auto synchronize current time with time server on daily or hourly intervals.

Time Server IP Address or web link of NTP Time Server

Update Now Synchronizes the current time with NTP Time Server on-demand.

TIP The Time Zone must be set before setting the Time and Date.


Chapter 8 General System Configuration

Device ID Configuration The Device ID Configuration Page lets you set the RTU Modbus ID for the RTU. To access this page, navigate to Main Menu>System Configuration>Device ID.

Figure 22 - Device ID Configuration Page

Item Description

RTU Modbus ID Modbus Slave ID of RTU

Set & Reboot Updates the RTU Modbus ID and reboots the RTU.

IMPORTANT These Reserved IDs cannot be used as a Device ID.• 230• 242• 245• 246• 247


Chapter 9

System Status

This chapter explains the System Status function. Topics include the following:• System Status Page• I/O Status• Module Status• ISAGRAF Status

System Status Page The System Status page lets you view the RTU hardware information for the RTU. To access this page, navigate to Main Menu>System Status>RTU.

Figure 23 - RTU Status Page


Chapter 9 System Status

Table 14 - Description for RTU Status Page

I/O Status This section provides information on the hardware and software diagnostic of the RTU. To access this page, navigate to Main Menu>System Status>RTU.

Figure 24 - I/O Status Page

Item Description

Serial Number Unique Serial Number of RTU

RTU Slave ID Modbus Slave ID of RTU

LAN 1 IP IP Address of LAN1 Ethernet Port

LAN 1 MAC MAC ID of LAN1 Ethernet Port



COM1 and COM2 Module to which the COM port is bound.

COM4 Module to which COM4 is bound (Default WMP).

Latitude User-entered latitude to pinpoint the location of RTU.

Longitude User-entered longitude to pinpoint the location of RTU.

Item Description

Board Temperature Board Temperature of RTU (In Celsius)

Supply Voltage Power Supply Voltage that is supplied to RTU (In Volts)

Memory Usage RTU RAM Usage – Total Available, Currently In use and Free (In Kilo bytes)

Disk Usage RTU Nonvolatile Memory Usage- Total Available, Currently In use and Free (In Kilo bytes)

CPU Usage RTU CPU Usage- Currently In use and Idle (In Percentage)

Modbus TCP Client Connected TCP client users that are connected to the RTU

RTU Start Time Date and time of last power on of the RTU.

Last FTP Login Last user who is logged in with FTP connection.

Trigger Diagnostic Gives on-demand Data information about the status of the RTU.


System Status Chapter 9

Module Status The Module Status page provides you with an overview of the software versions and upgrades in use for each module. To access this page, navigate to Main Menu>System Status>Module Status.

Figure 25 - Module Status Page

Item Description

Ghost Version Linux Ghost version number of the RTU

Suite Firmware Version The Suite Firmware Version number of the RTU

Status The running status of the corresponding Module

Version Version number of the corresponding Module. Displays Not Running if module is not running.

Fault Status Reason why the module has stopped running. If the Module is running or is disabled in the RTU Kernel, Fault Status is displayed as N/A.


Chapter 9 System Status

ISAGRAF Status The ISAGRAF Status page provides you with details and status about the ISAGRAF® module. To access this page, navigate to Main Menu>System Status>ISAGRAF Status.

Figure 26 - ISAGRAF Status Page

Item Description

Resource ID Shows the resource identification number, which is defined in ISAGRAF Workbench, for that resource.

Status Shows the running status of a resource. It can be Inactive, Active, or Error.

Version Shows the version number of the resource. It increases by one each time the resource is recompiled and deployed.

Cycle Count Shows the total number of cycles that the resource runs.

Current Time Shows the time that is spent by a resource in current cycle.

Prog Time Shows the cycle time that is defined in ISAGRAF Workbench.

Max Time Shows the Max time that is used by a resource to run a cycle.

Overrun Shows how many times a resource overrun (the execution time exceed the Program Time).


Chapter 10

I/O Configuration

This chapter shows you how to configure and calibrate the I/O ports of the RTU. To perform this task, you must have a personal computer with internet access and a digital multi-meter that measures current. Topics include the following:

• Configure the AI Channels• Configure the DI Channels• Configure the AO Channels• Configure the DO Channels

Configure the AI Channels This section provides information on how to configure the AI channels. To configure these channels, open the Web Application Tool at Main Menu>I/O Configuration>Analog Input. The 24-bit Raw Count Value, from each of the eight analog channels, can be scaled to user-configured Engineering Units (EU) by setting the EU low/high range.

Figure 27 - Analog Input Configuration


Chapter 10 I/O Configuration

Table 15 - Description for AI Configuration Page

When the input is 12 mA, the Actual Raw Count Value reads, “3932160”. The Actual EU for 12 mA can be calculated with Equation 1.

Equation 1

Step 1: Actual EU = [(3932160-1310720) / (6553600-1310720)] * (100-0)

Step 2: Actual EU = [2621440/5242880] * 100

Step 3: Actual EU = 50

Fix the Raw minimum value in Equation 1 to 1310720, and the Raw maximum value to 6553600, for 4 mA to 20 mA, respectively.

Configure the DI Channels This section provides information on how to configure the DI channels. To configure these channels, open the Web Application Tool at Main Menu>I/O Configuration>Digital Input.

Select the proper digital input type on the Digital Input Configuration page. The Pulse Counter is a simple frequency counter, which can detect up to 400 Hz. In Pulse Accumulation, the pulses are accumulated from one Scan to the next to obtain accurate measurements.

Item Description

Channel No. The number of the channel that corresponds to the Digital input.

Mode Determines if the Analog Input Channel reads Current or Voltage Signal.

Range Range of Analog Signal that is given to the corresponding Analog Input Channel

EU Low Engineering Unit Scaling-Lower Limit for the Analog Input Channel that corresponds

EU High Engineering Unit Scaling-Higher Limit for the Analog Input Channel that corresponds

Calib Low Raw counts that are read by corresponding Analog Input Channel when Minimum Input is applied.

Calib High Raw counts that are read by corresponding Analog Input Channel when Maximum Input is applied.

Scale up to 22 mA Scale Engineering data for Analog Current Inputs up to a maximum value of 22 mA. When disables, Engineering data is scaled only up to 20 mA.

Differential Determines if the corresponding Analog Input Channel reads Single Ended or Differential Analog Input Signal. Applicable only for Channels 1, 3, 5 and 7.

Channel 9 Fixed to display Temperature and is not user-configurable.

Channel 10 Fixed to display Temperature and is not user-configurable.


I/O Configuration Chapter 10

Figure 28 - Digital Input Configuration Page

The Debounce Time, of the DI, can be filtered for short-duration voltage spikes. Any spike, with a duration that is shorter than the set time, is then filtered out. Click Set & Restart to update the changes.

The Pulse Accumulator accumulates at every rising edge and resets to zero at preset gauge off time to a Maximum accumulation value of 4,294,967,295. The Pulse Per Minute is a frequency counter every minute.

Configure the AO Channels This section provides information on how to configure the AO channels. To configure these channels, open the Web Application Tool at Main Menu>I/O Configuration>Analog Output. The analog output type can be configured as current or voltage, from output 4…20 mA, or as a 1…5V output signal.

You can set a default value for the AO, by enabling the Default Value on Startup option, and setting the Default EU value. If the Default Value on Startup option is not checked, then the analog output holds 4 mA in Current mode and 0V in Voltage mode.

The analog value can be configured on the Analog Output Configuration page. Set the raw Count (819…4095), or EU (4…20 mA, or 1…5V), or Percentage (0…100%).

Item Description

Channel No. The number of the channel that corresponds to the Digital input.

Mode The Digital Input Type has three modes; Digital, Pulse Counter, and Pulse Accumulation.

Debounce Type (50 ms steps) When in Digital Input Mode, any fluctuations with duration less than the settime is ignored.



Figure 29 - Analog Output Configuration Page

When the AO type is Current, the actual output (in mA) can be calculated with Equation 2. For this example, the actual Raw Count value is 1638.

Equation 2

Step 1: AO (Current mA) = 4 * (5/4095 * 1638)

Step 2: AO (Current mA) = 4 * (0.001221 * 1638)

Step 3: AO (Current mA) = 4 * (2)

Step 4: AO (Current mA) = 8 mA

Item Description

Channel No. The number of the channel that corresponds to the Analog output.

Mode Determines if the corresponding Analog Output Channel outputs Current or Voltage Signal.

AO Count Raw counts corresponding to the analog signal to be outputted. Raw count of 819 outputs 1V in Voltage Mode and 4 mA in current mode. Raw count of 4095 outputs 5V in Voltage Mode and 20 mA in current mode.

Co-efficient First Polynomial Coefficient that are used to calibrate the output signal.

Constant Constant used to calibrate the output signal.

Default EU Default Analog Signal to be outputted by corresponding channels when powered on.

Default Value On Startup Determines if you output a pre-configured value (set in Constant) at power-on. If unchecked, the corresponding channels with an output of 0V in Voltage mode and 4 mA in the Current mode.


I/O Configuration Chapter 10

When the AO type is Voltage, the actual output (in Volts) can be calculated with Equation 3. For this example, the actual Raw Count value is “3276”.

Equation 3

Step 1: AO (Volts) = (5/4095 * 3276)

Step 2: AO (Volts) = (0.001221 * 3276)

Step 3: AO (Volts) = 4V

Table 16 can also be used to find the Raw Count and/or AO values.

Table 16 - Reference Raw Counts

AO Type = Voltage

Raw Count Actual Output (in mA) Percentage (in%)

819 1 0

1638 2 25

2457 3 50

3276 4 75

4095 5 100

AO Type = Current

Raw Count Actual Output (in mA) Percentage (in%)

819 4 0

1638 8 25

2457 12 50

3276 16 75

4095 20 100



Configure the DO Channels This section provides information on how to configure the DO channels. To configure these channels, open the Web Application Tool at Main Menu>I/O Configuration>Digital Output.

The default value is enabled on the start-up option. With a non-zero Pulse Duration, the digital output can give a durable pulse output, as configured. When the inverted option is checked, the binary logic is reversed.

Figure 30 - Digital Output Configuration Page

Item Description

Mode Whether corresponding digital output channel works in Digital Output or Pulse Output Mode.

Pulse Duration Duration for which digital output state stays On when in Pulse Output Mode.

Default Value Default state of corresponding digital output channel at power on when Default Value on startup (Default Value on Startup) is enabled.

Inverted Whether to invert the actual state of digital output. When selected, writing 0 to Coil Status register sets the DO to On state and writing 1 sets it to off state.

Default Value on Startup Whether to output a pre-configured default value (Default Value) at power-on.


Chapter 11

Interface Protocols

This chapter shows you how to configure the RTU and TCP slave parameters of the RTU. Topics include the following:

• RTU Slave Configuration• RTU Slave Statistics• TCP Slave Configuration • TCP Slave Statistics

RTU Slave Configuration This section provides information on how to configure the settings for the RTU slave. To configure these settings, open the Web Application Tool at Main Menu>System Configuration>Interface Protocol>Modbus Slave Serial.

Check the Enable option on COM1, COM2 and COM4, as per the requirement and availability.

Figure 31 - RTU Slave Configuration


Chapter 11 Interface Protocols

Table 17 - Description for RTU Slave Configuration Page

To verify the COM port availability, navigate to Main Menu>System Status>RTU. The value, No Application Binded, indicates that the port is available.

Figure 32 - RTU Page

Item Description

COM 1, COM 2, COM 4 Enable COM port for Modbus RTU Slave Module.

Protocol Type Choose to use RTU or ASCII Modbus Protocol type for RTU Slave Module.

Forwarded Query Time Out Maximum time that the RTU Slave Module waits before sending an exception for a query that is forwarded from the Modbus client to a Slave Device.

Forwarded Query Time Out Response Type of Exception Message to send to Modbus Client.

Send Exception Response Decides if an exception response to Modbus Client is sent.

Static-Enable Generates Communication statistics for RTU Slave Module.

Enable Auto Reset Determines if the Communication statistics are automatically reset every 24 hours at a specified time.

Reset Time Time of the day to reset Communication statistics.

IMPORTANT You must enter the Latitude and Longitude values. These values are only used as a reference.


Interface Protocols Chapter 11

Table 18 - Description for RTU Page

RTU Slave Statistics This section provides information on how to configure the RTU Slave Statistics. To access the statistics, navigate to Main Menu>System Status>Modbus Statistics>RTU Slave. Modbus statistics, for the RTU Slave ID, can be enabled or disabled. Statistics can be reset during the configuration period, daily, by selecting the Enable Auto Reset option.

Figure 33 - RTU Slave Statistics Page

Item Description

Serial Number Unique Serial Number of RTU

RTU Modbus ID Modbus Slave ID of RTU





COM #01, COM #02, COM #04 Module to which COM port is bounded to

Latitude User-entered latitude to pinpoint the location of RTU

Longitude User-entered longitude to pinpoint the location of RTU

Item Description

ID Modbus ID

Query Numbers of queries received

Last Query Time Time of last received query

Response Number of responses sent

Last Response Time Time of last sent response

CRC Err Number of CRC Errors in received query

Invalid Number of Invalid (Non-available Modbus registers) requests in received query

Reset Reset Statistics to zero for the corresponding Modbus ID

Reset All Reset Statistics to zero for all Modbus IDs



TCP Slave Configuration This section provides information on how to configure the settings for the TCP slave. To configure these settings, open the Web Application Tool at Main Menu>System Configuration>Interface Protocols>Modbus Slave TCP.

Figure 34 - TCP Slave Configuration Page

Item Description

Max Client Maximum number of Modbus Clients that can connect to the RTU.

Forwarded Query Time Out Maximum time RTU Slave Module waits before sending an exception for a query that is forwarded from Modbus client to a Slave Device.

Forwarded Query Time Out Response Type of Exception Message to send to Modbus Client.

Send Exception Response Whether to send an exception response to Modbus Client.

Modbus Port TCP Port number to be used for Modbus TCP Slave.

Idle Socket Time Out Maximum time TCP Slave port waits before closing the TCP Socket.


Interface Protocols Chapter 11

TCP Slave Statistics The Modbus statistics for the TCP Slave ID can be enabled or disabled. Reset the statistics during the configuration period, daily. Check Enable Auto Reset to configure this option.

Figure 35 - TCP Slave Statistics Page

View the Statistics on the MB_TCP_SLAVE Statistics page.

Figure 36 - TCP Slave Statistics Dialog Box

Item Description

Enable Whether to generate Communication statistics for TCP Slave Module.

Enable Auto Reset Determines if the Communication statistics are automatically reset every 24 hours at a specified time.


Item Description

ID Modbus ID

Query Numbers of queries received

Last Query Time Time of last received query

Response Number of responses sent

Last Response Time Time of last sent response

CRC Err Number of CRC Errors in received query

Invalid Number of Invalid (Non-available Modbus registers) requests in received query

Reset Reset Statistics to zero for the corresponding Modbus ID

Reset All Reset Statistics to zero for all Modbus IDs



Notes:


Chapter 12

Modbus 3rd Party Interface

This chapter describes the Modbus 3rd Party Interface. Topics include the following:• Modbus RTU Master Configuration• Slave Device Configuration• RTU Master Statistics• Modbus TCP Master Configuration• TCP Master Statistics• Internal Transfer Configuration

Modbus RTU Master Configuration

This section provides information on how to configure the settings for the Modbus RTU master. To configure these settings, open the Web Application Tool at Main Menu>Modbus 3rd Party Interface>Modbus Master Serial.

Figure 37 - Serial Master Configuration Page


Chapter 12 Modbus 3rd Party Interface

Table 19 - Description for Serial Master Configuration Page

Slave Device Configuration This section provides information on how to configure the settings for the slave device. Each Slave ID can be enabled or disabled by selecting the Enable option. Click the Edit button to edit the slave device configuration.

Figure 38 - Slave Device Section

The Slave Device Configuration, dialog box appears when the Edit button is selected. Each setting on this page is user-configurable.

Item Description

Max. Char Recv Time The time difference that is allowed between two consecutive bytes. If the time gap is more, the query is discarded.

Forward error response Forwards an error response that is received from Slave Device to Modbus Slave Module.

Static-Enable Generates Communication statistics for Serial Master Module.

Enable Auto Reset Automatically resets Communication statistics every 24 hours at specified time.


Total 3rd Party Slave Total number of Slave Devices polled by the Serial Master Module.

Item Description

Total 3rd Party Slave Total number of Slave Devices polled by the Serial Master Module.

Slave # - ID Modbus Device ID of Slave Device to be polled

Slave # - Enable Enables polling of the corresponding Slave Device


Modbus 3rd Party Interface Chapter 12

Figure 39 - Slave Device Configuration (Dialog Box)

The Target ID can be configured for any value within the range of 1…247, except for the reserved slave IDs listed in Table 20.

Table 20 - Reserved Slave IDs

To access the Register Configuration page, click Configure Registers on the Slave Device Configuration, dialog box. See Figure 39.

From this page, you can configure the total numbers of ScanGroup, and the ScanGroup settings. The configured register can be polled at any given interval, as the Scan rate, or triggered by the value that is read from the Trigger Register. This method can also be used for conditional polling.

Item Description

Target ID Modbus Device ID that the Data from the Slave Device is updated.

COM Port RTU Serial port to which the Slave Device is connected.

Modbus TimeOut Maximum time Serial Master waits for response from Slave Device before generating a Timeout exception response.

Modbus Read Idle Time Delay between responses that are received from Slave Device and sending the next query.

Protocol Type Whether to use RTU or ASCII Modbus protocol to poll the Slave Device.

Mode Polls the Slave Device in Local or Remote mode. When in Remote mode, Modbus Queries received by Modbus Slave Module is directly forwarded to the Slave Device and response is sent back to the Modbus Slave Module.

iNOC 242

Datalogger 230 and 245

IO_Module 246

Statistic ID 247

IMPORTANT When the Mode is selected as “Remote”, the Target ID must be the same as the Device ID.



Figure 40 - Register Configuration Page

Item Description

Total ScanGroup Total Number of Scan groups that are configured for the Slave Device.

Scan Group-Scan Rate Time Interval that the Serial Master polls the Slave Device.

Scan Group-Scan Trigger Register Modbus Register that is used for triggering (enabling) the Scan group. If the register is set to 0, the Scan group is always enabled.

Scan Group- Scan Trigger Value Value of the Trigger Register that the Scan group is triggered (enabled).

Total Transfer Total number of Register transfers for one Scan group.

Register #--Slave Start Address Slave Device, Modbus-register Type, and address that Data is polled.

Register #-Local Start Address Local Modbus Register Type and address to which Data from Slave Device to be updated.

Register #-Data Type Data Type of the Slave Device Modbus Register to be polled.

Register #-No. of Registers Number of consecutive registers to be polled from the Slave Device.

Register #-Swapped Determines if the Data Type of the Slave Device Register is inverted (Big-endian mode).

Register #-Scaling Scales the Slave Device Register before saving to the local register.

Register # Scaling Type Scale the Data in Factor mode or Range mode. When in factor mode, Data is scaled with the following formula: Destination Data = (Source Data * Factor) + OffsetWhen in range Scaling mode, the Data is scaled with the following formula:Destination Data = [(Source Data - Source Min) * (Destination Max - Destination Min) / (Source Max - Source Min)] + Destination Min

Scaling-Factor Factor that is used for Factor Scaling. See the formula that is given in Register # Scaling Type.

Scaling-Offset Offset used for Factor Scaling. See the formula that is given in Register # Scaling Type.

Scaling-Source Min Minimum value of source Data that are used for Range Scaling. Any source Data less than this value is clamped. See the formula that is given in Register # Scaling Type.

Scaling- Source Max Maximum value of source Data that are used for Range Scaling. Any source Data greater than this value is clamped. See the formula that is given in Register # Scaling Type.

Scaling- Destination Min Minimum value of destination Data that are used for Range Scaling. Any destination Data less than this value is clamped. See the formula that is given in Register # Scaling Type.

Scaling- Destination Max Maximum value of destination Data that are used for Range Scaling. Any destination Data greater than this value is clamped. See the formula that is given in Register # Scaling Type.



RTU Master Statistics This section provides information on how to configure the RTU Master Statistics. Modbus Statistics, for the RTU Master ID, can be enabled or disabled. Statistics can be reset during the configuration period, daily, by selecting the Enable Auto Reset option.

Statistics can be viewed on the MB_RTU_Master Statistics page. To access this page, navigate to the Web Application Tool at Main Menu>System Status>Modbus Statistics>RTU Master.

Figure 41 - RTU Master Statistics Page

Table 21 - Description for RTU Master Statistics Page

IMPORTANT Be sure to specify the appropriate Scan options.

IMPORTANT If Target ID is equal to one, the following local register addresses are the only addresses that can be used.CS 0001…9999IS 10001…19999IR 30000…39999HR 40001…49999

Item Description

ID Slave Device Modbus ID

Query Numbers of queries that are sent to Slave Device.

Last Query Time Time of last sent query

Response Number of responses received form Slave Device.

Last Response Time Time of last received response

Time Out Number of time outs for the sent queries

CRC Err Number of CRC errors in received responses

Invalid Number of Invalid (Non-available Modbus Registers) responses

Reset Reset Statistics to zero for the corresponding Slave Device

Reset All Reset Statistics to zero for all Slave Devices

Over Run-ID Slave Device Modbus ID that Over Run (Execution Time exceeded Scan Time) occurred

Over Run-Scan Group Scan group number for which Over Run occurred.

Over Run-Over Run by milliseconds Time in milliseconds by which Execution Time exceeded Scan Time.



Modbus TCP Master Configuration

The total number of third-party slave devices is determined on the TCP Master Configuration page. Check the Enable option to activate each Slave ID. Click Refresh to clear out the settings, or Set to apply the new settings.

To access the TCP Master Configuration page, navigate to Main Menu>Modbus 3rd Party Interface>Modbus Master TCP.

Figure 42 - TCP Master Configuration Page

To edit the slave device configuration, click the Edit button and make your changes. The Target ID can be configured for any value within the range of 1…247, except for the reserved slave IDs in Table 20.

Item Description

Max Char Recv Time The time difference that is allowed between two consecutive bytes, if the time gap is more the query is discarded.

Forward Error Response Forwards an error response that is received from Slave Device to Modbus Slave Module.

Statistic-Enable Generates Communication statistics for TCP Master Module.

Enable Auto Reset Automatically resets Communication statistics every 24 hours at specified time.


Total 3rd Party Slave Total number of Slave Devices polled by the TCP Master Module.

Slave # - ID Modbus Device ID of Slave Device to be polled.

Slave # - Enable Enables polling of the corresponding Slave Device.



Figure 43 - Slave Device Configuration Page

Modbus statistics, for the TCP Master ID, can be enabled or disabled. They can be reset during the configuration period, daily, by selecting the Enable Auto Reset option.

To access the Register Configuration page, click Configure Registers on the TCP Master Slave Device Configuration, dialog box. See Figure 43.

Item Description

Target ID Modbus Device ID that Data from the Slave Device is updated.

TCP IP IP Address of the Slave Device to be polled.

Port No Modbus TCP Port number of Slave Device to be polled.

Modbus Time Out Maximum time TCP Master waits for response from Slave Device before generating a Timeout exception response.

Modbus Read Idle Time Delay between response that is received from Slave Deice and sending the next query.

Mode Polls the Slave Device in local or remote mode. When in remote mode, Modbus Queries received by Modbus Slave Module is directly forwarded to the Slave Device and response is sent back to the Modbus Slave Module.

IMPORTANT When the Mode is selected as “Remote”, the Target ID must be the same as the Device ID.



Figure 44 - TCP Master Register Configuration Page



Table 22 - Description for TCP Master Register Configuration Page

Item Description

Total ScanGroup Total Number of scan groups that are configured for the Slave Device.

Scan Group-Scan Rate Time Interval at which TCP Master polls the Slave Device.

Scan Group- Scan Trigger Register Modbus Register that is used for triggering (enabling) the Scan group. If the register is set to 0, the Scan group is always enabled.

Scan Group- Scan Trigger Value Value of the Trigger Register for which the Scan group is triggered (enabled).

Total Transfer Total number of Register transfers for one Scan group.

Register #--Slave Start Address Slave Device, Modbus Register Type, and Address from which Data is polled.

Register #-Local Start Address Local Modbus Register Type and Address to which Data from Slave Device to be updated.

Register #-Data Type Data Type of the Slave Device Modbus Register to be polled.

Register #-No. of Registers Number of consecutive registers to be polled from the Slave Device.

Register #-Swapped Determines if the Data Type of Slave Device Register is inverted (Big-endian mode)

Register #-Scaling Whether to scale the Slave Device Register before saving to the local register.

Register # Scaling Type Whether to scale the Data in Factor mode or Range mode. When in factor mode, Data is scaled with the following formula:

Destination Data = (Source Data * Factor) + OffsetWhen in range scaling mode, the Data is scaled with the following formula:

Destination Data = [(Source Data - Source Min) * (Destination Max - Destination Min) / (Source Max - Source Min)] + Destination Min

Scaling-Factor Factor that is used for Factor Scaling. See formula that is given in Register # Scaling Type.

Scaling-Offset Offset used for Factor Scaling. See formula that is given in Register # Scaling Type.

Scaling-Source Min Minimum value of source Data that are used for Range Scaling. Any source Data less than this value is clamped. See formula that is given in Register # Scaling Type.

Scaling- Source Max Maximum value of source Data that are used for Range Scaling. Any source Data greater than this value is clamped. See formula that is given in Register # Scaling Type.

Scaling- Destination Min Minimum value of destination Data that are used for Range Scaling. Any destination Data less than this value is clamped. See formula that is given in Register # Scaling Type.

Scaling- Destination Max Maximum value of destination Data that are used for Range Scaling. Any destination Data greater than this value is clamped. See formula that is given in Register # Scaling Type.



TCP Master Statistics This section provides information on how to configure the TCP Master Statistics. To navigate to this page, open the Web Application Tool at Main Menu>System Status>Modbus Statistics>TCP Master.

Figure 45 - TCP Master Statistics Page

Item Description

ID Slave Device Modbus ID

Query Numbers of queries that are sent to Slave Device.

Last Query Time Time of last sent query

Response Number of responses that are received from Slave Device.

Last Response Time Time of last received response

Time Out Number of time outs for the sent queries

CRC Err Number of CRC errors in received responses

Invalid Number of Invalid (Non-available Modbus Registers) responses

Reset Reset Statistics to zero for the corresponding Slave Device.

Reset All Reset Statistics to zero for all Slave Devices.

Over Run-ID Slave Device Modbus ID that Over Run (Execution Time exceeded Scan Time) occurred.

Over Run-Scan Group Scan group number for which Over Run occurred.

Over Run-Over Run by milliseconds Time in milliseconds by which Execution Time exceeded Scan Time.



Internal Transfer Configuration

Internal transfers can be configured in the Registers Configuration page. To access this page, go to Main Menu>Modbus 3rd Party Interface>Internal Transfer. This functionality lets you transfer data from a source address to a destination address.

Figure 46 - Internal Transfer Configuration Page

Item Description

Total 3rd Party Slave Total number of devices ID for which Internal transfer is to be configured.

Slave # - ID Modbus Device ID for which Internal transfer is to be configured.

Slave # - Enable Whether to enable polling of the corresponding Internal Transfer ID.



Notes:


Chapter 13

Logging

This chapter describes the Logging and Alarm configurations that are available with the RTU. Topics include the following:

• Message Logger• Data Logger• Modbus Data Copy Configuration• Alarms

Message Logger The message logger records all RTU messages on the console of the local VGA port, TCP network, or the Logfile for the modules. To access this page, navigate to Main Menu>System Configuration>System Debut Message Logger.

Figure 47 - System Debug Message, Logger Configuration Page


Chapter 13 Logging

Table 23 - Description for System Debug Message Logger Confirmation Page

Data Logger The Data Logger records the I/O data and any third-party Modbus data with a date and UNIX time stamp.

The General section of the Data Logger Configuration page can be modified to include custom settings, with additional options to enable/disable Modbus Logging. To access this page, navigate to Main Menu>Data Logger.

The Data logger will log maximum 50000 records. The values are then stored in a FIFO format with the latest value at the top. When the limit is reached (50.000 logs), a new Common Log File is created and the last available Common Log File is renamed as backup. A maximum of one log-backup file is created.

Figure 48 - Data Logger Configuration Page

Item Description

Log To-Console Displays the system debug messages on monitor through VGA port for the corresponding module.

Log To-Log File Saves the system debug messages to Message.csv log file for the corresponding module.

Log To-TCP Displays the system debug message over TCP Port 8000 for the corresponding module.

Message Type-Critical Error Generate system debug message for all critical error messages generated by the corresponding module.

Message Type-Error Generate system debug message for all errors messages generated by the corresponding module.

Message Type-Warning Generates system debug message for all warning messages generated by the corresponding module.

Message Type-Info Generates system debug message for all info messages generated by the corresponding module.

Message Type-Debug Generates system debug message for all debug messages generated by the corresponding module.


Logging Chapter 13

Table 24 - Description for Data Logger Configuration Page

The Data logger can be configured to log the register value of any slave device; however, the register address must always be an absolute Modbus register address. The file name can be configured to as many names, or same names, as the file (.csv) generates.

The Data Type can be selected from the Pull-down Menu. These values are the data-type options.

• 1 – INT• 2 – SHORT• 3 – FLOAT• 4 – USHORT• 5 – UINT• 6 – BIT

The Inverse feature is enabled when the Register values, which are stored in the Modbus register database, are in the inverse format. The Data logger reverses the 'read' value before logging it in to the log file.

Item Description

Maximum Logs For Common Log File Maximum number of logs to be saved in Common Log File before a new file is generated. When the limit is reached, a new Common Log File is created and the last available Common Log file is renamed as backup.

Common Log File Logging Interval Time interval at which data points are save in log file when in Common Log File Type mode.

Total Data Points Number of Data points to be logged. Maximum of 100 Data Points can be logged simultaneously.

Data Points-Device ID Modbus Device ID of the Data point to be logged.

Data Points-Register Modbus Register Type and Address of the Data point to be logged.

Data Points-File Name Name of the log file for corresponding Data point when in Single Log File Type Mode.

Data Points-Data Type Data Type of the Data point to be logged

Data Points-Inverse Whether the Data Type of the Data point to be logged is inverted (Big-endian mode)

Data Points-Maximum Logs Maximum number of logs to be saved in Single File Type Mode before a new file is generated. When the limit is reached, a new Log File is created and the last available log file is renamed as backup.

Data Points-Log File Type Whether to log each Data point in separate files or all Data points in one common log file.

Data Points-Log Interval Time interval at which Data points are save in log file when in Single Log File Type Mode.

Data Points-Log Option Whether to save the Data point to the log file at set interval (Item 11) or whenever the value of the Data point changes. Applicable only for Single Log File Type Mode.

IMPORTANT File name must exclude any space.


Chapter 13 Logging

The Data Points window also enables the configuration of the 'Log File Type', 'Max Logs', and 'Log Interval secs' options. You can change the settings of the Log Option feature from the Pull-down Menu.

The register value can be logged when the register value, or fixed time (seconds) intervals (anything occurring earlier), are changed.

Modbus Data Copy Configuration

Modbus Data Copy Configuration can be configured on the following page. To access this page, go to Main Menu>Modbus Data Copy. This functionality lets you copy data from a source address to a new Destination Address (Fixed to iXC2-RTU ID 1). This functionality is useful for transferring data from Wireless registers (WMP registers) to a new destination address (ID 1).

Figure 49 - Modbus Data Copy Configuration


Logging Chapter 13

Table 25 - Description for Modbus Data Copy Configuration Page

Item Description

Scan Rate Frequency in milliseconds at which Data is copied from the source address to the Destination Address. Fixed to 1000msecs.

Total Transfers Total Number of Transfers to be executed. Maximum allowed total transfers is 100.

Source-ID Modbus Device ID of the Source Register.

Source-Address Modbus Register Type and Address of the Source Register.

Source-Data Type Data Type of the Source Register.

Source-Inverse Whether the Data Type of Source Register is inverted (Big-endian

Destination-ID Modbus Device ID of the Destination Register. Fixed to iXC2-RTU ID.

Destination Address Modbus Register Type and Address of the Destination Register.

Source-Data Type Data Type of the Destination Register.

No. of Data Points Number of consecutive Registers to be copied in one transfer. Maximum allowed number of Data points is 100.

Scaling-Enable Scale the source Data before copying to the destination register.

Scaling-Type Whether to scale the Data in Factor mode or Range mode. When in factor mode, Data is scaled with the following formula:Destination Data = (Source Data * Factor) + OffsetWhen in range scaling mode, the Data is scaled with the following formula:Destination Data = [(Source Data – Source Min) * (Destination Max – Destination Min) / (Source Max - Source Min)] + Destination Min

Scaling-Factor Factor that is used for Factor Scaling. See the formula that is given in the Scaling-Type description.

Scaling-Offset Offset used for Factor Scaling. See the formula that is given in the Scaling-Type description.

Scaling-Source Min Minimum value of source Data that are used for Range Scaling. Any source Data less than this value is clamped. See the formula that is given in the Scaling-Type description.

Scaling- Source Max Maximum value of source Data that are used for Range Scaling. Any source Data greater than this value is clamped. See the formula that is given in the Scaling-Type description.

Scaling- Destination Min Minimum value of destination Data that are used for Range Scaling. Any destination Data less than this value is clamped. See the formula that is given in the Scaling-Type description.

Scaling- Destination Max Maximum value of destination Data that are used for Range Scaling. Any destination Data greater than this value is clamped. See the formula that is given in the Scaling-Type description.


Chapter 13 Logging

Alarms This section provides information on the configuration of the EU Alarms of all AI channels. Set the Alarm Status register to active the alarm. Other registers are also updated to give the following alarm information:

• Alarm Value - the EU value for alarm has occurred• Time of Alarm - The time stamp (UTC) when the alarm occurred• Type of Alarm

Contact your local distributor or Rockwell Automation® representative for the Alarm Modbus registers.

To configure the alarm, open the Web Application Tool at Main Menu>I/O Configuration>Alarms. Check Enable, on the Alarm Configuration page, for the appropriate channel.

The EU Low and EU High Setpoint values, for each channel alarm, are also configured on the Alarm Configuration page. Click Set & Restart to update your changes.

Figure 50 - Alarms Configuration Page

Item Description

Enable Enables Alarm for the corresponding AI Channel. When unchecked no alarm is generated.

EU Low Setpoint EU Low Limit to trigger an Alarm for the corresponding channel.

EU High Setpoint EU High Limit to trigger an Alarm for the corresponding channel.

Auto Acknowledge Resets the alarm automatically when the EU Data in back in accepted range.


Chapter 14

Advanced Applications

This chapter describes the advanced applications of the RTU. Topics include the following:• RTU Kernel Configuration• Module Status• Wireless Messaging Protocol• Web server Configuration

RTU Kernel Configuration Advance Applications can be powered ON or OFF at the RTU Kernel web page. Navigate to the RTU Kernel page at Main Menu>System Configuration>RTU Kernel. Check the Status option to turn on any advanced module. Click Set & Restart to restart the RTU Kernel and update the changes.

Figure 51 - RTU Kernel Configuration Page

ATTENTION: Misuse of the RTU Kernel can disable the functionality of a module that is bound to another module. Only fully trained personnel can have access to this page.


Chapter 14 Advanced Applications

Table 26 - Description for RTU Kernel Configuration Page

Module Status You can also verify if the module has been started from the web server or the Module Status page. To access this page, navigate to Main Menu>System Status>Module Status.

Figure 52 - Module Status Page

Item Description

Watch Dog Interval Frequency in seconds at which the software watch-dog timer checks RTU Kernel. This time is fixed to 180 seconds and is not user-configurable.

Enable Automatically runs the corresponding module at power-on.

Set & Reboot Updates any changes that are made in the page and reboots the RTU.

Item Description

Ghost Version Linux™ Ghost version number of the RTU

Suite Firmware Version The Suite Firmware Revision number of the RTU

Status The running status of the corresponding Module.

Version Version number of the corresponding Module. Displays Not Running if module is not running.

Fault Status Reason due to which the module has stopped running. If the Module is running or is disabled in the RTU Kernel, Fault Status is displayed as N/A.


Advanced Applications Chapter 14

Wireless Messaging Protocol (Gateway)

The RTU communicates with wireless transmitters through the wireless messaging protocol (WMP). WMP is a long-range, wireless, proprietary protocol that supports 2.4-GHz and 900-MHz frequencies.

WMP Configuration

This section provides information on how to configure the settings for WMP. To configure these settings, navigate to the WMP Configuration page at Main Menu>Gateway>Configuration>General.

Figure 53 - WMP Configuration Page



Table 27 - Description for WMP Configuration Page

Serial Filtering

Only transmitters with serial numbers that are present in the serial number list is allowed to register with the iXC2 RTU. To access this page, navigate to Main Menu>Gateway>Configuration>Serial Filtering.

Figure 54 - Serial Filtering Screen

Item Description

Gateway ID Modbus ID of Gateway Module.

WMP Time Out Maximum time the gateway waits for a response from the transmitter that works in remote mode.

COM COM Port that Radio Modem is connected to. Fixed to COM4.

First Trans ID Modbus ID of the first transmitter. Any transmitter with Modbus ID less than the First Trans ID is rejected and the transmitter information is saved in the rejected transmitters list.

Last Trans ID Modbus ID of the last registered transmitter. Any transmitter with ID greater than the Last Trans ID is rejected. Always fixed to First Trans ID + 99.

Check Response Time When enabled, gateway saves the response time for all registered transmitters by sending mail box Messages at scheduled interval.

Radio Mode Enables API Mode to determine signal strength and fade margin of all registered transmitters. Works only with 2.4-GHz radio.

Communication Error Alarm-Enable Enables Communication Error Alarm Feature.

Total Nodes Total number of transmitters that Communication error-alarm action is performed.

Node ID Transmitter ID that Communication error- alarm action is performed.

Alarm Setting Number of sleep intervals, the gateway waits before triggering the Communication Error Alarm Action.

Alarm Action Determines if action is taken. Reset EU to zero, Reset Raw to zero, Set EU to error, like display -999, when the Communication error alarm is triggered.



Table 28 - Description for Serial Filtering Page

Rejected Serial Numbers

From the Rejected Serials Numbers page, you can accept a rejected transmitter whose serial is not present in the Serial Filtering list. To access this page, navigate to Main Menu>Gateway>Transmitter Status>Rejected Serial Numbers.

Figure 55 - Rejected Serial Numbers

Item Description

Serial Filter Enables the serial filtering

Add Adds corresponding serial number to the serial filtering list

Delete Deletes corresponding serial number from the serial filtering list

Item Description

Accept When checked and Set & Restart is clicked, the Serial number gets automatically added to the serial filtering list and the transmitter registers with the gateway.

Reset Reset Rejected Serial Numbers List on Demand.



Rejected Transmitters

The Rejected Transmitters page shows a list of wireless transmitters IDs and serial numbers that are rejected when the serial filter is enabled. To clear this list, click Reset. This section populates again if the wireless transmitters, with filtered-out serial numbers, are still communicating to the WMP gateway. To access this page, navigate to Main Menu>Gateway>Transmitter Status>Rejected Transmitters / Rejected Serial Numbers.

Figure 56 - Rejected Transmitters Page

Item Description

Accept Accept/Register a transmitter whose serial is not present in the serial filtering list. When checked and Set & Restart is clicked, the Serial number gets automatically added to the serial filtering list and the transmitter registers with the gateway.

Reset Reset Rejected Serial Numbers List on Demand.



Registered Transmitters

The Registered Transmitters page lists all wireless transmitters that have successfully registered with the WMP gateway. To access this page, navigate to Main Menu>Gateway>Transmitter Status>Registered Transmitters.

Figure 57 - Registered Transmitters Page

Item Description

Delete Node ID ID of the transmitter to be deleted from the registered transmitters list.

Delete Deletes the transmitter whose ID is specified in Item 1 from the registered transmitters list.

Registered Transmitters-Node ID Modbus ID of registered transmitters.

Registered Transmitters-Serial Number Serial Number of registered transmitters.



Change Transmitter ID

This section provides information on how to configure the settings of any 'communicating' wireless transmitter slave ID. To access this page, navigate to Main Menu>Gateway>Transmitter Status>Registered Transmitters.

Figure 58 - Change Transmitter ID Page

Item Description

Serial Number Serial Number of the transmitter whose ID is changed.

Current ID Current Modbus ID of the transmitter.

New ID New Modbus ID of the transmitter.

Registered Transmitters-Node ID Modbus ID of registered transmitters.

Registered Transmitter-Serial Number Serial Number of registered transmitters.



WMP Statistics

The WMP Statistics page shows the communication efficiency between the wireless transmitters and the gateway. From this page, you can also view the statistics for each wireless transmitter that communicates with the gateway. To access this page, navigate to Main Menu>System Status>WMP Statistics.

Figure 59 - WMP Statistics Page

Item Description

Transmitter ID Transmitter ID of the registered transmitter.

Messages Sent Number of Messages that are sent from the gateway to the registered transmitter.

Messages Received Number of Messages that are received by the gateway from the registered transmitter.

Last Message Time Time of last Message that is received from the registered transmitter.

Time Since Last Message (Seconds) Time in seconds since the last received Message from the registered transmitter.

Next Message (Seconds) Time in seconds until the next scheduled Message to be received from the registered transmitter.

Response Time Time in milliseconds that the transmitter takes to respond to a request from the gateway.

Transmitter Efficiency Ratio of number of Messages that are received by the transmitter from the gateway to the number of Messages that are sent by the transmitter.

Received Efficiency Ratio of number of Messages that are received by the gateway from the registered transmitter to the number of Messages that are sent by the transmitter.



WMP Hardware Configuration

The RTU comes with WMP enabled on COM4, by default. SW4 controls COM4 and the radio port.

SW4 is exposed by removing the enclosure cover on the RTU. The RTU has two DIP switches. Here is the function of the DIP switches.

• DIP switch 1: Controls the external COM4 for either RS-232 or RS-485. When this switch is on, RS-485 is enabled. When Switch 1 is off, RS-232 is enabled.

• DIP switch 2: Controls the internal radio port on COM4. When this switch is on, the radio is enabled. When Switch 2 is off, the radio is disabled.

Figure 60 - Switch 4 Configuration

IMPORTANT See Chapter 3 for instructions on how to remove the enclosure cover and proper DIP switch safety.



Web Server Configuration This section provides information on setting the port that is used for the web server. The Latitude and Longitude values can also be configured from this page. To access the web server Configuration page, navigate to Main Menu>System Configuration>Web Server.

Figure 61 - Web Server Configuration Page

IMPORTANT The web server port must always be “80”.

Item Description

Web Server Port HTTP port number to be used for Web Server

Latitude Latitude to pinpoint the location of RTU

Longitude Longitude to pinpoint the location of RTU



Notes:


Chapter 15

Restore Default Configuration

The Restore Default Configuration page lets you return the software to its original settings. From this page, you can choose to restore all original configurations by checking the Restore All Default option at the top of the page. You can also restore the configuration for individual modules by checking the option next to the appropriate System, I/O, Logging, or Alarm settings. To access this page, navigate to Main Menu>System Configuration>Restore Default.

Figure 62 - Restore Default Configuration Dialog Box

Item Description

Restore All Default Restores all module configurations to default values.


Chapter 15 Restore Default Configuration

Notes:


Chapter 16

Downloads

This chapter describes how to download files and applications to the RTU. Topics include the following:

• ISAGRAF Projects• Download Logs• Configuration Files

To access the Download page, navigate to Download from the Main Menu. From this page, you can download the RTU folder (Suite Firmware) or select to download the Binary applications, Configurations, or Data files separately. ISAGRAF projects and Logs can also be downloaded from this page.

ISAGRAF Projects From this page, you can download any ISAGRAF project on the RTU. If an ISAGRAF project is not available in the RTU, a warning is shown.

Figure 63 - ISAGRAF “No Project” Warning


Chapter 16 Downloads

Download Logs Navigate to the Download Logs page at Main Menu>Downloads>Logs. From this page, you can download data logs in the .csv format and other log files. To download the CSV file right, click the file and select “Save Link As”.

Figure 64 - Download Logs Page

Configuration Files From this page, you can download the actual configuration file. This file contains the settings of the configuration for the RTU.

Figure 65 - Download Configuration Dialog Box

Item Description

Linux-Log Linux™ Boot-up Sequence log when last powered on.

DataLog Current and last backup csv files generated by the Data Logger Module.

TOP Process Information log.


Chapter 17

System Upgrade

The System Upgrade function lets you upgrade the iXC2 RTU operating system. There are four types of files that can be upgraded: Suit Firmware, I/O Firmware, ISAGRAF Project, and Configuration. To access this section, navigate to Main Menu > System Upgrade.

To upgrade the suite firmware, follow these instructions.

1. Select the file type from the pull-down menu.

2. Click Browse and choose the file that you upgrade.

3. Click Upgrade and access the selected file.

Figure 66 - System Upgrade Page/Suite Firmware

Item Description

File Type This field has four options; Suite Firmware, I/O Firmware, ISAGRAF Project, and Configuration.

File Name The name of the file.

Browse Browse and Select the Suite Firmware file to be upgraded on to the RTU.

Retain Configuration Retain exit configuration while loading the new suite firmware.

Upgrade Upgrade the selected Suite Firmware file to the RTU.

Download-Suite Firmware Create a Suite Firmware File with current configuration. When selected, generates a download link for the Suite Firmware file.

IMPORTANT If the Retain Configuration Checkbox is not checked during upgrade, all setting configurations in the RTU are cleared once the suite firmware is upgraded.


Chapter 17 System Upgrade

To upgrade the application, for the local RTU, follow these instructions.

1. Select I/O Firmware.

2. Choose the correct file type.

3. Click Upgrade.

Figure 67 - System Upgrade Page/I/O Firmware

To upgrade the ISAGRAF Project file, follow these instructions.

1. Select ISAGRAF project.

2. Browse for the project file that is upgraded.

3. Click Upgrade.

Figure 68 - System Upgrade Page/ISAGRAF Project

Item Description

Select File Loads the Firmware locally available on the RTU or upload from the Host Personal Computer.

File Name When in Host File Selection mode, browse and select the firmware file to be uploaded.

Upgrade Upgrade the selected Firmware file to the I/O Board.

Item Description


File Name Browse and select the ISGRAF Project file to be uploaded.

Upgrade Upgrade the selected ISAGRAF Project file to the iXC2 RTU.


System Upgrade Chapter 17

To upgrade Configuration file, follow these instructions.

1. Select Configuration.

2. Browse for the file that is upgraded.

3. Click Upgrade.

Figure 69 - System Upgrade Page/Configuration File

Item Description


File Name Browse and select the Configuration file to be uploaded.

Upgrade Upgrade the selected Configuration file to the iXC2 RTU.


Chapter 17 System Upgrade

Notes:


Chapter 18

User-defined Programming (ISAGRAF 6.4)

The RTU runs user-defined custom programs, created on ISAGRAF® Version 6.4. This chapter explains the steps to create and install an ISAGRAF application with ISAGRAF 6.4 workbench on an iXC2 RTU.

Create a New Project Follow these steps to create a project.

1. Install the latest build of ISAGRAF 6.4 Workbench.

2. Run the ISAGRAF 6.4 for vMonitor platform. Click Finish.


Chapter 18 User-defined Programming (ISAGRAF 6.4)

3. Under Installed Templates, navigate to ISAGRAF 5>vMonitor.

4. Click iXC2.

5. Name your project.

6. Click OK.


User-defined Programming (ISAGRAF 6.4) Chapter 18

Create Target Variables Follow these steps to create target variables.

1. To open the list of variables, double-click Global Variables under Resource 1.

2. Create the variables to be used in the program.

3. Type the variable name and data type (BOOL, INT for 16-bit Short register, DINT for 32-bit Long register, and Real for Floating Point Register).

4. Choose Direction as the Var for Internal Tags, VarInput for Input Tags, and VarOutput for Output Tags.

TIP Attributes for the Input tags can only be Read, while Output tags could be either Read/Write or Write.



Add a New Device Follow these steps to add a device.

1. Select the Resource 1 I/O Device tab.

2. Click the Add Device icon from the panel on the left.

3. Choose the appropriate I/O wiring type from the Device Selector window.

4. Type the number of channels/registers for each I/O device.

5. You can also add an alias name, if applicable.

6. Click OK.

Table 29 shows the I/O devices that are available for the application, along with the Modbus register types.

Table 29 - I/O Wiring Types

I/O Wiring Type Modbus Reg Type

InBool Digital Inputs

OutBool Digital Outputs

InReal Analog Inputs (Raw, EU, Linear Accumulation, or Voltage)

OutReal Analog Outputs

InVBool/OutVBool Any reserved Input/Coil Status Register

InVShort/OutVShort (For INT datatype) Any reserved signed 16-bit short input/holding register

InVReal/OutVReal (For Real datatype) Any reserved signed Floating Point input/holding register

InVLong/OutVLong (For DINT datatype) Any reserved signed 32-bit Long input/holding register



Wire the Variable Follow these steps to wire the appropriate variables to the new I/O device.

1. To open the Variable Selector window, double-click the device.

2. Click the Global Variables tab.

3. Choose the Variable to be wired from the menu.

4. After you have wired the appropriate variables, click OK.

Configure the Connection Settings

Follow these steps to configure the connection settings.

1. Go to Deployment view.

2. To go to access the Properties button, right-click the network line.



3. Click Properties.

The IP address can be found in the Properties section of the window.

4. Type the IP address that corresponds to the LAN port that is used by the workbench.

5. Save the project.

Create a Simple-addition Program

Follow these steps to create a simple-addition program.

1. Right-click Programs under Resource 1.

2. Add a Function Block Diagram (FDB).

3. To open the program editor window, double-click the newly created program.

4. Right-click on any empty space and insert three variables.

5. To insert an Addition (+) function block, right-click an empty space and select Insert>Block,



6. Connect the three variables to the inputs and outputs of the function block as shown in the next figure.

7. Save all changes.

Build the Project Follow these steps to build the project.

1. Navigate to Build>Build Solution.

2. Check the Output window for errors.

3. Once the project is compiled, without any errors, download it to the RTU.

TIP If the build is a success, the Output window displays the word “succeeded”.



4. Right-click on the Project name in the Solution Explorer window, and select Download.

The workbench now begins to download the program onto the iXC2 RTU. The download progress can be monitored in the Output window.


Appendix A

Switch COM1 to RS-485

The CPU card (version 1.2) adds support to the RS-485 and RS-232 interface. To use this CPU card, prepare an RTU with the CPU (Version 1.2) and configure the RTU with access to the BIOS settings.

Configure RTU COM1 as RS-485 with the BIOS Setting

1. Power on the RTU.

2. Press the Delete key to enter the BIOS settings.

3. Navigate to Chipset>Southbridge Configuration.

4. Press Enter.

IMPORTANT This document assumes that you know how to connect the RTU to a keyboard and monitor to access the BIOS.


Appendix A Switch COM1 to RS-485

5. Navigate to Serial/Parallel Port Configuration, under Southbridge Configuration.

6. Press Enter.

The COM1 setting is configured on this page.

7. Navigate to Port Type, under SB Serial Port1.

8. Press Enter.

This section presents the option to change the Serial Port Type.

9. Select RS-485.

10. Press Enter.

11. (Follow this step only if applicable) Change the communication rate.

12. Navigate to SB Serial Port1>Baud Rate.

13. Press Enter.

Display the list of available communication rate options.

14. Select the required communication rate with the ‘Select Item’ keys.


Switch COM1 to RS-485 Appendix A

15. Press Enter.

16. Press F10 and save the changes and exit the BIOS.

Now, the RTU must boot through the normal boot cycle. COM1 is now switched for the RS-485 function.


Appendix A Switch COM1 to RS-485

Notes:


Appendix B

vMiConfig for iXC2 RTU

This section describes how to install and use the Rockwell Automation® vMiConfig configuration software with the iXC2 RTU. The vMiConfig delivers the configuration of the following iXC2 RTU applications:

• DNP3 (Master and Outstation)• Enron Modbus• MQTT Application• EtherNet/IP Device Scanner

Software Installation The zipped vMiConfig installation files are available with and without the required Microsoft .NET Framework 4.0.

Figure 70 - vMiConfig Installation Packages

If the .Net Framework 4.0 is already installed on the target personal computer, only the smaller install pack (without the .NET Framework) is required.

To install the software, follow these instructions.

1. Unzip the appropriate install pack.

2. Double-click the setup file, Rockwell Automation vMiConfig Setup 1.0XX.exe.

The software installation wizard opens and guides you through the installation process.


Appendix B vMiConfig for iXC2 RTU

Once the installation wizard is complete, a dialog box appears and confirms that the installation was successful.

iXC2 RTU Project Launch the Software

Once the vMiConfig software has been installed, follow these instructions to launch the application.

1. Select the vMiConfig shortcut that is installed under the Rockwell Automation folder.

2. Navigate to Start > Rockwell Automation > vMiConfig.


vMiConfig for iXC2 RTU Appendix B

The vMiConfig application opens.

Creating a Project

To create a iXC2 project, follow these instructions.

1. From the File menu, choose New.

The New RTU Project window opens.



2. In the RTU Type combo box, select the ‘vMonitor iXC2’ option.

3. Type the IP address of the iXC2 RTU and select Ok.

A new iXC2 project is created and displayed.

4. To save the project, select the Save option under the File menu.

A Save file dialog appears and allows the project file name and folder to be selected.

TIP The Project Explorer shows the various iXC2 applications in a tree view that can be used for navigating between the various configuration options.The Property Panel shows the main properties of the item that is selected in the Project Explorer.

TIP The project files are saved with a .Vmj extension. The default folder is: My Documents\Rockwell Automation\vMiConfig.

ATTENTION: Although the project files are saved in an XML format, edits to the file (outside of the vMiConfig software) can cause unexpected results.



5. To change the configuration of the project (offline) iXC2 IP address, right-click the iXC2 icon at the top of the Project Explorer.

6. To modify the IP address (originally configured in the previous section), type the new address and click Ok.

7. To connect to the iXC2 RTU, right-click the iXC2 icon in the Project Explorer™ and select Go Online.

A green iXC2 icon indicates a successful online connection to the iXC2 RTU.

TIP The IP address that is configured here is used by vMiConfig to communicate to the iXC2 RTU. A change to this value does not change the actual IP address of the iXC2 RTU.



8. Similarly, to disconnect from the iXC2 RTU, right-click the iXC2 icon in the Project Explorer and select Go Offline.

A gray iXC2 icon, in the Project Explorer, indicates that a change has been made.

When the iXC2 RTU is online, the applications (DNP3, Enron Modbus, EtherNet/IP Scanner, and MQTT) are not necessarily online. Although, these applications can only be online if the iXC2 RTU is online. Each application is discussed separately in subsequent sections.

Modbus Monitor

Modbus Monitor manages multiple pre-configured Modbus registers when online with the iXC2 RTU. Modbus Monitor can be configured when the iXC2 RTU is online or offline; however, to monitor the RTU, the vMiConfig software must be enabled. To configure the Modbus Monitor, follow these instructions.

1. To open the Modbus Monitor, double-click the Monitoring icon in the Project Explorer.

TIP If the communication to the iXC2 is terminated, unexpectedly, the software enters an offline state and report this condition with a red iXC2 RTU icon.



The Modbus monitor window opens, with its mode set to Run or Stopped. The mode depends on the Online status of the iXC2 RTU.

2. Add new Monitoring items a line at a time.

The monitoring items include the following:• Description – optional user description.• Modbus Range – The Modbus Range Qualifier for the address to be

monitored, either;– CS – Coils– IS – Discrete Inputs– IR – Input Registers– HR – Holding Registers

• Modbus Address – The Modbus address to be monitored, entered in decimal.• Data Format – The following data formats are supported:

– INT – 16-bit integer that is expressed in decimal. (Spans 1 Modbus register)– Word – 32-bit integer that is expressed in decimal. (Spans 2 Modbus register)– Real – 32 bit real expressed as a floating point. (Spans 2 Modbus register)– IntHex – 16-bit integer that is expressed in hexadecimal. (Spans 1 Modbus register)– WordHex – 32-bit integer that is expressed in hexadecimal. (Spans 2 Modbus register)

3. To accept the monitoring items, click the Save icon in the toolbar.

If the iXC2 is online, then live monitoring can be started by selecting the Play button on the toolbar.

In this mode, each Modbus register is read and its value expressed in the pre-configured data format. Each time a value is successfully updated the Status field is green. If the update failed, the Status field is red.

TIP To edit the monitoring points, the monitor must first be stopped. To stop and run the monitor, click the Stop and Play icons on the top toolbar.



4. To write to a Modbus register, first select the relevant row and then select the Write button on the toolbar.

The Modbus Register Write window opens.

5. Type the new value for the register and click Write.

Modbus Mapping Report

The Modbus Mapping Report provides a summary of all Modbus mapping that has been configured across the iXC2 RTU project.

To open the report, follow these instructions.

1. Right-click the iXC2 icon.

2. Select Modbus Mapping Report.

TIP When using the Write command, even though the value is written immediately to the iXC2 register, the monitor only updates the value when it is next scheduled. For this reason, it is possible for the monitor to display the previous value for a few seconds.



The Modbus Mapping Report window opens.

For each Modbus Mapping item, the range and source are described. The Destructive checkbox is checked, if the mapping can cause the Modbus register to be altered.

If the Modbus ranges of two, or more destructive mapping items overlap, the items are deemed to be in Conflict. These items are colored in salmon.

TIP Mapping items in conflict does not necessarily represent a problem, as there could be legitimate reasons for doing so. The Conflict serves only as a warning.



DNP3 Application The DNP3 application is composed of both the DNP3 Master and DNP3 Outstation functionality. After either or both of these functions have been configured, the DNP3 configuration must be downloaded to the iXC2 DNP3 application.

DNP3 Master

Configuration

To configure the DNP3 master, follow these instructions.

1. To open the DNP3 Master Configuration, double-click the DNP3 Master icon in the Project Explorer.

The DNP3 Master Configuration box opens, and is divided into four tabs: General, Mapping, Scan Classes, and Security.

2. To modify the controls, check the Enable DNP3 Master box.

Parameters Description

Master Enabled Used to enable the DNP3 Master function.

Protocol Specifies whether the DNP3 master uses Ethernet (TCP or UDP) or serial protocols.

COM Port Specifies the COM port to be used if the serial protocol is selected.

Node Address Master DNP3 Node Address.

Retry Limit The retry limit determines how many times the iXC2 must retry the message exchange before failing it.

Timeout The timeout is used to determine the interval between retries when a message exchange has failed.

Reply Wait Time The reply message wait is the minimum delay before the DNP3 reply is transmitted to the DNP3 device.



3. Access the Mapping tab to map the DNP3 items to an internal Modbus register.

Parameter Description

Function The DNP3 function to be applied. The following options can be selected:• Read• Write• Select + Operate• Direct Operate• Direct Operate with no response.

Scan Class Scan class to be used. Determines the rate at which the DNP3 Outstation is polled. (See the Scan Classes Tab.)

IP address IP address of the DNP3 Outstation to be polled.

Node Address Node address of the DNP3 Outstation to be polled.

DNP3 Group The DNP3 Object Group (Analog Inputs) to be polled.

DNP3 Variation The DNP3 Variation of the DNP2 Group. (Specifies the format.)

Reformat Depending on the selected Group-Variation combination, a number of Reformat options are available. These options typically affect how the status byte is sourced or discarded.Options include:• Normal• Override Status (Constant)• Discard StatusSee the Reformat Option in the next section for more information.

Status Source Depending on the Reformat option, the Status Source specifies the constant value for the Status (Reformat = Override Status Constant).

DNP3 Index Start The Start Index of the DNP3 objects.

DNP3 Index Count The number of DNP3 objects.

Modbus Address The source (output) or destination (input) Modbus Register.



4. Next, access the Scan Classes tab to configure the polling rate interval for each of the four scan classes: A, B, C, and D.

5. Configure the Security parameters.

The Enable Security checkbox must be checked before the other controls can be modified.

TIP The interval is entered in milliseconds.



Table 30 - Parameter Description for DNP3 Master Security Tab

Functions Requiring Triggers

The Read and Write DNP3 functions are executed at the polling rate that is defined by the configured Scan Class. However, the other operate functions (Select + Operate, Direct Operate and Direct Operate with No Response) require an additional trigger to execute.

These functions are typically used for Control Relay Output Blocks (CROB) and Analog Output Blocks (AOB). The three functions are described in Table 31.

Table 31 - Select/Operate, Direct-operate, and Direct-operate No Response Functions

To accommodate this trigger, an additional Modbus register (16-bit) is required and the DNP3 object data.

Bit 0 (value 1) of this register is used as the actual trigger. To trigger the operation, the iXC2 application must set the bit (Value = 1). After the next scan interval (configured by the scan class), the DNP3 master application executes the operation, and when complete resets the trigger bit (Value = 0).

Parameter Description

Security Enabled DNP3 Secure Authentication can be enabled or disabled.

MAC Algorithm The MAC algorithm is used to encrypt the challenge data for secure authentication. DNP3 allows for various encryption standards in different formats to be used for secure authentication:• HMAC SHA-1 encryption (four octets – serial) – for legacy support• HMAC SHA-1 encryption (eight octets – serial)• HMAC SHA-1 encryption (10 octets – networked)• HMAC SHA-256 encryption (eight octets – serial)• HMAC SHA-256 encryption (16 octets –networked)• AES-GMAC (12 octets)

Key Wrap Algorithm DNP3 uses various keys for secure authentication. The keys are used for data exchange and called the session keys and these keys are updated frequently. To exchange the session keys between two DNP3 devices, the update key is used to encrypt the data and session keys before exchanging it between parties. DNP3 allows for two standards to encrypt the session keys:• AES-128 Key Wrap• AES-256 Key Wrap

Aggressive Mode To reduce the required bandwidth that is used for secure authentication, you can select Aggressive mode. This mode lets the message initiator anticipate and provide the required authentication in the request message.This action reduces the normal four message exchange to a two message exchange.

Critical Function List• Read• Response

This section specifies whether each of the optionally secured functions requires security.

Function Description

Select/Operate The select/operate function is a two-step operation where the Master first “Arms” the outputs with the select function before enabling the “Armed” output with the operate function.

Direct-Operate The Direct-Operate function has a similar outcome to the Select/Operate function but is a one-step function. Thus the outputs are “Armed” and executed in the same function.

Direct-Operate with no response

The Direct-Operate with no response function is similar to the Direct-Operate but does not require an acknowledgment that the operation has been executed.



Mapping and Reformat Options

Generally, the DNP3 Mapping expects the data that is contained within the mapped Modbus register to resemble that of the linked DNP3 object. as defined by the DNP3 object specification for that specific Group and Variation combination.

In cases where Modbus data points do not contain any status information, a complete remapping for those data points to spare Modbus registers is required. To reduce this effort, particularly for existing applications, a number of reformat options are available, but depend on the Group and Variation combination. The options are: Normal, Override Status (Constant), and Discard Status.

With the Normal reformat option, all required DNP3 data must exist in the configured Modbus registers. To simplify the population of the data items, the data is expected to be padded so that each data item starts on a 16-bit boundary. This type of reformat is useful as many DNP3 objects that include an 8-bit status flag, do so at the beginning of the object. Without the padding, the next item, typically the value, would start half-way through the first Modbus register.

In Figure 71, an Analog Output (Single Float and Control Status Flag format) (Group 41 Variation 3) is mapped to Modbus registers. The Modbus Register starts at 45401 with the Normal reformat option. The Direct Operate function is used and therefore requires a trigger register.

Figure 71 - DNP3 Master Mapping - “Normal” Operate Example

With the Status Override (Constant) option, the status flag is not expected to be contained within the configured Modbus registers. Instead the status flag is replaced with the constant value that is configured in the mapping item.



In Figure 72, an Analog Output (Single Float and Control Status Flag format) (Group 41 Variation 3) is mapped to Modbus registers. The Modbus register starts at 45401 with the Status Override (Constant) reformat option. The Direct Operate function is used and therefore requires a trigger-register.

Figure 72 - DNP3 Master Mapping - “Status Override - Constant” Example

When a DNP3 Master receives reply-data from an Outstation, the data structure contains a Status flag. With the Normal option, this Status flag would be written into the destination Modbus register. With the Discard Status option, the status flag would be removed from the DNP3 data before being written to the mapped Modbus registers.

Figure 73shows three Analog Inputs that are formatted as Read with Status (Group 40 Variation 3), and are read from an outstation. These inputs are mapped to Modbus registers and begin at 45121 with the Discard Status reformat option.

Figure 73 - DNP3 Master Mapping - “Discard Status” Example



Download the Application

To download the DNP3 configuration to the iXC2 RTU, follow these instructions.

1. Right-click the DNP3 application icon.

2. Select Download.

If the iXC2 is not already online, it connects and goes online automatically.

The downloading progress is reported with a progress bar window.

When the download is complete, the DNP3 application is online. The green DNP3, DNP3 Master, and DNP3 Outstation icons in the Project Explorer indicates the status.

TIP When downloading to the DNP3 application, both the DNP3 Master and DNP3 Outstation configurations are downloaded.

TIP The vMiConfig utility can only go online with an application if the offline (project) and online (iXC2) configuration are the same. If they are not identical, you must choose to download (to the device) or upload (from the device.)



Monitoring DNP3 Master

To monitor the status of the DNP3 Master application, follow these instructions.

1. Right-click the DNP3 Master icon and select the Status option.

The status form opens and shows three tabs.

2. Click the first tab to access the general DNP3 communication statistics.

Statistic Description

Application Messages Tx The number of application DNP3 packets sent by the RTU.

Application Messages Rx The number of application DNP3 packets received by the RTU.

Critical Messages Tx The number of critical DNP3 packets sent by the RTU when security is enabled.

Critical Messages Rx The number of critical DNP3 packets received by the RTU when security is enabled.

Messages Discarded The number of DNP3 packets that are discarded by the RTU.

Error Messages Tx The number of error DNP3 packets sent by the RTU.

Error Messages Rx The number of error DNP3 packets received by the RTU.

Checksum errors The number of corrupted DNP3 packets received by the RTU.

Timeouts The number of message response timeouts the RTU has encountered.

DNP3 Request Out of Range – Low The DNP3 request has a range that is outside of the configured DNP3 mapping bounds for the specific group and variation. This error is specific to the range being lower than the configured range.

DNP3 Request Out of Range – High The DNP3 request has a range that is outside of the configured DNP3 mapping bounds for the specific group and variation. This error is specific to the range being higher than the configured range.



3. Click the second tab to access the statistics that are associated with DNP3 security.

Node Mismatch The received message node number did not match the configured node address.

Select Size Too Large When the Select/Operate functionality is used, the iXC2 RTU supports a maximum of 255 bytes per transaction (or one full DNP3 message).

Select Operate Data Mismatch The Select/Operate functionality requires that the response to the Select function matches the Select request.



Authentication Successes Increases every time the device successfully authenticates a message.

Session Key Changes When the session keys have been successfully updated

Session Key Change Failures When the session keys have failed to update

Update Key Changes The Update Key has changed.

Authentication Failures The other device has provided invalid authentication information such as an incorrect MAC.

Authorization Failures Increases when you are not authorized to perform an operation that has been requested.

Unexpected Responses The other device has responded with a message that was not expected during the authentication process.

No Responses The other device has not replied during the authentication process.

Aggressive Not Supported When Aggressive Mode Authentication is not supported this value increases.

MAC Algorithm Not Supported The MAC algorithm that is requested is not supported.

Key Wrap Algorithm Not Supported The Key Wrap algorithm that is requested is not supported.

Update Key Not Permitted Updating of a key was not permitted.

Unknown User The user who is used for authentication was unknown. The default user (1) is the only user supported.



4. Access the last tab to configure and download a pre-shared key for DNP3 Secure Authentication. See the DNP3 Security section for more information.

DNP3 Outstation

Configuration

Follow these instructions to configure the DNP3 outstation.

1. To open the DNP3 Outstation Configuration, double-click the DNP3 Outstation icon in the Project Explorer™.

The DNP3 Outstation Configuration form opens. It is divided into three tabs.

IMPORTANT The Enable DNP3 Outstation checkbox must first be checked before any of the other controls can be modified.



The General configuration is comprised of the following parameters.

2. Access the second tab to map the DNP3 items to internal Modbus registers.

Name Description

Outstation Enabled Used to enable the DNP3 Outstation function.

Node Address Outstation DNP3 Node Address.

User Location Name End-user defined Location Name for the RTU.

User ID Code End-user defined ID Code for the RTU.

User Device Name End-user defined Device Name for the RTU.

Ethernet Protocol Specifies whether the DNP3 Outstation uses TCP or UDP on Ethernet.

COM 1 Used to enable DNP3 Outstation functionality on serial COM Port 1.




Name Description

DNP3 Group The DNP3 Object Group (Analog Inputs).

DNP3 Variation The DNP3 Variation of the DNP3 Group. (Specifies the format.)

Reformat Depending on the selected Group-Variation combination, a number of Reformat options are available. These options typically affect how the status byte is sourced or discarded.Options include:• Normal• Override Status (Constant)• Override Status (Modbus)• Discard StatusSee the Reformat Option in the next section for more information.

Status Source Based on the Reformat option, the Status Source specifies the constant value for the Status (Reformat=Override Status Constant) or the Modbus register that contains the Status (Reformat=Override Status Modbus).

DNP3 Index Start The Start Index of the DNP3 objects.

DNP3 Index Count The number of DNP3 objects.

Modbus Address The source (read) or destination (write) Modbus Register.



3. To configure the Security parameters, click the last tab.

IMPORTANT The Enable Security checkbox must be checked before the other controls can be modified.

Name Description

Security Enabled DNP3 Secure Authentication can be enabled or disabled.

MAC Algorithm The MAC algorithm is used to encrypt the challenge data for secure authentication. DNP3 allows for various encryption standards in different formats to be used for secure authentication:• HMAC SHA-1 encryption (four octets – serial) – for legacy support• HMAC SHA-1 encryption (eight octets – serial)• HMAC SHA-1 encryption (10 octets – networked)• HMAC SHA-256 encryption (eight octets – serial)• HMAC SHA-256 encryption (16 octets –networked)• AES-GMAC (12 octets)

Key Wrap Algorithm DNP3 uses various keys for secure authentication. The keys that are used for data exchange and called the session keys and these keys are updated frequently. To exchange the session keys between two DNP3 devices, the update key is used to encrypt the data and session keys before exchanging it between parties. DNP3 allows for two standards to encrypt the session keys:• AES-128 Key Wrap• AES-256 Key Wrap

Aggressive Mode To reduce the required bandwidth that is used for secure authentication, you can select Aggressive mode. This mode lets the message initiator anticipate and provide the required authentication in the request message. This mode reduces the normal four message exchange to a two message exchange.

Critical Function List• Read• Response

This section specifies whether each of the optionally secured functions requires security.



Mapping and Reformat Options

Generally, the DNP3 Mapping expects the data that is contained within the mapped Modbus register to resemble that of the linked DNP3 object. The DNP3 object specification, for that specific Group and Variation combination, defines the DNP3 Mapping.

However, in cases where Modbus data points do not contain any status information, a complete remapping for those data points to spare Modbus registers would be required. To reduce this effort, particularly for existing applications, a number of reformat options are available, depending on the Group and Variation combination. The options are: Normal, Override Status (Constant), Override Status (Modbus), and Discard Status.

With the Normal reformat option, all required DNP3 data must exist in the configured Modbus registers. To simplify the population of the data items, the data is expected to be padded so that each data item starts on a 16-bit boundary. This action is useful as many DNP3 objects that include an 8-bit status flag, do so at the beginning of the object. Without the padding, the next item, typically the value, would start half-way through the first Modbus register.

In the following example, three Analog Inputs with the Single Float and Status Flag format (Group 30 Variation 5) are mapped to Modbus registers. The Modbus register begins at 45201 with the Normal reformat option.



With the Status Override (Constant) option, the status flag is not expected to be contained within the configured Modbus registers. Instead the status flag is replaced with the constant value that is configured in the mapping item.

In the following example, three Analog Inputs with the Single Float and Status Flag format (Group 30 Variation 5) are mapped to Modbus registers. The Modbus registers begin at 45201 with the Status Override (Constant) reformat option. The override status source value is set to 1, which typically implies Online.



With the Status Override (Modbus) option, the status flag is not expected to be contained within the configured mapped Modbus registers. Instead the status flag is replaced with the value that is contained in an alternative register configures in the Status Source.

In the following example, three Analog Inputs with the Single Float and Status Flag format (Group 30 Variation 5) are mapped to Modbus registers. The Modbus register starts at 45201 with the Status Override (Modbus) reformat option. The override status source Modbus register is set to 45777.

The same status value (the contents of register 45777) is used for all objects in the map item.



Typically, when a DNP3 Outstation receives “output” data from the DNP3 Master (with operations such as Write, Select-Operate, Direct Operate), the data structure contains a Control Status. With the Normal option, this Control Status is written into the destination Modbus register. However, with the Discard Status option, the control status flag is removed from the DNP3 data before being written to the mapped Modbus registers.

In the following example, three Analog Outputs, which include a control status (Group 40 Variation 3) are mapped to Modbus registers. The Modbus register starts at 45201 with the Discard Status reformat option.


Once the DNP3 configuration is complete, it can be downloaded to the iXC2 device. Follow these instructions to download the application.

1. Right-click the DNP3 application icon and select Download.



If the iXC2 is not already online, it connects and goes online automatically.

The downloading progress is reported with a Progress Bar window.

Once the download is complete the DNP3 application is online, indicated by the green DNP3 application, Master, and Outstation icons in the Project Explorer.

Monitor the DNP3 Outstation

To monitor the status of the DNP3 Outstation application, follow these instructions.

1. Right-click the DNP3 Outstation icon and select the Status option.

The status form opens and shows four tabs.

TIP When downloading to the DNP3 application, both the DNP3 Master and DNP3 Outstation configurations are downloaded.

TIP The vMiConfig utility can only go online with an application if the offline (project) and online (iXC2) configuration are the same. If they are not identical, you must choose to download (to the device) or upload (from the device).



2. Access the first tab to view the general DNP3 communication statistics.

Table 32 - Descriptions for DNP3 Statistics Tab


Application Messages Tx The number of application DNP3 packets sent by the RTU.

Application Messages Rx The number of application DNP3 packets received by the RTU.

Critical Messages Tx The number of critical DNP3 packets sent by the RTU when security is enabled.

Critical Messages Rx The number of critical DNP3 packets received by the RTU when security is enabled.

Messages Discarded The number of DNP3 packets that are discarded by the RTU.

Error Messages Tx The number of error DNP3 packets sent by the RTU.

Error Messages Rx The number of error DNP3 packets received by the RTU.

Checksum errors The number of corrupted DNP3 packets received by the RTU.

Timeouts The number of message response timeouts the RTU has encountered.

DNP3 Request Out of Range – Low The DNP3 request has a range that is outside of the configured DNP3 mapping bounds for the specific group and variation. This error is specific to the range being lower than the configured range.

DNP3 Request Out of Range – High The DNP3 request has a range that is outside of the configured DNP3 mapping bounds for the specific group and variation. This error is specific to the range being higher than the configured range.

Node Mismatch The received message node number did not match the configured node address.

Select Size Too Large When the Select/Operate functionality is used, the iXC2 RTU supports a maximum of 255 bytes per transaction (or one full DNP3 message.

Select Operate Data Mismatch The Select/Operate functionality requires that the response to the Select function matches the Select request.

Class 1 Unsolicited Messages Sent The number of unsolicited Class 1 Event messages sent.





3. To configure the DNP3 Event statistics, access the second tab.

Table 33 - DNP3 Outstation Status - Event Statistics


Rollover Indicates that the event buffer has rolled-over.

Overflow Indicates that the event buffer overflow has been set. This indicates that eventshave been lost.

Total Event Count The total number of events in the buffer.

Current Event Index The current event index. The index that will be assigned to the next event recordthat is logged.

Last Event Index The event index of the oldest event record in the buffer.

No Class Event Count The number of event records in the buffer not assigned to any class.

Class 1 Event Count The number of Class 1 event records in the buffer.



Class 1 Unsolicited Mode Indicates that the DNP3 master has invoked the unsolicited mode for Class 1 events.





4. Click the third tab to configure the statistics that are associated with DNP3 security.

Table 34 - Description for Security Statistics Tab


Authentication Successes Increases every time the device successfully authenticates a message.

Session Key Changes When the session keys have been successfully updated

Session Key Change Failures When the session keys have failed to update

Update Key Changes The Update Key has changed.

Authentication Failures The other device has provided invalid authentication information such as an incorrect MAC.

Authorization Failures Increases when you are not authorized to perform an operation that has been requested.

Unexpected Responses The other device has responded with a message that was not expected during the authentication process.

No Responses The other device has not replied during the authentication process.

Aggressive Not Supported When Aggressive Mode Authentication is not supported this value increases.

MAC Algorithm Not Supported The MAC algorithm that is requested is not supported

Key Wrap Algorithm Not Supported The Key Wrap algorithm that is requested is not supported.

Update Key Not Permitted Updating of a key was not permitted.

Unknown User The user who is used for authentication was unknown. The default user (1) is the only user supported.



5. Click the last tab to configure and download a pre-shared key for DNP3 Secure Authentication. See the DNP3 Security section for more information.

Event Management

The DNP3 events are useful for multiple reasons. These events can verify that the changes that an outstation experienced during a period of no communications with the master are recorded, and later transferred to the master. Events can also be used to reduce the communication overhead, by effectively only transmitting data when it changes, rather than cyclically polling it (Report-By-Exception).

Not all DNP3 objects are available for use with the event mechanism. Appendix D tabulates the objects that are supported and their corresponding event-reporting formats (Event Variations).

The DNP3 Event mechanism can be divided into three main functions:• Event Generation• Event Log• Event Reporting

Event Generation

The event generation function examines each DNP3 object item that is configured for events, and determines if an event is generated.

Either of the two criteria would trigger an event to be logged:• The status value changes (if applicable)• The primary object value changes by an amount greater or equal to the pre-

configured deadband.



Event Log

The event log is a non-volatile circular buffer of event records. The buffer can store a maximum of 20,000 records.

Each record contains a time stamp of the event and the DNP3 object item data needed to report the event in the pre-configured format (Event Variation).

Event Reporting

In response to a DNP3 Master request for events, the Event Reporting module scans the event log for the first unread event that matched the DNP3 Master request criteria. The module then returns the appropriate event.

The request is for events of a specific object item (Group, Variation, and Item) or a general Integrity Poll, that is, for an entire class (either Class 1, Class 2 or Class 3). For this reason, events are not necessarily unloaded in the order in which they are logged.

The event report is then returned in the reply of the DNP3 Master request, which the DNP3 master would then Acknowledge.

The receipt of this master acknowledgment serves as confirmation that the event record has been received and must be flagged as read. To flag the event, increment the Last-Read record indexes for each affected object item.

Unsolicited Event Reporting

In addition to reporting an event in response to a request from a DNP3 master, the Event Manager also supports unsolicited event reporting. The Unsolicited Event reporting functionality can be enabled and subsequently disabled by the DNP3 master at any time.

When in this mode, the Event Manager will, at a fixed rate, transmit any unread events one at a time. The combination of events being generated based on change, and the unsolicited reporting mode being enabled, lets the iXC2 to report by exception.



DNP3 Security

DNP3 offers Secure Authentication for links at risk of being attacked. There are various Key Change methods, Message Authentication Code (MAC) algorithms, and Authentication methods provided in the DNP3 protocol specification.

Various keys are used in DNP3 Secure Authentication. Session keys are used most frequently as it is used for Authentication of the requests. The DNP3 master updates the keys at a certain interval or every time there has been a message failure. The DNP3 master encrypts these keys before sending them across the wire with the Key Wrap Algorithm selected and the Update key. The Update Key can be updated in numerous ways, including the delivery of the key with another set of Keys that encrypt the message.

The iXC2 DNP3 application supports DNP3 Secure Authentication 5, which supports the Pre-Shared Key method for Key Changes. The Update Key is entered into each device by means outside of the DNP3 protocol.

Within the Master and Outstation Status forms of vMiConfig, you can write the Update Key to the iXC2. The key that is entered must match the Key Wrap Algorithm selected. Thus if AES-128 Key Wrap is selected the Update Key must be 128 bit (16 bytes) long. If AES-256 Key Wrap is selected, the Update Key must be 256 bit (32 bytes) long. You can either enter a predetermined hexadecimal code or create a code with the random Generate function. This key is encrypted before being sent to the iXC2 where it is saved into nonvolatile memory.

WARNING: The Key update method in vMiConfig is a write-only function. Therefore, once the key has been downloaded you are no longer able to view the key again and must provision to document or save the key in a secure manner.

WARNING: The remote DNP3 device must have the same Update Key as the iXC2. Failure to comply, results in a failed data exchange for critical messages.



Enron Modbus Application The Enron Modbus slave application allows the RTU to exchange data with an Enron Modbus Polling master.

Enron Modbus is an extension of the Modbus protocol with additional support for non-integer data types and mechanisms for the transfer of historical (report and event) information.

General Configuration

To configure the Enron Modbus Configuration, follow these instructions.

1. To open the general, Enron Modbus configuration form, double-click the Enron Modbus icon in the Project Explorer.

2. To configure the General settings, click the first tab of the configuration window.

The Enable Enron Modbus checkbox must first be checked before the other controls can be configured.

Name Description

Enable Enron Modbus Used to enable the Enron Modbus application.

Physical Port Defines the application that binds to either the Ethernet or serial ports. The following options are available:• TCP (Ethernet)• COM Port 1• COM Port 2• COM Port 3• COM Port 4

Node Address The Modbus node address of the application.



3. To configure the mapping between the Enron Modbus and standard Modbus registers, click the second tab.

Enron Modbus specifies ranges of registers that must have specific data types.

Name Description

Enron Modbus Address The Enron Modbus register address is used by the external Enron Modbus master.

Modbus Address The internal Modbus register address in the iXC2.

Length The length (in bytes) of the mapping item.

Description The description is an optional used-defined string.

Name Description

1001...1999 Booleans

3001...3999 16-bit Short Integers

5001...5999 32-bit Long Integers

7001...7999 32-Bit Floating Point Reals



4. To configure the Alarm and Event retrieval, click the last tab.

Name Description

Register Reference The Enron Modbus register used to unload the events. Typically, Register 32 is used.

Event Table The internal iXC2 table (files) that is the source for the events, either EventReport or AlarmReport.

Default Change Map This map is the fixed value that is used for the change map parameter in each event reply. Defaults to zero.



Report Configuration

To create an Enron Modbus reports, follow these instructions.

1. Right-click the Enron Reports icon and select Add.

The Enron report configuration window opens, the first tab comprises the general report settings.

2. To make changes to the General settings, access this tab.

Name Description

Report Name User-defined name for the report.

Register Reference The Enron Modbus register used to request the report. Typically this reference is a register in the 701...799 range.

Source Table The internal iXC2 table (files) that is the source for the report, either HourlyReport or DailyReport.

Record Index Field The field name in the source table to be used for the record index.This field can be selected with the Field Selector.

Date Time Field The field name in the source table to be used for the Date and Time.This field can be selected with the Field Selector.



3. Type field names, manually, or select a name from the Field Selector window.

4. Use the final tab to select the fields to be reported, and the order in which they must be reported.

To insert a field, follow these instructions.

1. Right-click the left margin of the item and select Insert.

2. Add the fields one at a time, manually, by selecting the browse option, or with the Add Multiple window.

Multiple reports can be added, providing they have different Register References.




Once the Enron Modbus configuration is complete, follow these instructions to download the configuration to the iXC2 device.

1. Right-click the Enron Modbus application icon.

2. Select Download.

If the iXC2 is not already online, it connects and goes online automatically. The downloading progress is reported with a Progress Bar window.

Once the download is complete, the Enron Modbus application is online. A green, Enron Modbus application icon in the Project Explorer indicates the change.



Monitor Enron Modbus

To monitor the status of the Enron Modbus application, follow these instructions.

1. Right-click the Enron Modbus icon.

2. Select the Status option.

The status form opens and shows the Enron Modbus application statistics.

Name Description

Rx Packet Count The number of Enron Modbus packets that are received by the iXC2 RTU.

Tx Packet Count The number of Enron Modbus packets that are transmitted by the iXC2 RTU.

Checksum Errors The number of packets excluded due to a checksum error.

Map Item Not Found Request Modbus register not found in the mapping.

Node Mismatch Modbus request destination address does not match the configured node address.

Illegal Function Modbus request function is not supported.



MQTT Application The implementation of the MQTT applications allow the iXC-2 RTU to exchange data with MQTT brokers.

There exists two independent MQTT Client Applications, viz. MQTT Client A and MQTT Client B.

The vMiConfig utility is used to setup and download the static MQTT configuration to each of the iXC-2 MQTT Clients. This configuration includes details of the primary and secondary MQTT Brokers to which the iXC-2 client should connect.

General Configuration

To configure the General settings of the MQTT Client, follow these instructions.

1. To open the MQTT configuration form for one of the MQTT client applications, double-click the MQTT (A or B) icon in the Project Explorer.

The first tab of the configuration window contains the General settings.

2. Check the Enable MQTT Client checkbox to configure the other controls.



Table 35 - MQTT General Parameters

3. To configure the MQTT Topic Names, click the second Topic Names tab.

Figure 74 - MQTT Topic Names Tab

Name Description

Enable MQTT Client Used to enable the MQTT function.

Device Identifier The MQTT unique identifier

Compression Either None or GZip.The compression (and decompression) is applied to all published and received data.

Backfill Data

Log File Size The maximum size (records) of the backfill historical log file.

Publish Interval The minimum interval (milliseconds) between backfill data sets being published.

Publish Size The maximum number of backfill data records to be included in each published set.

Transaction Log Size The maximum size (datasets) of the backfill transaction historical log file.

Will and Connection Status Options

LWT Enable Enables the Last Will and Testament (LWT) functionality.

LWT Retain Sets the Retain flag in the LWT message.

Connect Retain Sets the Retain flag in the connection status.

Name Description

Configuration Topic The topic name to be used to subscribe to receive the dynamic configuration.

Configuration Ack Topic The topic name to be used to publish the configuration acknowledgment, in response to receiving new configuration.

Live Data Topic The topic name to be used for live data publishing.

BackFill Data Topic The topic name to be used for backfill data publishing.

Connection Status Topic The topic name to be used for connection status messages (including the LWT.)

Health Topic The topic name to be used for health / heartbeat messages.



4. To configure the Primary MQTT broker connection parameters, click the Primary Broker tab.

Figure 75 - Primary MQTT Broker Tab

Name Description

Host Name The host name or IP address of the MQTT broker.


Secure Connection Options

Secure Connection Enables secure connections.When enabled the secured port is used and TLS security is applied.

Secured Port The TCP port to be used for secure connections.


Authenticate Server Option Selects whether the Server Certificate will be authenticated against the Certificate Authority.

Certificate Authority Certificate Authority, used for server authentication.Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Client Certificate Client Certificate, used for server to authenticate the client.Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Client Key Client Key File, must match the Client certificate.Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Authentication Options

Authentication Enables authentication. If disabled, an anonymous login is used.



Connection Options




5. To configure the Secondary MQTT broker connection parameters, click the Secondary Broker tab.

Figure 76 - Secondary MQTT Broker Tab

Ping Interval The interval (seconds) between ping requests sent to the broker.This can be used to keep the connection active.Setting the Ping Interval to zero, disables the pinging action. The connection will then be closed after the Keep Alive interval, if there is no activity.

Ping Interval The interval (seconds) between ping requests sent to the broker.This can be used to keep the connection active.Setting the Ping Interval to zero, disables the pinging action. The connection will then be closed after the Keep Alive interval, if there is no activity.


Clean Session Specifies whether the connection to the MQTT broker will have the Clean Session flag set.When cleared, the iXC-2 and broker would continue with the configured topic subscriptions from the previous session.

Name Description

Name Description

Enable Enables secondary broker connection.

Host Name The host name or IP address of the MQTT broker.


Secure Connection Options

Secure Connection Enables secure connections.When enabled the secured port is used and TLS security is applied.

Secured Port The TCP port to be used for secure connections.




Downloading Application

Once the MQTT client application configuration is complete, it can be downloaded to the iXC2 device. Follow these instructions.

1. Right-click the MQTT application (A or B) icon and selecting Download.

Figure 77 - MQTT Context Menu

Authenticate Server Option Selects whether the Server Certificate will be authenticated against the Certificate Authority.

Certificate Authority Certificate Authority, used for server authentication.Note: This file can be transferred to the iXC-2, using the vMiConfig utility

Client Certificate Client Certificate, used for server to authenticate the client.Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Client Key Client Key File, must match the Client certificate.Note: This file can be transferred to the iXC-2, using the vMiConfig utility.

Authentication Options

Authentication Enables authentication. If disabled, an anonymous login is used.



Connection Options


Ping Interval The interval (seconds) between ping requests sent to the broker. This can be used to keep the connection active.Setting the Ping Interval to zero, disables the pinging action. The connection will then be closed after the Keep Alive interval, if there is no activity.


Clean Session Specifies whether the connection to the MQTT broker will have the Clean Session flag set.When cleared, the iXC-2 and broker would continue with the configured topic subscriptions from the previous session.

IMPORTANT If both MQTT client applications are being used, they must be downloaded separately. If the iXC2 is not already online, it will connect and go online automatically.

Name Description



The downloading progress will be reported by means of a Progress Bar window.

Figure 78 - MQTT Download Progress Bar

Once the download is complete the MQTT application will be online, indicated by the green MQTT application icon in the Project Explorer.

Figure 79 - MQTT Online

Monitoring MQTT

To monitor the status of the MQTT application, follow these instructions.

1. Right-click the MQTT client icon (A or B).

2. Select the Status option.

Figure 80 - MQTT Online Context Menu



The status form will open showing that specific MQTT client application’s Status tab.

Figure 81 - MQTT Status Tab

These status parameters are as follows:

Table 36 - MQTT Status Parameters

Name Description

Static Configuration Indicates the validity of the current static configuration.

Dynamic Configuration Indicates the validity of the last received (cached) dynamic configuration.

Primary Broker Indicates the current connection status to the Primary MQTT broker.

Secondary Broker Indicates the current connection status to the Secondary MQTT broker.



To download a certificate file to the iXC-2, follow these instructions.

1. Select the Download Certificate button.

A file dialog window appears.

2. Select the required certificate file (.PEM).

Figure 82 - Select PEM Certificate File

The file will then be transferred to the iXC2 RTU. Once completed, the Download Successful prompt will be displayed.

Figure 83 - Certificate File Download Complete

The Clear Continuous Data Log and Clear Transaction Data Log buttons can be used to clear all the records in the continuous and transaction logs respectively.



3. To view the MQTT statistics, click the last tab.

Figure 84 - MQTT Statistics Tab

Name Description

Current Connection Count Number of MQTT connections active.

Connections Accepted Number of connection requests accepted by the broker.

Connections Rejected - Identifier Number of connection requests rejected by broker due to invalid client identifier.

Connections Rejected - Server Unavailable Number of connection requests rejected by broker due to the server not being available.

Connections Rejected - Not Authorized Number of connection requests rejected by broker due to invalid authorization.

Connections Rejected - User / Password Number of connection requests rejected by broker due to invalid username and password combination.

TLS Certificate Rejected Number of secure connection requests rejected due to an invalid TLS certificate.

Configuration Accepted Count Number of published dynamic configuration sets received and accepted.

Configuration Rejected Count Number of published dynamic configuration sets received but not accepted.

Configuration Ack Publish Count Number of configuration acknowledgments published.

Live Continuous Data Publish Count Number of Live Data sets published with continuous data.

Live Transaction Data Publish Count Number of Live Data sets published with transaction data.

BackFill Continuous Data Publish Count Number of Backfill Data sets published with continuous data.

BackFill Continuous Data in Log Number of Backfill Data records in continuous log.

BackFill Transaction Data Publish Count Number of Backfill Data sets published with transaction data.

BackFill Transaction Data in Log Number of Backfill Data sets in transaction log.



EtherNet/IP Scanner Application

The EtherNet/IP Scanner application allows the addition of remote EtherNet/IP IO devices to the iXC-2. Each EtherNet/IP device requires a specific library definition file, before it can be added.

The configuration user interface of each EtherNet/IP device is defined by the aforementioned definition file. Typically the configuration lets you:

• Modify the optional settings of the device (scaling factors).• Modify the connection parameters (Requested Packet Interval).• Map the I/O data to internal iXC2 Modbus registers.• Configure device parameters (Drive maximum frequency).

Configuration

To add an EtherNet/IP device to the application, follow these instructions.

1. Right-click the EtherNet/IP Scanner icon.

2. Select Add.

The Add Device window appears and shows a list of the EtherNet/IP devices.



3. Select the required device and then clock on the Add button.

The configuration window, specific for that device is opened. In this example, the 1794-AENTR (FLEX Ethernet Adapter) has been selected. Once added, the configuration window opens.

Because the FLEX adapter does not exchange data, many of the tabs and parameters are either not visible or have been disabled. Typically with adapters only the Instance Name, Revision, Keying, and IP address can be configured. These parameters are discussed in more detail in the next example.

4. To add a FLEX I/O device beneath the FLEX adapter, right-click on the adapter and select the Add option.

TIP A number of device libraries are automatically installed with vMiConfig. If the number of devices does not appear in the list, then select the Refresh Cache menu item.

TIP Only devices with a network that match the parent device network is shown. For example, only EtherNet/IP devices are shown when adding from the root, and only FLEX™ I/O devices are shown when adding from a FLEX adapter.



The Add Device window opens and displays all devices that can be added to a Flex-bus.

General Connection Parameters

In this example, the 1794-IF4I (FLEX 4-Channel Analog Isolated Input module) has been selected. Once added, the configuration window opens.



Table 37 - Description for Device Config Module General Tab

Map the Assembly Data

The second tab is used to configure the mapping between the produced and consumed data of the device, and the iXC2 RTU internal Modbus registers.

Table 38 - Description for Device Config Module Mapping Tab

Name Description

Description Functional description of the selected device. Read only.

Instance User-defined Instance name for the device. Instance names must be unique.

Revision The major and minor revision of the device. Depending on the Electronic Keying option, an incorrect revision helps prevent the connection.

Electronic Keying Electronic Keying has the following options: • Disabled: The product-match is ignored and the connection is attempted.• Exact: The product type, code, and revision must match exactly for a

connection to be established.• Compatible: The configured product type, code, and revision must be

compatible with the actual device for a connection to be established.

IP Address The IP address of the device. This address is valid only for EtherNet/IP devices and are hidden for non-Ethernet devices (Flexbus module)

Slot The slot position of the device. This position is valid only for bus- or chassis- based modules, and are hidden for Ethernet module.

RPI The Requested Packet Interval determines the rate at which the device and the iXC2 exchanges produced data. The value is in milliseconds.

Accepts Listen Only Certain devices accept a second “Listen-Only” connection, and allow for multiple iXC2 RTU to connect to them. This option is disabled if not available.

Name Description

Assembly Type One of the following assembly types can be selected:• Input – Data produced by the device and is transferred to the configured Modbus address.• Output – Data consumed by the device and is sourced from the configured Modbus address.• Connection – This connection is a virtual assembly that provides the status of the actual connection.

Connection Index This index specifies the connection number (1 and 2) when multiple connections to a device are required. This column is not visible when only one connection to the device is required.

Assembly Offset The starting byte position of the assembly to be used.



The mapping items can either be entered manually or with the mapping template within the device library definition. When using the latter Remap function, the Modbus register starts with the Start Modbus Address value and increment for each item, based on the length of the previous item.

This operation can add just the recommended items in the library template, or all items, depending on the radio-button selection.

Specific Device Configuration

Depending on the device that is selected one or more configuration tabs are displayed, which lets you configure the target device. This example shows the configuration for the 1794-IF4I module.

Description An optional user-defined description for the mapping item.

Modbus Address The internal iXC2 Modbus register when the data is mapped to (in the case of Inputs) or from (in the case of Outputs.)

Length A number of bytes to be transferred.

WARNING: When applying the Remap function, all existing mapped items for that device are deleted.

TIP Once the mapping data for a device has been accepted, it can be easily added to the Modbus Monitor. Right-click the device and select “Add to Modbus Monitor”.

Name Description



Device Parameters

If the EtherNet/IP device supports Device Parameters, then the Parameters tab is visible.

The Device Parameters provide a mechanism to configure and monitor various device attributes by exchanging them with the values in pre-configured Modbus registers. Each parameter has a configurable Read and Write Modbus address and associated Modbus Range Qualifier as one of the following:

• CS – Coils• IS – Discrete Inputs• IR – Input Registers• HR – Holding Registers

Additional Modbus registers can be configured to trigger a Read or Write of all the configured parameters.

Any change to the value of the Read Trigger Address, causes the reading of all the configured device parameters, the results of which are written to the corresponding Read registers for each parameter.

Similarly, any change to the value of the Write Trigger Address, causes the writing of all the corresponding Write register values to the device.

Each parameter also contains a Pre-Connection option, which when enabled causes the parameters to be written to the device before the class 1 connection to the device is attempted.

Should the setting of a parameter fail and that parameter’s Abort Connection option is set, then the connection will not be established. Instead, the writing of all the pre-connection parameters will be aborted and restarted.



The writing of a parameter to the device makes use of the Set Attribute Single CIP service. The reading of a parameter from the device makes use of the Get Attribute Single CIP service. The example shows the Parameters tab for the PowerFlex755 drive.

Figure 85 - Device Parameter Configuration Tab

Name Description

Class The item’s object class ID. (Note that the value must be entered in decimal.)

Instance The item’s Instance ID. (Note that the value must be entered in decimal.)

Attribute The item’s Attribute ID. (Note that the value must be entered in decimal.)

Description An optional user-defined description for the item.

Read Range Specifies the Modbus Range Qualifier for the Read parameter, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

Read Address The associated Modbus register for parameter reads. When a parameter read is triggered, the device parameter value will be written to this register.

Write Range Specifies the Modbus Range Qualifier for the Write parameter, either:CS – CoilsIS – Discrete InputsIR – Input RegistersHR – Holding Registers (default)

Write Address Specifies whether the parameter should be written to the device before the class 1 connectionestablishment

Data Type The Data Type for the value to be written.(Note that the data type must match the typeexpected by the device for that specific parameter.).

Initial Value The initial value expressed as a string. During a download, the initial values are written to the mapped “Write” Modbus register.Note: The value must comply with the aforementioned Data Type, if not the cell background will be colored orange.

Pre-Connection Specifies whether the parameter should be written to the device before the class 1 connectionestablishment.

Abort Connection Checking the Abort Connection option, will result in the connection not being attempted should the writing of the Pre-Connection parameter be unsuccessful.Instead, the writing of the entire set of parameters will be re-attempted. Connection with the device will only be attempted once all the parameters (with the Abort Connection and Pre-Connection options set) have been successfully written.



Downloading the Configuration

Once the EtherNet/IP configuration is complete, it can be downloaded to the iXC-2 device by right-clicking on the EtherNet/IP Scanner application icon and selecting Download.

If the iXC2 RTU is not already online, it connects and goes online automatically. The downloading progress is reported with a Progress Bar window.

Once the download is complete the EtherNet/IP application will be online, indicated by the green EtherNet/IP Scanner application icon in the Project Explorer.



Monitoring EtherNet/IP Devices

To monitor the status of the EtherNet/IP devices, right-click that specific device icon and select the Status option.

The status form opens and shows two tabs. The first tab shows the device Connection Status. The device status can be one of the following:

• Connected (Green)• Connected – Listen Only (Blue)• Not Connected (Red)• Parameter Abort (Salmon)

Name Description

Connection The connection ID for the connection. (Numbers from 1)

Fwd Opens The number of Forward Opens issued from the iXC2 to establish a Class 1 connection.

Fwd Closes The number of Forward Closes issued from the iXC2 to terminate a Class 1 connection.

Timeouts The number of timeouts that are experienced by the iXC2 as it waits for produced data from the device.

Tx Count The number of scheduled (produced) packets that are sent by the iXC2 to the device.

Rx Count The number of scheduled (produced) packets that are received by the iXC2 from the device.



The second tab displays the assembly data that is associated with that device. The raw assembly data is shown in the value field next to the corresponding mapping item.

The ConnectionStatus is a 16-bit integer that describes the status of that specific device connection. The iXC2 application uses this integer to determine if the EtherNet/IP device is connected correctly.

This table defines the structure of the ConnectionStatus.

If the device has Device Parameters that are configured, then the Parameter tab is visible. This tab can be used to monitor and modify the device parameter values.

TIP The raw assembly data is displayed in decimal integer format, and therefore does not represent the device intended data format.

Bit Function Description

Bit 0 Connected The connection is valid.

Bit 1 Listen Only The connection that is reverted to a Listen-Only connection due to an ownership conflict.

Bit 2 Pre-Connection Parameter Abort

The connection to the device was aborted due to the failure of writing one or more pre-connection parameters.

Bit 3...5 Reversed



Each configured device parameter is shown, one per row, including the current values of the Modbus registers associated with reading and writing. The initial value, which is derived from the configuration, is also displayed.

If a parameter Read value is not equal to that of the corresponding Write value, then both of these values are highlighted in orange.

If a parameter Write value is not equal to the corresponding Initial value, then both of these values are highlighted in orange.

The value of a Write value can be changed by double-clicking the cell. This action triggers a Modbus write.

If you select the Read Parameters button, you trigger the reading of all device parameters (reading from the physical device and writing to the Read value Modbus register.)

If you select the Write Parameters button, you trigger the writing of all device parameters (reading from the Write value Modbus register and writing to the physical device.)

If you select the Copy Write to Initial button, it updates the Initial Values in the configuration with the current Write values. Note, that following this procedure, the project needs to be saved to persist the changes.

If you select the Copy Initial to Write button, it updates the Write values with the Initial values. This method is achieved through a series of Modbus writes.



Notes:


Appendix C

DNP3 Object Summary

Group Variation Size (bytes)

Pad Position

Outstation Master

Allow Status

Override

Allow Status

Discard

Allow Status

Override

Allow Status

Discard

G01 - Binary InputsV01 - Packed Format 0.1 - - - - -

V02 - With Flags 1 1 - - - -

G02 - Binary Input Events

V01 - Without Time 1 1 - - - -

V02 - With Absolute Time 7 1 - - - -

V03 - With Relative Time 3 1 - - - -

G03 - Double Bit Binary InputsV01 - Packed Format 0.2 - - - - -

V02 - With Flags 1 1 - - - -

G04 - Double Bit Binary Input Events

V01 - Without Time 1 1 - - - -

V02 - With Absolute Time 7 1 - - - -

V03 - With Relative Time 3 1 - - - -

G10 - Binary OutputsV01 - Packed Format 0.1 - - - - -

V02 - Output Status With Flags 1 1 - - - -

G11 - Binary Output EventsV01 - Status Without Time 1 1 - - - -

V02 - Status With Time 7 1 - - - -

G12 - Binary Output Commands

V01 - Control Relay Output Block 11 11 - - - -

V02 - Pattern Control Block 11 11 - - - -

V03 - Pattern Mask 0.1 - - - - -

G13 - Binary Output Command EventsV01 - Command Status Without Time 1 1 - - - -

V02 - Command Status With Time 7 1 - - - -

G20 - Counters

V01 - 32-bit With Flag 5 1 Yes - - Yes


V03 - 32-bit With Flag - Delta 5 1 Yes - - Yes


V05 - 32-bit Without Flag 4 - - - - -


V07 - 32-bit Without Flag - Delta 4 - - - - -



Appendix C DNP3 Object Summary

G21 - Frozen Counters





V05 - 32-bit With Flag And Time 11 1 - - - -


V07 - 32-bit With Flag And Time - Delta 11 1 - - - -






G22 - Counter Events









G23-Frozen Events









G30-Analog Inputs





V05 - Single Floating Point With Flag 5 1 Yes - - Yes

V06 - Double Floating Point With Flag 9 1 Yes - - Yes


Pad Position

Outstation Master

Allow Status

Override

Allow Status

Discard

Allow Status

Override

Allow Status

Discard


DNP3 Object Summary Appendix C

G31-Frozen Analog Inputs



V03 - 32-bit With Time Of Freeze 11 1 - - - -

V04 - 16-bit With Time Of Freeze 9 1 - - - -





G32-Analog Input Events

V01 - 32-bit Without Time 5 1 Yes - - Yes


V03 - 32-bit With Time 11 1 - - - -

V04 - 16-bit With Time 9 1 - - - -

V05 - Single Floating Point Without Time 5 1 Yes - - Yes

V06 - Double Floating Point Without Time 3 1 Yes - - Yes

V07 - Single Floating Point With Time 11 1 - - - -

V08 - Double Floating Point With Time 15 1 - - - -

G33-Frozen Analog Input Events



V03 - 32-bit With Time 11 1 - - - -

V04 - 16-bit With Time 9 1 - - - -





G34-Analog Input Reporting Deadbands

V01 - 16-bit 2 - - - - -

V02 - 32-bit 4 - - - - -

V03 - Single Floating Point 4 - - - - -

G40-Analog Output Status





G41-Analog Outputs

V01 - 32-bit 5 - - Yes Yes -

V02 - 16-bit 3 - - Yes Yes -

V03 - Single Floating Point 5 - - Yes Yes -

V04 - Double Floating Point 9 - - Yes Yes -


Pad Position

Outstation Master

Allow Status

Override

Allow Status

Discard

Allow Status

Override

Allow Status

Discard


Appendix C DNP3 Object Summary

G42-Analog Output Events



V03 - 32-bit With Time 11 1 - - - -

V04 - 16-bit With Time 9 1 - - - -





G43-Analog Output Command Events



V03 - 32-bit With Time 11 1 - - - -

V04 - 16-bit With Time 9 1 - - - -





G50-Time And Date

V01 - Absolute Time 6 - - - - -

V02 - Absolute Time And Interval 10 - - - - -

V03 - Absolute Time At Last Recorded Time 6 - - - - -

V04 - Indexed Absolute Time and Long Interval 11 - - - - -

G51-Time And Date of OccurrenceV01 - Absolute Time - Synchronized 6 - - - - -

V02 - Absolute Time - Unsynchronized 6 - - - - -

G52-Time Delays V01 - Coarse 2 - - - - -

V02 - Fine 2 - - - - -

G80-Internal Indications V01 - Packed Format 0.1 - - - - -

G101-BCD Integers

V01 - Small 2 - - - - -

V02 - Medium 4 - - - - -

V03 - Large 8 - - - - -

G102-Unsigned Integers V01 - 8-bit 1 - - - - -

G110-Octet Strings V01 - General 1 - - - - -

G111-Octet String Events V01 - General 1 - - - - -

G112-Virtual Terminal Output Blocks V01 - General 1 - - - - -

G113-Virtual Terminal Event Data V01 - General 1 - - - - -


Pad Position

Outstation Master

Allow Status

Override

Allow Status

Discard

Allow Status

Override

Allow Status

Discard


Appendix D

DNP3 Event Summary

Static Event Options

Group Variation

Description Group Variation

Description

G01 V02 BinaryInputs (+ Flags)

G02 V01 BinaryInputEvents (No Time)

G02 V02 BinaryInputEvents (+ Abs Time)

G02 V03 BinaryInputEvents (+ Rel Time)

G03 V02 DoubleBitBinaryInputs (+ Flags)

G04 V01 DoubleBitBinaryInputEvents (No Time)

G04 V02 DoubleBitBinaryInputEvents (+ Abs Time)

G04 V03 DoubleBitBinaryInputEvents (+ Rel Time)

G10 V02 BinaryOutputs (Output Status + Flags)G11 V01 BinaryOutputEvents (Status No Time)

G11 V02 BinaryOutputEvents (Status + Time)

G12 V01

BinaryOutputCommands (CROB)

(Note: Events not available when using the Discard Reformat option)

G13 V01 BinaryOutputCommandEvents (Status No Time)

G13 V02 BinaryOutputCommandEvents (Status + Time)

G12 V02

BinaryOutputCommands (PCB)

(Note: Events not available when using the Discard Reformat option.)

G13 V01 BinaryOutputCommandEvents (Status No Time)

G13 V02 BinaryOutputCommandEvents (Status + Time)

G20 V01 Counters (32-bit + Flag)G22 V01 CounterEvents (32-bit + Flag)

G22 V05 CounterEvents (32-bit + Flag + Time)

G21 V01 FrozenCounters (32-bit + Flag)G23 V01 FrozenCounterEvents (32-bit + Flag)

G23 V05 FrozenCounterEvents (32-bit + Flag + Time)

G21 V02 FrozenCounters (16-bit + Flag)G23 V02 FrozenCounterEvents (16-bit + Flag)

G23 V06 FrozenCounterEvents (16-bit + Flag + Time)

G30 V01 AnalogInputs (32-bit + Flag)G32 V01 AnalogInputEvents (32-bit No Time)

G32 V03 AnalogInputEvents (32-bit + Time)

G30 V02 AnalogInputs (16-bit + Flag)G32 V02 AnalogInputEvents (16-bit No Time)

G32 V04 AnalogInputEvents (16-bit + Time)

G30 V05 AnalogInputs (Single Float + Flag)G32 V05 AnalogInputEvents (Single Float No Time)

G32 V07 AnalogInputEvents (Single Float + Time)

G30 V06 AnalogInputs (Double Float + Flag)G32 V06 AnalogInputEvents (Double Float No Time)

G32 V08 AnalogInputEvents (Double Float + Time)

G31 V01 FrozenAnalogInputs (32-bit + Flag)G33 V01 FrozenAnalogInputEvents (32-bit No Time)

G33 V03 FrozenAnalogInputEvents (32-bit + Time)

G31 V02 FrozenAnalogInputs (16-bit + Flag)G33 V02 FrozenAnalogInputEvents (16-bit No Time)

G33 V04 FrozenAnalogInputEvents (16-bit + Time)


Appendix D DNP3 Event Summary

G31 V07 FrozenAnalogInputs (Single Float + Flag)G33 V05 FrozenAnalogInputEvents (Single Float No Time)

G33 V07 FrozenAnalogInputEvents (Single Float + Time)

G31 V08 FrozenAnalogInputs (Double Float + Flag)G33 V06 FrozenAnalogInputEvents (Double Float No Time)

G33 V08 FrozenAnalogInputEvents (Double Float + Time)

G40 V01 AnalogOutputStatus (32-bit + Flag)G42 V01 AnalogOutputEvents (32-bit No Time)

G42 V03 AnalogOutputEvents (32-bit + Time)

G40 V02 AnalogOutputStatus (16-bit + Flag)G42 V02 AnalogOutputEvents (16-bit No Time)

G42 V04 AnalogOutputEvents (16-bit + Time)

G40 V03 AnalogOutputStatus (Single Float + Flag)G42 V05 AnalogOutputEvents (Single Float No Time)

G42 V07 AnalogOutputEvents (Single Float + Time)

G40 V04 AnalogOutputStatus (Double Float + Flag)G42 V06 AnalogOutputEvents (Double Float No Time)

G42 V08 AnalogOutputEvents (Double Float + Time)

G41 V01 AnalogOutputs (32-bit)G43 V01 AnalogOutputCommandEvents (32-bit No Time)

G43 V03 AnalogOutputCommandEvents (32-bit + Time)

G41 V02 AnalogOutputs (16-bit)G43 V02 AnalogOutputCommandEvents (16-bit No Time)

G43 V04 AnalogOutputCommandEvents (16-bit + Time)

G41 V03 AnalogOutputs (Single Float)G43 V05 AnalogOutputCommandEvents (Single Float No Time)

G43 V07 AnalogOutputCommandEvents (Single Float + Time)

G41 V04 AnalogOutputs (Double Float)G43 V06 AnalogOutputCommandEvents (Double Float No Time)

G43 V08 AnalogOutputCommandEvents (Double Float + Time)

Static Event Options

Group Variation

Description Group Variation

Description


Appendix E

Specifications

System Hardware Input/output

Processor and Memory• 800 MHz CPU• x86 Architecture• 512 MB on board System Memory• Solid-state Embedded update disk (2 GB) Standard (4 GB) Optional

Attribute Value

Analog Inputs • 8 Channels - Single Ended• 24-bit resolution• Range is 0-5V DC or 4-20 mA• Transient protection diodes.• Overvoltage Protection up to 24V DC• Overcurrent Protection up to 25 mA• 250 Ω Impedance in mA mode• 0.1% FS Calibrated Accuracy

Digital Inputs • 9 Channels• Optically Isolated up to 5 kV-rms• Overvoltage Protection up to 24V DC• Max. 400 Hz Input rate• 1 kΩ Input Impedance• 4V DC minimum High-level threshold

Digital Outputs • 8 Channels - Single Ended• Open-collector type.• Max. sinking 500 mA per channel• Clamp terminal that is provided for Inductive loads

Analog Outputs • 2 Channels• 12-bit resolution• 0...5V DS or 4-20mA Modes• Sourcing Type• Max. load 400 Ω on mA mode• Max. load 500 kΩ on Voltage mode• Overvoltage Protection up to 15V DC• Current output that is limited to 25 mA• 10 Ω Output Impedance in mA mode• 0.5% FS Calibrated Accuracy

Board Temperature Sensor • Independent Analog Input sensor (Ch-9)• ±2 °C Accuracy over temperature• ±0.5 °C linearity• -40°C to +125 °C Operating temp.

Onboard Humidity Sensor • Independent Analog Input sensor (Ch-10)• ±3% RH Accuracy• 0% to 100% RH Operating range


Appendix E Specifications

Ethernet Communications Ports• Two Integrated 10/100 Ethernet ports with TX/RX light-emitting diode

Serial Communication Ports• COM1 RJ45-F type connection with light-emitting diode (Opto-

Isolated)• RS-232 (Default) / RS-485 (Optional - software selectable via BIOS)• COM2 RS-485 with light-emitting diode• COM3 with light-emitting diode (Not available for users)• COM4 RS-485 (Optional) / RS-232 (Default - switch selectable)

(Disabled if Wireless Module Option is installed)• 2 USB 2.0

Timer/Clock• Onboard battery-backed RTC• NTP synchronization available• Watchdog timers - one Hardware and one Software

Video Output• VGA D-Sub15 Connector• Max. Resolution 800 x 600

Wireless Communications Optional Wireless Kit that supports proprietary Rockwell Automation WMP protocol (900 MHz and 2.4 GHz)

Environmental SpecificationsAttribute Value

Operating Temperature (IEC 60068-2-14 Na) -30°C to +70 °C (-22 °F to + 158 °F)

Storage Temperature -40°C to +85 °C (-40°F to + 185 °F)

Humidity Range 5...85% noncondensing

Emissions CISPR 11: Group 1, Class A

ESD Immunity (IEC 61000-4-2) 6 kV Contact, 8 kV Air

Radiated RF Immunity (IEC 61000-4-3) • 10V/m with 1 kHz sine-wave 80% AM from 80... 2000 MHz• 3V/m with 1 kHz sine-wave 80% AM from 1400...2000 MHz• 1V/m with 1 kHz sine-wave 80% AM from 2000...2700 MHz


Specifications Appendix E

Mechanical Specifications

Power Consumption

Software Specifications

EFT/B Immunity (IEC 61000-4-4) • ±2 kV on signal ports• ±2 kV on Power ports• ±1 kV on communication ports

Surge Transient Immunity (IEC 61000-4-5) • ±1 kV line-earth (CM) on signal ports• ±1 kV line-earth (CM) on communication ports

Conducted RF Immunity (IEC61000-4-6) 10V rms with 1 kHz sine-wave 80% AM from 150 kHz...80 MHz on all ports

Attribute Value

Attribute Value

General Dimensions (W x H x D) • 127 mm x 123.96 mm x 90 mm• 5.00" x 4.88" x 3.54"

Weight • 900 grams• 2 lbs

Mount Style DIN Rail (EN 50022 - 35 x 7.5)

Enclosure Type Rating Metal Enclosure meets IP20

Attribute Value

Supply Voltage +24V DC Nominal (+12V DC to 28V DC Range), Class 2

Power Consumption 4 Watts

Attribute Value

Operating System Open Source LINUX


Appendix E Specifications

Firmware Specifications Basic Modules• LINUX Operating System• System Manager to monitor health status for each module• Remote firmware update• Web server (Configuration and Reporting)• Daily Report Generation• Remote Login and system maintenance• MODBUS Slave communication Protocol (TCP and RTU)• MODBUS Master to connect with third-party devices (TCP and RTU)• Data Logging• WMP Gateway• IEC 61131-3 Standard User Programmability

Advanced Optional Modules• Net Oil computer (NOC)• Flow Calculation (AGA3, AGA7, AGA8, AGA9, API 21.1)• Well Test


Index

Aacceptlistenonly parameter 29adapter

I/O 27remote 27

addressRTU IP 31destination 73factory default IP 33IP 98IP configuration page 25local register 63local start 62Modbus register 71slave start 62source 37

address bar 35alarm 73

alarms configuration 73analog inputs 15analog output 17API reports 32application

advanced 75download 87Ethernet/IP scanner 27flow computer 31internal 39ISAGRAF 95safe installation 12upgrade 92web server menu 37

attributeabortonfail 29

automation collaborative platform 93

Bbase unit

mounting dimensions 14electrostatic discharge 14removal 14

baud rate 23BIOS settings 101

serial/parellel port configuration 102set up iXC2 COM1 as RS-485 101southbridge configuration 101

bitsdatas 23stop 23

Ccables

safety 12in use 19

certification 11channel

alarm configuration 73analog input channels 15configuration

AI 47AO 49DI 48DO 51

CIP implementation 27CIP library 28class 3 connection 28COM 1 - RS-232 19COM 2 - RS-485 20COM 4 - RS-232 20common industrial protocol 26communication

class 1 30synchronous 28

communication portsCOM 1– rs-232 19COM 2 – rs-485 20COM 4 – rs-232 20LAN1 and LAN2 - Ethernet port 21TCP/IP connections 21USB 21WMPprotocol 20

conditional polling 61configuration

board time 38channel


COMport 22default communication 23device ID 38DNP3 master 114Ethernet port 21Ethernet/IP device 27internal transfer 68modbus data copy 72Modbus RTU master 59Modbus TCP master 64report 31RTU kernel 39, 75RTU slave 53slave device 61TCP slave 56web server 85WMP 77WMP hardware 84

configurerestore default configuration 87


Index

connectionclass 1 28class 3 28listen only 29

connection management 30connection status 32ConnectionPath parameter 30connectionstatus integer 32connector pinout 21

RJ45 21RTU 11

access 35features overview 11mounting 16power 15

Ddata

acquisition 9destination 69download files 89downloadlogs 90exchange 30tranfers 70

data bits 25data copy

Modbus 39Modbus configuration 74

data logger 39data point window 73data types 73

ISAGRAF DINT datatype 99INT datatype 99Real datatype 99

debounce time 50default value on start up 51destination address 74diagnostics 46

hardware 46software 46

DIN rail 16DIP switch

configuration 84overview 18

DNP3application 116master 116implementation 32

downloadconfiguration files 90data files 89data logs 90ISAGRAPH projects 89logs 90

Eembedded I/O

analog inputs 17analog outputs 19digital inputs 19digital outputs 20

Enron Modbusimplementation 35polling master 35

Ethernet/IP device configuration 29implementation 32scanner application 29

Ffeature

COM portCOM1 11COM2 11COM4 11LAN1 Ethernet 11LAN2 Ethernet 11USB 11

connector antenna 11overview 11power

status indicator 11switch 11primary terminal connector 11secondary terminal connector 11

RJ45 connector pinout 11terminal

analog input 11analog output 11digital input 11digital output 11opti-isolator digital input 11

flow computer application 35forward open request 30

Ggrounding 14

Hhardware

diagnostics 46opti-isolator DI 19RTU information 45WMP configuration 84

hardware handshakeenable 26overview 21

home page 38


Index

Iinput range

DC input range 15install

RTU 13installation

hazardous locations 14ISAGRAF

add a new device 98build the project 101configure the connection settings 100create a new project 95create a simple-addition program 101create target variables 97import target definitions 96new project 95

Llatitude 85library

CIP 30list identity 30list interfaces 30list services 30listen-only connections 31logging

data 72messages 71

login options 35factory default IP address 37user level description 37

longitude 85

Mmemory

nonvolatile usage 47Modbus

3rd party interface 61configuration

device ID 44Modbus data copy 74Modbus RTU master 61Modbus TCP master 65

data copy 39default device ID 25mapping report 114monitor 112port 57protocol type 56queries 63register 64register oveerview 29register type 68RS-485 22RTU master 22RTU slave 22slave module 67statistics 59timeout 63

modesAO digital and voltage 51API 79big-endian 64common log file type 73current 51digital input 50digital output 54factor 63host file selection 92local 63pulse output 54radio 79range 64remote 63single-log file type 73

module status 47monitoring

RTU operation 11using the VGA port 71using watch dog time 41

mountingdimensions 16DIN rail 16drilling holes 14requirements 16surfaces 16

Nnetwork

ETCP 100LAN1 and LAN2 configuration 27remote operations 11TCP 71

newlink DIP switchesaccess 18

newlink statussystem s 45

non-zero pulse duration 53

Oownership conflict 31


Index

Pparameter

acceptlistenonly 31connectionpath 30DNP3 master mapping 118pre-connection 31

powerRTU 15primary terminal connector 11removal 18safety 14secondary terminal connector 11status indicator 15supply voltage 47switch 10switch the setting 18

power lines 14pre-connection parameters 31protocol

interface 39, 55TCP 30user datagram 30WMP 22

configuration 79protocol interfaces 32pulse accumulation 50pulse counter 50

Rradio port 84range86voltage range 17raw count value 49register session 30remote I/O adapter 29report configuration 35requested packet interval 30reserved slave IDs 63resolution

12-bit resolution 1924-bit resolution 17

restart limit value 41restore all default 87RPI 30RTU 29

SScanGroup settings 63send RR data 30send unit data 30service

set attribute single 31set points 75software

diagnostics 46return to original settings 87versions 47watch-dog timer 42

source address 74statistics

DNP3 32RTU master 65RTU slave 57TCP master 69TCP slave 59WMP 82

statusconnection 32module 78

status indicatorCOM2 22power15

stop bits 25synchronous communication 30system status 45system upgrade 93

Ttarget ID 63terminals


time synchronization 42tools 13transmitters

change ID 82registered 81rejected 80

trigger register 63triggers 120

UUDP 30UNIX time stamp 72unregister session 30upgrade

application 94system 93

user-datagram protocol 30


Index

VvMiConfig 105

create a project 109mapping and reformat options 120software installation 107

Wwatch dog interval 41web server 11

configuration 78log in 38

wireless messaging protocol (WMP) 79

XXML 29


Index

Notes:


Publication 1759-UM001D-EN-P - January 2018Supersedes Publication 1759-UM001B-EN-P - October 2016 Copyright © 2018 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.

Rockwell Automation SupportUse the following resources to access support information.

Documentation FeedbackYour comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the How Are We Doing? form at http://literature.rockwellautomation.com/idc/groups/literature/documents/du/ra-du002_-en-e.pdf.

Technical Support Center Knowledgebase Articles, How-to Videos, FAQs, Chat, User Forums, and Product Notification Updates. https://rockwellautomation.custhelp.com/

Local Technical Support Phone Numbers Locate the phone number for your country. http://www.rockwellautomation.com/global/support/get-support-now.page

Direct Dial Codes Find the Direct Dial Code for your product. Use the code to route your call directly to a technical support engineer. http://www.rockwellautomation.com/global/support/direct-dial.page

Literature Library Installation Instructions, Manuals, Brochures, and Technical Data. http://www.rockwellautomation.com/global/literature-library/overview.page

Product Compatibility and Download Center (PCDC)

Get help determining how products interact, check features and capabilities, and find associated firmware. http://www.rockwellautomation.com/global/support/pcdc.page

.

Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400

Rockwell Automation maintains current product environmental information on its website at http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page.

Allen-Bradley, FLEX, ISAGRAF, Rockwell Automation, Rockwell Software, and vMiConfig are trademarks of Rockwell Automation, Inc.Trademarks not belonging to Rockwell Automation are property of their respective companies.

http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page