The Ethernet/IP plugin

PRINTED MANUAL

© 1999-2017 AGG Software

Ethernet/IP plugin

© 1999-2017 AGG Software

All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or
mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the
written permission of the publisher.

Products that are referred to in this document may be either trademarks and/or registered trademarks of the
respective owners. The publisher and the author make no claim to these trademarks.

While every precaution has been taken in the preparation of this document, the publisher and the author assume no
responsibility for errors or omissions, or for damages resulting from the use of information contained in this
document or from the use of programs and source code that may accompany it. In no event shall the publisher and
the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused
directly or indirectly by this document.

Printed: 7/6/2017

Publisher
AGG Software

Production
© 1999-2017 AGG Software
http://www.aggsoft.com
 Contents I

Table of Contents

Part 1 Introduction 1

Part 2 System requirements 1

Part 3 Installing Ethernet/IP 2

Part 4 Glossary 3

Part 5 User Manual 3

1 Data...................................................................................................................................
query 3
2 Request
...................................................................................................................................
method 5
3 AB Micro
...................................................................................................................................
800 5
4 AB MicroLogix
...................................................................................................................................
1400 7

Part 6 Troubles? 10
1 Possible
...................................................................................................................................
problems 10

© 1999-2017 AGG Software

1 Ethernet/IP plugin

1 Introduction
This parser plugin allows to read tag values from ControlLogix, PLC 5, SLC 500 and MicroLogix
controllers using EtherNet/IP protocol. The parser uses "Unconnected Messages" with PCCC-style
commands. EtherNet/IP is an industrial network protocol that adapts the Common Industrial Protocol
to standard Ethernet.

Features:
· Can send valid data request to any EtherNet/IP-compatible device;
· Symbolic or class/instance/attribute addressing;
· Supports various data types: STRING, BOOL, CONTROL, COUNTER, DINT, INT, LINT, REAL,
SINT, TIMER, USINT, UINT, UDINT, ULINT, LREAL, STRING, DATETIME, DATE, TIME;
· Automatically detects a data type of returned data.
· Can read arrays.
· Can poll data by a custom interval.

2 System requirements
The following requirements must be met for "Ethernet/IP" to be installed:

Operating system: Windows 2000 SP4 and above, including both x86 and x64 workstations and
servers. A latest service pack for the corresponding OS is required.
Free disk space: Not less than 5 MB of free disk space is recommended.
Special access requirements: You should log on as a user with Administrator rights in order to
install this module.

The main application (core) must be installed, for example, Advanced Serial Data Logger.

Notes for Microsoft Vista and above:

Since our software saves data to the registry and installs to the Program Files folder, the following
requirements must be met:

1. You need Administrator rights to run and install our software

2. The shortcut icon of our software will be located on the desktop;
3. Windows Vista will ask for your confirmation to continue the installation.

NOTE: You can configure the user account only once in order not to see the above dialog box any
more. Search Google for the solution of this problem.

© 1999-2017 AGG Software

 Installing Ethernet/IP 2

3 Installing Ethernet/IP
1. Close the main application (for example, Advanced Serial Data Logger) if it is running;
2. Copy the program to your hard drive;
3. Run the module installation file with a double click on the file name in Windows Explorer;
4. Follow the instructions of the installation software. Usually, it is enough just to click the "Next"
button several times;
5. Start the main application. The name of the module will appear on the "Modules" tab of the
"Settings" window if it is successfully installed.

If the module is compatible with the program, its name and version will be displayed in the module
list. You can see examples of installed modules on fig.1-2. Some types of modules require additional
configuration. To do it, just select a module from the list and click the "Setup" button next to the list.
The configuration of the module is described below.

You can see some types of modules on the "Log file" tab. To configure such a module, you should
select it from the "File type" list and click the "Advanced" button.

Fig.1. Exam ple of installed m odule

© 1999-2017 AGG Software

3 Ethernet/IP plugin

4 Glossary
Plug-in - module

Main program – the program shell that uses this module. For example: Advanced Serial Data
Logger

Parser – the module that processes the data flow singling out data packets from it and variables
from data packets. These variables are used in data export modules after that.

Core - see "Main program".

5 User Manual
5.1 Data query
To add new item click "Actions->Add new request". The dialog window will be shown (fig.1). Enter a
request description, that can contain any characters and click the "OK" button.

Fig.1. Nam e dialog

The new request will appear in the requests tree (fig.2). Each request has few important options:

· Device path - a path to your EIP compatible PLC in the Ethernet/IP network. Should be empty
for direct connections;
· Address - it's an address (symbolic name) of a data item in the PLC's memory. If the item is an
array then you may add an index in this array;

Examples:

VALUE1 - read data from the "VALUE1" tag.

VALUE1[2] - VALUE1 is an array and the program will read the 3rd element from this array (the
array index starts from 0).
@22/1/1 - read data from class 22, instance 1 and attribute 1.

· Number of elements to read - for arrays you may read the specified number of sequential
elements;
· Request timeout - after reaching the timeout limit the program will automatically cancel current
request and execute next request in the queue. The timeout value depends on the network on

