MCPcopy Index your code
hub / github.com/digitalpetri/ethernet-ip

github.com/digitalpetri/ethernet-ip @v1.6.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.6.0 ↗ · + Follow
736 symbols 1,542 edges 98 files 54 documented · 7%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

EtherNet/IP Client

Build status Maven Central

Asynchronous, non-blocking, EtherNet/IP client implementation for Java

Maven

EtherNet/IP Client

<dependency>
    <groupId>com.digitalpetri.enip</groupId>
    <artifactId>enip-client</artifactId>
    <version>1.4.1</version>
</dependency>

CIP Client

<dependency>
    <groupId>com.digitalpetri.enip</groupId>
    <artifactId>cip-client</artifactId>
    <version>1.4.1</version>
</dependency>

Quick Start

EtherNet/IP Example

EtherNetIpClientConfig config = EtherNetIpClientConfig.builder("10.20.4.57")
        .setSerialNumber(0x00)
        .setVendorId(0x00)
        .setTimeout(Duration.ofSeconds(2))
        .build();

EtherNetIpClient client = new EtherNetIpClient(config);

client.connect().get();

client.listIdentity().whenComplete((li, ex) -> {
    if (li != null) {
        li.getIdentity().ifPresent(id -> {
            System.out.println("productName=" + id.getProductName());
            System.out.println("revisionMajor=" + id.getRevisionMajor());
            System.out.println("revisionMinor=" + id.getRevisionMinor());
        });
    } else {
        ex.printStackTrace();
    }
});

client.disconnect().get();

// Call this before application / JVM shutdown
EtherNetIpShared.releaseSharedResources();

CIP Service Example

EtherNetIpClientConfig config = EtherNetIpClientConfig.builder("10.20.4.57")
        .setSerialNumber(0x00)
        .setVendorId(0x00)
        .setTimeout(Duration.ofSeconds(2))
        .build();

// backplane, slot 0
PaddedEPath connectionPath = new PaddedEPath(
        new PortSegment(1, new byte[]{(byte) 0}));

CipClient client = new CipClient(config, connectionPath);

client.connect().get();

GetAttributeListService service = new GetAttributeListService(
        new PaddedEPath(new ClassId(0x01), new InstanceId(0x01)),
        new int[]{4},
        new int[]{2}
);

client.invokeUnconnected(service).whenComplete((as, ex) -> {
    if (as != null) {
        try {
            ByteBuf data = as[0].getData();
            int major = data.readUnsignedByte();
            int minor = data.readUnsignedByte();

            System.out.println(String.format("firmware v%s.%s", major, minor));
        } catch (Throwable t) {
            t.printStackTrace();
        } finally {
            Arrays.stream(as).forEach(a -> ReferenceCountUtil.release(a.getData()));
        }
    } else {
        ex.printStackTrace();
    }
});

client.disconnect().get();

// Call this before application / JVM shutdown
EtherNetIpShared.releaseSharedResources();

Logix Example

See the logix-services README!

License

Apache License, Version 2.0

Extension points exported contracts — how you extend this code

CipService (Interface)
(no doc) [17 implementers]
cip-core/src/main/java/com/digitalpetri/enip/cip/services/CipService.java
CipConnectionFactory (Interface)
(no doc) [2 implementers]
cip-client/src/main/java/com/digitalpetri/enip/cip/CipConnectionPool.java
ChannelStateListener (Interface)
(no doc)
enip-client/src/main/java/com/digitalpetri/enip/EtherNetIpClient.java
CipServiceInvoker (Interface)
(no doc) [2 implementers]
cip-core/src/main/java/com/digitalpetri/enip/cip/services/CipServiceInvoker.java
CpfItemHandler (Interface)
(no doc) [2 implementers]
cip-client/src/main/java/com/digitalpetri/enip/cip/CipClient.java

Core symbols most depended-on inside this repo

v
called by 46
cip-core/src/main/java/com/digitalpetri/enip/cip/CipStatusCodes.java
release
called by 34
cip-client/src/main/java/com/digitalpetri/enip/cip/CipConnectionPool.java
getData
called by 24
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/MessageRouterResponse.java
complete
called by 24
enip-client/src/main/java/com/digitalpetri/enip/util/FutureUtils.java
getGeneralStatus
called by 23
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/MessageRouterResponse.java
encode
called by 17
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/MessageRouterRequest.java
getAdditionalStatus
called by 16
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/MessageRouterResponse.java
decode
called by 16
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/MessageRouterResponse.java

Shape

Method 604
Class 117
Enum 9
Interface 6

Languages

Java100%

Modules by API surface

enip-client/src/main/java/com/digitalpetri/enip/EtherNetIpClientConfig.java37 symbols
cip-core/src/main/java/com/digitalpetri/enip/cip/epath/LogicalSegment.java37 symbols
enip-client/src/main/java/com/digitalpetri/enip/EtherNetIpClient.java35 symbols
cip-client/src/main/java/com/digitalpetri/enip/cip/CipConnectionPool.java27 symbols
enip-core/src/main/java/com/digitalpetri/enip/cpf/CipIdentityItem.java19 symbols
enip-core/src/main/java/com/digitalpetri/enip/commands/ListServices.java19 symbols
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/LargeForwardOpenRequest.java17 symbols
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/ForwardOpenRequest.java17 symbols
enip-core/src/main/java/com/digitalpetri/enip/commands/ListInterfaces.java15 symbols
cip-client/src/main/java/com/digitalpetri/enip/cip/CipClient.java15 symbols
enip-core/src/main/java/com/digitalpetri/enip/EnipPacket.java13 symbols
cip-core/src/main/java/com/digitalpetri/enip/cip/structs/LargeForwardOpenResponse.java12 symbols

For agents

$ claude mcp add ethernet-ip \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact