EtherNet/IP Adapter Stack

(EADK & EIPA)

Getting Started
(For use with EtherNet/IP Adapter Stack version 4.9.0 and higher)

Pyramid Solutions, Inc.

30200 Telegraph Rd, Suite 440
Bingham Farms, Michigan 48025

Phone: 248-549-1200
Web: www.pyramidsolutions.com
 Getting Started – EtherNet/IP Adapter Stack

Document Revision

Revision Remarks Date Author

1.00 Initial Release 11/1/2006 MM
1.01 Updated for v4.0.0 release 6/8/2009 MM
1.02 Updated for v4.1.0 release 10/4/2010 MM
1.03 Updated for v4.3.0 release 8/28/2012 MM
1.04 Updated for v4.8.0 release 1/29/2018 MM
1.05 Updated for v4.9.0 release 5/14/2019 PG

Copyright © (2001 – 2019) Pyramid Solutions, Inc. Page 1

 Getting Started – EtherNet/IP Adapter Stack

TABLE OF CONTENTS

DOCUMENT REVISION .................................................................................................1

ETHERNET/IP ADAPTER STACK INSTALLATION ROADMAP ..........................3

APPLICATION OBJECTS ......................................................................................................3
Time Sync Object (0x43) ...............................................................................................3
DLR Object (0x47) ........................................................................................................3
CIP Energy Objects (0x4E-0x50)..................................................................................3
BINARIES ...........................................................................................................................3
CONFORMANCE TEST CONFIGURATION.............................................................................3
DEBUGSOCKETAPP ...........................................................................................................3
DOCS .................................................................................................................................3
EDS....................................................................................................................................3
EXAMPLES .........................................................................................................................4
LOGIX TAG READ & WRITE DEMO SOURCE ......................................................................4
SRC (EADK ONLY) ...........................................................................................................4
Microsoft Compatible Projects .....................................................................................4
Source Files ...................................................................................................................4

Copyright © (2001 – 2019) Pyramid Solutions, Inc. Page 2

 Getting Started – EtherNet/IP Adapter Stack

EtherNet/IP Adapter Stack Installation Roadmap

This document describes the directory structure for the installation of the EADK and EIPA.

Application Objects
This directory contains CIP objects that are not native to the EtherNet/IP Stack.

Time Sync Object (0x43)

The Time Sync Object is the CIP object that represents IEEE-1588 v2 time synchronization
functionality. An IEEE-1588 v2 stack is NOT included with the EtherNet/IP stack.

DLR Object (0x47)

The DLR Object provides the configuration and status information interface for the Device Level
Ring (DLR) protocol.

CIP Energy Objects (0x4E-0x50)

The CIP Energy Objects provide energy and power reporting for a device.

Binaries
This directory contains pre-built versions of the Windows C++ and C# DLLs, Demo application,
as well as a few other example applications. The Log Generator directory contains logging
versions of the DLLs. The applications in that directory are just copies of the original but will
use the logging versions of the DLL.

Conformance Test Configuration

This is the ODVA conformance test files used to pass this version of the EtherNet/IP stack. It
can be used as a starting point for any application using the EtherNet/IP stack. There are several
file to go along with a variety of stack build options; see the readme files for details on
application and build option requirements.

DebugSocketApp
This is the source for DebugSocketApp, a client application for debugging information via
sockets. For more details see Application Note “EIP0009 – DebugSocketApp.pdf”

Docs
This is the EtherNet/IP Adapter Stack documentation directory.

Eds
This is the Electronic Data Sheet (EDS) file for the EtherNet/IP Adapter Stack. This can be used
as a starting point for any application using the EtherNet/IP Adapter Stack products

Copyright © (2001 – 2019) Pyramid Solutions, Inc. Page 3

 Getting Started – EtherNet/IP Adapter Stack

Examples
This directory contains the source that corresponds to Application Notes of the same name. i.e.
“EIP0003 – PCCC Messaging.pdf” source can be found in the EIP0003 directory.

Logix Tag Read & Write Demo Source

This is the source that corresponds to the EIP0001 and EIP0002 (reading and writing tags)
Application Notes.

Src (EADK Only)

Microsoft Compatible Projects

The EADK source code directory contains all source code files required to build a Windows.
EtIPAdapter projects and workspaces are included for Microsoft Visual Studio 2015.

Source Files
The following source files are included with the EADK. For complete details on the
components referenced below see “EADK Architecture.pdf”

Filename Description
EIPAsm.c Assembly object
EIPAsm.h
EIPClien.c Main task and connection client interface used by the
EIPClien.h API.
EIPCnct.c Connections component
EIPCnct.h
EIPCnlst.c Manages connection list (mostly for
EIPCnlst.h EIP_LARGE_CONFIG_OPT)
EIPCnMgr.c Connection Manager object
EIPCnMgr.h
EIPDbg.c Debugging via sockets component
EIPDbg.h
EIPEtlnk.c Ethernet Link object
EIPEtlnk.h
EIPFile.c File object
EIPFile.h
EIPID.c Identity object
EIPID.h
EIPInc.h Include file
EIPIO.c I/O Data component
EIPIO.h
EIPNotfy.c Event Notification component
EIPNotfy.h
EIPPCCC.c Rockwell PCCC Object (0x67)
EIPPCCC.h

Copyright © (2001 – 2019) Pyramid Solutions, Inc. Page 4

 Getting Started – EtherNet/IP Adapter Stack

Filename Description
\Platform\Windows Windows specific implementation.
\Platform\WinCE Windows CE v.3.0/4.x/5.0 specific implementation.
\Platform\Linux Linux specific implementation.
\Platform\Templates Template platform files
\Platform\Netburner Netburner SDK (Motorola Coldfire) specific
implementation
\Platform\VxWorks VxWorks specific implementation
EIPPdu.c Utility functions for handling PDUs
EIPPdu.h
EIPPort.c Port object
EIPPort.h
EIPQoS.c QoS object (optionally included with EIP_QOS #define)
EIPQoS.h
EIPRoutr.c Message Router component (message component + CIP
EIPRoutr.h object)
EIPRqst.c Requests component
EIPRqst.h
EIPSckt.c Socket Interface component
EIPSckt.h
EIPSessn.c Sessions component
EIPSessn.h
EIPTcpip.c TCP/IP object
EIPTcpip.h
EIPTrace.c Debug trace utility
EIPTrace.h
EIPUCMM.c Messaging component
EIPUCMM.h
EIPUtil.c Network address and Memory access utilities.
EIPUtil.h
EtIpApi.h Structure definitions, #defines used by EtherNet/IP stack
Adapter\EtIPAdapter.cpp Application interface. Include this header file into
Adapter\EtIPAdapter.h applications that will use the EADK DLL.
Adapter\StdAfx.cpp Precompiled header file for use with VC++
Adapter\StdAfx.h

Copyright © (2001 – 2019) Pyramid Solutions, Inc. Page 5