© 1999-2017 AGG Software

 User Manual 4

which master (program) and slave (device) is running. If the network is slow then timeout value
should be larger and if network is fast then timeout value can be small.
· Export name - if this value is not empty the program will export the tag's value using this name.
If the name is empty the the program will using the address as a name.
· Scale - if this parameters is not equal 1 then the program will scale a returned value using this
coefficient;
· Default value - this value will be used if the parser can't get the specified values from a
response.

Fig.2. Requests

© 1999-2017 AGG Software

5 Ethernet/IP plugin

5.2 Request method

The plugin can send requests in two modes:

· Once, on program startup - the program will send request once, when the program starts.
· Polling - the program will be sending request periodically based on an interval specified. The
interval between requests depends on the network on which master (program) and slave (device)
is running. If the network is slow then time for each request will be larger and vice versa.
Because, the program are executing all requests in the queue one by one, then time between
requests depends on the number of requests in the queue.

Fig.3. Request m ethods

If you added few requests to the queue, then you can move it up and down. Select a request title and
execute a corresponding menu item by clicking the "Actions" button.
With help of this button you can change an item description and delete requests.

You can access all actions through the popup menu in the request tree.

5.3 AB Micro 800

This PLC series uses a symbolic addressing method. The program may read data from the "Global
variables" area by a tag name. The logger should work in the TCP client mode and connect to a port
#44818, directly to the PLC.

© 1999-2017 AGG Software

 User Manual 6

Fig.1. Tag in a PLC

Fig.2. Data parser

© 1999-2017 AGG Software

7 Ethernet/IP plugin

Fig.3. Queue

5.4 AB MicroLogix 1400

This PLC series does not support a symbolic addressing method. The program may read data from
area by a file type and address. The following file types are supported:

R - Control;
C - Counter;
F - Floating-point;
I - Input;
N - Integer;
O - Output;
T - Timer;

The data address should look like: N7:0

N - file data type ID.

7 - file number.

© 1999-2017 AGG Software

 User Manual 8

0 - element address

The logger should work in the TCP client mode and connect to a port #44818, directly to the PLC.

Fig.2. Data parser

© 1999-2017 AGG Software

9 Ethernet/IP plugin

Fig.3. Queue

© 1999-2017 AGG Software

 Troubles? 10

6 Troubles?
6.1 Possible problems
No data for publication/exporting – no data is passed for exporting. Solution: configure the
parser, make sure that one or more variables are declared in the parser.

Error on binding variable with name %s [%s] – the error usually occurs if data does not
correspond to the specified format. For example, the date and time format does not correspond to
the data.

Unable to disconnect from the database [%s] and Unable to connect to a database [%s] – it is
impossible to connect/disconnect to/form the database. You should check the parameters of the
database connection. The analysis of the additional information will help you locate the error.

Database access error [%s]. Stop operations with the database? – the message appears if an error
occurs during an attempt to execute an SQL query if the second variant of reacting to errors is
selected. The message implies a "Yes" or "No" answer. The analysis of the additional information
will help you locate the error.

Unable to verify your SQL script [%s] – the message appears when an attempt to analyze your
SQL query fails. Check if the syntax of your SQL query is correct.

Tested successfully – the message appears if your database connection is successfully tested. It
requires no additional actions.

Database isn't used – the message appears if the module is temporarily disabled (the "Temporarily
disabled" check box is selected) or the database name field is empty. Check the connection
parameters.

Database isn't selected - the message appears if the database type is not selected. Check the
connection parameters.

Database: %s – %s contains the database name. The message appears if the database connection
is successful. Usually, you see it when you call the module for the first time. It requires no additional
actions.

Invalid data block length (columns=%d,length=%d) – an internal application error. It means that
the data sent by the parser is in an invalid format. Perhaps, you are using the module incompatible
with the version of the Advanced Serial Data Logger kernel. Update the versions of both the kernel
and the module.

The time of connection is not due yet (%d,%d) – the message appears during an attempt to
connect to the database after the connection to it has been lost and the "Reconnect after" option is
enabled. No additional actions are required.

Invalid procedure call. Bad arguments –an attempt to call the module using invalid parameters.
Perhaps, you are using the module incompatible with the version of the Advanced Serial Data Logger
kernel. Update the versions of both the kernel and the module.

© 1999-2017 AGG Software

11 Ethernet/IP plugin

Writing to the database is complete - the message appears if your queue of SQL queries is
successfully executed. It requires no additional actions.

Writing to the database is complete with errors – the message appears if the executing your
queue of SQL queries was interrupted by an error. It requires no additional actions.

Your SQL is empty. Please, specify some SQL text first – the message appears if you do not
enter the text for your SQL query. Check if the options on the "SQL queue" tab are configured
correctly.

Invalid temporary path – the path to the temporary file specified by you does not exist. Enter a
new path in the "Temporary folder" field on the "Errors handling" tab.

%s, %d – will be replaced by additional information.

© 1999-2017 AGG Software